View Source GoogleApi.AdExchangeBuyer.V2beta1.Api.Accounts (google_api_ad_exchange_buyer v0.41.0)

API calls for all endpoints tagged Accounts.

Summary

Functions

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

Creates a new client buyer.

adexchangebuyer2_accounts_clients_get(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

Gets a client buyer with a given client account ID.

adexchangebuyer2_accounts_clients_invitations_create(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

Creates and sends out an email invitation to access an Ad Exchange client buyer account.

adexchangebuyer2_accounts_clients_invitations_get(connection, account_id, client_account_id, invitation_id, optional_params \\ [], opts \\ [])

Retrieves an existing client user invitation.

adexchangebuyer2_accounts_clients_invitations_list(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

Lists all the client users invitations for a client with a given account ID.

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

Lists all the clients for the current sponsor buyer.

adexchangebuyer2_accounts_clients_update(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

Updates an existing client buyer.

adexchangebuyer2_accounts_clients_users_get(connection, account_id, client_account_id, user_id, optional_params \\ [], opts \\ [])

Retrieves an existing client user.

adexchangebuyer2_accounts_clients_users_list(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

Lists all the known client users for a specified sponsor buyer account ID.

adexchangebuyer2_accounts_clients_users_update(connection, account_id, client_account_id, user_id, optional_params \\ [], opts \\ [])

Updates an existing client user. Only the user status can be changed on update.

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

Creates a creative.

adexchangebuyer2_accounts_creatives_deal_associations_add(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

Associate an existing deal with a creative.

adexchangebuyer2_accounts_creatives_deal_associations_list(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

List all creative-deal associations.

adexchangebuyer2_accounts_creatives_deal_associations_remove(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

Remove the association between a deal and a creative.

adexchangebuyer2_accounts_creatives_get(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

Gets a creative.

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

Lists creatives.

adexchangebuyer2_accounts_creatives_stop_watching(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.

adexchangebuyer2_accounts_creatives_update(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

Updates a creative.

adexchangebuyer2_accounts_creatives_watch(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.

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

List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.

adexchangebuyer2_accounts_finalized_proposals_pause(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

adexchangebuyer2_accounts_finalized_proposals_resume(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Update given deals to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

adexchangebuyer2_accounts_products_get(connection, account_id, product_id, optional_params \\ [], opts \\ [])

Gets the requested product by ID.

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

List all products visible to the buyer (optionally filtered by the specified PQL query).

adexchangebuyer2_accounts_proposals_accept(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an ABORTED error message will be returned. This call updates the proposal_state from PROPOSED to BUYER_ACCEPTED, or from SELLER_ACCEPTED to FINALIZED. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.

adexchangebuyer2_accounts_proposals_add_note(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.

adexchangebuyer2_accounts_proposals_cancel_negotiation(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.

adexchangebuyer2_accounts_proposals_complete_setup(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API. This call updates the is_setup_completed field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To mark an individual deal as ready to serve, call buyers.finalizedDeals.setReadyToServe in the Marketplace API.

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

Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.

adexchangebuyer2_accounts_proposals_get(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Gets a proposal given its ID. The proposal is returned at its head revision.

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

List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.

adexchangebuyer2_accounts_proposals_pause(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Update the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.

adexchangebuyer2_accounts_proposals_resume(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Update the given proposal to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all deals in the proposal. Note that if the has_seller_paused bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.

adexchangebuyer2_accounts_proposals_update(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision, an ABORTED error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a deal_id, the server will assign a new unique ID and create the deal. If passed-in deal has a deal_id, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a deal_id not present at head.

adexchangebuyer2_accounts_publisher_profiles_get(connection, account_id, publisher_profile_id, optional_params \\ [], opts \\ [])

Gets the requested publisher profile by id.

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

List all publisher profiles visible to the buyer

Functions

Link to this function

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

View Source 
@spec adexchangebuyer2_accounts_clients_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Client.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new client buyer.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.Client.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_clients_get(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Client.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a client buyer with a given client account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the client's sponsor buyer. (required)
  • client_account_id (type: String.t) - Numerical account ID of the client buyer to retrieve. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.Client{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_accounts_clients_invitations_create(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_invitations_create(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ClientUserInvitation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates and sends out an email invitation to access an Ad Exchange client buyer account.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the client's sponsor buyer. (required)
  • client_account_id (type: String.t) - Numerical account ID of the client buyer that the user should be associated with. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.ClientUserInvitation.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_clients_invitations_get(connection, account_id, client_account_id, invitation_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_invitations_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ClientUserInvitation.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an existing client user invitation.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the client's sponsor buyer. (required)
  • client_account_id (type: String.t) - Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required)
  • invitation_id (type: String.t) - Numerical identifier of the user invitation to retrieve. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.ClientUserInvitation{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_accounts_clients_invitations_list(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_invitations_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListClientUserInvitationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the client users invitations for a client with a given account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the client's sponsor buyer. (required)
  • client_account_id (type: String.t) - Numerical account ID of the client buyer to list invitations for. (required) You must either specify a string representation of a numerical account identifier or the - character to list all the invitations for all the clients of a given sponsor 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()) - Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListClientUserInvitationsResponse.nextPageToken returned from the previous call to the clients.invitations.list method.
  • opts (type: keyword()) - Call options

Returns

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

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

View Source 
@spec adexchangebuyer2_accounts_clients_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListClientsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the clients for the current sponsor buyer.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Unique numerical account ID of the sponsor buyer to list the clients for.
  • 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()) - Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the accounts.clients.list method.
    • :partnerClientId (type: String.t) - Optional unique identifier (from the standpoint of an Ad Exchange sponsor buyer partner) of the client to return. If specified, at most one client will be returned in the response.
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_clients_update(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Client.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing client buyer.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required)
  • client_account_id (type: String.t) - Unique numerical account ID of the client to update. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.Client.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_clients_users_get(connection, account_id, client_account_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_users_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ClientUser.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Retrieves an existing client user.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the client's sponsor buyer. (required)
  • client_account_id (type: String.t) - Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
  • user_id (type: String.t) - Numerical identifier of the user to retrieve. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.ClientUser{}} on success
  • {:error, info} on failure
Link to this function

adexchangebuyer2_accounts_clients_users_list(connection, account_id, client_account_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_users_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListClientUsersResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists all the known client users for a specified sponsor buyer account ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the sponsor buyer of the client to list users for. (required)
  • client_account_id (type: String.t) - The account ID of the client buyer to list users for. (required) You must specify either a string representation of a numerical account identifier or the - character to list all the client users for all the clients of a given sponsor 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()) - Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the accounts.clients.users.list method.
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_clients_users_update(connection, account_id, client_account_id, user_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_clients_users_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ClientUser.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates an existing client user. Only the user status can be changed on update.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Numerical account ID of the client's sponsor buyer. (required)
  • client_account_id (type: String.t) - Numerical account ID of the client buyer that the user to be retrieved is associated with. (required)
  • user_id (type: String.t) - Numerical identifier of the user to retrieve. (required)
  • 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.AdExchangeBuyer.V2beta1.Model.ClientUser.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source 
@spec adexchangebuyer2_accounts_creatives_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a creative.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
  • 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").
    • :duplicateIdMode (type: String.t) - Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative).
    • :body (type: GoogleApi.AdExchangeBuyer.V2beta1.Model.Creative.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_deal_associations_add(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_deal_associations_add(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Associate an existing deal with a creative.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account the creative belongs to.
  • creative_id (type: String.t) - The ID of the creative associated with the deal.
  • 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.AdExchangeBuyer.V2beta1.Model.AddDealAssociationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_deal_associations_list(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_deal_associations_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListDealAssociationsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all creative-deal associations.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account to list the associations from. Specify "-" to list all creatives the current user has access to.
  • creative_id (type: String.t) - The creative ID to list the associations from. Specify "-" to list all creatives under the above account.
  • 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()) - Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default.
    • :pageToken (type: String.t) - A token identifying a page of results the server should return. Typically, this is the value of ListDealAssociationsResponse.next_page_token returned from the previous call to 'ListDealAssociations' method.
    • :query (type: String.t) - An optional query string to filter deal associations. If no filter is specified, all associations will be returned. Supported queries are: - accountId=account_id_string - creativeId=creative_id_string - dealsId=deals_id_string - dealsStatus:{approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus:{approved, conditionally_approved, disapproved, not_checked} Example: 'dealsId=12345 AND dealsStatus:disapproved'
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_deal_associations_remove(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_deal_associations_remove(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Remove the association between a deal and a creative.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account the creative belongs to.
  • creative_id (type: String.t) - The ID of the creative associated with the deal.
  • 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.AdExchangeBuyer.V2beta1.Model.RemoveDealAssociationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_get(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a creative.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account the creative belongs to.
  • creative_id (type: String.t) - The ID of the creative to retrieve.
  • 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.AdExchangeBuyer.V2beta1.Model.Creative{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec adexchangebuyer2_accounts_creatives_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListCreativesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists creatives.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account to list the creatives from. Specify "-" to list all creatives the current user has access to.
  • 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()) - 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.next_page_token returned from the previous call to 'ListCreatives' method.
    • :query (type: String.t) - An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=account_id_string - creativeId=creative_id_string - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47'
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_stop_watching(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_stop_watching(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account of the creative to stop notifications for.
  • creative_id (type: String.t) - The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications.
  • 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.AdExchangeBuyer.V2beta1.Model.StopWatchingCreativeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_update(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Creative.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a creative.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account that this creative belongs to. Can be used to filter the response of the creatives.list method.
  • creative_id (type: String.t) - The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method.
  • 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.AdExchangeBuyer.V2beta1.Model.Creative.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_creatives_watch(connection, account_id, creative_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_creatives_watch(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Empty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - The account of the creative to watch.
  • creative_id (type: String.t) - The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic.
  • 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.AdExchangeBuyer.V2beta1.Model.WatchCreativeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source 
@spec adexchangebuyer2_accounts_finalized_proposals_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListProposalsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List finalized proposals, regardless if a proposal is being renegotiated. A filter expression (PQL query) may be specified to filter the results. The notes will not be returned.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the 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").
    • :filter (type: String.t) - An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
    • :filterSyntax (type: String.t) - Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
    • :pageSize (type: integer()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - The page token as returned from ListProposalsResponse.
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_finalized_proposals_pause(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_finalized_proposals_pause(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update given deals to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.pause endpoint. It is a no-op to pause already-paused deals. It is an error to call PauseProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The proposal_id of the proposal containing the deals.
  • 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.AdExchangeBuyer.V2beta1.Model.PauseProposalDealsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_finalized_proposals_resume(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_finalized_proposals_resume(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update given deals to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all listed deals in the request. Currently, this method only applies to PG and PD deals. For PA deals, call accounts.proposals.resume endpoint. It is a no-op to resume running deals or deals paused by the other party. It is an error to call ResumeProposalDeals for deals which are not part of the proposal of proposal_id or which are not finalized or renegotiating.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The proposal_id of the proposal containing the deals.
  • 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.AdExchangeBuyer.V2beta1.Model.ResumeProposalDealsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_products_get(connection, account_id, product_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_products_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Product.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the requested product by ID.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • product_id (type: String.t) - The ID for the product to get the head revision for.
  • 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.AdExchangeBuyer.V2beta1.Model.Product{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec adexchangebuyer2_accounts_products_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListProductsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all products visible to the buyer (optionally filtered by the specified PQL query).

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the 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").
    • :filter (type: String.t) - An optional PQL query used to query for products. See https://developers.google.com/ad-manager/docs/pqlreference for documentation about PQL and examples. Nested repeated fields, such as product.targetingCriterion.inclusions, cannot be filtered.
    • :pageSize (type: integer()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - The page token as returned from ListProductsResponse.
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_accept(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_accept(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Mark the proposal as accepted at the given revision number. If the number does not match the server's revision number an ABORTED error message will be returned. This call updates the proposal_state from PROPOSED to BUYER_ACCEPTED, or from SELLER_ACCEPTED to FINALIZED. Upon calling this endpoint, the buyer implicitly agrees to the terms and conditions optionally set within the proposal by the publisher.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The ID of the proposal to accept.
  • 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.AdExchangeBuyer.V2beta1.Model.AcceptProposalRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_add_note(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_add_note(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Note.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create a new note and attach it to the proposal. The note is assigned a unique ID by the server. The proposal revision number will not increase when associated with a new note.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The ID of the proposal to attach the note to.
  • 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.AdExchangeBuyer.V2beta1.Model.AddNoteRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_cancel_negotiation(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_cancel_negotiation(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Cancel an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized, but only cancels a negotiation unilaterally.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The ID of the proposal to cancel negotiation for.
  • 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.AdExchangeBuyer.V2beta1.Model.CancelNegotiationRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_complete_setup(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_complete_setup(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

You can opt-in to manually update proposals to indicate that setup is complete. By default, proposal setup is automatically completed after their deals are finalized. Contact your Technical Account Manager to opt in. Buyers can call this method when the proposal has been finalized, and all the required creatives have been uploaded using the Creatives API. This call updates the is_setup_completed field on the deals in the proposal, and notifies the seller. The server then advances the revision number of the most recent proposal. To mark an individual deal as ready to serve, call buyers.finalizedDeals.setReadyToServe in the Marketplace API.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The ID of the proposal to mark as setup completed.
  • 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.AdExchangeBuyer.V2beta1.Model.CompleteSetupRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

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

View Source 
@spec adexchangebuyer2_accounts_proposals_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the 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.AdExchangeBuyer.V2beta1.Model.Proposal.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_get(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets a proposal given its ID. The proposal is returned at its head revision.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The unique ID of the proposal
  • 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.AdExchangeBuyer.V2beta1.Model.Proposal{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec adexchangebuyer2_accounts_proposals_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.ListProposalsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List proposals. A filter expression (PQL query) may be specified to filter the results. To retrieve all finalized proposals, regardless if a proposal is being renegotiated, see the FinalizedProposals resource. Note that Bidder/ChildSeat relationships differ from the usual behavior. A Bidder account can only see its child seats' proposals by specifying the ChildSeat's accountId in the request path.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the 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").
    • :filter (type: String.t) - An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered.
    • :filterSyntax (type: String.t) - Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER.
    • :pageSize (type: integer()) - Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default.
    • :pageToken (type: String.t) - The page token as returned from ListProposalsResponse.
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_pause(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_pause(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the given proposal to pause serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to true for all deals in the proposal. It is a no-op to pause an already-paused proposal. It is an error to call PauseProposal for a proposal that is not finalized or renegotiating.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The ID of the proposal to pause.
  • 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.AdExchangeBuyer.V2beta1.Model.PauseProposalRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_resume(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_resume(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the given proposal to resume serving. This method will set the DealServingMetadata.DealPauseStatus.has_buyer_paused bit to false for all deals in the proposal. Note that if the has_seller_paused bit is also set, serving will not resume until the seller also resumes. It is a no-op to resume an already-running proposal. It is an error to call ResumeProposal for a proposal that is not finalized or renegotiating.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The ID of the proposal to resume.
  • 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.AdExchangeBuyer.V2beta1.Model.ResumeProposalRequest.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_proposals_update(connection, account_id, proposal_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_proposals_update(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.Proposal.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Update the given proposal at the client known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision, an ABORTED error message will be returned. Only the buyer-modifiable fields of the proposal will be updated. Note that the deals in the proposal will be updated to match the passed-in copy. If a passed-in deal does not have a deal_id, the server will assign a new unique ID and create the deal. If passed-in deal has a deal_id, it will be updated to match the passed-in copy. Any existing deals not present in the passed-in proposal will be deleted. It is an error to pass in a deal with a deal_id not present at head.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • proposal_id (type: String.t) - The unique ID of the proposal.
  • 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.AdExchangeBuyer.V2beta1.Model.Proposal.t) -
  • opts (type: keyword()) - Call options

Returns

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

adexchangebuyer2_accounts_publisher_profiles_get(connection, account_id, publisher_profile_id, optional_params \\ [], opts \\ [])

View Source 
@spec adexchangebuyer2_accounts_publisher_profiles_get(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.AdExchangeBuyer.V2beta1.Model.PublisherProfile.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the requested publisher profile by id.

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the buyer.
  • publisher_profile_id (type: String.t) - The id for the publisher profile to get.
  • 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.AdExchangeBuyer.V2beta1.Model.PublisherProfile{}} on success
  • {:error, info} on failure
Link to this function

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

View Source 
@spec adexchangebuyer2_accounts_publisher_profiles_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.AdExchangeBuyer.V2beta1.Model.ListPublisherProfilesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List all publisher profiles visible to the buyer

Parameters

  • connection (type: GoogleApi.AdExchangeBuyer.V2beta1.Connection.t) - Connection to server
  • account_id (type: String.t) - Account ID of the 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()) - Specify the number of results to include per page.
    • :pageToken (type: String.t) - The page token as return from ListPublisherProfilesResponse.
  • opts (type: keyword()) - Call options

Returns

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