GoogleApi.RealTimeBidding.V1.Api.Buyers (google_api_real_time_bidding v0.13.2)

View Source

API calls for all endpoints tagged Buyers.

Summary

Functions

realtimebidding_buyers_creatives_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a creative.

realtimebidding_buyers_creatives_get(connection, name, optional_params \\ [], opts \\ [])

Gets a creative.

realtimebidding_buyers_creatives_list(connection, parent, optional_params \\ [], opts \\ [])

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.

realtimebidding_buyers_creatives_patch(connection, name, optional_params \\ [], opts \\ [])

Updates a creative.

realtimebidding_buyers_get(connection, name, optional_params \\ [], opts \\ [])

Gets a buyer account by its name.

realtimebidding_buyers_get_remarketing_tag(connection, name, optional_params \\ [], opts \\ [])

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

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

Lists all buyer account information the calling buyer user or service account is permissioned to manage.

realtimebidding_buyers_user_lists_close(connection, name, optional_params \\ [], opts \\ [])

Changes the status of a user list to CLOSED. This prevents new users from being added to the user list.

realtimebidding_buyers_user_lists_create(connection, parent, optional_params \\ [], opts \\ [])

Creates a new user list.

realtimebidding_buyers_user_lists_get(connection, name, optional_params \\ [], opts \\ [])

Gets a user list by its name.

realtimebidding_buyers_user_lists_get_remarketing_tag(connection, name, optional_params \\ [], opts \\ [])

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

realtimebidding_buyers_user_lists_list(connection, parent, optional_params \\ [], opts \\ [])

Lists the user lists visible to the current user.

realtimebidding_buyers_user_lists_open(connection, name, optional_params \\ [], opts \\ [])

Changes the status of a user list to OPEN. This allows new users to be added to the user list.

realtimebidding_buyers_user_lists_update(connection, name, optional_params \\ [], opts \\ [])

Updates the given user list. Only user lists with URLRestrictions can be updated.

Functions

realtimebidding_buyers_creatives_create(connection, parent, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_creatives_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a creative.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the parent buyer that the new creative belongs to that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RealTimeBidding.V1.Model.Creative.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.Creative{}} on success
  • {:error, info} on failure

realtimebidding_buyers_creatives_get(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_creatives_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a creative.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the creative to retrieve. See creative.name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :view (type: String.t) - Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.Creative{}} on success
  • {:error, info} on failure

realtimebidding_buyers_creatives_list(connection, parent, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_creatives_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.ListCreativesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. lastStatusUpdate and creativeServingDecision may be outdated for creatives on sequential pages. We recommend Google Cloud Pub/Sub to view the latest status.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either buyers/{buyerAccountId} or bidders/{bidderAccountId}. For buyers/{buyerAccountId}, the buyerAccountId can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456) under bidder account (123), you would use the pattern: buyers/456. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123), you would use buyers/123. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use bidders/{bidderAccountId}, for example, for all creatives pertaining to bidder (123), use bidders/123.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
    • :pageSize (type: integer()) - Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.
    • :view (type: String.t) - Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.ListCreativesResponse{}} on success
  • {:error, info} on failure

realtimebidding_buyers_creatives_patch(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_creatives_patch(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a creative.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :updateMask (type: String.t) - Field mask to use for partial in-place updates.
    • :body (type: GoogleApi.RealTimeBidding.V1.Model.Creative.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.Creative{}} on success
  • {:error, info} on failure

realtimebidding_buyers_get(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.Buyer.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a buyer account by its name.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. Name of the buyer to get. Format: buyers/{buyerId}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.Buyer{}} on success
  • {:error, info} on failure

realtimebidding_buyers_get_remarketing_tag(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_get_remarketing_tag(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.GetRemarketingTagResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.GetRemarketingTagResponse{}} on success
  • {:error, info} on failure

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

@spec realtimebidding_buyers_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.ListBuyersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all buyer account information the calling buyer user or service account is permissioned to manage.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The maximum number of buyers to return. If unspecified, at most 100 buyers will be returned. The maximum value is 500; values above 500 will be coerced to 500.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. This value is received from a previous ListBuyers call in ListBuyersResponse.nextPageToken.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.ListBuyersResponse{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_close(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_close(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.UserList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Changes the status of a user list to CLOSED. This prevents new users from being added to the user list.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the user list to close. See UserList.name
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RealTimeBidding.V1.Model.CloseUserListRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.UserList{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_create(connection, parent, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.UserList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new user list.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the parent buyer of the user list to be retrieved, which must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RealTimeBidding.V1.Model.UserList.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.UserList{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_get(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_get(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.UserList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a user list by its name.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the user list to be retrieved. See UserList.name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.UserList{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_get_remarketing_tag(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_get_remarketing_tag(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.GetRemarketingTagResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

This has been sunset as of October 2023, and will return an error response if called. For more information, see the release notes: https://developers.google.com/authorized-buyers/apis/relnotes#real-time-bidding-api Gets remarketing tag for a buyer. A remarketing tag is a piece of JavaScript code that can be placed on a web page. When a user visits a page containing a remarketing tag, Google adds the user to a user list.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.GetRemarketingTagResponse{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_list(connection, parent, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.ListUserListsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the user lists visible to the current user.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The name of the parent buyer for the user lists to be returned that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , {buyerAccountId} should represent the account ID of the child seat buyer.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - The number of results to return per page.
    • :pageToken (type: String.t) - Continuation page token as received from a previous response.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.ListUserListsResponse{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_open(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_open(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.UserList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Changes the status of a user list to OPEN. This allows new users to be added to the user list.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Required. The name of the user list to open. See UserList.name
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RealTimeBidding.V1.Model.OpenUserListRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.UserList{}} on success
  • {:error, info} on failure

realtimebidding_buyers_user_lists_update(connection, name, optional_params \\ [], opts \\ [])

@spec realtimebidding_buyers_user_lists_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.RealTimeBidding.V1.Model.UserList.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates the given user list. Only user lists with URLRestrictions can be updated.

Parameters

  • connection (type: GoogleApi.RealTimeBidding.V1.Connection.t) - Connection to server
  • name (type: String.t) - Output only. Name of the user list that must follow the pattern buyers/{buyer}/userLists/{user_list}, where {buyer} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyer} represents the account ID of the child seat buyer. {user_list} is an int64 identifier assigned by Google to uniquely identify a user list.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :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) - 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.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.RealTimeBidding.V1.Model.UserList.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.RealTimeBidding.V1.Model.UserList{}} on success
  • {:error, info} on failure