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

API calls for all endpoints tagged Conversion.

Link to this section Summary

Functions

Inserts a batch of new conversions into DoubleClick Search

Updates a batch of conversions in DoubleClick Search

Updates the availabilities of a batch of floodlight activities in DoubleClick Search

Link to this section Functions

Link to this function doubleclicksearch_conversion_get(connection, agency_id, advertiser_id, engine_account_id, end_date, row_count, start_date, start_row, opts \\ []) View Source

Retrieves a list of conversions from a DoubleClick Search engine account.

Parameters

  • connection (GoogleApi.DoubleClickSearch.V2.Connection): Connection to server
  • agency_id (String): Numeric ID of the agency.
  • advertiser_id (String): Numeric ID of the advertiser.
  • engine_account_id (String): Numeric ID of the engine account.
  • end_date (Integer): Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
  • row_count (Integer): The number of conversions to return per call.
  • start_date (Integer): First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
  • start_row (Integer): The 0-based starting index for retrieving conversions results.
  • 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.
    • :ad_group_id (String): Numeric ID of the ad group.
    • :ad_id (String): Numeric ID of the ad.
    • :campaign_id (String): Numeric ID of the campaign.
    • :criterion_id (String): Numeric ID of the criterion.

Returns

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

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

Inserts a batch of new conversions into DoubleClick Search.

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.
    • :body (ConversionList):

Returns

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

Link to this function doubleclicksearch_conversion_patch(connection, advertiser_id, agency_id, end_date, engine_account_id, row_count, start_date, start_row, opts \\ []) View Source

Updates a batch of conversions in DoubleClick Search. This method supports patch semantics.

Parameters

  • connection (GoogleApi.DoubleClickSearch.V2.Connection): Connection to server
  • advertiser_id (String): Numeric ID of the advertiser.
  • agency_id (String): Numeric ID of the agency.
  • end_date (Integer): Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
  • engine_account_id (String): Numeric ID of the engine account.
  • row_count (Integer): The number of conversions to return per call.
  • start_date (Integer): First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
  • start_row (Integer): The 0-based starting index for retrieving conversions results.
  • 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.
    • :body (ConversionList):

Returns

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

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

Updates a batch of conversions in DoubleClick Search.

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.
    • :body (ConversionList):

Returns

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

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

Updates the availabilities of a batch of floodlight activities in DoubleClick Search.

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.
    • :empty (UpdateAvailabilityRequest):

Returns

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