GoogleApi.AdExchangeBuyer.V14.Api.PretargetingConfig (google_api_ad_exchange_buyer v0.36.0) View Source

API calls for all endpoints tagged PretargetingConfig.

Link to this section Summary

Link to this section Functions

Link to this function

adexchangebuyer_pretargeting_config_delete(connection, account_id, config_id, optional_params \\ [], opts \\ [])

View Source

Specs

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

Deletes an existing pretargeting config.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
  • account_id (type: String.t) - The account id to delete the pretargeting config for.
  • config_id (type: String.t) - The specific id of the configuration to delete.
  • 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
Link to this function

adexchangebuyer_pretargeting_config_get(connection, account_id, config_id, optional_params \\ [], opts \\ [])

View Source

Specs

adexchangebuyer_pretargeting_config_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Gets a specific pretargeting configuration

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
  • account_id (type: String.t) - The account id to get the pretargeting config for.
  • config_id (type: String.t) - The specific id of the configuration to retrieve.
  • 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.AdExchangeBuyer.V14.Model.PretargetingConfig{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer_pretargeting_config_insert(connection, account_id, optional_params \\ [], opts \\ [])

View Source

Specs

adexchangebuyer_pretargeting_config_insert(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Inserts a new pretargeting configuration.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
  • account_id (type: String.t) - The account id to insert the pretargeting config for.
  • 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.AdExchangeBuyer.V14.Model.PretargetingConfig.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer_pretargeting_config_list(connection, account_id, optional_params \\ [], opts \\ [])

View Source

Specs

adexchangebuyer_pretargeting_config_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfigList.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Retrieves a list of the authenticated user's pretargeting configurations.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
  • account_id (type: String.t) - The account id to get the pretargeting configs for.
  • 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.AdExchangeBuyer.V14.Model.PretargetingConfigList{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer_pretargeting_config_patch(connection, account_id, config_id, optional_params \\ [], opts \\ [])

View Source

Specs

adexchangebuyer_pretargeting_config_patch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing pretargeting config. This method supports patch semantics.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
  • account_id (type: String.t) - The account id to update the pretargeting config for.
  • config_id (type: String.t) - The specific id of the configuration to update.
  • 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.AdExchangeBuyer.V14.Model.PretargetingConfig.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer_pretargeting_config_update(connection, account_id, config_id, optional_params \\ [], opts \\ [])

View Source

Specs

adexchangebuyer_pretargeting_config_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Updates an existing pretargeting config.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V14.Connection.t) - Connection to server
  • account_id (type: String.t) - The account id to update the pretargeting config for.
  • config_id (type: String.t) - The specific id of the configuration to update.
  • 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.AdExchangeBuyer.V14.Model.PretargetingConfig.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.AdExchangeBuyer.V14.Model.PretargetingConfig{}} on success
  • {:error, info} on failure