feat(authorizedbuyersmarketplace): update the API

#### authorizedbuyersmarketplace:v1 The following keys were added: - schemas.Deal.properties.eligibleSeatIds.description - schemas.Deal.properties.eligibleSeatIds.items.type - schemas.Deal.properties.eligibleSeatIds.readOnly - schemas.Deal.properties.eligibleSeatIds.type - schemas.Deal.properties.mediaPlanner.$ref - schemas.Deal.properties.mediaPlanner.description - schemas.Deal.properties.mediaPlanner.readOnly - schemas.MediaPlanner.description - schemas.MediaPlanner.id - schemas.MediaPlanner.properties.accountId.description - schemas.MediaPlanner.properties.accountId.readOnly - schemas.MediaPlanner.properties.accountId.type - schemas.MediaPlanner.type The following keys were changed: - resources.bidders.resources.finalizedDeals.methods.list.parameters.filter.description - resources.buyers.resources.finalizedDeals.methods.list.parameters.filter.description - schemas.Deal.properties.billedBuyer.description - schemas.Deal.properties.buyer.description
googleapis · Mar 14, 2024 · ce3b9d9 · ce3b9d9
1 parent f660310
commit ce3b9d9
Show file tree

Hide file tree

Showing 2 changed files with 51 additions and 9 deletions.
diff --git a/discovery/authorizedbuyersmarketplace-v1.json b/discovery/authorizedbuyersmarketplace-v1.json
@@ -119,7 +119,7 @@
               ],
               "parameters": {
                 "filter": {
-                  "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus",
+                  "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus",
                   "location": "query",
                   "type": "string"
                 },
@@ -767,7 +767,7 @@
               ],
               "parameters": {
                 "filter": {
-                  "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus",
+                  "description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus",
                   "location": "query",
                   "type": "string"
                 },
@@ -1307,7 +1307,7 @@
       }
     }
   },
-  "revision": "20231213",
+  "revision": "20240312",
   "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
   "schemas": {
     "AcceptProposalRequest": {
@@ -1774,12 +1774,12 @@
       "id": "Deal",
       "properties": {
         "billedBuyer": {
-          "description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`",
+          "description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`",
           "readOnly": true,
           "type": "string"
         },
         "buyer": {
-          "description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`",
+          "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`",
           "readOnly": true,
           "type": "string"
         },
@@ -1831,6 +1831,14 @@
           "readOnly": true,
           "type": "string"
         },
+        "eligibleSeatIds": {
+          "description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.",
+          "items": {
+            "type": "string"
+          },
+          "readOnly": true,
+          "type": "array"
+        },
         "estimatedGrossSpend": {
           "$ref": "Money",
           "description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly."
@@ -1845,6 +1853,11 @@
           "format": "google-datetime",
           "type": "string"
         },
+        "mediaPlanner": {
+          "$ref": "MediaPlanner",
+          "description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).",
+          "readOnly": true
+        },
         "name": {
           "description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}",
           "type": "string"
@@ -2340,6 +2353,18 @@
       },
       "type": "object"
     },
+    "MediaPlanner": {
+      "description": "Describes a single Media Planner account.",
+      "id": "MediaPlanner",
+      "properties": {
+        "accountId": {
+          "description": "Output only. Account ID of the media planner.",
+          "readOnly": true,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "MobileApplicationTargeting": {
       "description": "Mobile application targeting settings.",
       "id": "MobileApplicationTargeting",

diff --git a/src/apis/authorizedbuyersmarketplace/v1.ts b/src/apis/authorizedbuyersmarketplace/v1.ts
@@ -377,11 +377,11 @@ export namespace authorizedbuyersmarketplace_v1 {
    */
   export interface Schema$Deal {
     /**
-     * Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId\}`
+     * Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId\}`
      */
     billedBuyer?: string | null;
     /**
-     * Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId\}`
+     * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId\}`
      */
     buyer?: string | null;
     /**
@@ -412,6 +412,10 @@ export namespace authorizedbuyersmarketplace_v1 {
      * Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
      */
     displayName?: string | null;
+    /**
+     * Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+     */
+    eligibleSeatIds?: string[] | null;
     /**
      * Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
      */
@@ -424,6 +428,10 @@ export namespace authorizedbuyersmarketplace_v1 {
      * Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
      */
     flightStartTime?: string | null;
+    /**
+     * Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+     */
+    mediaPlanner?: Schema$MediaPlanner;
     /**
      * Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId\}/proposals/{proposalId\}/deals/{dealId\}
      */
@@ -716,6 +724,15 @@ export namespace authorizedbuyersmarketplace_v1 {
      */
     videoTargeting?: Schema$VideoTargeting;
   }
+  /**
+   * Describes a single Media Planner account.
+   */
+  export interface Schema$MediaPlanner {
+    /**
+     * Output only. Account ID of the media planner.
+     */
+    accountId?: string | null;
+  }
   /**
    * Mobile application targeting settings.
    */
@@ -1352,7 +1369,7 @@ export namespace authorizedbuyersmarketplace_v1 {
   export interface Params$Resource$Bidders$Finalizeddeals$List
     extends StandardParameters {
     /**
-     * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus
+     * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
      */
     filter?: string;
     /**
@@ -3799,7 +3816,7 @@ export namespace authorizedbuyersmarketplace_v1 {
   export interface Params$Resource$Buyers$Finalizeddeals$List
     extends StandardParameters {
     /**
-     * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * dealServingStatus
+     * Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
      */
     filter?: string;
     /**