google_api_double_click_search v0.5.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

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

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

Generates and returns a report immediately.

Parameters

connection (type: GoogleApi.DoubleClickSearch.V2.Connection.t) - Connection to server
optional_params (type: keyword()) - Optional parameters
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :reportRequest (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

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

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

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
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

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

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

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

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
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
opts (type: keyword()) - Call options

Returns

{:ok, %{}} on success
{:error, info} on failure

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

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

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
- :alt (type: String.t) - Data format for the response.
- :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
- :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
- :reportRequest (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