diff --git a/discovery/dfareporting-v4.json b/discovery/dfareporting-v4.json index 33d996b8dd..ec0a3d3502 100644 --- 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", diff --git a/src/apis/dfareporting/v4.ts b/src/apis/dfareporting/v4.ts index 7095cc84f5..2fb3500236 100644 --- a/src/apis/dfareporting/v4.ts +++ b/src/apis/dfareporting/v4.ts @@ -170,6 +170,8 @@ export namespace dfareporting_v4 { subaccounts: Resource$Subaccounts; targetableRemarketingLists: Resource$Targetableremarketinglists; targetingTemplates: Resource$Targetingtemplates; + tvCampaignDetails: Resource$Tvcampaigndetails; + tvCampaignSummaries: Resource$Tvcampaignsummaries; userProfiles: Resource$Userprofiles; userRolePermissionGroups: Resource$Userrolepermissiongroups; userRolePermissions: Resource$Userrolepermissions; @@ -261,6 +263,8 @@ export namespace dfareporting_v4 { this.context ); this.targetingTemplates = new Resource$Targetingtemplates(this.context); + this.tvCampaignDetails = new Resource$Tvcampaigndetails(this.context); + this.tvCampaignSummaries = new Resource$Tvcampaignsummaries(this.context); this.userProfiles = new Resource$Userprofiles(this.context); this.userRolePermissionGroups = new Resource$Userrolepermissiongroups( this.context @@ -1382,7 +1386,7 @@ export namespace dfareporting_v4 { totalAmountMicros?: string | null; } /** - * Contains additional information about cart data. + * Contains additional information about cart data. This field may only be used when calling batchinsert; it is not supported by batchupdate. */ export interface Schema$CartData { /** @@ -1398,7 +1402,7 @@ export namespace dfareporting_v4 { */ merchantFeedLanguage?: string | null; /** - * The Merchant Center ID where the items are uploaded. + * The Merchant Center ID where the items are uploaded. This is a required field. */ merchantId?: string | null; } @@ -1634,13 +1638,17 @@ export namespace dfareporting_v4 { kind?: string | null; } /** - * Represents a response to the queryCompatibleFields method. + * Represents a response to the queryCompatibleFields method. Next ID: 10 */ export interface Schema$CompatibleFields { /** * Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */ crossDimensionReachReportCompatibleFields?: Schema$CrossDimensionReachReportCompatibleFields; + /** + * Contains items that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". + */ + crossMediaReachReportCompatibleFields?: Schema$CrossMediaReachReportCompatibleFields; /** * Contains items that are compatible to be selected for a report of type "FLOODLIGHT". */ @@ -1744,7 +1752,7 @@ export namespace dfareporting_v4 { */ childDirectedTreatment?: boolean | null; /** - * Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. + * Custom floodlight variables. */ customVariables?: Schema$CustomFloodlightVariable[]; /** @@ -2866,6 +2874,27 @@ export namespace dfareporting_v4 { */ overlapMetrics?: Schema$Metric[]; } + /** + * Represents fields that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". + */ + export interface Schema$CrossMediaReachReportCompatibleFields { + /** + * Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. + */ + dimensionFilters?: Schema$Dimension[]; + /** + * Dimensions which are compatible to be selected in the "dimensions" section of the report. + */ + dimensions?: Schema$Dimension[]; + /** + * The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields. + */ + kind?: string | null; + /** + * Metrics which are compatible to be selected in the "metricNames" section of the report. + */ + metrics?: Schema$Metric[]; + } /** * A custom floodlight variable. This field may only be used when calling batchinsert; it is not supported by batchupdate. */ @@ -2875,7 +2904,7 @@ export namespace dfareporting_v4 { */ kind?: string | null; /** - * The type of custom floodlight variable to supply a value for. These map to the "u[1-20]=" in the tags. + * The type of custom floodlight variable to supply a value for. These map to the "u[1-100]=" in the tags. */ type?: string | null; /** @@ -5739,6 +5768,15 @@ export namespace dfareporting_v4 { overlapMetricNames?: string[]; pivoted?: boolean; } | null; + /** + * Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". + */ + crossMediaReachCriteria?: { + dateRange?: Schema$DateRange; + dimensionFilters?: Schema$DimensionValue[]; + dimensions?: Schema$SortedDimension[]; + metricNames?: string[]; + } | null; /** * The report's email delivery settings. */ @@ -6590,6 +6628,94 @@ export namespace dfareporting_v4 { */ kind?: string | null; } + /** + * TvCampaignDetail contains data from a TV campaign for specific start dates and date windows. + */ + export interface Schema$TvCampaignDetail { + /** + * ID of this TV campaign. + */ + id?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". + */ + kind?: string | null; + /** + * The timepoints of the TV campaign. + */ + timepoints?: Schema$TvCampaignTimepoint[]; + } + /** + * Response message for TvCampaignSummariesService.List. + */ + export interface Schema$TvCampaignSummariesListResponse { + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummariesListResponse". + */ + kind?: string | null; + /** + * List of TV campaign summaries. + */ + tvCampaignSummaries?: Schema$TvCampaignSummary[]; + } + /** + * TvCampaignSummary contains aggregate data from a TV campaign. + */ + export interface Schema$TvCampaignSummary { + /** + * The end date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". + */ + endDate?: string | null; + /** + * GRP of this TV campaign. + */ + grp?: string | null; + /** + * ID of this TV campaign. + */ + id?: string | null; + /** + * Impressions across the entire TV campaign. + */ + impressions?: string | null; + /** + * Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". + */ + kind?: string | null; + /** + * Identifier. Name of this TV campaign. + */ + name?: string | null; + /** + * Spend across the entire TV campaign. + */ + spend?: number | null; + /** + * The start date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". + */ + startDate?: string | null; + /** + * "CampaignComponentType" of this TV campaign. + */ + type?: string | null; + } + /** + * A single data point for TvCampaignDetail, which holds information about the TV campaign for a specific start date and date window. + */ + export interface Schema$TvCampaignTimepoint { + /** + * The date window of the timepoint. + */ + dateWindow?: string | null; + /** + * The spend within the time range of the timepoint. + */ + spend?: number | null; + /** + * The start date of the timepoint. A string in the format of "yyyy-MM-dd". + */ + startDate?: string | null; + } /** * A Universal Ad ID as per the VAST 4.0 spec. Applicable to the following creative types: INSTREAM_AUDIO, INSTREAM_VIDEO and VPAID. */ @@ -28467,6 +28593,237 @@ export namespace dfareporting_v4 { requestBody?: Schema$TargetingTemplate; } + export class Resource$Tvcampaigndetails { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets one TvCampaignDetail by ID. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Tvcampaigndetails$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Tvcampaigndetails$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Tvcampaigndetails$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Tvcampaigndetails$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tvcampaigndetails$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tvcampaigndetails$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v4/userprofiles/{+profileId}/tvCampaignDetails/{+id}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId', 'id'], + pathParams: ['id', 'profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Tvcampaigndetails$Get + extends StandardParameters { + /** + * Required. Account ID associated with this request. + */ + accountId?: string; + /** + * Required. TV Campaign ID. + */ + id?: string; + /** + * Required. User profile ID associated with this request. + */ + profileId?: string; + } + + export class Resource$Tvcampaignsummaries { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Retrieves a list of TV campaign summaries. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Tvcampaignsummaries$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tvcampaignsummaries$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Tvcampaignsummaries$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Tvcampaignsummaries$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Tvcampaignsummaries$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Tvcampaignsummaries$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dfareporting.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/dfareporting/v4/userprofiles/{+profileId}/tvCampaignSummaries' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['profileId'], + pathParams: ['profileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Tvcampaignsummaries$List + extends StandardParameters { + /** + * Required. Account ID associated with this request. + */ + accountId?: string; + /** + * Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. + */ + name?: string; + /** + * Required. User profile ID associated with this request. + */ + profileId?: string; + } + export class Resource$Userprofiles { context: APIRequestContext; constructor(context: APIRequestContext) {