Struct google_realtimebidding1::api::BuyerMethods

source ·

pub struct BuyerMethods<'a, S>where
    S: 'a,
{ /* private fields */ }

Expand description

A builder providing access to all methods supported on buyer resources. It is not used directly, but through the RealTimeBidding hub.

§Example

Instantiate a resource builder

extern crate hyper;
extern crate hyper_rustls;
extern crate google_realtimebidding1 as realtimebidding1;
 
use std::default::Default;
use realtimebidding1::{RealTimeBidding, oauth2, hyper, hyper_rustls, chrono, FieldMask};
 
let secret: oauth2::ApplicationSecret = Default::default();
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = RealTimeBidding::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// Usually you wouldn't bind this to a variable, but keep calling *CallBuilders*
// like `creatives_create(...)`, `creatives_get(...)`, `creatives_list(...)`, `creatives_patch(...)`, `get(...)`, `get_remarketing_tag(...)`, `list(...)`, `user_lists_close(...)`, `user_lists_create(...)`, `user_lists_get(...)`, `user_lists_get_remarketing_tag(...)`, `user_lists_list(...)`, `user_lists_open(...)` and `user_lists_update(...)`
// to build up your call.
let rb = hub.buyers();

Implementations§

source §

impl<'a, S> BuyerMethods<'a, S>

source

pub fn creatives_create( &self, request: Creative, parent: &str ) -> BuyerCreativeCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a creative.

§Arguments

request - No description provided.
parent - Required. The name of the parent buyer that the new creative belongs to that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns a creative. For a bidder accessing creatives on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.

source

pub fn creatives_get(&self, name: &str) -> BuyerCreativeGetCall<'a, S>

Create a builder to help you perform the following task:

Gets a creative.

§Arguments

name - Required. Name of the creative to retrieve. See creative.name.

source

pub fn creatives_list(&self, parent: &str) -> BuyerCreativeListCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

parent - Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either buyers/{buyerAccountId} or bidders/{bidderAccountId}. For buyers/{buyerAccountId}, the buyerAccountId can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (456) under bidder account (123), you would use the pattern: buyers/456. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (123), you would use buyers/123. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use bidders/{bidderAccountId}, for example, for all creatives pertaining to bidder (123), use bidders/123.

source

pub fn creatives_patch( &self, request: Creative, name: &str ) -> BuyerCreativePatchCall<'a, S>

Create a builder to help you perform the following task:

Updates a creative.

§Arguments

request - No description provided.
name - Output only. Name of the creative. Follows the pattern buyers/{buyer}/creatives/{creative}, where {buyer} represents the account ID of the buyer who owns the creative, and {creative} is the buyer-specific creative ID that references this creative in the bid response.

source

pub fn user_lists_close( &self, request: CloseUserListRequest, name: &str ) -> BuyerUserListCloseCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
name - Required. The name of the user list to close. See UserList.name

source

pub fn user_lists_create( &self, request: UserList, parent: &str ) -> BuyerUserListCreateCall<'a, S>

Create a builder to help you perform the following task:

Creates a new user list.

§Arguments

request - No description provided.
parent - Required. The name of the parent buyer of the user list to be retrieved, which must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyerAccountId} should represent the account ID of the child seat buyer.

source

pub fn user_lists_get(&self, name: &str) -> BuyerUserListGetCall<'a, S>

Create a builder to help you perform the following task:

Gets a user list by its name.

§Arguments

name - Required. The name of the user list to be retrieved. See UserList.name.

source

pub fn user_lists_get_remarketing_tag( &self, name: &str ) -> BuyerUserListGetRemarketingTagCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

name - Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.

source

pub fn user_lists_list(&self, parent: &str) -> BuyerUserListListCall<'a, S>

Create a builder to help you perform the following task:

Lists the user lists visible to the current user.

§Arguments

parent - Required. The name of the parent buyer for the user lists to be returned that must follow the pattern buyers/{buyerAccountId}, where {buyerAccountId} represents the account ID of the buyer who owns user lists. For a bidder accessing user lists on behalf of a child seat buyer , {buyerAccountId} should represent the account ID of the child seat buyer.

source

pub fn user_lists_open( &self, request: OpenUserListRequest, name: &str ) -> BuyerUserListOpenCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
name - Required. The name of the user list to open. See UserList.name

source

pub fn user_lists_update( &self, request: UserList, name: &str ) -> BuyerUserListUpdateCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

request - No description provided.
name - Output only. Name of the user list that must follow the pattern buyers/{buyer}/userLists/{user_list}, where {buyer} represents the account ID of the buyer who owns the user list. For a bidder accessing user lists on behalf of a child seat buyer, {buyer} represents the account ID of the child seat buyer. {user_list} is an int64 identifier assigned by Google to uniquely identify a user list.

source

pub fn get(&self, name: &str) -> BuyerGetCall<'a, S>

Create a builder to help you perform the following task:

Gets a buyer account by its name.

§Arguments

name - Required. Name of the buyer to get. Format: buyers/{buyerId}

source

pub fn get_remarketing_tag( &self, name: &str ) -> BuyerGetRemarketingTagCall<'a, S>

Create a builder to help you perform the following task:

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

§Arguments

name - Required. To fetch the remarketing tag for an account, the name must follow the pattern buyers/{accountId}, where {accountId} represents the ID of the buyer that owns the remarketing tag. For a bidder accessing the remarketing tag on behalf of a child seat buyer, {accountId} should represent the ID of the child seat buyer. To fetch the remarketing tag for a specific user list, the name must follow the pattern buyers/{accountId}/userLists/{userListId}. See UserList.name.

source