feat(dfareporting): update the API

#### dfareporting:v4 The following keys were added: - resources.tvCampaignDetails.methods.get.description - resources.tvCampaignDetails.methods.get.flatPath - resources.tvCampaignDetails.methods.get.httpMethod - resources.tvCampaignDetails.methods.get.id - resources.tvCampaignDetails.methods.get.parameterOrder - resources.tvCampaignDetails.methods.get.parameters.accountId.description - resources.tvCampaignDetails.methods.get.parameters.accountId.format - resources.tvCampaignDetails.methods.get.parameters.accountId.location - resources.tvCampaignDetails.methods.get.parameters.accountId.type - resources.tvCampaignDetails.methods.get.parameters.id.description - resources.tvCampaignDetails.methods.get.parameters.id.location - resources.tvCampaignDetails.methods.get.parameters.id.pattern - resources.tvCampaignDetails.methods.get.parameters.id.required - resources.tvCampaignDetails.methods.get.parameters.id.type - resources.tvCampaignDetails.methods.get.parameters.profileId.description - resources.tvCampaignDetails.methods.get.parameters.profileId.format - resources.tvCampaignDetails.methods.get.parameters.profileId.location - resources.tvCampaignDetails.methods.get.parameters.profileId.pattern - resources.tvCampaignDetails.methods.get.parameters.profileId.required - resources.tvCampaignDetails.methods.get.parameters.profileId.type - resources.tvCampaignDetails.methods.get.path - resources.tvCampaignDetails.methods.get.response.$ref - resources.tvCampaignDetails.methods.get.scopes - resources.tvCampaignSummaries.methods.list.description - resources.tvCampaignSummaries.methods.list.flatPath - resources.tvCampaignSummaries.methods.list.httpMethod - resources.tvCampaignSummaries.methods.list.id - resources.tvCampaignSummaries.methods.list.parameterOrder - resources.tvCampaignSummaries.methods.list.parameters.accountId.description - resources.tvCampaignSummaries.methods.list.parameters.accountId.format - resources.tvCampaignSummaries.methods.list.parameters.accountId.location - resources.tvCampaignSummaries.methods.list.parameters.accountId.type - resources.tvCampaignSummaries.methods.list.parameters.name.description - resources.tvCampaignSummaries.methods.list.parameters.name.location - resources.tvCampaignSummaries.methods.list.parameters.name.type - resources.tvCampaignSummaries.methods.list.parameters.profileId.description - resources.tvCampaignSummaries.methods.list.parameters.profileId.format - resources.tvCampaignSummaries.methods.list.parameters.profileId.location - resources.tvCampaignSummaries.methods.list.parameters.profileId.pattern - resources.tvCampaignSummaries.methods.list.parameters.profileId.required - resources.tvCampaignSummaries.methods.list.parameters.profileId.type - resources.tvCampaignSummaries.methods.list.path - resources.tvCampaignSummaries.methods.list.response.$ref - resources.tvCampaignSummaries.methods.list.scopes - schemas.CompatibleFields.properties.crossMediaReachReportCompatibleFields.$ref - schemas.CompatibleFields.properties.crossMediaReachReportCompatibleFields.description - schemas.CrossMediaReachReportCompatibleFields.description - schemas.CrossMediaReachReportCompatibleFields.id - schemas.CrossMediaReachReportCompatibleFields.properties.dimensionFilters.description - schemas.CrossMediaReachReportCompatibleFields.properties.dimensionFilters.items.$ref - schemas.CrossMediaReachReportCompatibleFields.properties.dimensionFilters.type - schemas.CrossMediaReachReportCompatibleFields.properties.dimensions.description - schemas.CrossMediaReachReportCompatibleFields.properties.dimensions.items.$ref - schemas.CrossMediaReachReportCompatibleFields.properties.dimensions.type - schemas.CrossMediaReachReportCompatibleFields.properties.kind.description - schemas.CrossMediaReachReportCompatibleFields.properties.kind.type - schemas.CrossMediaReachReportCompatibleFields.properties.metrics.description - schemas.CrossMediaReachReportCompatibleFields.properties.metrics.items.$ref - schemas.CrossMediaReachReportCompatibleFields.properties.metrics.type - schemas.CrossMediaReachReportCompatibleFields.type - schemas.Report.properties.crossMediaReachCriteria.description - schemas.Report.properties.crossMediaReachCriteria.properties.dateRange.$ref - schemas.Report.properties.crossMediaReachCriteria.properties.dateRange.description - schemas.Report.properties.crossMediaReachCriteria.properties.dimensionFilters.description - schemas.Report.properties.crossMediaReachCriteria.properties.dimensionFilters.items.$ref - schemas.Report.properties.crossMediaReachCriteria.properties.dimensionFilters.type - schemas.Report.properties.crossMediaReachCriteria.properties.dimensions.description - schemas.Report.properties.crossMediaReachCriteria.properties.dimensions.items.$ref - schemas.Report.properties.crossMediaReachCriteria.properties.dimensions.type - schemas.Report.properties.crossMediaReachCriteria.properties.metricNames.description - schemas.Report.properties.crossMediaReachCriteria.properties.metricNames.items.type - schemas.Report.properties.crossMediaReachCriteria.properties.metricNames.type - schemas.Report.properties.crossMediaReachCriteria.type - schemas.TvCampaignDetail.description - schemas.TvCampaignDetail.id - schemas.TvCampaignDetail.properties.id.description - schemas.TvCampaignDetail.properties.id.type - schemas.TvCampaignDetail.properties.kind.description - schemas.TvCampaignDetail.properties.kind.type - schemas.TvCampaignDetail.properties.timepoints.description - schemas.TvCampaignDetail.properties.timepoints.items.$ref - schemas.TvCampaignDetail.properties.timepoints.type - schemas.TvCampaignDetail.type - schemas.TvCampaignSummariesListResponse.description - schemas.TvCampaignSummariesListResponse.id - schemas.TvCampaignSummariesListResponse.properties.kind.description - schemas.TvCampaignSummariesListResponse.properties.kind.type - schemas.TvCampaignSummariesListResponse.properties.tvCampaignSummaries.description - schemas.TvCampaignSummariesListResponse.properties.tvCampaignSummaries.items.$ref - schemas.TvCampaignSummariesListResponse.properties.tvCampaignSummaries.type - schemas.TvCampaignSummariesListResponse.type - schemas.TvCampaignSummary.description - schemas.TvCampaignSummary.id - schemas.TvCampaignSummary.properties.endDate.description - schemas.TvCampaignSummary.properties.endDate.type - schemas.TvCampaignSummary.properties.grp.description - schemas.TvCampaignSummary.properties.grp.format - schemas.TvCampaignSummary.properties.grp.type - schemas.TvCampaignSummary.properties.id.description - schemas.TvCampaignSummary.properties.id.type - schemas.TvCampaignSummary.properties.impressions.description - schemas.TvCampaignSummary.properties.impressions.format - schemas.TvCampaignSummary.properties.impressions.type - schemas.TvCampaignSummary.properties.kind.description - schemas.TvCampaignSummary.properties.kind.type - schemas.TvCampaignSummary.properties.name.description - schemas.TvCampaignSummary.properties.name.type - schemas.TvCampaignSummary.properties.spend.description - schemas.TvCampaignSummary.properties.spend.format - schemas.TvCampaignSummary.properties.spend.type - schemas.TvCampaignSummary.properties.startDate.description - schemas.TvCampaignSummary.properties.startDate.type - schemas.TvCampaignSummary.properties.type.description - schemas.TvCampaignSummary.properties.type.enum - schemas.TvCampaignSummary.properties.type.enumDescriptions - schemas.TvCampaignSummary.properties.type.type - schemas.TvCampaignSummary.type - schemas.TvCampaignTimepoint.description - schemas.TvCampaignTimepoint.id - schemas.TvCampaignTimepoint.properties.dateWindow.description - schemas.TvCampaignTimepoint.properties.dateWindow.enum - schemas.TvCampaignTimepoint.properties.dateWindow.enumDescriptions - schemas.TvCampaignTimepoint.properties.dateWindow.type - schemas.TvCampaignTimepoint.properties.spend.description - schemas.TvCampaignTimepoint.properties.spend.format - schemas.TvCampaignTimepoint.properties.spend.type - schemas.TvCampaignTimepoint.properties.startDate.description - schemas.TvCampaignTimepoint.properties.startDate.type - schemas.TvCampaignTimepoint.type The following keys were changed: - schemas.CartData.description - schemas.CartData.properties.merchantId.description - schemas.CompatibleFields.description - schemas.Conversion.properties.customVariables.description - schemas.CustomFloodlightVariable.properties.type.description - schemas.Report.properties.type.enum - schemas.Report.properties.type.enumDescriptions
googleapis · Oct 10, 2024 · 10a83f9 · 10a83f9
1 parent 7871df4
commit 10a83f9
Show file tree

Hide file tree

Showing 2 changed files with 657 additions and 12 deletions.
diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json
@@ -9561,6 +9561,91 @@
         }
       }
     },
+    "tvCampaignDetails": {
+      "methods": {
+        "get": {
+          "description": "Gets one TvCampaignDetail by ID.",
+          "flatPath": "userprofiles/{userprofilesId}/tvCampaignDetails/{tvCampaignDetailsId}",
+          "httpMethod": "GET",
+          "id": "dfareporting.tvCampaignDetails.get",
+          "parameterOrder": [
+            "profileId",
+            "id"
+          ],
+          "parameters": {
+            "accountId": {
+              "description": "Required. Account ID associated with this request.",
+              "format": "int64",
+              "location": "query",
+              "type": "string"
+            },
+            "id": {
+              "description": "Required. TV Campaign ID.",
+              "location": "path",
+              "pattern": "^[^/]+$",
+              "required": true,
+              "type": "string"
+            },
+            "profileId": {
+              "description": "Required. User profile ID associated with this request.",
+              "format": "int64",
+              "location": "path",
+              "pattern": "^[^/]+$",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "userprofiles/{+profileId}/tvCampaignDetails/{+id}",
+          "response": {
+            "$ref": "TvCampaignDetail"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/dfatrafficking"
+          ]
+        }
+      }
+    },
+    "tvCampaignSummaries": {
+      "methods": {
+        "list": {
+          "description": "Retrieves a list of TV campaign summaries.",
+          "flatPath": "userprofiles/{userprofilesId}/tvCampaignSummaries",
+          "httpMethod": "GET",
+          "id": "dfareporting.tvCampaignSummaries.list",
+          "parameterOrder": [
+            "profileId"
+          ],
+          "parameters": {
+            "accountId": {
+              "description": "Required. Account ID associated with this request.",
+              "format": "int64",
+              "location": "query",
+              "type": "string"
+            },
+            "name": {
+              "description": "Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field.",
+              "location": "query",
+              "type": "string"
+            },
+            "profileId": {
+              "description": "Required. User profile ID associated with this request.",
+              "format": "int64",
+              "location": "path",
+              "pattern": "^[^/]+$",
+              "required": true,
+              "type": "string"
+            }
+          },
+          "path": "userprofiles/{+profileId}/tvCampaignSummaries",
+          "response": {
+            "$ref": "TvCampaignSummariesListResponse"
+          },
+          "scopes": [
+            "https://www.googleapis.com/auth/dfatrafficking"
+          ]
+        }
+      }
+    },
     "userProfiles": {
       "methods": {
         "get": {
@@ -10067,7 +10152,7 @@
       }
     }
   },
-  "revision": "20240821",
+  "revision": "20240926",
   "rootUrl": "https://dfareporting.googleapis.com/",
   "schemas": {
     "Account": {
@@ -11664,7 +11749,7 @@
       "type": "object"
     },
     "CartData": {
-      "description": "Contains additional information about cart data.",
+      "description": "Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate.",
       "id": "CartData",
       "properties": {
         "items": {
@@ -11683,7 +11768,7 @@
           "type": "string"
         },
         "merchantId": {
-          "description": "The Merchant Center ID where the items are uploaded.",
+          "description": "The Merchant Center ID where the items are uploaded. This is a required field.",
           "format": "int64",
           "type": "string"
         }
@@ -11968,13 +12053,17 @@
       "type": "object"
     },
     "CompatibleFields": {
-      "description": "Represents a response to the queryCompatibleFields method.",
+      "description": "Represents a response to the queryCompatibleFields method. Next ID: 10",
       "id": "CompatibleFields",
       "properties": {
         "crossDimensionReachReportCompatibleFields": {
           "$ref": "CrossDimensionReachReportCompatibleFields",
           "description": "Contains items that are compatible to be selected for a report of type \"CROSS_DIMENSION_REACH\"."
         },
+        "crossMediaReachReportCompatibleFields": {
+          "$ref": "CrossMediaReachReportCompatibleFields",
+          "description": "Contains items that are compatible to be selected for a report of type \"CROSS_MEDIA_REACH\"."
+        },
         "floodlightReportCompatibleFields": {
           "$ref": "FloodlightReportCompatibleFields",
           "description": "Contains items that are compatible to be selected for a report of type \"FLOODLIGHT\"."
@@ -12107,7 +12196,7 @@
           "type": "boolean"
         },
         "customVariables": {
-          "description": "Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate.",
+          "description": "Custom floodlight variables.",
           "items": {
             "$ref": "CustomFloodlightVariable"
           },
@@ -14300,6 +14389,38 @@
       },
       "type": "object"
     },
+    "CrossMediaReachReportCompatibleFields": {
+      "description": "Represents fields that are compatible to be selected for a report of type \"CROSS_MEDIA_REACH\".",
+      "id": "CrossMediaReachReportCompatibleFields",
+      "properties": {
+        "dimensionFilters": {
+          "description": "Dimensions which are compatible to be selected in the \"dimensionFilters\" section of the report.",
+          "items": {
+            "$ref": "Dimension"
+          },
+          "type": "array"
+        },
+        "dimensions": {
+          "description": "Dimensions which are compatible to be selected in the \"dimensions\" section of the report.",
+          "items": {
+            "$ref": "Dimension"
+          },
+          "type": "array"
+        },
+        "kind": {
+          "description": "The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields.",
+          "type": "string"
+        },
+        "metrics": {
+          "description": "Metrics which are compatible to be selected in the \"metricNames\" section of the report.",
+          "items": {
+            "$ref": "Metric"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "CustomFloodlightVariable": {
       "description": "A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate.",
       "id": "CustomFloodlightVariable",
@@ -14309,7 +14430,7 @@
           "type": "string"
         },
         "type": {
-          "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-20]=\" in the tags.",
+          "description": "The type of custom floodlight variable to supply a value for. These map to the \"u[1-100]=\" in the tags.",
           "enum": [
             "U1",
             "U2",
@@ -19117,6 +19238,37 @@
           },
           "type": "object"
         },
+        "crossMediaReachCriteria": {
+          "description": "Optional. The report criteria for a report of type \"CROSS_MEDIA_REACH\".",
+          "properties": {
+            "dateRange": {
+              "$ref": "DateRange",
+              "description": "Required. The date range this report should be run for."
+            },
+            "dimensionFilters": {
+              "description": "Required. The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed.",
+              "items": {
+                "$ref": "DimensionValue"
+              },
+              "type": "array"
+            },
+            "dimensions": {
+              "description": "Required. The list of dimensions the report should include.",
+              "items": {
+                "$ref": "SortedDimension"
+              },
+              "type": "array"
+            },
+            "metricNames": {
+              "description": "Required. The list of names of metrics the report should include.",
+              "items": {
+                "type": "string"
+              },
+              "type": "array"
+            }
+          },
+          "type": "object"
+        },
         "delivery": {
           "description": "The report's email delivery settings.",
           "properties": {
@@ -19486,13 +19638,15 @@
             "REACH",
             "PATH_TO_CONVERSION",
             "CROSS_DIMENSION_REACH",
-            "FLOODLIGHT"
+            "FLOODLIGHT",
+            "CROSS_MEDIA_REACH"
           ],
           "enumDescriptions": [
             "",
             "",
             "",
             "",
+            "",
             ""
           ],
           "type": "string"
@@ -20561,6 +20715,140 @@
       },
       "type": "object"
     },
+    "TvCampaignDetail": {
+      "description": "TvCampaignDetail contains data from a TV campaign for specific start dates and date windows.",
+      "id": "TvCampaignDetail",
+      "properties": {
+        "id": {
+          "description": "ID of this TV campaign.",
+          "type": "string"
+        },
+        "kind": {
+          "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummary\".",
+          "type": "string"
+        },
+        "timepoints": {
+          "description": "The timepoints of the TV campaign.",
+          "items": {
+            "$ref": "TvCampaignTimepoint"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "TvCampaignSummariesListResponse": {
+      "description": "Response message for TvCampaignSummariesService.List.",
+      "id": "TvCampaignSummariesListResponse",
+      "properties": {
+        "kind": {
+          "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummariesListResponse\".",
+          "type": "string"
+        },
+        "tvCampaignSummaries": {
+          "description": "List of TV campaign summaries.",
+          "items": {
+            "$ref": "TvCampaignSummary"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "TvCampaignSummary": {
+      "description": "TvCampaignSummary contains aggregate data from a TV campaign.",
+      "id": "TvCampaignSummary",
+      "properties": {
+        "endDate": {
+          "description": "The end date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\".",
+          "type": "string"
+        },
+        "grp": {
+          "description": "GRP of this TV campaign.",
+          "format": "int64",
+          "type": "string"
+        },
+        "id": {
+          "description": "ID of this TV campaign.",
+          "type": "string"
+        },
+        "impressions": {
+          "description": "Impressions across the entire TV campaign.",
+          "format": "int64",
+          "type": "string"
+        },
+        "kind": {
+          "description": "Identifies what kind of resource this is. Value: the fixed string \"dfareporting#tvCampaignSummary\".",
+          "type": "string"
+        },
+        "name": {
+          "description": "Identifier. Name of this TV campaign.",
+          "type": "string"
+        },
+        "spend": {
+          "description": "Spend across the entire TV campaign.",
+          "format": "double",
+          "type": "number"
+        },
+        "startDate": {
+          "description": "The start date of the TV campaign, inclusive. A string of the format: \"yyyy-MM-dd\".",
+          "type": "string"
+        },
+        "type": {
+          "description": "\"CampaignComponentType\" of this TV campaign.",
+          "enum": [
+            "CAMPAIGN_COMPONENT_TYPE_UNSPECIFIED",
+            "COMPANY",
+            "BRAND",
+            "PRODUCT",
+            "CAMPAIGN"
+          ],
+          "enumDescriptions": [
+            "Required to exist; do not use.",
+            "Company.",
+            "Brand.",
+            "Product.",
+            "Campaign."
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "TvCampaignTimepoint": {
+      "description": "A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window.",
+      "id": "TvCampaignTimepoint",
+      "properties": {
+        "dateWindow": {
+          "description": "The date window of the timepoint.",
+          "enum": [
+            "WEEKS_UNSPECIFIED",
+            "WEEKS_ONE",
+            "WEEKS_FOUR",
+            "WEEKS_EIGHT",
+            "WEEKS_TWELVE"
+          ],
+          "enumDescriptions": [
+            "Default value, should never be set.",
+            "One week.",
+            "Four weeks.",
+            "Eight weeks.",
+            "Twelve weeks."
+          ],
+          "type": "string"
+        },
+        "spend": {
+          "description": "The spend within the time range of the timepoint.",
+          "format": "double",
+          "type": "number"
+        },
+        "startDate": {
+          "description": "The start date of the timepoint. A string in the format of \"yyyy-MM-dd\".",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "UniversalAdId": {
       "description": "A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID.",
       "id": "UniversalAdId",