forked from mystiq/dex
1371 lines
40 KiB
JSON
1371 lines
40 KiB
JSON
{
|
|
"kind": "discovery#restDescription",
|
|
"etag": "\"l66ggWbucbkBw9Lpos72oziyefE/bOoBgOb8TcnyMQXYMKjYeQ3PEwA\"",
|
|
"discoveryVersion": "v1",
|
|
"id": "adexchangebuyer:v1.3",
|
|
"name": "adexchangebuyer",
|
|
"canonicalName": "Ad Exchange Buyer",
|
|
"version": "v1.3",
|
|
"revision": "20141101",
|
|
"title": "Ad Exchange Buyer API",
|
|
"description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
|
|
"ownerDomain": "google.com",
|
|
"ownerName": "Google",
|
|
"icons": {
|
|
"x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
|
|
"x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
|
|
},
|
|
"documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
|
|
"protocol": "rest",
|
|
"baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.3/",
|
|
"basePath": "/adexchangebuyer/v1.3/",
|
|
"rootUrl": "https://www.googleapis.com/",
|
|
"servicePath": "adexchangebuyer/v1.3/",
|
|
"batchPath": "batch",
|
|
"parameters": {
|
|
"alt": {
|
|
"type": "string",
|
|
"description": "Data format for the response.",
|
|
"default": "json",
|
|
"enum": [
|
|
"json"
|
|
],
|
|
"enumDescriptions": [
|
|
"Responses with Content-Type of application/json"
|
|
],
|
|
"location": "query"
|
|
},
|
|
"fields": {
|
|
"type": "string",
|
|
"description": "Selector specifying which fields to include in a partial response.",
|
|
"location": "query"
|
|
},
|
|
"key": {
|
|
"type": "string",
|
|
"description": "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.",
|
|
"location": "query"
|
|
},
|
|
"oauth_token": {
|
|
"type": "string",
|
|
"description": "OAuth 2.0 token for the current user.",
|
|
"location": "query"
|
|
},
|
|
"prettyPrint": {
|
|
"type": "boolean",
|
|
"description": "Returns response with indentations and line breaks.",
|
|
"default": "true",
|
|
"location": "query"
|
|
},
|
|
"quotaUser": {
|
|
"type": "string",
|
|
"description": "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.",
|
|
"location": "query"
|
|
},
|
|
"userIp": {
|
|
"type": "string",
|
|
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
|
|
"location": "query"
|
|
}
|
|
},
|
|
"auth": {
|
|
"oauth2": {
|
|
"scopes": {
|
|
"https://www.googleapis.com/auth/adexchange.buyer": {
|
|
"description": "Manage your Ad Exchange buyer account configuration"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemas": {
|
|
"Account": {
|
|
"id": "Account",
|
|
"type": "object",
|
|
"description": "Configuration data for an Ad Exchange buyer account.",
|
|
"properties": {
|
|
"bidderLocation": {
|
|
"type": "array",
|
|
"description": "Your bidder locations that have distinct URLs.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"maximumQps": {
|
|
"type": "integer",
|
|
"description": "The maximum queries per second the Ad Exchange will send.",
|
|
"format": "int32"
|
|
},
|
|
"region": {
|
|
"type": "string",
|
|
"description": "The geographical region the Ad Exchange should send requests from. Only used by some quota systems, but always setting the value is recommended. Allowed values: \n- ASIA \n- EUROPE \n- US_EAST \n- US_WEST"
|
|
},
|
|
"url": {
|
|
"type": "string",
|
|
"description": "The URL to which the Ad Exchange will send bid requests."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"cookieMatchingNid": {
|
|
"type": "string",
|
|
"description": "The nid parameter value used in cookie match requests. Please contact your technical account manager if you need to change this."
|
|
},
|
|
"cookieMatchingUrl": {
|
|
"type": "string",
|
|
"description": "The base URL used in cookie match requests."
|
|
},
|
|
"id": {
|
|
"type": "integer",
|
|
"description": "Account id.",
|
|
"format": "int32"
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#account"
|
|
},
|
|
"maximumActiveCreatives": {
|
|
"type": "integer",
|
|
"description": "The maximum number of active creatives that an account can have, where a creative is active if it was inserted or bid with in the last 30 days. Please contact your technical account manager if you need to change this.",
|
|
"format": "int32"
|
|
},
|
|
"maximumTotalQps": {
|
|
"type": "integer",
|
|
"description": "The sum of all bidderLocation.maximumQps values cannot exceed this. Please contact your technical account manager if you need to change this.",
|
|
"format": "int32"
|
|
},
|
|
"numberActiveCreatives": {
|
|
"type": "integer",
|
|
"description": "The number of creatives that this account inserted or bid with in the last 30 days.",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
},
|
|
"AccountsList": {
|
|
"id": "AccountsList",
|
|
"type": "object",
|
|
"description": "An account feed lists Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single buyer account.",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"description": "A list of accounts.",
|
|
"items": {
|
|
"$ref": "Account"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#accountsList"
|
|
}
|
|
}
|
|
},
|
|
"BillingInfo": {
|
|
"id": "BillingInfo",
|
|
"type": "object",
|
|
"description": "The configuration data for an Ad Exchange billing info.",
|
|
"properties": {
|
|
"accountId": {
|
|
"type": "integer",
|
|
"description": "Account id.",
|
|
"format": "int32"
|
|
},
|
|
"accountName": {
|
|
"type": "string",
|
|
"description": "Account name."
|
|
},
|
|
"billingId": {
|
|
"type": "array",
|
|
"description": "A list of adgroup IDs associated with this particular account. These IDs may show up as part of a realtime bidding BidRequest, which indicates a bid request for this account.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#billingInfo"
|
|
}
|
|
}
|
|
},
|
|
"BillingInfoList": {
|
|
"id": "BillingInfoList",
|
|
"type": "object",
|
|
"description": "A billing info feed lists Billing Info the Ad Exchange buyer account has access to. Each entry in the feed corresponds to a single billing info.",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"description": "A list of billing info relevant for your account.",
|
|
"items": {
|
|
"$ref": "BillingInfo"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#billingInfoList"
|
|
}
|
|
}
|
|
},
|
|
"Creative": {
|
|
"id": "Creative",
|
|
"type": "object",
|
|
"description": "A creative and its classification data.",
|
|
"properties": {
|
|
"HTMLSnippet": {
|
|
"type": "string",
|
|
"description": "The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set."
|
|
},
|
|
"accountId": {
|
|
"type": "integer",
|
|
"description": "Account id.",
|
|
"format": "int32",
|
|
"annotations": {
|
|
"required": [
|
|
"adexchangebuyer.creatives.insert"
|
|
]
|
|
}
|
|
},
|
|
"advertiserId": {
|
|
"type": "array",
|
|
"description": "Detected advertiser id, if any. Read-only. This field should not be set in requests.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"advertiserName": {
|
|
"type": "string",
|
|
"description": "The name of the company being advertised in the creative.",
|
|
"annotations": {
|
|
"required": [
|
|
"adexchangebuyer.creatives.insert"
|
|
]
|
|
}
|
|
},
|
|
"agencyId": {
|
|
"type": "string",
|
|
"description": "The agency id for this creative.",
|
|
"format": "int64"
|
|
},
|
|
"attribute": {
|
|
"type": "array",
|
|
"description": "All attributes for the ads that may be shown from this snippet.",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"buyerCreativeId": {
|
|
"type": "string",
|
|
"description": "A buyer-specific id identifying the creative in this ad.",
|
|
"annotations": {
|
|
"required": [
|
|
"adexchangebuyer.creatives.insert"
|
|
]
|
|
}
|
|
},
|
|
"clickThroughUrl": {
|
|
"type": "array",
|
|
"description": "The set of destination urls for the snippet.",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"annotations": {
|
|
"required": [
|
|
"adexchangebuyer.creatives.insert"
|
|
]
|
|
}
|
|
},
|
|
"corrections": {
|
|
"type": "array",
|
|
"description": "Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"details": {
|
|
"type": "array",
|
|
"description": "Additional details about the correction.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "The type of correction that was applied to the creative."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"disapprovalReasons": {
|
|
"type": "array",
|
|
"description": "The reasons 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.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"details": {
|
|
"type": "array",
|
|
"description": "Additional details about the reason for disapproval.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"reason": {
|
|
"type": "string",
|
|
"description": "The categorized reason for disapproval."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"filteringReasons": {
|
|
"type": "object",
|
|
"description": "The filtering reasons for the creative. If this feature is not enabled, please ask your technical account manager. Read-only. This field should not be set in requests.",
|
|
"properties": {
|
|
"date": {
|
|
"type": "string",
|
|
"description": "The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST."
|
|
},
|
|
"reasons": {
|
|
"type": "array",
|
|
"description": "The filtering reasons.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"filteringCount": {
|
|
"type": "string",
|
|
"description": "The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.",
|
|
"format": "int64"
|
|
},
|
|
"filteringStatus": {
|
|
"type": "integer",
|
|
"description": "The filtering status code. Please refer to the creative-status-codes.txt file for different statuses.",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"height": {
|
|
"type": "integer",
|
|
"description": "Ad height.",
|
|
"format": "int32",
|
|
"annotations": {
|
|
"required": [
|
|
"adexchangebuyer.creatives.insert"
|
|
]
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#creative"
|
|
},
|
|
"productCategories": {
|
|
"type": "array",
|
|
"description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"restrictedCategories": {
|
|
"type": "array",
|
|
"description": "All restricted categories for the ads that may be shown from this snippet.",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"sensitiveCategories": {
|
|
"type": "array",
|
|
"description": "Detected sensitive categories, if any. Read-only. This field should not be set in requests.",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Creative serving status. Read-only. This field should not be set in requests."
|
|
},
|
|
"vendorType": {
|
|
"type": "array",
|
|
"description": "All vendor types for the ads that may be shown from this snippet.",
|
|
"items": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
},
|
|
"videoURL": {
|
|
"type": "string",
|
|
"description": "The url to fetch a video ad. If set, HTMLSnippet should not be set."
|
|
},
|
|
"width": {
|
|
"type": "integer",
|
|
"description": "Ad width.",
|
|
"format": "int32",
|
|
"annotations": {
|
|
"required": [
|
|
"adexchangebuyer.creatives.insert"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"CreativesList": {
|
|
"id": "CreativesList",
|
|
"type": "object",
|
|
"description": "The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"description": "A list of creatives.",
|
|
"items": {
|
|
"$ref": "Creative"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#creativesList"
|
|
},
|
|
"nextPageToken": {
|
|
"type": "string",
|
|
"description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this."
|
|
}
|
|
}
|
|
},
|
|
"DirectDeal": {
|
|
"id": "DirectDeal",
|
|
"type": "object",
|
|
"description": "The configuration data for an Ad Exchange direct deal.",
|
|
"properties": {
|
|
"accountId": {
|
|
"type": "integer",
|
|
"description": "The account id of the buyer this deal is for.",
|
|
"format": "int32"
|
|
},
|
|
"advertiser": {
|
|
"type": "string",
|
|
"description": "The name of the advertiser this deal is for."
|
|
},
|
|
"currencyCode": {
|
|
"type": "string",
|
|
"description": "The currency code that applies to the fixed_cpm value. If not set then assumed to be USD."
|
|
},
|
|
"endTime": {
|
|
"type": "string",
|
|
"description": "End time for when this deal stops being active. If not set then this deal is valid until manually disabled by the publisher. In seconds since the epoch.",
|
|
"format": "int64"
|
|
},
|
|
"fixedCpm": {
|
|
"type": "string",
|
|
"description": "The fixed price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the fixed price tier of buying (highest priority, pay exactly the configured fixed price).",
|
|
"format": "int64"
|
|
},
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Deal id.",
|
|
"format": "int64"
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#directDeal"
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Deal name."
|
|
},
|
|
"privateExchangeMinCpm": {
|
|
"type": "string",
|
|
"description": "The minimum price for this direct deal. In cpm micros of currency according to currency_code. If set, then this deal is eligible for the private exchange tier of buying (below fixed price priority, run as a second price auction).",
|
|
"format": "int64"
|
|
},
|
|
"publisherBlocksOverriden": {
|
|
"type": "boolean",
|
|
"description": "If true, the publisher has opted to have their blocks ignored when a creative is bid with for this deal."
|
|
},
|
|
"sellerNetwork": {
|
|
"type": "string",
|
|
"description": "The name of the publisher offering this direct deal."
|
|
},
|
|
"startTime": {
|
|
"type": "string",
|
|
"description": "Start time for when this deal becomes active. If not set then this deal is active immediately upon creation. In seconds since the epoch.",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
},
|
|
"DirectDealsList": {
|
|
"id": "DirectDealsList",
|
|
"type": "object",
|
|
"description": "A direct deals feed lists Direct Deals the Ad Exchange buyer account has access to. This includes direct deals set up for the buyer account as well as its merged stream seats.",
|
|
"properties": {
|
|
"directDeals": {
|
|
"type": "array",
|
|
"description": "A list of direct deals relevant for your account.",
|
|
"items": {
|
|
"$ref": "DirectDeal"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#directDealsList"
|
|
}
|
|
}
|
|
},
|
|
"PerformanceReport": {
|
|
"id": "PerformanceReport",
|
|
"type": "object",
|
|
"description": "The configuration data for an Ad Exchange performance report list.",
|
|
"properties": {
|
|
"calloutStatusRate": {
|
|
"type": "array",
|
|
"description": "Rate of various prefiltering statuses per match. Please refer to the callout-status-codes.txt file for different statuses.",
|
|
"items": {
|
|
"type": "any"
|
|
}
|
|
},
|
|
"cookieMatcherStatusRate": {
|
|
"type": "array",
|
|
"description": "Average QPS for cookie matcher operations.",
|
|
"items": {
|
|
"type": "any"
|
|
}
|
|
},
|
|
"creativeStatusRate": {
|
|
"type": "array",
|
|
"description": "Rate of ads with a given status. Please refer to the creative-status-codes.txt file for different statuses.",
|
|
"items": {
|
|
"type": "any"
|
|
}
|
|
},
|
|
"hostedMatchStatusRate": {
|
|
"type": "array",
|
|
"description": "Average QPS for hosted match operations.",
|
|
"items": {
|
|
"type": "any"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#performanceReport"
|
|
},
|
|
"latency50thPercentile": {
|
|
"type": "number",
|
|
"description": "The 50th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
|
|
"format": "double"
|
|
},
|
|
"latency85thPercentile": {
|
|
"type": "number",
|
|
"description": "The 85th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
|
|
"format": "double"
|
|
},
|
|
"latency95thPercentile": {
|
|
"type": "number",
|
|
"description": "The 95th percentile round trip latency(ms) as perceived from Google servers for the duration period covered by the report.",
|
|
"format": "double"
|
|
},
|
|
"noQuotaInRegion": {
|
|
"type": "number",
|
|
"description": "Rate of various quota account statuses per quota check.",
|
|
"format": "double"
|
|
},
|
|
"outOfQuota": {
|
|
"type": "number",
|
|
"description": "Rate of various quota account statuses per quota check.",
|
|
"format": "double"
|
|
},
|
|
"pixelMatchRequests": {
|
|
"type": "number",
|
|
"description": "Average QPS for pixel match requests from clients.",
|
|
"format": "double"
|
|
},
|
|
"pixelMatchResponses": {
|
|
"type": "number",
|
|
"description": "Average QPS for pixel match responses from clients.",
|
|
"format": "double"
|
|
},
|
|
"quotaConfiguredLimit": {
|
|
"type": "number",
|
|
"description": "The configured quota limits for this account.",
|
|
"format": "double"
|
|
},
|
|
"quotaThrottledLimit": {
|
|
"type": "number",
|
|
"description": "The throttled quota limits for this account.",
|
|
"format": "double"
|
|
},
|
|
"region": {
|
|
"type": "string",
|
|
"description": "The trading location of this data."
|
|
},
|
|
"timestamp": {
|
|
"type": "string",
|
|
"description": "The unix timestamp of the starting time of this performance data.",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
},
|
|
"PerformanceReportList": {
|
|
"id": "PerformanceReportList",
|
|
"type": "object",
|
|
"description": "The configuration data for an Ad Exchange performance report list. https://sites.google.com/a/google.com/adx-integration/Home/engineering/binary-releases/rtb-api-release https://cs.corp.google.com/#piper///depot/google3/contentads/adx/tools/rtb_api/adxrtb.py",
|
|
"properties": {
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#performanceReportList"
|
|
},
|
|
"performanceReport": {
|
|
"type": "array",
|
|
"description": "A list of performance reports relevant for the account.",
|
|
"items": {
|
|
"$ref": "PerformanceReport"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PretargetingConfig": {
|
|
"id": "PretargetingConfig",
|
|
"type": "object",
|
|
"properties": {
|
|
"billingId": {
|
|
"type": "string",
|
|
"description": "The id for billing purposes, provided for reference. Leave this field blank for insert requests; the id will be generated automatically.",
|
|
"format": "int64"
|
|
},
|
|
"configId": {
|
|
"type": "string",
|
|
"description": "The config id; generated automatically. Leave this field blank for insert requests.",
|
|
"format": "int64"
|
|
},
|
|
"configName": {
|
|
"type": "string",
|
|
"description": "The name of the config. Must be unique. Required for all requests."
|
|
},
|
|
"creativeType": {
|
|
"type": "array",
|
|
"description": "List must contain exactly one of PRETARGETING_CREATIVE_TYPE_HTML or PRETARGETING_CREATIVE_TYPE_VIDEO.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"dimensions": {
|
|
"type": "array",
|
|
"description": "Requests which allow one of these (width, height) pairs will match. All pairs must be supported ad dimensions.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"height": {
|
|
"type": "string",
|
|
"description": "Height in pixels.",
|
|
"format": "int64"
|
|
},
|
|
"width": {
|
|
"type": "string",
|
|
"description": "Width in pixels.",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"excludedContentLabels": {
|
|
"type": "array",
|
|
"description": "Requests with any of these content labels will not match. Values are from content-labels.txt in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"excludedGeoCriteriaIds": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these geo criteria ids will not match.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"excludedPlacements": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these placements will not match.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"token": {
|
|
"type": "string",
|
|
"description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the placement."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"excludedUserLists": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these users list ids will not match.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"excludedVerticals": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these vertical ids will not match. Values are from the publisher-verticals.txt file in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"geoCriteriaIds": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these geo criteria ids will match.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"description": "Whether this config is active. Required for all requests."
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "The kind of the resource, i.e. \"adexchangebuyer#pretargetingConfig\".",
|
|
"default": "adexchangebuyer#pretargetingConfig"
|
|
},
|
|
"languages": {
|
|
"type": "array",
|
|
"description": "Request containing any of these language codes will match.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"mobileCarriers": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these mobile carrier ids will match. Values are from mobile-carriers.csv in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"mobileDevices": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these mobile device ids will match. Values are from mobile-devices.csv in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"mobileOperatingSystemVersions": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these mobile operating system version ids will match. Values are from mobile-os.csv in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"placements": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these placements will match.",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"token": {
|
|
"type": "string",
|
|
"description": "The value of the placement. Interpretation depends on the placement type, e.g. URL for a site placement, channel name for a channel placement, app id for a mobile app placement."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the placement."
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"platforms": {
|
|
"type": "array",
|
|
"description": "Requests matching any of these platforms will match. Possible values are PRETARGETING_PLATFORM_MOBILE, PRETARGETING_PLATFORM_DESKTOP, and PRETARGETING_PLATFORM_TABLET.",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"supportedCreativeAttributes": {
|
|
"type": "array",
|
|
"description": "Creative attributes should be declared here if all creatives corresponding to this pretargeting configuration have that creative attribute. Values are from pretargetable-creative-attributes.txt in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"userLists": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these user list ids will match.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"vendorTypes": {
|
|
"type": "array",
|
|
"description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
},
|
|
"verticals": {
|
|
"type": "array",
|
|
"description": "Requests containing any of these vertical ids will match.",
|
|
"items": {
|
|
"type": "string",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"PretargetingConfigList": {
|
|
"id": "PretargetingConfigList",
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"description": "A list of pretargeting configs",
|
|
"items": {
|
|
"$ref": "PretargetingConfig"
|
|
}
|
|
},
|
|
"kind": {
|
|
"type": "string",
|
|
"description": "Resource type.",
|
|
"default": "adexchangebuyer#pretargetingConfigList"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"resources": {
|
|
"accounts": {
|
|
"methods": {
|
|
"get": {
|
|
"id": "adexchangebuyer.accounts.get",
|
|
"path": "accounts/{id}",
|
|
"httpMethod": "GET",
|
|
"description": "Gets one account by ID.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"description": "The account id",
|
|
"required": true,
|
|
"format": "int32",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"id"
|
|
],
|
|
"response": {
|
|
"$ref": "Account"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "adexchangebuyer.accounts.list",
|
|
"path": "accounts",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieves the authenticated user's list of accounts.",
|
|
"response": {
|
|
"$ref": "AccountsList"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"patch": {
|
|
"id": "adexchangebuyer.accounts.patch",
|
|
"path": "accounts/{id}",
|
|
"httpMethod": "PATCH",
|
|
"description": "Updates an existing account. This method supports patch semantics.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"description": "The account id",
|
|
"required": true,
|
|
"format": "int32",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"id"
|
|
],
|
|
"request": {
|
|
"$ref": "Account"
|
|
},
|
|
"response": {
|
|
"$ref": "Account"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"update": {
|
|
"id": "adexchangebuyer.accounts.update",
|
|
"path": "accounts/{id}",
|
|
"httpMethod": "PUT",
|
|
"description": "Updates an existing account.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "integer",
|
|
"description": "The account id",
|
|
"required": true,
|
|
"format": "int32",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"id"
|
|
],
|
|
"request": {
|
|
"$ref": "Account"
|
|
},
|
|
"response": {
|
|
"$ref": "Account"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"billingInfo": {
|
|
"methods": {
|
|
"get": {
|
|
"id": "adexchangebuyer.billingInfo.get",
|
|
"path": "billinginfo/{accountId}",
|
|
"httpMethod": "GET",
|
|
"description": "Returns the billing information for one account specified by account ID.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "integer",
|
|
"description": "The account id.",
|
|
"required": true,
|
|
"format": "int32",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId"
|
|
],
|
|
"response": {
|
|
"$ref": "BillingInfo"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "adexchangebuyer.billingInfo.list",
|
|
"path": "billinginfo",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieves a list of billing information for all accounts of the authenticated user.",
|
|
"response": {
|
|
"$ref": "BillingInfoList"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"creatives": {
|
|
"methods": {
|
|
"get": {
|
|
"id": "adexchangebuyer.creatives.get",
|
|
"path": "creatives/{accountId}/{buyerCreativeId}",
|
|
"httpMethod": "GET",
|
|
"description": "Gets the status for a single creative. A creative will be available 30-40 minutes after submission.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "integer",
|
|
"description": "The id for the account that will serve this creative.",
|
|
"required": true,
|
|
"format": "int32",
|
|
"location": "path"
|
|
},
|
|
"buyerCreativeId": {
|
|
"type": "string",
|
|
"description": "The buyer-specific id for this creative.",
|
|
"required": true,
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId",
|
|
"buyerCreativeId"
|
|
],
|
|
"response": {
|
|
"$ref": "Creative"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"insert": {
|
|
"id": "adexchangebuyer.creatives.insert",
|
|
"path": "creatives",
|
|
"httpMethod": "POST",
|
|
"description": "Submit a new creative.",
|
|
"request": {
|
|
"$ref": "Creative"
|
|
},
|
|
"response": {
|
|
"$ref": "Creative"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "adexchangebuyer.creatives.list",
|
|
"path": "creatives",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "integer",
|
|
"description": "When specified, only creatives for the given account ids are returned.",
|
|
"format": "int32",
|
|
"repeated": true,
|
|
"location": "query"
|
|
},
|
|
"buyerCreativeId": {
|
|
"type": "string",
|
|
"description": "When specified, only creatives for the given buyer creative ids are returned.",
|
|
"repeated": true,
|
|
"location": "query"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer",
|
|
"description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
|
|
"format": "uint32",
|
|
"minimum": "1",
|
|
"maximum": "1000",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"type": "string",
|
|
"description": "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.",
|
|
"location": "query"
|
|
},
|
|
"statusFilter": {
|
|
"type": "string",
|
|
"description": "When specified, only creatives having the given status are returned.",
|
|
"enum": [
|
|
"approved",
|
|
"disapproved",
|
|
"not_checked"
|
|
],
|
|
"enumDescriptions": [
|
|
"Creatives which have been approved.",
|
|
"Creatives which have been disapproved.",
|
|
"Creatives whose status is not yet checked."
|
|
],
|
|
"location": "query"
|
|
}
|
|
},
|
|
"response": {
|
|
"$ref": "CreativesList"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"directDeals": {
|
|
"methods": {
|
|
"get": {
|
|
"id": "adexchangebuyer.directDeals.get",
|
|
"path": "directdeals/{id}",
|
|
"httpMethod": "GET",
|
|
"description": "Gets one direct deal by ID.",
|
|
"parameters": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The direct deal id",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"id"
|
|
],
|
|
"response": {
|
|
"$ref": "DirectDeal"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "adexchangebuyer.directDeals.list",
|
|
"path": "directdeals",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieves the authenticated user's list of direct deals.",
|
|
"response": {
|
|
"$ref": "DirectDealsList"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"performanceReport": {
|
|
"methods": {
|
|
"list": {
|
|
"id": "adexchangebuyer.performanceReport.list",
|
|
"path": "performancereport",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieves the authenticated user's list of performance metrics.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to get the reports.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "query"
|
|
},
|
|
"endDateTime": {
|
|
"type": "string",
|
|
"description": "The end time of the report in ISO 8601 timestamp format using UTC.",
|
|
"required": true,
|
|
"location": "query"
|
|
},
|
|
"maxResults": {
|
|
"type": "integer",
|
|
"description": "Maximum number of entries returned on one result page. If not set, the default is 100. Optional.",
|
|
"format": "uint32",
|
|
"minimum": "1",
|
|
"maximum": "1000",
|
|
"location": "query"
|
|
},
|
|
"pageToken": {
|
|
"type": "string",
|
|
"description": "A continuation token, used to page through performance reports. To retrieve the next page, set this parameter to the value of \"nextPageToken\" from the previous response. Optional.",
|
|
"location": "query"
|
|
},
|
|
"startDateTime": {
|
|
"type": "string",
|
|
"description": "The start time of the report in ISO 8601 timestamp format using UTC.",
|
|
"required": true,
|
|
"location": "query"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId",
|
|
"endDateTime",
|
|
"startDateTime"
|
|
],
|
|
"response": {
|
|
"$ref": "PerformanceReportList"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"pretargetingConfig": {
|
|
"methods": {
|
|
"delete": {
|
|
"id": "adexchangebuyer.pretargetingConfig.delete",
|
|
"path": "pretargetingconfigs/{accountId}/{configId}",
|
|
"httpMethod": "DELETE",
|
|
"description": "Deletes an existing pretargeting config.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to delete the pretargeting config for.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
},
|
|
"configId": {
|
|
"type": "string",
|
|
"description": "The specific id of the configuration to delete.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId",
|
|
"configId"
|
|
],
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"get": {
|
|
"id": "adexchangebuyer.pretargetingConfig.get",
|
|
"path": "pretargetingconfigs/{accountId}/{configId}",
|
|
"httpMethod": "GET",
|
|
"description": "Gets a specific pretargeting configuration",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to get the pretargeting config for.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
},
|
|
"configId": {
|
|
"type": "string",
|
|
"description": "The specific id of the configuration to retrieve.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId",
|
|
"configId"
|
|
],
|
|
"response": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"insert": {
|
|
"id": "adexchangebuyer.pretargetingConfig.insert",
|
|
"path": "pretargetingconfigs/{accountId}",
|
|
"httpMethod": "POST",
|
|
"description": "Inserts a new pretargeting configuration.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to insert the pretargeting config for.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId"
|
|
],
|
|
"request": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"response": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"list": {
|
|
"id": "adexchangebuyer.pretargetingConfig.list",
|
|
"path": "pretargetingconfigs/{accountId}",
|
|
"httpMethod": "GET",
|
|
"description": "Retrieves a list of the authenticated user's pretargeting configurations.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to get the pretargeting configs for.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId"
|
|
],
|
|
"response": {
|
|
"$ref": "PretargetingConfigList"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"patch": {
|
|
"id": "adexchangebuyer.pretargetingConfig.patch",
|
|
"path": "pretargetingconfigs/{accountId}/{configId}",
|
|
"httpMethod": "PATCH",
|
|
"description": "Updates an existing pretargeting config. This method supports patch semantics.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to update the pretargeting config for.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
},
|
|
"configId": {
|
|
"type": "string",
|
|
"description": "The specific id of the configuration to update.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId",
|
|
"configId"
|
|
],
|
|
"request": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"response": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
},
|
|
"update": {
|
|
"id": "adexchangebuyer.pretargetingConfig.update",
|
|
"path": "pretargetingconfigs/{accountId}/{configId}",
|
|
"httpMethod": "PUT",
|
|
"description": "Updates an existing pretargeting config.",
|
|
"parameters": {
|
|
"accountId": {
|
|
"type": "string",
|
|
"description": "The account id to update the pretargeting config for.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
},
|
|
"configId": {
|
|
"type": "string",
|
|
"description": "The specific id of the configuration to update.",
|
|
"required": true,
|
|
"format": "int64",
|
|
"location": "path"
|
|
}
|
|
},
|
|
"parameterOrder": [
|
|
"accountId",
|
|
"configId"
|
|
],
|
|
"request": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"response": {
|
|
"$ref": "PretargetingConfig"
|
|
},
|
|
"scopes": [
|
|
"https://www.googleapis.com/auth/adexchange.buyer"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|