Ad Exchange Buyer API v1.1

Version: 5.3

Ad Exchange Buyer API v1.1

This documentation has been automatically generated using information supplied by the Google API Discovery service.

Lets you manage your Ad Exchange Buyer account. Google documentation.

(require gapi/macro)

(require-gapi-doc adexchangebuyer.v1.1.js)

1 API Parameters

The following optional keyword arguments may be passed to all functions for this web service:

procedure
(_ [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp]) → jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

This is not actually a function. This is just using Scribble’s defproc form to list the optional keyword arguments that may be passed to all functions for this service.

alt: Data format for the response.

fields: Selector specifying which fields to include in a partial response.

key: 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: OAuth 2.0 token for the current user.

prettyPrint: Returns response with indentations and line breaks.

quotaUser: 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. Overrides userIp if both are provided.

userIp: IP address of the site where the request originates. Use this if you want to enforce per-user limits.

2 Resources

2.1 directDeals

procedure
(adexchangebuyer-directDeals-list [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the authenticated user’s list of direct deals.

procedure
(adexchangebuyer-directDeals-get #:id id
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets one direct deal by ID.

id: The direct deal id

2.2 accounts

procedure
(adexchangebuyer-accounts-list [ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves the authenticated user’s list of accounts.

procedure
(adexchangebuyer-accounts-get #:id id
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets one account by ID.

id: The account id

procedure
(adexchangebuyer-accounts-patch
#:id id
[ #:kind kind
#:bidderLocation bidderLocation
#:cookieMatchingNid cookieMatchingNid
#:cookieMatchingUrl cookieMatchingUrl
#:maximumTotalQps maximumTotalQps
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  kind : string? = 'N/A
  bidderLocation : string? = 'N/A
  cookieMatchingNid : string? = 'N/A
  cookieMatchingUrl : string? = 'N/A
  maximumTotalQps : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates an existing account. This method supports patch semantics.

id: The account id

kind: Resource type.

bidderLocation: Your bidder locations that have distinct URLs.

cookieMatchingNid: The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.

cookieMatchingUrl: The base URL used in cookie match requests.

maximumTotalQps: The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.

procedure
(adexchangebuyer-accounts-update
#:id id
[ #:kind kind
#:bidderLocation bidderLocation
#:cookieMatchingNid cookieMatchingNid
#:cookieMatchingUrl cookieMatchingUrl
#:maximumTotalQps maximumTotalQps
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  id : string?
  kind : string? = 'N/A
  bidderLocation : string? = 'N/A
  cookieMatchingNid : string? = 'N/A
  cookieMatchingUrl : string? = 'N/A
  maximumTotalQps : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Updates an existing account.

id: The account id

kind: Resource type.

bidderLocation: Your bidder locations that have distinct URLs.

cookieMatchingNid: The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this.

cookieMatchingUrl: The base URL used in cookie match requests.

maximumTotalQps: The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.

2.3 creatives

procedure
(adexchangebuyer-creatives-list [ #:maxResults maxResults
#:pageToken pageToken
#:statusFilter statusFilter
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  maxResults : string? = 'N/A
  pageToken : string? = 'N/A
  statusFilter : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Retrieves a list of the authenticated user’s active creatives.

maxResults: Maximum number of entries returned on one result page. If not set, the default is 100. Optional.

pageToken: A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.

statusFilter: When specified, only creatives having the given status are returned.

procedure
(adexchangebuyer-creatives-get
#:accountId accountId
#:buyerCreativeId buyerCreativeId
[ #:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  accountId : string?
  buyerCreativeId : string?
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Gets the status for a single creative.

accountId: The id for the account that will serve this creative.

buyerCreativeId: The buyer-specific id for this creative.

procedure
(adexchangebuyer-creatives-insert
[ #:attribute attribute
#:kind kind
#:status status
#:HTMLSnippet HTMLSnippet
#:accountId accountId
#:advertiserId advertiserId
#:advertiserName advertiserName
#:buyerCreativeId buyerCreativeId
#:clickThroughUrl clickThroughUrl
#:disapprovalReasons disapprovalReasons
#:height height
#:productCategories productCategories
#:sensitiveCategories sensitiveCategories
#:vendorType vendorType
#:videoURL videoURL
#:width width
#:alt alt
#:fields fields
#:key key
#:oauth_token oauth_token
#:prettyPrint prettyPrint
#:quotaUser quotaUser
#:userIp userIp])
→ jsexpr?
  attribute : string? = 'N/A
  kind : string? = 'N/A
  status : string? = 'N/A
  HTMLSnippet : string? = 'N/A
  accountId : string? = 'N/A
  advertiserId : string? = 'N/A
  advertiserName : string? = 'N/A
  buyerCreativeId : string? = 'N/A
  clickThroughUrl : string? = 'N/A
  disapprovalReasons : string? = 'N/A
  height : string? = 'N/A
  productCategories : string? = 'N/A
  sensitiveCategories : string? = 'N/A
  vendorType : string? = 'N/A
  videoURL : string? = 'N/A
  width : string? = 'N/A
  alt : string? = 'N/A
  fields : string? = 'N/A
  key : string? = (api-key)
  oauth_token : string? = 'N/A
  prettyPrint : string? = 'N/A
  quotaUser : string? = 'N/A
  userIp : string? = 'N/A

Submit a new creative.

attribute: All attributes for the ads that may be shown from this snippet.

kind: Resource type.

status: Creative serving status. Read-only. This field should not be set in requests.

HTMLSnippet: The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.

accountId: Account id.

advertiserId: Detected advertiser id, if any. Read-only. This field should not be set in requests.

advertiserName: The name of the company being advertised in the creative.

buyerCreativeId: A buyer-specific id identifying the creative in this ad.

clickThroughUrl: The set of destination urls for the snippet.

disapprovalReasons: The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.

height: Ad height.

productCategories: Detected product categories, if any. Read-only. This field should not be set in requests.

sensitiveCategories: Detected sensitive categories, if any. Read-only. This field should not be set in requests.

vendorType: All vendor types for the ads that may be shown from this snippet.

videoURL: The url to fetch a video ad. If set, HTMLSnippet should not be set.

width: Ad width.