feat(dfareporting)!: update the API

BREAKING CHANGE: This release has breaking changes. #### dfareporting:v3.5 The following keys were deleted: - schemas.CreativeAssetMetadata.properties.mediaRequestInfo.$ref - schemas.CreativeAssetMetadata.properties.mediaResponseInfo.$ref - schemas.MediaRequestInfo.description - schemas.MediaRequestInfo.id - schemas.MediaRequestInfo.properties.currentBytes.description - schemas.MediaRequestInfo.properties.currentBytes.format - schemas.MediaRequestInfo.properties.currentBytes.type - schemas.MediaRequestInfo.properties.customData.description - schemas.MediaRequestInfo.properties.customData.type - schemas.MediaRequestInfo.properties.diffObjectVersion.description - schemas.MediaRequestInfo.properties.diffObjectVersion.type - schemas.MediaRequestInfo.properties.finalStatus.description - schemas.MediaRequestInfo.properties.finalStatus.format - schemas.MediaRequestInfo.properties.finalStatus.type - schemas.MediaRequestInfo.properties.notificationType.description - schemas.MediaRequestInfo.properties.notificationType.enum - schemas.MediaRequestInfo.properties.notificationType.enumDescriptions - schemas.MediaRequestInfo.properties.notificationType.type - schemas.MediaRequestInfo.properties.requestId.description - schemas.MediaRequestInfo.properties.requestId.type - schemas.MediaRequestInfo.properties.requestReceivedParamsServingInfo.description - schemas.MediaRequestInfo.properties.requestReceivedParamsServingInfo.format - schemas.MediaRequestInfo.properties.requestReceivedParamsServingInfo.type - schemas.MediaRequestInfo.properties.totalBytes.description - schemas.MediaRequestInfo.properties.totalBytes.format - schemas.MediaRequestInfo.properties.totalBytes.type - schemas.MediaRequestInfo.properties.totalBytesIsEstimated.description - schemas.MediaRequestInfo.properties.totalBytesIsEstimated.type - schemas.MediaRequestInfo.type - schemas.MediaResponseInfo.description - schemas.MediaResponseInfo.id - schemas.MediaResponseInfo.properties.customData.description - schemas.MediaResponseInfo.properties.customData.type - schemas.MediaResponseInfo.properties.dataStorageTransform.description - schemas.MediaResponseInfo.properties.dataStorageTransform.format - schemas.MediaResponseInfo.properties.dataStorageTransform.type - schemas.MediaResponseInfo.properties.dynamicDropTarget.description - schemas.MediaResponseInfo.properties.dynamicDropTarget.format - schemas.MediaResponseInfo.properties.dynamicDropTarget.type - schemas.MediaResponseInfo.properties.dynamicDropzone.description - schemas.MediaResponseInfo.properties.dynamicDropzone.type - schemas.MediaResponseInfo.properties.requestClass.description - schemas.MediaResponseInfo.properties.requestClass.enum - schemas.MediaResponseInfo.properties.requestClass.enumDescriptions - schemas.MediaResponseInfo.properties.requestClass.type - schemas.MediaResponseInfo.properties.scottyAgentUserId.description - schemas.MediaResponseInfo.properties.scottyAgentUserId.format - schemas.MediaResponseInfo.properties.scottyAgentUserId.type - schemas.MediaResponseInfo.properties.scottyCustomerLog.description - schemas.MediaResponseInfo.properties.scottyCustomerLog.format - schemas.MediaResponseInfo.properties.scottyCustomerLog.type - schemas.MediaResponseInfo.properties.trafficClassField.description - schemas.MediaResponseInfo.properties.trafficClassField.enum - schemas.MediaResponseInfo.properties.trafficClassField.enumDescriptions - schemas.MediaResponseInfo.properties.trafficClassField.type - schemas.MediaResponseInfo.properties.verifyHashFromHeader.description - schemas.MediaResponseInfo.properties.verifyHashFromHeader.type - schemas.MediaResponseInfo.type #### dfareporting:v4 The following keys were added: - schemas.CartData.description - schemas.CartData.id - schemas.CartData.properties.items.description - schemas.CartData.properties.items.items.$ref - schemas.CartData.properties.items.type - schemas.CartData.properties.merchantFeedLabel.description - schemas.CartData.properties.merchantFeedLabel.type - schemas.CartData.properties.merchantFeedLanguage.description - schemas.CartData.properties.merchantFeedLanguage.type - schemas.CartData.properties.merchantId.description - schemas.CartData.properties.merchantId.format - schemas.CartData.properties.merchantId.type - schemas.CartData.type - schemas.CartDataItem.description - schemas.CartDataItem.id - schemas.CartDataItem.properties.itemId.description - schemas.CartDataItem.properties.itemId.type - schemas.CartDataItem.properties.quantity.description - schemas.CartDataItem.properties.quantity.format - schemas.CartDataItem.properties.quantity.type - schemas.CartDataItem.properties.unitPrice.description - schemas.CartDataItem.properties.unitPrice.format - schemas.CartDataItem.properties.unitPrice.type - schemas.CartDataItem.type - schemas.Conversion.properties.cartData.$ref - schemas.Conversion.properties.cartData.description - schemas.DirectorySite.properties.publisherSpecificationId.description - schemas.DirectorySite.properties.publisherSpecificationId.format - schemas.DirectorySite.properties.publisherSpecificationId.readOnly - schemas.DirectorySite.properties.publisherSpecificationId.type - schemas.Placement.properties.adServingPlatformId.description - schemas.Placement.properties.adServingPlatformId.format - schemas.Placement.properties.adServingPlatformId.type - schemas.Placement.properties.siteServed.description - schemas.Placement.properties.siteServed.type - schemas.Site.properties.adServingPlatformId.description - schemas.Site.properties.adServingPlatformId.format - schemas.Site.properties.adServingPlatformId.type The following keys were changed: - schemas.SiteVideoSettings.properties.publisherSpecificationId.description - schemas.VideoSettings.properties.publisherSpecificationId.description
googleapis · Aug 27, 2024 · f690620 · f690620
1 parent 73a27e5
commit f690620
Show file tree

Hide file tree

Showing 4 changed files with 136 additions and 244 deletions.
diff --git a/discovery/dfareporting-v3.5.json b/discovery/dfareporting-v3.5.json
@@ -161,7 +161,7 @@
       }
     }
   },
-  "revision": "20240625",
+  "revision": "20240821",
   "rootUrl": "https://dfareporting.googleapis.com/",
   "schemas": {
     "ClickTag": {
@@ -399,12 +399,6 @@
           "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#creativeAssetMetadata\".",
           "type": "string"
         },
-        "mediaRequestInfo": {
-          "$ref": "MediaRequestInfo"
-        },
-        "mediaResponseInfo": {
-          "$ref": "MediaResponseInfo"
-        },
         "richMedia": {
           "description": "True if the uploaded asset is a rich media asset. This is a read-only, auto-generated field.",
           "type": "boolean"
@@ -630,154 +624,6 @@
       },
       "type": "object"
     },
-    "MediaRequestInfo": {
-      "description": "Extra information added to operations that support Scotty media requests.",
-      "id": "MediaRequestInfo",
-      "properties": {
-        "currentBytes": {
-          "description": "The number of current bytes uploaded or downloaded.",
-          "format": "int64",
-          "type": "string"
-        },
-        "customData": {
-          "description": "Data to be copied to backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.",
-          "type": "string"
-        },
-        "diffObjectVersion": {
-          "description": "Set if the http request info is diff encoded. The value of this field is the version number of the base revision. This is corresponding to Apiary's mediaDiffObjectVersion (//depot/google3/java/com/google/api/server/media/variable/DiffObjectVersionVariable.java). See go/esf-scotty-diff-upload for more information.",
-          "type": "string"
-        },
-        "finalStatus": {
-          "description": "The existence of the final_status field indicates that this is the last call to the agent for this request_id. http://google3/uploader/agent/scotty_agent.proto?l=737&rcl=347601929",
-          "format": "int32",
-          "type": "integer"
-        },
-        "notificationType": {
-          "description": "The type of notification received from Scotty.",
-          "enum": [
-            "START",
-            "PROGRESS",
-            "END",
-            "RESPONSE_SENT",
-            "ERROR"
-          ],
-          "enumDescriptions": [
-            "Such requests signals the start of a request containing media upload. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.",
-            "Such requests signals that the upload has progressed and that the backend might want to access the media file specified in relevant fields in the resource. Only the media field(s) in the inserted/updated resource are set. The response should either return an error or succeed. On success, responses don't need to contain anything.",
-            "Such requests signals the end of a request containing media upload. END should be handled just like normal Insert/Upload requests, that is, they should process the request and return a complete resource in the response. Pointers to media data (a GFS path usually) appear in the relevant fields in the inserted/updated resource. See gdata.Media in data.proto.",
-            "Such requests occur after an END and signal that the response has been sent back to the client. RESPONSE_SENT is only sent to the backend if it is configured to receive them. The response does not need to contain anything.",
-            "Such requests indicate that an error occurred while processing the request. ERROR is only sent to the backend if it is configured to receive them. It is not guaranteed that all errors will result in this notification to the backend, even if the backend requests them. Since these requests are just for informational purposes, the response does not need to contain anything."
-          ],
-          "type": "string"
-        },
-        "requestId": {
-          "description": "The Scotty request ID.",
-          "type": "string"
-        },
-        "requestReceivedParamsServingInfo": {
-          "description": "The partition of the Scotty server handling this request. type is uploader_service.RequestReceivedParamsServingInfo LINT.IfChange(request_received_params_serving_info_annotations) LINT.ThenChange()",
-          "format": "byte",
-          "type": "string"
-        },
-        "totalBytes": {
-          "description": "The total size of the file.",
-          "format": "int64",
-          "type": "string"
-        },
-        "totalBytesIsEstimated": {
-          "description": "Whether the total bytes field contains an estimated data.",
-          "type": "boolean"
-        }
-      },
-      "type": "object"
-    },
-    "MediaResponseInfo": {
-      "description": "This message is for backends to pass their scotty media specific fields to ESF. Backend will include this in their response message to ESF. Example: ExportFile is an rpc defined for upload using scotty from ESF. rpc ExportFile(ExportFileRequest) returns (ExportFileResponse) Message ExportFileResponse will include apiserving.MediaResponseInfo to tell ESF about data like dynamic_dropzone it needs to pass to Scotty. message ExportFileResponse { optional gdata.Media blob = 1; optional apiserving.MediaResponseInfo media_response_info = 2 }",
-      "id": "MediaResponseInfo",
-      "properties": {
-        "customData": {
-          "description": "Data to copy from backend response to the next backend requests. Custom data is returned to Scotty in the agent_state field, which Scotty will then provide in subsequent upload notifications.",
-          "type": "string"
-        },
-        "dataStorageTransform": {
-          "description": "Specifies any transformation to be applied to data before persisting it or retrieving from storage. E.g., encryption options for blobstore2. This should be of the form uploader_service.DataStorageTransform.",
-          "format": "byte",
-          "type": "string"
-        },
-        "dynamicDropTarget": {
-          "description": "Specifies the Scotty Drop Target to use for uploads. If present in a media response, Scotty does not upload to a standard drop zone. Instead, Scotty saves the upload directly to the location specified in this drop target. Unlike drop zones, the drop target is the final storage location for an upload. So, the agent does not need to clone the blob at the end of the upload. The agent is responsible for garbage collecting any orphaned blobs that may occur due to aborted uploads. For more information, see the drop target design doc here: http://goto/ScottyDropTarget This field will be preferred to dynamicDropzone. If provided, the identified field in the response must be of the type uploader.agent.DropTarget.",
-          "format": "byte",
-          "type": "string"
-        },
-        "dynamicDropzone": {
-          "description": "Specifies the Scotty dropzone to use for uploads.",
-          "type": "string"
-        },
-        "requestClass": {
-          "description": "Request class to use for all Blobstore operations for this request.",
-          "enum": [
-            "UNKNOWN_REQUEST_CLASS",
-            "LATENCY_SENSITIVE",
-            "PRODUCTION_BATCH",
-            "BEST_EFFORT"
-          ],
-          "enumDescriptions": [
-            "Unpopulated request_class in log files will be taken as 0 in dremel query. GoogleSQL will try to cast it to enum by default. An unused 0 value is added to avoid GoogleSQL casting error. Please refer to b/69677280.",
-            "A latency-sensitive request.",
-            "A request generated by a batch process.",
-            "A best-effort request."
-          ],
-          "type": "string"
-        },
-        "scottyAgentUserId": {
-          "description": "Requester ID passed along to be recorded in the Scotty logs",
-          "format": "int64",
-          "type": "string"
-        },
-        "scottyCustomerLog": {
-          "description": "Customer-specific data to be recorded in the Scotty logs type is logs_proto_scotty.CustomerLog",
-          "format": "byte",
-          "type": "string"
-        },
-        "trafficClassField": {
-          "description": "Specifies the TrafficClass that Scotty should use for any RPCs to fetch the response bytes. Will override the traffic class GTOS of the incoming http request. This is a temporary field to facilitate whitelisting and experimentation by the bigstore agent only. For instance, this does not apply to RTMP reads. WARNING: DO NOT USE WITHOUT PERMISSION FROM THE SCOTTY TEAM.",
-          "enum": [
-            "BE1",
-            "AF1",
-            "AF2",
-            "AF3",
-            "AF4",
-            "NC1",
-            "NC0",
-            "BE0",
-            "LLQ",
-            "LLQ1",
-            "LLQ2",
-            "LLQ3"
-          ],
-          "enumDescriptions": [
-            "Application-selectable traffic classes Best effort",
-            "Assured forwarding priority 1",
-            "Assured forwarding priority 2",
-            "Assured forwarding priority 3",
-            "Assured forwarding priority 4",
-            "Network control",
-            "Network control",
-            "Best effort at high packet loss",
-            "Low-latency queue (LLQ) best effort (go/llq)",
-            "LLQ assured forwarding priority 1 (go/llq2)",
-            "LLQ assured forwarding priority 2 (go/llq2)",
-            "LLQ assured forwarding priority 3 (go/llq3)"
-          ],
-          "type": "string"
-        },
-        "verifyHashFromHeader": {
-          "description": "Tells Scotty to verify hashes on the agent's behalf by parsing out the X-Goog-Hash header.",
-          "type": "boolean"
-        }
-      },
-      "type": "object"
-    },
     "OffsetPosition": {
       "description": "Offset Position.",
       "id": "OffsetPosition",

diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json
@@ -10067,7 +10067,7 @@
       }
     }
   },
-  "revision": "20240625",
+  "revision": "20240821",
   "rootUrl": "https://dfareporting.googleapis.com/",
   "schemas": {
     "Account": {
@@ -11663,6 +11663,54 @@
       },
       "type": "object"
     },
+    "CartData": {
+      "description": "Contains additional information about cart data.",
+      "id": "CartData",
+      "properties": {
+        "items": {
+          "description": "Data of the items purchased.",
+          "items": {
+            "$ref": "CartDataItem"
+          },
+          "type": "array"
+        },
+        "merchantFeedLabel": {
+          "description": "The feed labels associated with the feed where your items are uploaded. For more information, please refer to  https://support.google.com/merchants/answer/12453549. This is a required field.",
+          "type": "string"
+        },
+        "merchantFeedLanguage": {
+          "description": "The language associated with the feed where your items are uploaded. Use ISO 639-1 language codes. This field is needed only when item IDs are not unique across multiple Merchant Center feeds.",
+          "type": "string"
+        },
+        "merchantId": {
+          "description": "The Merchant Center ID where the items are uploaded.",
+          "format": "int64",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "CartDataItem": {
+      "description": "Contains data of the items purchased.",
+      "id": "CartDataItem",
+      "properties": {
+        "itemId": {
+          "description": "The shopping id of the item. Must be equal to the Merchant Center product identifier. This is a required field.",
+          "type": "string"
+        },
+        "quantity": {
+          "description": "Number of items sold. This is a required field.",
+          "format": "int32",
+          "type": "integer"
+        },
+        "unitPrice": {
+          "description": "Unit price excluding tax, shipping, and any transaction level discounts. Interpreted in CM360 Floodlight config parent advertiser's currency code. This is a required field.",
+          "format": "double",
+          "type": "number"
+        }
+      },
+      "type": "object"
+    },
     "ChangeLog": {
       "description": "Describes a change that a user has made to a resource.",
       "id": "ChangeLog",
@@ -12050,6 +12098,10 @@
           ],
           "type": "string"
         },
+        "cartData": {
+          "$ref": "CartData",
+          "description": "The cart data associated with this conversion."
+        },
         "childDirectedTreatment": {
           "description": "Whether this particular request may come from a user under the age of 13, under COPPA compliance.",
           "type": "boolean"
@@ -14964,6 +15016,12 @@
           "description": "Name of this directory site.",
           "type": "string"
         },
+        "publisherSpecificationId": {
+          "description": "Output only. Default publisher specification ID of video placements under this directory site. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max",
+          "format": "int64",
+          "readOnly": true,
+          "type": "string"
+        },
         "settings": {
           "$ref": "DirectorySiteSettings",
           "description": "Directory site settings."
@@ -17614,6 +17672,11 @@
           "description": "Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect.",
           "type": "boolean"
         },
+        "adServingPlatformId": {
+          "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the placement. Measurement partners can use this field to add ad-server specific macros. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+          "format": "int64",
+          "type": "string"
+        },
         "additionalSizes": {
           "description": "Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used.",
           "items": {
@@ -17773,6 +17836,10 @@
           "$ref": "DimensionValue",
           "description": "Dimension value for the ID of the site. This is a read-only, auto-generated field."
         },
+        "siteServed": {
+          "description": "Optional. Whether the ads in the placement are served by another platform and CM is only used for tracking or they are served by CM. A false value indicates the ad is served by CM.",
+          "type": "boolean"
+        },
         "size": {
           "$ref": "Size",
           "description": "Size associated with this placement. When inserting or updating a placement, only the size ID field is used. This field is required on insertion."
@@ -19568,6 +19635,11 @@
           "format": "int64",
           "type": "string"
         },
+        "adServingPlatformId": {
+          "description": "Optional. Ad serving platform ID to identify the ad serving platform used by the site. Measurement partners can use this field to add ad-server specific macros. If set, this value acts as the default during placement creation. Possible values are: * `1`, Adelphic * `2`, Adform * `3`, Adobe * `4`, Amobee * `5`, Basis (Centro) * `6`, Beeswax * `7`, Amazon * `8`, DV360 (DBM) * `9`, Innovid * `10`, MediaMath * `11`, Roku OneView DSP * `12`, TabMo Hawk * `13`, The Trade Desk * `14`, Xandr Invest DSP * `15`, Yahoo DSP * `16`, Zeta Global * `17`, Scaleout * `18`, Bidtellect * `19`, Unicorn * `20`, Teads * `21`, Quantcast * `22`, Cognitiv",
+          "format": "int64",
+          "type": "string"
+        },
         "approved": {
           "description": "Whether this site is approved.",
           "type": "boolean"
@@ -19819,7 +19891,7 @@
           "type": "string"
         },
         "publisherSpecificationId": {
-          "description": "Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings.",
+          "description": "Publisher specification ID used to identify site-associated publisher requirements and automatically populate transcode settings. If publisher specification ID is specified, it will take precedence over transcode settings. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max",
           "format": "int64",
           "type": "string"
         },
@@ -21119,7 +21191,7 @@
           "type": "string"
         },
         "publisherSpecificationId": {
-          "description": "Publisher specification ID of a video placement.",
+          "description": "Publisher specification ID of a video placement. Possible values are: * `1`, Hulu * `2`, NBC * `3`, CBS * `4`, CBS Desktop * `5`, Discovery * `6`, VEVO HD * `7`, VEVO Vertical * `8`, Fox * `9`, CW Network * `10`, Disney * `11`, IGN * `12`, NFL.com * `13`, Turner Broadcasting * `14`, Tubi on Fox * `15`, Hearst Corporation * `16`, Twitch Desktop * `17`, ABC * `18`, Univision * `19`, MLB.com * `20`, MLB.com Mobile * `21`, MLB.com OTT * `22`, Polsat * `23`, TVN * `24`, Mediaset * `25`, Antena 3 * `26`, Mediamond * `27`, Sky Italia * `28`, Tubi on CBS * `29`, Spotify * `30`, Paramount * `31`, Max",
           "format": "int64",
           "type": "string"
         },