google_api_double_click_search

v0.0.1

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

API calls for all endpoints tagged Reports.

Link to this section Summary

Functions

doubleclicksearch_reports_generate(connection, opts \\ [])

Generates and returns a report immediately

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

Polls for the status of a report request

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

Downloads a report file encoded in UTF-8

doubleclicksearch_reports_request(connection, opts \\ [])

Inserts a report request into the reporting system

Link to this section Functions

Link to this function doubleclicksearch_reports_generate(connection, opts \\ []) View Source 
doubleclicksearch_reports_generate(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.DoubleClickSearch.V2.Model.Report.t} |
  {:error, Tesla.Env.t}

Generates and returns a report immediately.

Parameters

  • connection (GoogleApi.DoubleClickSearch.V2.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :report_request (ReportRequest):

Returns

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

Link to this function doubleclicksearch_reports_get(connection, report_id, opts \\ []) View Source 
doubleclicksearch_reports_get(Tesla.Env.client, String.t, keyword) ::
  {:ok, GoogleApi.DoubleClickSearch.V2.Model.Report.t} |
  {:error, Tesla.Env.t}

Polls for the status of a report request.

Parameters

  • connection (GoogleApi.DoubleClickSearch.V2.Connection): Connection to server
  • report_id (String): ID of the report request being polled.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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, opts \\ []) View Source 
doubleclicksearch_reports_get_file(Tesla.Env.client, String.t, Integer.t, keyword) ::
  {:ok, nil} |
  {:error, Tesla.Env.t}

Downloads a report file encoded in UTF-8.

Parameters

  • connection (GoogleApi.DoubleClickSearch.V2.Connection): Connection to server
  • report_id (String): ID of the report.
  • report_fragment (Integer): The index of the report fragment to download.

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Returns

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

Link to this function doubleclicksearch_reports_request(connection, opts \\ []) View Source 
doubleclicksearch_reports_request(Tesla.Env.client, keyword) ::
  {:ok, GoogleApi.DoubleClickSearch.V2.Model.Report.t} |
  {:error, Tesla.Env.t}

Inserts a report request into the reporting system.

Parameters

  • connection (GoogleApi.DoubleClickSearch.V2.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :alt (String): Data format for the response.
    • :fields (String): Selector specifying which fields to include in a partial response.
    • :key (String): 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 (String): OAuth 2.0 token for the current user.
    • :pretty_print (Boolean): Returns response with indentations and line breaks.
    • :quota_user (String): 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. Overrides userIp if both are provided.
    • :user_ip (String): IP address of the site where the request originates. Use this if you want to enforce per-user limits.
    • :report_request (ReportRequest):

Returns

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