@maxim_mazurok/gapi.client.dfareporting-v4 0.0.20240821 → 0.0.20240926

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://dfareporting.googleapis.com/$discovery/rest?version=v4
-// Revision: 20240821
+// Revision: 20240926
 
 /// <reference types="gapi.client" />
 
@@ -573,7 +573,7 @@ declare namespace gapi.client {
       merchantFeedLabel?: string;
       /** 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. */
       merchantFeedLanguage?: string;
-      /** 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;
     }
     interface CartDataItem {
@@ -690,6 +690,8 @@ declare namespace gapi.client {
     interface CompatibleFields {
       /** Contains items that are compatible to be selected for a report of type "CROSS_DIMENSION_REACH". */
       crossDimensionReachReportCompatibleFields?: CrossDimensionReachReportCompatibleFields;
+      /** Contains items that are compatible to be selected for a report of type "CROSS_MEDIA_REACH". */
+      crossMediaReachReportCompatibleFields?: CrossMediaReachReportCompatibleFields;
       /** Contains items that are compatible to be selected for a report of type "FLOODLIGHT". */
       floodlightReportCompatibleFields?: FloodlightReportCompatibleFields;
       /** The kind of resource this is, in this case dfareporting#compatibleFields. */
@@ -740,7 +742,7 @@ declare namespace gapi.client {
       cartData?: CartData;
       /** Whether this particular request may come from a user under the age of 13, under COPPA compliance. */
       childDirectedTreatment?: boolean;
-      /** Custom floodlight variables. This field may only be used when calling batchinsert; it is not supported by batchupdate. */
+      /** Custom floodlight variables. */
       customVariables?: CustomFloodlightVariable[];
       /** The display click ID. This field is mutually exclusive with encryptedUserId, encryptedUserIdCandidates[], matchId, mobileDeviceId, gclid, and impressionId. This or encryptedUserId or encryptedUserIdCandidates[] or matchId or mobileDeviceId or gclid or impressionId is a required field. */
       dclid?: string;
@@ -1289,10 +1291,20 @@ declare namespace gapi.client {
       /** Metrics which are compatible to be selected in the "overlapMetricNames" section of the report. */
       overlapMetrics?: Metric[];
     }
+    interface CrossMediaReachReportCompatibleFields {
+      /** Dimensions which are compatible to be selected in the "dimensionFilters" section of the report. */
+      dimensionFilters?: Dimension[];
+      /** Dimensions which are compatible to be selected in the "dimensions" section of the report. */
+      dimensions?: Dimension[];
+      /** The kind of resource this is, in this case dfareporting#crossMediaReachReportCompatibleFields. */
+      kind?: string;
+      /** Metrics which are compatible to be selected in the "metricNames" section of the report. */
+      metrics?: Metric[];
+    }
     interface CustomFloodlightVariable {
       /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#customFloodlightVariable". */
       kind?: string;
-      /** 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;
       /** The value of the custom floodlight variable. The length of string must not exceed 100 characters. */
       value?: string;
@@ -2714,6 +2726,17 @@ declare namespace gapi.client {
         /** Whether the report is pivoted or not. Defaults to true. */
         pivoted?: boolean;
       };
+      /** Optional. The report criteria for a report of type "CROSS_MEDIA_REACH". */
+      crossMediaReachCriteria?: {
+        /** Required. The date range this report should be run for. */
+        dateRange?: DateRange;
+        /** 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. */
+        dimensionFilters?: DimensionValue[];
+        /** Required. The list of dimensions the report should include. */
+        dimensions?: SortedDimension[];
+        /** Required. The list of names of metrics the report should include. */
+        metricNames?: string[];
+      };
       /** The report's email delivery settings. */
       delivery?: {
         /** Whether the report should be emailed to the report owner. */
@@ -3198,6 +3221,48 @@ declare namespace gapi.client {
       /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#transcodeSetting". */
       kind?: string;
     }
+    interface TvCampaignDetail {
+      /** ID of this TV campaign. */
+      id?: string;
+      /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". */
+      kind?: string;
+      /** The timepoints of the TV campaign. */
+      timepoints?: TvCampaignTimepoint[];
+    }
+    interface TvCampaignSummariesListResponse {
+      /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummariesListResponse". */
+      kind?: string;
+      /** List of TV campaign summaries. */
+      tvCampaignSummaries?: TvCampaignSummary[];
+    }
+    interface TvCampaignSummary {
+      /** The end date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". */
+      endDate?: string;
+      /** GRP of this TV campaign. */
+      grp?: string;
+      /** ID of this TV campaign. */
+      id?: string;
+      /** Impressions across the entire TV campaign. */
+      impressions?: string;
+      /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#tvCampaignSummary". */
+      kind?: string;
+      /** Identifier. Name of this TV campaign. */
+      name?: string;
+      /** Spend across the entire TV campaign. */
+      spend?: number;
+      /** The start date of the TV campaign, inclusive. A string of the format: "yyyy-MM-dd". */
+      startDate?: string;
+      /** "CampaignComponentType" of this TV campaign. */
+      type?: string;
+    }
+    interface TvCampaignTimepoint {
+      /** The date window of the timepoint. */
+      dateWindow?: string;
+      /** The spend within the time range of the timepoint. */
+      spend?: number;
+      /** The start date of the timepoint. A string in the format of "yyyy-MM-dd". */
+      startDate?: string;
+    }
     interface UniversalAdId {
       /** Registry used for the Ad ID value. */
       registry?: string;
@@ -12270,6 +12335,72 @@ declare namespace gapi.client {
         body: TargetingTemplate
       ): Request<TargetingTemplate>;
     }
+    interface TvCampaignDetailsResource {
+      /** Gets one TvCampaignDetail by ID. */
+      get(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Required. Account ID associated with this request. */
+        accountId?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** Required. TV Campaign ID. */
+        id: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Required. User profile ID associated with this request. */
+        profileId: string;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<TvCampaignDetail>;
+    }
+    interface TvCampaignSummariesResource {
+      /** Retrieves a list of TV campaign summaries. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Required. Account ID associated with this request. */
+        accountId?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** Required. Search string to filter the list of TV campaign summaries. Matches any substring. Required field. */
+        name?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Required. User profile ID associated with this request. */
+        profileId: string;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<TvCampaignSummariesListResponse>;
+    }
     interface UserProfilesResource {
       /** Gets one user profile by ID. */
       get(request?: {
@@ -12898,6 +13029,10 @@ declare namespace gapi.client {
 
     const targetingTemplates: TargetingTemplatesResource;
 
+    const tvCampaignDetails: TvCampaignDetailsResource;
+
+    const tvCampaignSummaries: TvCampaignSummariesResource;
+
     const userProfiles: UserProfilesResource;
 
     const userRolePermissionGroups: UserRolePermissionGroupsResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dfareporting-v4",
-  "version": "0.0.20240821",
+  "version": "0.0.20240926",
   "description": "TypeScript typings for Campaign Manager 360 API v4",
   "repository": {
     "type": "git",

package/readme.md

@@ -1378,6 +1378,21 @@ await gapi.client.dfareporting.targetingTemplates.update({
   profileId: 'profileId',
 });
 
+/*
+Gets one TvCampaignDetail by ID.
+*/
+await gapi.client.dfareporting.tvCampaignDetails.get({
+  id: 'id',
+  profileId: 'profileId',
+});
+
+/*
+Retrieves a list of TV campaign summaries.
+*/
+await gapi.client.dfareporting.tvCampaignSummaries.list({
+  profileId: 'profileId',
+});
+
 /*
 Gets one user profile by ID.
 */