google_api_double_click_search

v0.15.0

google_api_double_click_search v0.15.0 GoogleApi.DoubleClickSearch.V2.Api.Reports View Source

API calls for all endpoints tagged Reports.

Link to this section Summary

Functions

doubleclicksearch_reports_generate(connection, optional_params \\ [], opts \\ [])

Generates and returns a report immediately.

doubleclicksearch_reports_get(connection, report_id, optional_params \\ [], opts \\ [])

Polls for the status of a report request.

doubleclicksearch_reports_get_file(connection, report_id, report_fragment, optional_params \\ [], opts \\ [])

Downloads a report file encoded in UTF-8.

doubleclicksearch_reports_request(connection, optional_params \\ [], opts \\ [])

Inserts a report request into the reporting system.

Link to this section Functions

Link to this function

doubleclicksearch_reports_generate(connection, optional_params \\ [], opts \\ [])

View Source

Specs

doubleclicksearch_reports_generate(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DoubleClickSearch.V2.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Generates and returns a report immediately.

Parameters

  • connection (type: GoogleApi.DoubleClickSearch.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DoubleClickSearch.V2.Model.ReportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DoubleClickSearch.V2.Model.Report{}} on success
  • {:error, info} on failure
Link to this function

doubleclicksearch_reports_get(connection, report_id, optional_params \\ [], opts \\ [])

View Source

Specs

doubleclicksearch_reports_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DoubleClickSearch.V2.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Polls for the status of a report request.

Parameters

  • connection (type: GoogleApi.DoubleClickSearch.V2.Connection.t) - Connection to server
  • report_id (type: String.t) - ID of the report request being polled.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DoubleClickSearch.V2.Model.Report{}} on success
  • {:error, info} on failure
Link to this function

doubleclicksearch_reports_get_file(connection, report_id, report_fragment, optional_params \\ [], opts \\ [])

View Source

Specs

doubleclicksearch_reports_get_file(
  Tesla.Env.client(),
  String.t(),
  integer(),
  keyword(),
  keyword()
) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}

Downloads a report file encoded in UTF-8.

Parameters

  • connection (type: GoogleApi.DoubleClickSearch.V2.Connection.t) - Connection to server
  • report_id (type: String.t) - ID of the report.
  • report_fragment (type: integer()) - The index of the report fragment to download.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %{}} on success
  • {:error, info} on failure
Link to this function

doubleclicksearch_reports_request(connection, optional_params \\ [], opts \\ [])

View Source

Specs

doubleclicksearch_reports_request(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DoubleClickSearch.V2.Model.Report.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Inserts a report request into the reporting system.

Parameters

  • connection (type: GoogleApi.DoubleClickSearch.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DoubleClickSearch.V2.Model.ReportRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DoubleClickSearch.V2.Model.Report{}} on success
  • {:error, info} on failure