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

API calls for all endpoints tagged Conversion.

Link to this section Summary

Functions

doubleclicksearch_conversion_get(connection, agency_id, advertiser_id, engine_account_id, end_date, row_count, start_date, start_row, optional_params \\ [], opts \\ [])

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

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

Inserts a batch of new conversions into DoubleClick Search.

doubleclicksearch_conversion_patch(connection, advertiser_id, agency_id, end_date, engine_account_id, row_count, start_date, start_row, optional_params \\ [], opts \\ [])

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

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

Updates a batch of conversions in DoubleClick Search.

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

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

Link to this section Functions

doubleclicksearch_conversion_get(connection, agency_id, advertiser_id, engine_account_id, end_date, row_count, start_date, start_row, optional_params \\ [], opts \\ [])

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

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

Parameters

connection (type: GoogleApi.DoubleClickSearch.V2.Connection.t) - Connection to server
agency_id (type: String.t) - Numeric ID of the agency.
advertiser_id (type: String.t) - Numeric ID of the advertiser.
engine_account_id (type: String.t) - Numeric ID of the engine account.
end_date (type: integer()) - Last date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
row_count (type: integer()) - The number of conversions to return per call.
start_date (type: integer()) - First date (inclusive) on which to retrieve conversions. Format is yyyymmdd.
start_row (type: integer()) - The 0-based starting index for retrieving conversions results.
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.
- :adGroupId (type: String.t) - Numeric ID of the ad group.
- :adId (type: String.t) - Numeric ID of the ad.
- :campaignId (type: String.t) - Numeric ID of the campaign.
- :criterionId (type: String.t) - Numeric ID of the criterion.
opts (type: keyword()) - Call options

Returns

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

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

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

Inserts a batch of new conversions into DoubleClick Search.

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.
- :body (type: GoogleApi.DoubleClickSearch.V2.Model.ConversionList.t) -
opts (type: keyword()) - Call options

Returns

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

doubleclicksearch_conversion_patch(connection, advertiser_id, agency_id, end_date, engine_account_id, row_count, start_date, start_row, optional_params \\ [], opts \\ [])

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

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

Parameters

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

Returns

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

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

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

Updates a batch of conversions in DoubleClick Search.

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.
- :body (type: GoogleApi.DoubleClickSearch.V2.Model.ConversionList.t) -
opts (type: keyword()) - Call options

Returns

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

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

doubleclicksearch_conversion_update_availability(
  Tesla.Env.client(),
  keyword(),
  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 (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.
- :empty (type: GoogleApi.DoubleClickSearch.V2.Model.UpdateAvailabilityRequest.t) -
opts (type: keyword()) - Call options

Returns

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