@maxim_mazurok/gapi.client.dfareporting-v5 0.1.20260605 → 0.2.20260713

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=v5
-// Revision: 20260605
+// Revision: 20260713
 
 /// <reference types="gapi.client" />
 
@@ -568,8 +568,7 @@ declare namespace gapi.client {
       endDate?: string;
       /** Optional. Whether the campaign has EU political ads. Campaign Manager 360 doesn't allow campaigns with EU political ads to serve in the EU. They can still serve in other regions. */
       euPoliticalAdsDeclaration?:
-        | 'CONTAINS_EU_POLITICAL_ADS'
-        | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADS';
+        'CONTAINS_EU_POLITICAL_ADS' | 'DOES_NOT_CONTAIN_EU_POLITICAL_ADS';
       /** Overrides that can be used to activate or deactivate advertiser event tags. */
       eventTagOverrides?: EventTagOverride[];
       /** External ID for this campaign. */
@@ -729,6 +728,12 @@ declare namespace gapi.client {
       /** Whether this entity should override the inherited click-through URL suffix with its own defined value. */
       overrideInheritedSuffix?: boolean;
     }
+    interface ColumnHeader {
+      /** Output only. The column name. */
+      name?: string;
+      /** Output only. The column type. */
+      type?: 'COLUMN_TYPE_UNSPECIFIED' | 'DIMENSION' | 'METRIC';
+    }
     interface CompanionClickThroughOverride {
       /** Click-through URL of this companion click-through override. */
       clickThroughUrl?: ClickThroughUrl;
@@ -879,10 +884,7 @@ declare namespace gapi.client {
     interface ConversionError {
       /** The error code. */
       code?:
-        | 'INVALID_ARGUMENT'
-        | 'INTERNAL'
-        | 'PERMISSION_DENIED'
-        | 'NOT_FOUND';
+        'INVALID_ARGUMENT' | 'INTERNAL' | 'PERMISSION_DENIED' | 'NOT_FOUND';
       /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#conversionError". */
       kind?: string;
       /** A description of the error. */
@@ -1392,8 +1394,7 @@ declare namespace gapi.client {
       sslCompliant?: boolean;
       /** Initial wait time type before making the asset visible. Applicable to the following creative types: all RICH_MEDIA. */
       startTimeType?:
-        | 'ASSET_START_TIME_TYPE_NONE'
-        | 'ASSET_START_TIME_TYPE_CUSTOM';
+        'ASSET_START_TIME_TYPE_NONE' | 'ASSET_START_TIME_TYPE_CUSTOM';
       /** Streaming URL for video asset. This is a read-only field. Applicable to the following creative types: INSTREAM_VIDEO and all VPAID. */
       streamingServingUrl?: string;
       /** Whether the asset is transparent. Applicable to the following creative types: all RICH_MEDIA. Additionally, only applicable to HTML5 assets. */
@@ -1699,8 +1700,7 @@ declare namespace gapi.client {
       creativeOptimizationConfigurationId?: string;
       /** Type of creative rotation. Can be used to specify whether to use sequential or random rotation. */
       type?:
-        | 'CREATIVE_ROTATION_TYPE_SEQUENTIAL'
-        | 'CREATIVE_ROTATION_TYPE_RANDOM';
+        'CREATIVE_ROTATION_TYPE_SEQUENTIAL' | 'CREATIVE_ROTATION_TYPE_RANDOM';
       /** Strategy for calculating weights. Used with CREATIVE_ROTATION_TYPE_RANDOM. */
       weightCalculationStrategy?:
         | 'WEIGHT_STRATEGY_EQUAL'
@@ -2174,10 +2174,7 @@ declare namespace gapi.client {
       remarketingValueAttributes?: RemarketingValueAttribute[];
       /** Optional. The rotation type to select from eligible rows. Rotation type only apply when the filtering rule results in more than one eligible rows. */
       rotationType?:
-        | 'ROTATION_TYPE_UNKNOWN'
-        | 'RANDOM'
-        | 'OPTIMIZED'
-        | 'WEIGHTED';
+        'ROTATION_TYPE_UNKNOWN' | 'RANDOM' | 'OPTIMIZED' | 'WEIGHTED';
       /** Optional. The type of the rule, the default value is OPEN. */
       ruleType?:
         | 'RULE_SET_TYPE_UNKNOWN'
@@ -2248,9 +2245,7 @@ declare namespace gapi.client {
         | 'DFP_NETWORK_CODE';
       /** Describes whether the encrypted cookie was received from ad serving (the %m macro) or from Data Transfer. */
       encryptionSource?:
-        | 'ENCRYPTION_SCOPE_UNKNOWN'
-        | 'AD_SERVING'
-        | 'DATA_TRANSFER';
+        'ENCRYPTION_SCOPE_UNKNOWN' | 'AD_SERVING' | 'DATA_TRANSFER';
       /** Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */
       kind?: string;
     }
@@ -2461,11 +2456,7 @@ declare namespace gapi.client {
       stringValue?: string;
       /** Optional. Right hand side of the expression. */
       valueType?:
-        | 'RHS_VALUE_TYPE_UNKNOWN'
-        | 'STRING'
-        | 'REQUEST'
-        | 'BOOL'
-        | 'DEPENDENT';
+        'RHS_VALUE_TYPE_UNKNOWN' | 'STRING' | 'REQUEST' | 'BOOL' | 'DEPENDENT';
     }
     interface File {
       /** The date range for which the file has report data. The date range will always be the absolute date range for which the report is run. */
@@ -2486,11 +2477,7 @@ declare namespace gapi.client {
       reportId?: string;
       /** The status of the report file. */
       status?:
-        | 'PROCESSING'
-        | 'REPORT_AVAILABLE'
-        | 'FAILED'
-        | 'CANCELLED'
-        | 'QUEUED';
+        'PROCESSING' | 'REPORT_AVAILABLE' | 'FAILED' | 'CANCELLED' | 'QUEUED';
       /** The URLs where the completed report file can be downloaded. */
       urls?: {
         /** The URL for downloading the report data through the API. */
@@ -2536,11 +2523,7 @@ declare namespace gapi.client {
       attributionEnabled?: boolean;
       /** Code type used for cache busting in the generated tag. Applicable only when floodlightActivityGroupType is COUNTER and countingMethod is STANDARD_COUNTING or UNIQUE_COUNTING. */
       cacheBustingType?:
-        | 'JAVASCRIPT'
-        | 'ACTIVE_SERVER_PAGE'
-        | 'JSP'
-        | 'PHP'
-        | 'COLD_FUSION';
+        'JAVASCRIPT' | 'ACTIVE_SERVER_PAGE' | 'JSP' | 'PHP' | 'COLD_FUSION';
       /** Required. The conversion category of the activity. */
       conversionCategory?:
         | 'CONVERSION_CATEGORY_DEFAULT'
@@ -2605,10 +2588,7 @@ declare namespace gapi.client {
       sslRequired?: boolean;
       /** The status of the activity. This can only be set to ACTIVE or ARCHIVED_AND_DISABLED. The ARCHIVED status is no longer supported and cannot be set for Floodlight activities. The DISABLED_POLICY status indicates that a Floodlight activity is violating Google policy. Contact your account manager for more information. */
       status?:
-        | 'ACTIVE'
-        | 'ARCHIVED_AND_DISABLED'
-        | 'ARCHIVED'
-        | 'DISABLED_POLICY';
+        'ACTIVE' | 'ARCHIVED_AND_DISABLED' | 'ARCHIVED' | 'DISABLED_POLICY';
       /** Subaccount ID of this floodlight activity. This is a read-only field that can be left blank. */
       subaccountId?: string;
       /** Tag format type for the floodlight activity. If left blank, the tag format will default to HTML. */
@@ -3582,9 +3562,7 @@ declare namespace gapi.client {
     interface PricingSchedule {
       /** Placement cap cost option. */
       capCostOption?:
-        | 'CAP_COST_NONE'
-        | 'CAP_COST_MONTHLY'
-        | 'CAP_COST_CUMULATIVE';
+        'CAP_COST_NONE' | 'CAP_COST_MONTHLY' | 'CAP_COST_CUMULATIVE';
       endDate?: string;
       /** Whether this placement is flighted. If true, pricing periods will be computed automatically. */
       flighted?: boolean;
@@ -3917,6 +3895,36 @@ declare namespace gapi.client {
       /** Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */
       pivotedActivityMetrics?: Metric[];
     }
+    interface ReportDataQueryRequest {
+      /** Optional. The requested date range covering the report duration. */
+      dateRange?: DateRange;
+      /** Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`. */
+      dimensionFilters?: DimensionValue[];
+      /** Optional. The list of dimension names to group by. */
+      dimensionNames?: string[];
+      /** Optional. Maximum number of result rows to return per page. The default value is 100. The maximum allowed value is 1000. Values above 1000 will be coerced (clamped) down to 1000. Negative values will be rejected. */
+      maxResults?: number;
+      /** Required. The list of metric names to include. */
+      metricNames?: string[];
+      /** Optional. Continuation token for paginating results. */
+      pageToken?: string;
+      /** Optional. Sort options across either requested dimensions or metrics. */
+      sortBys?: SortBy[];
+    }
+    interface ReportDataResponse {
+      /** Output only. Ordered descriptors of the requested column fields. */
+      columnHeaders?: ColumnHeader[];
+      /** Output only. Token to retrieve the next page of rows, or empty if end of results. */
+      nextPageToken?: string;
+      /** Output only. The resulting set of matching data rows. */
+      rows?: ReportDataRow[];
+      /** Output only. Singular aggregate total row for the entire query matching the criteria. Column headers apply in the exact same order as data rows. In the total_row: - All dimension columns contain an empty string (""), as aggregation does not apply. - Non-summable metric columns (e.g. Reach metrics) contain an empty string (""), as grand total aggregation cannot be mathematically/logically computed for them. */
+      totalRow?: ReportDataRow;
+    }
+    interface ReportDataRow {
+      /** Output only. A single sequential list of all cell values matching column_headers indices exactly. - Metric cells that are suppressed due to Minimum Reporting Standard (MRS) privacy protection constraints return "-". */
+      values?: string[];
+    }
     interface ReportList {
       /** The eTag of this response for caching purposes. */
       etag?: string;
@@ -4097,6 +4105,12 @@ declare namespace gapi.client {
       /** Whether the user can skip creatives served to this placement. */
       skippable?: boolean;
     }
+    interface SortBy {
+      /** Required. The dimension or metric field name to sort on. */
+      name?: string;
+      /** Optional. The sort order of this column. */
+      sortOrder?: 'ASCENDING' | 'DESCENDING';
+    }
     interface SortedDimension {
       /** The kind of resource this is, in this case dfareporting#sortedDimension. */
       kind?: string;
@@ -4445,12 +4459,7 @@ declare namespace gapi.client {
     interface UniversalAdId {
       /** Registry used for the Ad ID value. */
       registry?:
-        | 'OTHER'
-        | 'AD_ID_OFFICIAL'
-        | 'CLEARCAST'
-        | 'DCM'
-        | 'ARPP'
-        | 'CUSV';
+        'OTHER' | 'AD_ID_OFFICIAL' | 'CLEARCAST' | 'DCM' | 'ARPP' | 'CUSV';
       /** ID value for this creative. Only alphanumeric characters and the following symbols are valid: "_/\-". Maximum length is 64 characters. Read only when registry is DCM. */
       value?: string;
     }
@@ -12683,6 +12692,66 @@ declare namespace gapi.client {
         body: RemarketingListShare,
       ): Request<RemarketingListShare>;
     }
+    interface ReportDataResource {
+      /** Executes an ad-hoc query and returns structured JSON payload data. */
+      query(request: {
+        /** V1 error format. */
+        '$.xgafv'?: '1' | '2';
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: 'json' | 'media' | 'proto';
+        /** 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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Required. The Campaign Manager 360 user profile ID. */
+        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 body */
+        resource: ReportDataQueryRequest;
+      }): Request<ReportDataResponse>;
+      query(
+        request: {
+          /** V1 error format. */
+          '$.xgafv'?: '1' | '2';
+          /** OAuth access token. */
+          access_token?: string;
+          /** Data format for response. */
+          alt?: 'json' | 'media' | 'proto';
+          /** 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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Returns response with indentations and line breaks. */
+          prettyPrint?: boolean;
+          /** Required. The Campaign Manager 360 user profile ID. */
+          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;
+        },
+        body: ReportDataQueryRequest,
+      ): Request<ReportDataResponse>;
+    }
     interface CompatibleFieldsResource {
       /** Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. */
       query(request: {
@@ -14897,6 +14966,8 @@ declare namespace gapi.client {
 
     const remarketingLists: RemarketingListsResource;
 
+    const reportData: ReportDataResource;
+
     const reports: ReportsResource;
 
     const sites: SitesResource;

package/package.json

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

package/readme.md

@@ -1232,6 +1232,11 @@ await gapi.client.dfareporting.remarketingListShares.update({
   profileId: 'profileId',
 });
 
+/*
+Executes an ad-hoc query and returns structured JSON payload data.
+*/
+await gapi.client.dfareporting.reportData.query({profileId: 'profileId'});
+
 /*
 Deletes a report by its ID.
 */