@maxim_mazurok/gapi.client.dfareporting-v5 0.2.20260605 → 0.2.20260713
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +105 -1
- package/package.json +1 -1
- package/readme.md +5 -0
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://dfareporting.googleapis.com/$discovery/rest?version=v5
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260713
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -728,6 +728,12 @@ declare namespace gapi.client {
|
|
|
728
728
|
/** Whether this entity should override the inherited click-through URL suffix with its own defined value. */
|
|
729
729
|
overrideInheritedSuffix?: boolean;
|
|
730
730
|
}
|
|
731
|
+
interface ColumnHeader {
|
|
732
|
+
/** Output only. The column name. */
|
|
733
|
+
name?: string;
|
|
734
|
+
/** Output only. The column type. */
|
|
735
|
+
type?: 'COLUMN_TYPE_UNSPECIFIED' | 'DIMENSION' | 'METRIC';
|
|
736
|
+
}
|
|
731
737
|
interface CompanionClickThroughOverride {
|
|
732
738
|
/** Click-through URL of this companion click-through override. */
|
|
733
739
|
clickThroughUrl?: ClickThroughUrl;
|
|
@@ -3889,6 +3895,36 @@ declare namespace gapi.client {
|
|
|
3889
3895
|
/** Metrics which are compatible to be selected as activity metrics to pivot on in the "activities" section of the report. */
|
|
3890
3896
|
pivotedActivityMetrics?: Metric[];
|
|
3891
3897
|
}
|
|
3898
|
+
interface ReportDataQueryRequest {
|
|
3899
|
+
/** Optional. The requested date range covering the report duration. */
|
|
3900
|
+
dateRange?: DateRange;
|
|
3901
|
+
/** Optional. The list of dimension values on which report lines are filtered. Utilizes the existing legacy filter message `DimensionValue`. */
|
|
3902
|
+
dimensionFilters?: DimensionValue[];
|
|
3903
|
+
/** Optional. The list of dimension names to group by. */
|
|
3904
|
+
dimensionNames?: string[];
|
|
3905
|
+
/** 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. */
|
|
3906
|
+
maxResults?: number;
|
|
3907
|
+
/** Required. The list of metric names to include. */
|
|
3908
|
+
metricNames?: string[];
|
|
3909
|
+
/** Optional. Continuation token for paginating results. */
|
|
3910
|
+
pageToken?: string;
|
|
3911
|
+
/** Optional. Sort options across either requested dimensions or metrics. */
|
|
3912
|
+
sortBys?: SortBy[];
|
|
3913
|
+
}
|
|
3914
|
+
interface ReportDataResponse {
|
|
3915
|
+
/** Output only. Ordered descriptors of the requested column fields. */
|
|
3916
|
+
columnHeaders?: ColumnHeader[];
|
|
3917
|
+
/** Output only. Token to retrieve the next page of rows, or empty if end of results. */
|
|
3918
|
+
nextPageToken?: string;
|
|
3919
|
+
/** Output only. The resulting set of matching data rows. */
|
|
3920
|
+
rows?: ReportDataRow[];
|
|
3921
|
+
/** 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. */
|
|
3922
|
+
totalRow?: ReportDataRow;
|
|
3923
|
+
}
|
|
3924
|
+
interface ReportDataRow {
|
|
3925
|
+
/** 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 "-". */
|
|
3926
|
+
values?: string[];
|
|
3927
|
+
}
|
|
3892
3928
|
interface ReportList {
|
|
3893
3929
|
/** The eTag of this response for caching purposes. */
|
|
3894
3930
|
etag?: string;
|
|
@@ -4069,6 +4105,12 @@ declare namespace gapi.client {
|
|
|
4069
4105
|
/** Whether the user can skip creatives served to this placement. */
|
|
4070
4106
|
skippable?: boolean;
|
|
4071
4107
|
}
|
|
4108
|
+
interface SortBy {
|
|
4109
|
+
/** Required. The dimension or metric field name to sort on. */
|
|
4110
|
+
name?: string;
|
|
4111
|
+
/** Optional. The sort order of this column. */
|
|
4112
|
+
sortOrder?: 'ASCENDING' | 'DESCENDING';
|
|
4113
|
+
}
|
|
4072
4114
|
interface SortedDimension {
|
|
4073
4115
|
/** The kind of resource this is, in this case dfareporting#sortedDimension. */
|
|
4074
4116
|
kind?: string;
|
|
@@ -12650,6 +12692,66 @@ declare namespace gapi.client {
|
|
|
12650
12692
|
body: RemarketingListShare,
|
|
12651
12693
|
): Request<RemarketingListShare>;
|
|
12652
12694
|
}
|
|
12695
|
+
interface ReportDataResource {
|
|
12696
|
+
/** Executes an ad-hoc query and returns structured JSON payload data. */
|
|
12697
|
+
query(request: {
|
|
12698
|
+
/** V1 error format. */
|
|
12699
|
+
'$.xgafv'?: '1' | '2';
|
|
12700
|
+
/** OAuth access token. */
|
|
12701
|
+
access_token?: string;
|
|
12702
|
+
/** Data format for response. */
|
|
12703
|
+
alt?: 'json' | 'media' | 'proto';
|
|
12704
|
+
/** JSONP */
|
|
12705
|
+
callback?: string;
|
|
12706
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12707
|
+
fields?: string;
|
|
12708
|
+
/** 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. */
|
|
12709
|
+
key?: string;
|
|
12710
|
+
/** OAuth 2.0 token for the current user. */
|
|
12711
|
+
oauth_token?: string;
|
|
12712
|
+
/** Returns response with indentations and line breaks. */
|
|
12713
|
+
prettyPrint?: boolean;
|
|
12714
|
+
/** Required. The Campaign Manager 360 user profile ID. */
|
|
12715
|
+
profileId: string;
|
|
12716
|
+
/** 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. */
|
|
12717
|
+
quotaUser?: string;
|
|
12718
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12719
|
+
upload_protocol?: string;
|
|
12720
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12721
|
+
uploadType?: string;
|
|
12722
|
+
/** Request body */
|
|
12723
|
+
resource: ReportDataQueryRequest;
|
|
12724
|
+
}): Request<ReportDataResponse>;
|
|
12725
|
+
query(
|
|
12726
|
+
request: {
|
|
12727
|
+
/** V1 error format. */
|
|
12728
|
+
'$.xgafv'?: '1' | '2';
|
|
12729
|
+
/** OAuth access token. */
|
|
12730
|
+
access_token?: string;
|
|
12731
|
+
/** Data format for response. */
|
|
12732
|
+
alt?: 'json' | 'media' | 'proto';
|
|
12733
|
+
/** JSONP */
|
|
12734
|
+
callback?: string;
|
|
12735
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
12736
|
+
fields?: string;
|
|
12737
|
+
/** 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. */
|
|
12738
|
+
key?: string;
|
|
12739
|
+
/** OAuth 2.0 token for the current user. */
|
|
12740
|
+
oauth_token?: string;
|
|
12741
|
+
/** Returns response with indentations and line breaks. */
|
|
12742
|
+
prettyPrint?: boolean;
|
|
12743
|
+
/** Required. The Campaign Manager 360 user profile ID. */
|
|
12744
|
+
profileId: string;
|
|
12745
|
+
/** 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. */
|
|
12746
|
+
quotaUser?: string;
|
|
12747
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
12748
|
+
upload_protocol?: string;
|
|
12749
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
12750
|
+
uploadType?: string;
|
|
12751
|
+
},
|
|
12752
|
+
body: ReportDataQueryRequest,
|
|
12753
|
+
): Request<ReportDataResponse>;
|
|
12754
|
+
}
|
|
12653
12755
|
interface CompatibleFieldsResource {
|
|
12654
12756
|
/** 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. */
|
|
12655
12757
|
query(request: {
|
|
@@ -14864,6 +14966,8 @@ declare namespace gapi.client {
|
|
|
14864
14966
|
|
|
14865
14967
|
const remarketingLists: RemarketingListsResource;
|
|
14866
14968
|
|
|
14969
|
+
const reportData: ReportDataResource;
|
|
14970
|
+
|
|
14867
14971
|
const reports: ReportsResource;
|
|
14868
14972
|
|
|
14869
14973
|
const sites: SitesResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1232,6 +1232,11 @@ await gapi.client.dfareporting.remarketingListShares.update({
|
|
|
1232
1232
|
profileId: 'profileId',
|
|
1233
1233
|
});
|
|
1234
1234
|
|
|
1235
|
+
/*
|
|
1236
|
+
Executes an ad-hoc query and returns structured JSON payload data.
|
|
1237
|
+
*/
|
|
1238
|
+
await gapi.client.dfareporting.reportData.query({profileId: 'profileId'});
|
|
1239
|
+
|
|
1235
1240
|
/*
|
|
1236
1241
|
Deletes a report by its ID.
|
|
1237
1242
|
*/
|