Api-roll 33: 2016-03-14

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": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/EdmLlIWDPOXUaIR9PyM0JrTn9Ls\"",
+    "etag": "\"bRFOOrZKfO9LweMbPqu0kcu6De8/vcHwFj9oUgGXFm1JrBjoH-LeGlY\"",
     "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 1031 matching lines @@
                         }
                     },
                     "path": "proposals/search",
                     "response": {
                         "$ref": "GetOrdersResponse"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/adexchange.buyer"
                     ]
                 },
+                "setupcomplete": {
+                    "description": "Update the given proposal to indicate that setup has been completed.",
+                    "httpMethod": "POST",
+                    "id": "adexchangebuyer.proposals.setupcomplete",
+                    "parameterOrder": [
+                        "proposalId"
+                    ],
+                    "parameters": {
+                        "proposalId": {
+                            "description": "The proposal id for which the setup is complete",
+                            "location": "path",
+                            "required": true,
+                            "type": "string"
+                        }
+                    },
+                    "path": "proposals/{proposalId}/setupcomplete",
+                    "scopes": [
+                        "https://www.googleapis.com/auth/adexchange.buyer"
+                    ]
+                },
                 "update": {
                     "description": "Update the given proposal",
                     "httpMethod": "PUT",
                     "id": "adexchangebuyer.proposals.update",
                     "parameterOrder": [
                         "proposalId",
                         "revisionNumber",
                         "updateAction"
                     ],
                     "parameters": {
@@ skipping 36 matching lines @@
                         "$ref": "Proposal"
                     },
                     "response": {
                         "$ref": "Proposal"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/adexchange.buyer"
                     ]
                 }
             }
+        },
+        "pubprofiles": {
+            "methods": {
+                "list": {
+                    "description": "Gets the requested publisher profile(s) by publisher accountId.",
+                    "httpMethod": "GET",
+                    "id": "adexchangebuyer.pubprofiles.list",
+                    "parameterOrder": [
+                        "accountId"
+                    ],
+                    "parameters": {
+                        "accountId": {
+                            "description": "The accountId of the publisher to get profiles for.",
+                            "format": "int32",
+                            "location": "path",
+                            "required": true,
+                            "type": "integer"
+                        }
+                    },
+                    "path": "publisher/{accountId}/profiles",
+                    "response": {
+                        "$ref": "GetPublisherProfilesByAccountIdResponse"
+                    },
+                    "scopes": [
+                        "https://www.googleapis.com/auth/adexchange.buyer"
+                    ]
+                }
+            }
         }
     },
-    "revision": "20160118",
+    "revision": "20160229",
     "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",
+                                "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"
                             },
                             "url": {
@@ skipping 647 matching lines @@
                     "description": "Resource type.",
                     "type": "string"
                 },
                 "nextPageToken": {
                     "description": "Continuation token used to page through creatives. To retrieve the next page of results, set the next request's \"pageToken\" value to this.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "DealServingMetadata": {
+            "id": "DealServingMetadata",
+            "properties": {
+                "dealPauseStatus": {
+                    "$ref": "DealServingMetadataDealPauseStatus",
+                    "description": "Tracks which parties (if any) have paused a deal. (readonly, except via PauseResumeOrderDeals action)"
+                }
+            },
+            "type": "object"
+        },
+        "DealServingMetadataDealPauseStatus": {
+            "description": "Tracks which parties (if any) have paused a deal. The deal is considered paused if has_buyer_paused || has_seller_paused.",
+            "id": "DealServingMetadataDealPauseStatus",
+            "properties": {
+                "hasBuyerPaused": {
+                    "type": "boolean"
+                },
+                "hasSellerPaused": {
+                    "type": "boolean"
+                }
+            },
+            "type": "object"
+        },
         "DealTerms": {
             "id": "DealTerms",
             "properties": {
                 "brandingType": {
                     "description": "Visibilty of the URL in bid requests.",
                     "type": "string"
                 },
                 "description": {
                     "description": "Description for the proposed terms of the deal.",
                     "type": "string"
@@ skipping 41 matching lines @@
                     "description": "Count of guaranteed looks. Required for deal, optional for product.",
                     "format": "int64",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "DealTermsNonGuaranteedAuctionTerms": {
             "id": "DealTermsNonGuaranteedAuctionTerms",
             "properties": {
-                "privateAuctionId": {
-                    "description": "Id of the corresponding private auction.",
-                    "type": "string"
+                "autoOptimizePrivateAuction": {
+                    "description": "True if open auction buyers are allowed to compete with invited buyers in this private auction (buyer-readonly).",
+                    "type": "boolean"
                 },
                 "reservePricePerBuyers": {
                     "description": "Reserve price for the specified buyer.",
                     "items": {
                         "$ref": "PricePerBuyer"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
@@ skipping 113 matching lines @@
         },
         "EditAllOrderDealsResponse": {
             "id": "EditAllOrderDealsResponse",
             "properties": {
                 "deals": {
                     "description": "List of all deals in the proposal after edit.",
                     "items": {
                         "$ref": "MarketplaceDeal"
                     },
                     "type": "array"
+                },
+                "orderRevisionNumber": {
+                    "description": "The latest revision number after the update has been applied.",
+                    "format": "int64",
+                    "type": "string"
                 }
             },
             "type": "object"
         },
         "GetOffersResponse": {
             "id": "GetOffersResponse",
             "properties": {
                 "products": {
                     "description": "The returned list of products.",
                     "items": {
@@ skipping 36 matching lines @@
                 "proposals": {
                     "description": "The list of matching proposals.",
                     "items": {
                         "$ref": "Proposal"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
+        "GetPublisherProfilesByAccountIdResponse": {
+            "id": "GetPublisherProfilesByAccountIdResponse",
+            "properties": {
+                "profiles": {
+                    "description": "Profiles for the requested publisher",
+                    "items": {
+                        "$ref": "PublisherProfileApiProto"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "MarketplaceDeal": {
             "description": "A proposal can contain multiple deals. A deal contains the terms and targeting information that is used for serving.",
             "id": "MarketplaceDeal",
             "properties": {
                 "buyerPrivateData": {
                     "$ref": "PrivateData",
                     "description": "Buyer private data (hidden from seller)."
                 },
                 "creationTimeMs": {
                     "description": "The time (ms since epoch) of the deal creation. (readonly)",
                     "format": "int64",
                     "type": "string"
                 },
                 "creativePreApprovalPolicy": {
                     "description": "Specifies the creative pre-approval policy (buyer-readonly)",
                     "type": "string"
                 },
+                "creativeSafeFrameCompatibility": {
+                    "description": "Specifies whether the creative is safeFrame compatible (buyer-readonly)",
+                    "type": "string"
+                },
                 "dealId": {
                     "description": "A unique deal=id for the deal (readonly).",
                     "type": "string"
                 },
+                "dealServingMetadata": {
+                    "$ref": "DealServingMetadata",
+                    "description": "Metadata about the serving status of this deal (readonly, writes via custom actions)"
+                },
                 "deliveryControl": {
                     "$ref": "DeliveryControl",
                     "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
                 },
                 "externalDealId": {
                     "description": "The external deal id assigned to this deal once the deal is finalized. This is the deal-id that shows up in serving/reporting etc. (readonly)",
                     "type": "string"
                 },
                 "flightEndTimeMs": {
                     "description": "Proposed flight end time of the deal (ms since epoch) This will generally be stored in a granularity of a second. (updatable)",
@@ skipping 25 matching lines @@
                 },
                 "productId": {
                     "description": "The product-id from which this deal was created. (readonly, except on create)",
                     "type": "string"
                 },
                 "productRevisionNumber": {
                     "description": "The revision number of the product that the deal was created from (readonly, except on create)",
                     "format": "int64",
                     "type": "string"
                 },
+                "programmaticCreativeSource": {
+                    "description": "Specifies the creative source for programmatic deals, PUBLISHER means creative is provided by seller and ADVERTISR means creative is provided by buyer. (buyer-readonly)",
+                    "type": "string"
+                },
                 "proposalId": {
                     "type": "string"
                 },
                 "sellerContacts": {
                     "description": "Optional Seller contact information for the deal (buyer-readonly)",
                     "items": {
                         "$ref": "ContactInformation"
                     },
                     "type": "array"
                 },
                 "sharedTargetings": {
-                    "description": "The shared targeting visible to buyers and sellers. (updatable)",
+                    "description": "The shared targeting visible to buyers and sellers. Each shared targeting entity is AND'd together. (updatable)",
                     "items": {
                         "$ref": "SharedTargeting"
                     },
                     "type": "array"
                 },
                 "syndicationProduct": {
                     "description": "The syndication product associated with the deal. (readonly, except on create)",
                     "type": "string"
                 },
                 "terms": {
@@ skipping 524 matching lines @@
                     "format": "int64",
                     "type": "string"
                 },
                 "creatorContacts": {
                     "description": "Optional contact information for the creator of this product. (buyer-readonly)",
                     "items": {
                         "$ref": "ContactInformation"
                     },
                     "type": "array"
                 },
+                "deliveryControl": {
+                    "$ref": "DeliveryControl",
+                    "description": "The set of fields around delivery control that are interesting for a buyer to see but are non-negotiable. These are set by the publisher. This message is assigned an id of 100 since some day we would want to model this as a protobuf extension."
+                },
                 "flightEndTimeMs": {
                     "description": "The proposed end time for the deal (ms since epoch) (buyer-readonly)",
                     "format": "int64",
                     "type": "string"
                 },
                 "flightStartTimeMs": {
                     "description": "Inventory availability dates. (times are in ms since epoch) The granularity is generally in the order of seconds. (buyer-readonly)",
                     "format": "int64",
                     "type": "string"
                 },
@@ skipping 15 matching lines @@
                     "items": {
                         "$ref": "MarketplaceLabel"
                     },
                     "type": "array"
                 },
                 "lastUpdateTimeMs": {
                     "description": "Time of last update in ms. since epoch (readonly)",
                     "format": "int64",
                     "type": "string"
                 },
+                "legacyOfferId": {
+                    "description": "Optional legacy offer id if this offer is a preferred deal offer.",
+                    "type": "string"
+                },
                 "name": {
                     "description": "The name for this product as set by the seller. (buyer-readonly)",
                     "type": "string"
                 },
+                "privateAuctionId": {
+                    "description": "Optional private auction id if this offer is a private auction offer.",
+                    "type": "string"
+                },
                 "productId": {
                     "description": "The unique id for the product (readonly)",
                     "type": "string"
                 },
                 "revisionNumber": {
                     "description": "The revision number of the product. (readonly)",
                     "format": "int64",
                     "type": "string"
                 },
                 "seller": {
@@ skipping 58 matching lines @@
                 },
                 "inventorySource": {
                     "description": "What exchange will provide this inventory (readonly, except on create).",
                     "type": "string"
                 },
                 "isRenegotiating": {
                     "description": "True if the proposal is being renegotiated (readonly).",
                     "type": "boolean"
                 },
                 "isSetupComplete": {
-                    "description": "True, if the buyside inventory setup is complete for this proposal. (readonly)",
+                    "description": "True, if the buyside inventory setup is complete for this proposal. (readonly, except via OrderSetupCompleted action)",
                     "type": "boolean"
                 },
                 "kind": {
                     "default": "adexchangebuyer#proposal",
                     "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#proposal\".",
                     "type": "string"
                 },
                 "labels": {
                     "description": "List of labels associated with the proposal. (readonly)",
                     "items": {
                         "$ref": "MarketplaceLabel"
                     },
                     "type": "array"
                 },
                 "lastUpdaterOrCommentorRole": {
                     "description": "The role of the last user that either updated the proposal or left a comment. (readonly)",
                     "type": "string"
                 },
                 "lastUpdaterRole": {
                     "type": "string"
                 },
                 "name": {
                     "description": "The name for the proposal (updatable)",
                     "type": "string"
                 },
+                "negotiationId": {
+                    "description": "Optional negotiation id if this proposal is a preferred deal proposal.",
+                    "type": "string"
+                },
                 "originatorRole": {
                     "description": "Indicates whether the buyer/seller created the proposal.(readonly)",
                     "type": "string"
                 },
+                "privateAuctionId": {
+                    "description": "Optional private auction id if this proposal is a private auction proposal.",
+                    "type": "string"
+                },
                 "proposalId": {
                     "description": "The unique id of the proposal. (readonly).",
                     "type": "string"
                 },
                 "proposalState": {
                     "description": "The current state of the proposal. (readonly)",
                     "type": "string"
                 },
                 "revisionNumber": {
                     "description": "The revision number for the proposal (readonly).",
@@ skipping 12 matching lines @@
                 "sellerContacts": {
                     "description": "Optional contact information for the seller (buyer-readonly).",
                     "items": {
                         "$ref": "ContactInformation"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
+        "PublisherProfileApiProto": {
+            "id": "PublisherProfileApiProto",
+            "properties": {
+                "buyerPitchStatement": {
+                    "description": "A pitch statement for the buyer",
+                    "type": "string"
+                },
+                "googlePlusLink": {
+                    "description": "Link to publisher's Google+ page.",
+                    "type": "string"
+                },
+                "isParent": {
+                    "description": "True, if this is the parent profile, which represents all domains owned by the publisher.",
+                    "type": "boolean"
+                },
+                "kind": {
+                    "default": "adexchangebuyer#publisherProfileApiProto",
+                    "description": "Identifies what kind of resource this is. Value: the fixed string \"adexchangebuyer#publisherProfileApiProto\".",
+                    "type": "string"
+                },
+                "logoUrl": {
+                    "description": "The url to the logo for the publisher.",
+                    "type": "string"
+                },
+                "mediaKitLink": {
+                    "description": "The url for additional marketing and sales materials.",
+                    "type": "string"
+                },
+                "name": {
+                    "type": "string"
+                },
+                "overview": {
+                    "description": "Publisher provided overview.",
+                    "type": "string"
+                },
+                "profileId": {
+                    "description": "Unique id for the publisher profile",
+                    "format": "int32",
+                    "type": "integer"
+                },
+                "publisherDomains": {
+                    "description": "The list of domains represented in this publisher profile. Empty if this is a parent profile.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "rateCardInfoLink": {
+                    "description": "Link to publisher rate card",
+                    "type": "string"
+                },
+                "samplePageLink": {
+                    "description": "Link for a sample content page.",
+                    "type": "string"
+                },
+                "topHeadlines": {
+                    "description": "Publisher provided key metrics and rankings.",
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                }
+            },
+            "type": "object"
+        },
         "Seller": {
             "id": "Seller",
             "properties": {
                 "accountId": {
                     "description": "The unique id for the seller. The seller fills in this field. The seller account id is then available to buyer in the product.",
                     "type": "string"
                 },
                 "subAccountId": {
                     "description": "Optional sub-account id for the seller.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "SharedTargeting": {
             "id": "SharedTargeting",
             "properties": {
                 "exclusions": {
-                    "description": "The list of values to exclude from targeting.",
+                    "description": "The list of values to exclude from targeting. Each value is AND'd together.",
                     "items": {
                         "$ref": "TargetingValue"
                     },
                     "type": "array"
                 },
                 "inclusions": {
-                    "description": "The list of value to include as part of the targeting.",
+                    "description": "The list of value to include as part of the targeting. Each value is OR'd together.",
                     "items": {
                         "$ref": "TargetingValue"
                     },
                     "type": "array"
                 },
                 "key": {
                     "description": "The key representing the shared targeting criterion.",
                     "type": "string"
                 }
             },
@@ skipping 97 matching lines @@
                     "type": "integer"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "adexchangebuyer/v1.4/",
     "title": "Ad Exchange Buyer API",
     "version": "v1.4"
 }