feat(realtimebidding)!: update the API

BREAKING CHANGE: This release has breaking changes. #### realtimebidding:v1 The following keys were deleted: - schemas.CreativeServingDecision.properties.chinaServingStatus.$ref - schemas.CreativeServingDecision.properties.chinaServingStatus.description - schemas.CreativeServingDecision.properties.dealsServingStatus.$ref - schemas.CreativeServingDecision.properties.dealsServingStatus.description - schemas.CreativeServingDecision.properties.openAuctionServingStatus.$ref - schemas.CreativeServingDecision.properties.openAuctionServingStatus.description - schemas.CreativeServingDecision.properties.russiaServingStatus.$ref - schemas.CreativeServingDecision.properties.russiaServingStatus.description - schemas.ServingStatus.description - schemas.ServingStatus.id - schemas.ServingStatus.properties.status.description - schemas.ServingStatus.properties.status.enum - schemas.ServingStatus.properties.status.enumDescriptions - schemas.ServingStatus.properties.status.type - schemas.ServingStatus.properties.topics.description - schemas.ServingStatus.properties.topics.items.$ref - schemas.ServingStatus.properties.topics.type - schemas.ServingStatus.type The following keys were added: - schemas.Creative.properties.name.readOnly - schemas.CreativeServingDecision.properties.chinaPolicyCompliance.$ref - schemas.CreativeServingDecision.properties.chinaPolicyCompliance.description - schemas.CreativeServingDecision.properties.dealsPolicyCompliance.$ref - schemas.CreativeServingDecision.properties.dealsPolicyCompliance.description - schemas.CreativeServingDecision.properties.networkPolicyCompliance.$ref - schemas.CreativeServingDecision.properties.networkPolicyCompliance.description - schemas.CreativeServingDecision.properties.platformPolicyCompliance.$ref - schemas.CreativeServingDecision.properties.platformPolicyCompliance.description - schemas.CreativeServingDecision.properties.russiaPolicyCompliance.$ref - schemas.CreativeServingDecision.properties.russiaPolicyCompliance.description - schemas.PolicyCompliance.description - schemas.PolicyCompliance.id - schemas.PolicyCompliance.properties.status.description - schemas.PolicyCompliance.properties.status.enum - schemas.PolicyCompliance.properties.status.enumDescriptions - schemas.PolicyCompliance.properties.status.type - schemas.PolicyCompliance.properties.topics.description - schemas.PolicyCompliance.properties.topics.items.$ref - schemas.PolicyCompliance.properties.topics.type - schemas.PolicyCompliance.type The following keys were changed: - resources.buyers.resources.creatives.methods.patch.parameters.name.description - schemas.Creative.properties.name.description - schemas.Date.description - schemas.Date.properties.day.description - schemas.Date.properties.month.description - schemas.Date.properties.year.description
googleapis · Oct 20, 2020 · 7c2c1ac · 7c2c1ac
1 parent 95a1f95
commit 7c2c1ac
Show file tree

Hide file tree

Showing 2 changed files with 87 additions and 78 deletions.
diff --git a/discovery/realtimebidding-v1.json b/discovery/realtimebidding-v1.json
@@ -362,7 +362,7 @@
               ],
               "parameters": {
                 "name": {
-                  "description": "Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.",
+                  "description": "Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.",
                   "location": "path",
                   "pattern": "^buyers/[^/]+/creatives/[^/]+$",
                   "required": true,
@@ -593,7 +593,7 @@
       }
     }
   },
-  "revision": "20201006",
+  "revision": "20201017",
   "rootUrl": "https://realtimebidding.googleapis.com/",
   "schemas": {
     "AdvertiserAndBrand": {
@@ -819,7 +819,8 @@
           "type": "array"
         },
         "name": {
-          "description": "Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.",
+          "description": "Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.",
+          "readOnly": true,
           "type": "string"
         },
         "native": {
@@ -858,13 +859,13 @@
       "description": "Top level status and detected attributes of a creative.",
       "id": "CreativeServingDecision",
       "properties": {
-        "chinaServingStatus": {
-          "$ref": "ServingStatus",
-          "description": "The serving status of this creative in China. When approved or disapproved, this status applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction."
+        "chinaPolicyCompliance": {
+          "$ref": "PolicyCompliance",
+          "description": "The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction."
         },
-        "dealsServingStatus": {
-          "$ref": "ServingStatus",
-          "description": "Status of this creative when bidding on PG and PD deals (outside of Russia and China)."
+        "dealsPolicyCompliance": {
+          "$ref": "PolicyCompliance",
+          "description": "Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China)."
         },
         "detectedAdvertisers": {
           "description": "Detected advertisers and brands.",
@@ -1010,33 +1011,37 @@
           "format": "google-datetime",
           "type": "string"
         },
-        "openAuctionServingStatus": {
-          "$ref": "ServingStatus",
-          "description": "Status of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China)."
+        "networkPolicyCompliance": {
+          "$ref": "PolicyCompliance",
+          "description": "Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China)."
+        },
+        "platformPolicyCompliance": {
+          "$ref": "PolicyCompliance",
+          "description": "Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851."
         },
-        "russiaServingStatus": {
-          "$ref": "ServingStatus",
-          "description": "The serving status of this creative in Russia. When approved or disapproved, this status applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction."
+        "russiaPolicyCompliance": {
+          "$ref": "PolicyCompliance",
+          "description": "The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction."
         }
       },
       "type": "object"
     },
     "Date": {
-      "description": "Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
+      "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.",
       "id": "Date",
       "properties": {
         "day": {
-          "description": "Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.",
+          "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
           "format": "int32",
           "type": "integer"
         },
         "month": {
-          "description": "Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.",
+          "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
           "format": "int32",
           "type": "integer"
         },
         "year": {
-          "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.",
+          "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
           "format": "int32",
           "type": "integer"
         }
@@ -1479,6 +1484,36 @@
       "properties": {},
       "type": "object"
     },
+    "PolicyCompliance": {
+      "description": "Policy compliance of the creative for a transaction type or a region.",
+      "id": "PolicyCompliance",
+      "properties": {
+        "status": {
+          "description": "Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.",
+          "enum": [
+            "STATUS_UNSPECIFIED",
+            "PENDING_REVIEW",
+            "DISAPPROVED",
+            "APPROVED"
+          ],
+          "enumDescriptions": [
+            "Default value that should never be used.",
+            "Creative is pending review.",
+            "Creative cannot serve.",
+            "Creative is approved."
+          ],
+          "type": "string"
+        },
+        "topics": {
+          "description": "Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.",
+          "items": {
+            "$ref": "PolicyTopicEntry"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "PolicyTopicEntry": {
       "description": "Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.",
       "id": "PolicyTopicEntry",
@@ -1536,36 +1571,6 @@
       },
       "type": "object"
     },
-    "ServingStatus": {
-      "description": "Serving status of the creative for a transaction type or a region.",
-      "id": "ServingStatus",
-      "properties": {
-        "status": {
-          "description": "Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.",
-          "enum": [
-            "STATUS_UNSPECIFIED",
-            "PENDING_REVIEW",
-            "DISAPPROVED",
-            "APPROVED"
-          ],
-          "enumDescriptions": [
-            "Default value that should never be used.",
-            "Creative is pending review.",
-            "Creative cannot serve.",
-            "Creative is approved."
-          ],
-          "type": "string"
-        },
-        "topics": {
-          "description": "Policy topics related to the serving decision for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.",
-          "items": {
-            "$ref": "PolicyTopicEntry"
-          },
-          "type": "array"
-        }
-      },
-      "type": "object"
-    },
     "UrlDownloadSize": {
       "description": "The URL-level breakdown for the download size.",
       "id": "UrlDownloadSize",

diff --git a/src/apis/realtimebidding/v1.ts b/src/apis/realtimebidding/v1.ts
@@ -219,7 +219,7 @@ export namespace realtimebidding_v1 {
      */
     impressionTrackingUrls?: string[] | null;
     /**
-     * Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
+     * Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
      */
     name?: string | null;
     /**
@@ -244,13 +244,13 @@ export namespace realtimebidding_v1 {
    */
   export interface Schema$CreativeServingDecision {
     /**
-     * The serving status of this creative in China. When approved or disapproved, this status applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction.
+     * The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction.
      */
-    chinaServingStatus?: Schema$ServingStatus;
+    chinaPolicyCompliance?: Schema$PolicyCompliance;
     /**
-     * Status of this creative when bidding on PG and PD deals (outside of Russia and China).
+     * Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China).
      */
-    dealsServingStatus?: Schema$ServingStatus;
+    dealsPolicyCompliance?: Schema$PolicyCompliance;
     /**
      * Detected advertisers and brands.
      */
@@ -288,28 +288,32 @@ export namespace realtimebidding_v1 {
      */
     lastStatusUpdate?: string | null;
     /**
-     * Status of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China).
+     * Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China).
      */
-    openAuctionServingStatus?: Schema$ServingStatus;
+    networkPolicyCompliance?: Schema$PolicyCompliance;
     /**
-     * The serving status of this creative in Russia. When approved or disapproved, this status applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction.
+     * Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851.
      */
-    russiaServingStatus?: Schema$ServingStatus;
+    platformPolicyCompliance?: Schema$PolicyCompliance;
+    /**
+     * The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction.
+     */
+    russiaPolicyCompliance?: Schema$PolicyCompliance;
   }
   /**
-   * Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
+   * Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values * A month and day value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
    */
   export interface Schema$Date {
     /**
-     * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
+     * Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn&#39;t significant.
      */
     day?: number | null;
     /**
-     * Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
+     * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
      */
     month?: number | null;
     /**
-     * Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
+     * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
      */
     year?: number | null;
   }
@@ -576,6 +580,19 @@ export namespace realtimebidding_v1 {
    * A request to open a specified user list.
    */
   export interface Schema$OpenUserListRequest {}
+  /**
+   * Policy compliance of the creative for a transaction type or a region.
+   */
+  export interface Schema$PolicyCompliance {
+    /**
+     * Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.
+     */
+    status?: string | null;
+    /**
+     * Topics related to the policy compliance for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.
+     */
+    topics?: Schema$PolicyTopicEntry[];
+  }
   /**
    * Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
    */
@@ -626,19 +643,6 @@ export namespace realtimebidding_v1 {
      */
     httpCookie?: Schema$HttpCookieEvidence;
   }
-  /**
-   * Serving status of the creative for a transaction type or a region.
-   */
-  export interface Schema$ServingStatus {
-    /**
-     * Serving status for the given transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Can be used to filter the response of the creatives.list method.
-     */
-    status?: string | null;
-    /**
-     * Policy topics related to the serving decision for this transaction type (e.g., open auction, deals) or region (e.g., China, Russia). Topics may be present only if status is DISAPPROVED.
-     */
-    topics?: Schema$PolicyTopicEntry[];
-  }
   /**
    * The URL-level breakdown for the download size.
    */
@@ -1784,7 +1788,7 @@ export namespace realtimebidding_v1 {
      *
      *   // Do the magic
      *   const res = await realtimebidding.buyers.creatives.patch({
-     *     // Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
+     *     // Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
      *     name: 'buyers/my-buyer/creatives/my-creative',
      *     // Field mask to use for partial in-place updates.
      *     updateMask: 'placeholder-value',
@@ -1852,7 +1856,7 @@ export namespace realtimebidding_v1 {
      * @memberOf! ()
      *
      * @param {object} params Parameters for request
-     * @param {string} params.name Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
+     * @param {string} params.name Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
      * @param {string=} params.updateMask Field mask to use for partial in-place updates.
      * @param {().Creative} params.requestBody Request body data
      * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1986,7 +1990,7 @@ export namespace realtimebidding_v1 {
   export interface Params$Resource$Buyers$Creatives$Patch
     extends StandardParameters {
     /**
-     * Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
+     * Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
      */
     name?: string;
     /**