@datafire/google_adexchangebuyer2 v6.0.0
@datafire/google_adexchangebuyer2
Client library for Ad Exchange Buyer API II
Installation and Usage
npm install --save @datafire/google_adexchangebuyer2
let google_adexchangebuyer2 = require('@datafire/google_adexchangebuyer2').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Accesses the latest features for managing Authorized Buyers accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.
Actions
oauthCallback
Exchange the code passed to your redirect URI for an access_token
google_adexchangebuyer2.oauthCallback({
"code": ""
}, context)
Input
- input
object
- code required
string
- code required
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
oauthRefresh
Exchange a refresh_token for an access_token
google_adexchangebuyer2.oauthRefresh(null, context)
Input
This action has no parameters
Output
- output
object
- access_token
string
- refresh_token
string
- token_type
string
- scope
string
- expiration
string
- access_token
adexchangebuyer2.accounts.clients.list
Lists all the clients for the current sponsor buyer.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.list({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Unique numerical account ID of the sponsor buyer to list the clients for. - pageSize
integer
: Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: 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
string
: 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. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListClientsResponse
adexchangebuyer2.accounts.clients.create
Creates a new client buyer.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.create({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to create a client for. (required) - body Client
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Client
adexchangebuyer2.accounts.clients.get
Gets a client buyer with a given client account ID.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.get({
"accountId": "",
"clientAccountId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the client's sponsor buyer. (required) - clientAccountId required
string
: Numerical account ID of the client buyer to retrieve. (required) - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Client
adexchangebuyer2.accounts.clients.update
Updates an existing client buyer.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.update({
"accountId": "",
"clientAccountId": ""
}, context)
Input
- input
object
- accountId required
string
: Unique numerical account ID for the buyer of which the client buyer is a customer; the sponsor buyer to update a client for. (required) - clientAccountId required
string
: Unique numerical account ID of the client to update. (required) - body Client
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Client
adexchangebuyer2.accounts.clients.invitations.list
Lists all the client users invitations for a client with a given account ID.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.invitations.list({
"accountId": "",
"clientAccountId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the client's sponsor buyer. (required) - clientAccountId required
string
: 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. - pageSize
integer
: Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default. - pageToken
string
: 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. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
adexchangebuyer2.accounts.clients.invitations.create
Creates and sends out an email invitation to access an Ad Exchange client buyer account.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.invitations.create({
"accountId": "",
"clientAccountId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the client's sponsor buyer. (required) - clientAccountId required
string
: Numerical account ID of the client buyer that the user should be associated with. (required) - body ClientUserInvitation
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ClientUserInvitation
adexchangebuyer2.accounts.clients.invitations.get
Retrieves an existing client user invitation.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.invitations.get({
"accountId": "",
"clientAccountId": "",
"invitationId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the client's sponsor buyer. (required) - clientAccountId required
string
: Numerical account ID of the client buyer that the user invitation to be retrieved is associated with. (required) - invitationId required
string
: Numerical identifier of the user invitation to retrieve. (required) - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ClientUserInvitation
adexchangebuyer2.accounts.clients.users.list
Lists all the known client users for a specified sponsor buyer account ID.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.users.list({
"accountId": "",
"clientAccountId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the sponsor buyer of the client to list users for. (required) - clientAccountId required
string
: 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. - pageSize
integer
: Requested page size. The server may return fewer clients than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: 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. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListClientUsersResponse
adexchangebuyer2.accounts.clients.users.get
Retrieves an existing client user.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.users.get({
"accountId": "",
"clientAccountId": "",
"userId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the client's sponsor buyer. (required) - clientAccountId required
string
: Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) - userId required
string
: Numerical identifier of the user to retrieve. (required) - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ClientUser
adexchangebuyer2.accounts.clients.users.update
Updates an existing client user. Only the user status can be changed on update.
google_adexchangebuyer2.adexchangebuyer2.accounts.clients.users.update({
"accountId": "",
"clientAccountId": "",
"userId": ""
}, context)
Input
- input
object
- accountId required
string
: Numerical account ID of the client's sponsor buyer. (required) - clientAccountId required
string
: Numerical account ID of the client buyer that the user to be retrieved is associated with. (required) - userId required
string
: Numerical identifier of the user to retrieve. (required) - body ClientUser
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ClientUser
adexchangebuyer2.accounts.creatives.list
Lists creatives.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.list({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: The account to list the creatives from. Specify "-" to list all creatives the current user has access to. - pageSize
integer
: Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. - pageToken
string
: 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
string
: 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' - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListCreativesResponse
adexchangebuyer2.accounts.creatives.create
Creates a creative.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.create({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: The account that this creative belongs to. Can be used to filter the response of the creatives.list method. - duplicateIdMode
string
(values: NO_DUPLICATES, FORCE_ENABLE_DUPLICATE_IDS): Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). - body Creative
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Creative
adexchangebuyer2.accounts.creatives.get
Gets a creative.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.get({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account the creative belongs to. - creativeId required
string
: The ID of the creative to retrieve. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Creative
adexchangebuyer2.accounts.creatives.update
Updates a creative.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.update({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account that this creative belongs to. Can be used to filter the response of the creatives.list method. - creativeId required
string
: The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. - body Creative
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Creative
adexchangebuyer2.accounts.creatives.dealAssociations.list
List all creative-deal associations.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.dealAssociations.list({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account to list the associations from. Specify "-" to list all creatives the current user has access to. - creativeId required
string
: The creative ID to list the associations from. Specify "-" to list all creatives under the above account. - pageSize
integer
: Requested page size. Server may return fewer associations than requested. If unspecified, server will pick an appropriate default. - pageToken
string
: 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
string
: 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' - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListDealAssociationsResponse
adexchangebuyer2.accounts.creatives.dealAssociations.add
Associate an existing deal with a creative.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.dealAssociations.add({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account the creative belongs to. - creativeId required
string
: The ID of the creative associated with the deal. - body AddDealAssociationRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Empty
adexchangebuyer2.accounts.creatives.dealAssociations.remove
Remove the association between a deal and a creative.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.dealAssociations.remove({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account the creative belongs to. - creativeId required
string
: The ID of the creative associated with the deal. - body RemoveDealAssociationRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Empty
adexchangebuyer2.accounts.creatives.stopWatching
Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.stopWatching({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account of the creative to stop notifications for. - creativeId required
string
: The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. - body StopWatchingCreativeRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Empty
adexchangebuyer2.accounts.creatives.watch
Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.
google_adexchangebuyer2.adexchangebuyer2.accounts.creatives.watch({
"accountId": "",
"creativeId": ""
}, context)
Input
- input
object
- accountId required
string
: The account of the creative to watch. - creativeId required
string
: 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. - body WatchCreativeRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Empty
adexchangebuyer2.accounts.finalizedProposals.list
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.finalizedProposals.list({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - filter
string
: An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. - filterSyntax
string
(values: FILTER_SYNTAX_UNSPECIFIED, PQL, LIST_FILTER): Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. - pageSize
integer
: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: The page token as returned from ListProposalsResponse. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListProposalsResponse
adexchangebuyer2.accounts.products.list
List all products visible to the buyer (optionally filtered by the specified PQL query).
google_adexchangebuyer2.adexchangebuyer2.accounts.products.list({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - filter
string
: 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
integer
: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: The page token as returned from ListProductsResponse. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListProductsResponse
adexchangebuyer2.accounts.products.get
Gets the requested product by ID.
google_adexchangebuyer2.adexchangebuyer2.accounts.products.get({
"accountId": "",
"productId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - productId required
string
: The ID for the product to get the head revision for. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Product
adexchangebuyer2.accounts.proposals.list
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.list({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - filter
string
: An optional PQL filter query used to query for proposals. Nested repeated fields, such as proposal.deals.targetingCriterion, cannot be filtered. - filterSyntax
string
(values: FILTER_SYNTAX_UNSPECIFIED, PQL, LIST_FILTER): Syntax the filter is written in. Current implementation defaults to PQL but in the future it will be LIST_FILTER. - pageSize
integer
: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: The page token as returned from ListProposalsResponse. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output ListProposalsResponse
adexchangebuyer2.accounts.proposals.create
Create the given proposal. Each created proposal and any deals it contains are assigned a unique ID by the server.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.create({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - body Proposal
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.get
Gets a proposal given its ID. The proposal is returned at its head revision.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.get({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The unique ID of the proposal - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.update
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.update({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The unique ID of the proposal. - body Proposal
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.accept
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.accept({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The ID of the proposal to accept. - body AcceptProposalRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.addNote
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.addNote({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The ID of the proposal to attach the note to. - body AddNoteRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Note
adexchangebuyer2.accounts.proposals.cancelNegotiation
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.cancelNegotiation({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The ID of the proposal to cancel negotiation for. - body CancelNegotiationRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.completeSetup
Update the given proposal to indicate that setup has been completed. This method is called by the buyer when the line items have been created on their end for a finalized proposal and all the required creatives have been uploaded using the creatives API. This call updates the is_setup_completed
bit on the proposal and also notifies the seller. The server will advance the revision number of the most recent proposal.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.completeSetup({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The ID of the proposal to mark as setup completed. - body CompleteSetupRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.pause
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.pause({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The ID of the proposal to pause. - body PauseProposalRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.proposals.resume
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.
google_adexchangebuyer2.adexchangebuyer2.accounts.proposals.resume({
"accountId": "",
"proposalId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - proposalId required
string
: The ID of the proposal to resume. - body ResumeProposalRequest
- $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output Proposal
adexchangebuyer2.accounts.publisherProfiles.list
List all publisher profiles visible to the buyer
google_adexchangebuyer2.adexchangebuyer2.accounts.publisherProfiles.list({
"accountId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - pageSize
integer
: Specify the number of results to include per page. - pageToken
string
: The page token as return from ListPublisherProfilesResponse. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
adexchangebuyer2.accounts.publisherProfiles.get
Gets the requested publisher profile by id.
google_adexchangebuyer2.adexchangebuyer2.accounts.publisherProfiles.get({
"accountId": "",
"publisherProfileId": ""
}, context)
Input
- input
object
- accountId required
string
: Account ID of the buyer. - publisherProfileId required
string
: The id for the publisher profile to get. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- accountId required
Output
- output PublisherProfile
adexchangebuyer2.bidders.filterSets.bidMetrics.list
Lists all metrics that are measured in terms of number of bids.
google_adexchangebuyer2.adexchangebuyer2.bidders.filterSets.bidMetrics.list({
"filterSetName": ""
}, context)
Input
- input
object
- filterSetName required
string
: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123:bidders/123/filterSets/abc
- For an account-level filter set for the buyer account representing bidder 123:bidders/123/accounts/123/filterSets/abc
- For an account-level filter set for the child seat buyer account 456 whose bidder is 123:bidders/123/accounts/456/filterSets/abc
- pageSize
integer
: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: A token identifying a page of results the server should return. Typically, this is the value of ListBidMetricsResponse.nextPageToken returned from the previous call to the bidMetrics.list method. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- filterSetName required
Output
- output ListBidMetricsResponse
adexchangebuyer2.bidders.filterSets.bidResponseErrors.list
List all errors that occurred in bid responses, with the number of bid responses affected for each reason.
google_adexchangebuyer2.adexchangebuyer2.bidders.filterSets.bidResponseErrors.list({
"filterSetName": ""
}, context)
Input
- input
object
- filterSetName required
string
: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123:bidders/123/filterSets/abc
- For an account-level filter set for the buyer account representing bidder 123:bidders/123/accounts/123/filterSets/abc
- For an account-level filter set for the child seat buyer account 456 whose bidder is 123:bidders/123/accounts/456/filterSets/abc
- pageSize
integer
: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: A token identifying a page of results the server should return. Typically, this is the value of ListBidResponseErrorsResponse.nextPageToken returned from the previous call to the bidResponseErrors.list method. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: JSONP - fields
string
: Selector specifying which fields to include in a partial response. - key
string
: 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
string
: OAuth 2.0 token for the current user. - prettyPrint
boolean
: Returns response with indentations and line breaks. - quotaUser
string
: 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. - upload_protocol
string
: Upload protocol for media (e.g. "raw", "multipart"). - uploadType
string
: Legacy upload protocol for media (e.g. "media", "multipart").
- filterSetName required
Output
adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list
List all reasons for which bid responses were considered to have no applicable bids, with the number of bid responses affected for each reason.
google_adexchangebuyer2.adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list({
"filterSetName": ""
}, context)
Input
- input
object
- filterSetName required
string
: Name of the filter set that should be applied to the requested metrics. For example: - For a bidder-level filter set for bidder 123:bidders/123/filterSets/abc
- For an account-level filter set for the buyer account representing bidder 123:bidders/123/accounts/123/filterSets/abc
- For an account-level filter set for the child seat buyer account 456 whose bidder is 123:bidders/123/accounts/456/filterSets/abc
- pageSize
integer
: Requested page size. The server may return fewer results than requested. If unspecified, the server will pick an appropriate default. - pageToken
string
: A token identifying a page of results the server should return. Typically, this is the value of ListBidResponsesWithoutBidsResponse.nextPageToken returned from the previous call to the bidResponsesWithoutBids.list method. - $.xgafv
string
(values: 1, 2): V1 error format. - access_token
string
: OAuth access token. - alt
string
(values: json, media, proto): Data format for response. - callback
string
: J
- filterSetName required