Api-roll 42: 2016-11-08

discovery/googleapis/adexchangebuyer__v1.4.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/adexchange.buyer": {
                     "description": "Manage your Ad Exchange buyer account configuration"
                 }
             }
         }
     },
     "basePath": "/adexchangebuyer/v1.4/",
     "baseUrl": "https://www.googleapis.com/adexchangebuyer/v1.4/",
     "batchPath": "batch",
     "canonicalName": "Ad Exchange Buyer",
     "description": "Accesses your bidding-account information, submits creatives for validation, finds available direct deals, and retrieves performance reports.",
     "discoveryVersion": "v1",
     "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest",
-    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/OxFhwmXVMAvezu3DksziaPGZ_dY\"",
+    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/EvKs3Hkvcx40X69CkSu-499XWyU\"",
     "icons": {
         "x16": "https://www.google.com/images/icons/product/doubleclick-16.gif",
         "x32": "https://www.google.com/images/icons/product/doubleclick-32.gif"
     },
     "id": "adexchangebuyer:v1.4",
     "kind": "discovery#restDescription",
     "name": "adexchangebuyer",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 82 matching lines @@
                     ]
                 },
                 "patch": {
                     "description": "Updates an existing account. This method supports patch semantics.",
                     "httpMethod": "PATCH",
                     "id": "adexchangebuyer.accounts.patch",
                     "parameterOrder": [
                         "id"
                     ],
                     "parameters": {
+                        "confirmUnsafeAccountChange": {
+                            "description": "Confirmation for erasing bidder and cookie matching urls.",
+                            "location": "query",
+                            "type": "boolean"
+                        },
                         "id": {
                             "description": "The account id",
                             "format": "int32",
                             "location": "path",
                             "required": true,
                             "type": "integer"
                         }
                     },
                     "path": "accounts/{id}",
                     "request": {
                         "$ref": "Account"
                     },
                     "response": {
                         "$ref": "Account"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/adexchange.buyer"
                     ]
                 },
                 "update": {
                     "description": "Updates an existing account.",
                     "httpMethod": "PUT",
                     "id": "adexchangebuyer.accounts.update",
                     "parameterOrder": [
                         "id"
                     ],
                     "parameters": {
+                        "confirmUnsafeAccountChange": {
+                            "description": "Confirmation for erasing bidder and cookie matching urls.",
+                            "location": "query",
+                            "type": "boolean"
+                        },
                         "id": {
                             "description": "The account id",
                             "format": "int32",
                             "location": "path",
                             "required": true,
                             "type": "integer"
                         }
                     },
                     "path": "accounts/{id}",
                     "request": {
@@ skipping 305 matching lines @@
                         }
                     },
                     "path": "creatives",
                     "response": {
                         "$ref": "CreativesList"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/adexchange.buyer"
                     ]
                 },
+                "listDeals": {
+                    "description": "Lists the external deal ids associated with the creative.",
+                    "httpMethod": "GET",
+                    "id": "adexchangebuyer.creatives.listDeals",
+                    "parameterOrder": [
+                        "accountId",
+                        "buyerCreativeId"
+                    ],
+                    "parameters": {
+                        "accountId": {
+                            "description": "The id for the account that will serve this creative.",
+                            "format": "int32",
+                            "location": "path",
+                            "required": true,
+                            "type": "integer"
+                        },
+                        "buyerCreativeId": {
+                            "description": "The buyer-specific id for this creative.",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "creatives/{accountId}/{buyerCreativeId}/listDeals",
+                    "response": {
+                        "$ref": "CreativeDealIds"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/adexchange.buyer"
+                    ]
+                },
                 "removeDeal": {
                     "description": "Remove a deal id associated with the creative.",
                     "httpMethod": "POST",
                     "id": "adexchangebuyer.creatives.removeDeal",
                     "parameterOrder": [
                         "accountId",
                         "buyerCreativeId",
                         "dealId"
                     ],
                     "parameters": {
@@ skipping 564 matching lines @@
                             "type": "string"
                         },
                         "revisionNumber": {
                             "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.",
                             "format": "int64",
                             "location": "path",
                             "required": true,
                             "type": "string"
                         },
                         "updateAction": {
-                            "description": "The proposed action to take on the proposal.",
+                            "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
                             "enum": [
                                 "accept",
                                 "cancel",
                                 "propose",
+                                "proposeAndAccept",
                                 "unknownAction",
                                 "updateFinalized"
                             ],
                             "enumDescriptions": [
                                 "",
                                 "",
                                 "",
                                 "",
+                                "",
                                 ""
                             ],
                             "location": "path",
                             "required": true,
                             "type": "string"
                         }
                     },
                     "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
                     "request": {
                         "$ref": "Proposal"
@@ skipping 61 matching lines @@
                             "type": "string"
                         },
                         "revisionNumber": {
                             "description": "The last known revision number to update. If the head revision in the marketplace database has since changed, an error will be thrown. The caller should then fetch the latest proposal at head revision and retry the update at that revision.",
                             "format": "int64",
                             "location": "path",
                             "required": true,
                             "type": "string"
                         },
                         "updateAction": {
-                            "description": "The proposed action to take on the proposal.",
+                            "description": "The proposed action to take on the proposal. This field is required and it must be set when updating a proposal.",
                             "enum": [
                                 "accept",
                                 "cancel",
                                 "propose",
+                                "proposeAndAccept",
                                 "unknownAction",
                                 "updateFinalized"
                             ],
                             "enumDescriptions": [
                                 "",
                                 "",
                                 "",
                                 "",
+                                "",
                                 ""
                             ],
                             "location": "path",
                             "required": true,
                             "type": "string"
                         }
                     },
                     "path": "proposals/{proposalId}/{revisionNumber}/{updateAction}",
                     "request": {
                         "$ref": "Proposal"
@@ skipping 29 matching lines @@
                     "response": {
                         "$ref": "GetPublisherProfilesByAccountIdResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/adexchange.buyer"
                     ]
                 }
             }
         }
     },
-    "revision": "20160721",
+    "revision": "20161020",
     "rootUrl": "https://www.googleapis.com/",
     "schemas": {
         "Account": {
             "description": "Configuration data for an Ad Exchange buyer account.",
             "id": "Account",
             "properties": {
                 "bidderLocation": {
                     "description": "Your bidder locations that have distinct URLs.",
                     "items": {
                         "properties": {
                             "bidProtocol": {
-                                "description": "The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.3 right now. Allowed values:  \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_PROTOBUF",
+                                "description": "The protocol that the bidder endpoint is using. By default, OpenRTB protocols use JSON, except PROTOCOL_OPENRTB_PROTOBUF. PROTOCOL_OPENRTB_PROTOBUF uses protobuf encoding over the latest OpenRTB protocol version, which is 2.4 right now. Allowed values:  \n- PROTOCOL_ADX \n- PROTOCOL_OPENRTB_2_2 \n- PROTOCOL_OPENRTB_2_3 \n- PROTOCOL_OPENRTB_2_4 \n- PROTOCOL_OPENRTB_PROTOBUF",
                                 "type": "string"
                             },
                             "maximumQps": {
                                 "description": "The maximum queries per second the Ad Exchange will send.",
                                 "format": "int32",
                                 "type": "integer"
                             },
                             "region": {
                                 "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",
                                 "type": "string"
@@ skipping 459 matching lines @@
                     "type": "string"
                 },
                 "languages": {
                     "description": "Detected languages for this creative. Read-only. This field should not be set in requests.",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "nativeAd": {
-                    "description": "If nativeAd is set, HTMLSnippet and videoURL should not be set.",
+                    "description": "If nativeAd is set, HTMLSnippet and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)",
                     "properties": {
                         "advertiser": {
                             "type": "string"
                         },
                         "appIcon": {
                             "description": "The app icon, for app download ads.",
                             "properties": {
                                 "height": {
                                     "format": "int32",
                                     "type": "integer"
                                 },
                                 "url": {
                                     "type": "string"
                                 },
                                 "width": {
                                     "format": "int32",
                                     "type": "integer"
                                 }
                             },
                             "type": "object"
                         },
                         "body": {
                             "description": "A long description of the ad.",
                             "type": "string"
                         },
                         "callToAction": {
                             "description": "A label for the button that the user is supposed to click.",
                             "type": "string"
                         },
+                        "clickLinkUrl": {
+                            "description": "The URL that the browser/SDK will load when the user clicks the ad.",
+                            "type": "string"
+                        },
                         "clickTrackingUrl": {
                             "description": "The URL to use for click tracking.",
                             "type": "string"
                         },
                         "headline": {
                             "description": "A short title for the ad.",
                             "type": "string"
                         },
                         "image": {
                             "description": "A large image.",
@@ skipping 41 matching lines @@
                             "type": "string"
                         },
                         "starRating": {
                             "description": "The app rating in the app store. Must be in the range [0-5].",
                             "format": "double",
                             "type": "number"
                         },
                         "store": {
                             "description": "The URL to the app store to purchase/download the promoted app.",
                             "type": "string"
+                        },
+                        "videoURL": {
+                            "description": "The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.",
+                            "type": "string"
                         }
                     },
                     "type": "object"
                 },
                 "openAuctionStatus": {
                     "description": "Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.",
                     "type": "string"
                 },
                 "productCategories": {
                     "description": "Detected product categories, if any. Read-only. This field should not be set in requests.",
@@ skipping 94 matching lines @@
                         "type": "integer"
                     },
                     "type": "array"
                 },
                 "version": {
                     "description": "The version for this creative. Read-only. This field should not be set in requests.",
                     "format": "int32",
                     "type": "integer"
                 },
                 "videoURL": {
-                    "description": "The url to fetch a video ad. If set, HTMLSnippet should not be set.",
+                    "description": "The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.",
                     "type": "string"
                 },
                 "width": {
                     "annotations": {
                         "required": [
                             "adexchangebuyer.creatives.insert"
                         ]
                     },
                     "description": "Ad width.",
                     "format": "int32",
                     "type": "integer"
                 }
             },
             "type": "object"
         },
+        "CreativeDealIds": {
+            "description": "The external deal ids associated with a creative.",
+            "id": "CreativeDealIds",
+            "properties": {
+                "dealStatuses": {
+                    "description": "A list of external deal ids and ARC approval status.",
+                    "items": {
+                        "properties": {
+                            "arcStatus": {
+                                "description": "ARC approval status.",
+                                "type": "string"
+                            },
+                            "dealId": {
+                                "description": "External deal ID.",
+                                "format": "int64",
+                                "type": "string"
+                            },
+                            "webPropertyId": {
+                                "description": "Publisher ID.",
+                                "format": "int32",
+                                "type": "integer"
+                            }
+                        },
+                        "type": "object"
+                    },
+                    "type": "array"
+                },
+                "kind": {
+                    "default": "adexchangebuyer#creativeDealIds",
+                    "description": "Resource type.",
+                    "type": "string"
+                }
+            },
+            "type": "object"
+        },
         "CreativesList": {
             "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.",
             "id": "CreativesList",
             "properties": {
                 "items": {
                     "description": "A list of creatives.",
                     "items": {
                         "$ref": "Creative"
                     },
                     "type": "array"
@@ skipping 43 matching lines @@
             },
             "type": "object"
         },
         "DealTerms": {
             "id": "DealTerms",
             "properties": {
                 "brandingType": {
                     "description": "Visibilty of the URL in bid requests.",
                     "type": "string"
                 },
+                "crossListedExternalDealIdType": {
+                    "description": "Indicates that this ExternalDealId exists under at least two different AdxInventoryDeals. Currently, the only case that the same ExternalDealId will exist is programmatic cross sell case.",
+                    "type": "string"
+                },
                 "description": {
                     "description": "Description for the proposed terms of the deal.",
                     "type": "string"
                 },
                 "estimatedGrossSpend": {
                     "$ref": "Price",
                     "description": "Non-binding estimate of the estimated gross spend for this deal Can be set by buyer or seller."
                 },
                 "estimatedImpressionsPerDay": {
                     "description": "Non-binding estimate of the impressions served per day Can be set by buyer or seller.",
@@ skipping 389 matching lines @@
                 },
                 "flightStartTimeMs": {
                     "description": "Proposed flight start time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
                     "format": "int64",
                     "type": "string"
                 },
                 "inventoryDescription": {
                     "description": "Description for the deal terms. (updatable)",
                     "type": "string"
                 },
+                "isRfpTemplate": {
+                    "description": "Indicates whether the current deal is a RFP template. RFP template is created by buyer and not based on seller created products.",
+                    "type": "boolean"
+                },
                 "kind": {
                     "default": "adexchangebuyer#marketplaceDeal",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#marketplaceDeal\".",
                     "type": "string"
                 },
                 "lastUpdateTimeMs": {
                     "description": "The time (ms since epoch) when the deal was last updated. (readonly)",
                     "format": "int64",
                     "type": "string"
                 },
@@ skipping 432 matching lines @@
                     "type": "array"
                 },
                 "supportedCreativeAttributes": {
                     "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": {
                         "format": "int64",
                         "type": "string"
                     },
                     "type": "array"
                 },
+                "userIdentifierDataRequired": {
+                    "description": "Requests containing the specified type of user data will match. Possible values are HOSTED_MATCH_DATA, which means the request is cookie-targetable and has a match in the buyer's hosted match table, and COOKIE_OR_IDFA, which means the request has either a targetable cookie or an iOS IDFA.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
                 "userLists": {
                     "description": "Requests containing any of these user list ids will match.",
                     "items": {
                         "format": "int64",
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "vendorTypes": {
                     "description": "Requests that allow any of these vendor ids will match. Values are from vendors.txt in the downloadable files section.",
@@ skipping 241 matching lines @@
                     "description": "Optional contact information of the buyer. (seller-readonly)",
                     "items": {
                         "$ref": "ContactInformation"
                     },
                     "type": "array"
                 },
                 "buyerPrivateData": {
                     "$ref": "PrivateData",
                     "description": "Private data for buyer. (hidden from seller)."
                 },
+                "dbmAdvertiserIds": {
+                    "description": "IDs of DBM advertisers permission to this proposal.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
                 "hasBuyerSignedOff": {
                     "description": "When an proposal is in an accepted state, indicates whether the buyer has signed off. Once both sides have signed off on a deal, the proposal can be finalized by the seller. (seller-readonly)",
                     "type": "boolean"
                 },
                 "hasSellerSignedOff": {
                     "description": "When an proposal is in an accepted state, indicates whether the buyer has signed off Once both sides have signed off on a deal, the proposal can be finalized by the seller. (buyer-readonly)",
                     "type": "boolean"
                 },
                 "inventorySource": {
                     "description": "What exchange will provide this inventory (readonly, except on create).",
@@ skipping 363 matching lines @@
                     "type": "string"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "adexchangebuyer/v1.4/",
     "title": "Ad Exchange Buyer API",
     "version": "v1.4"
 }