@maxim_mazurok/gapi.client.dfareporting-v4 0.0.20240201 → 0.0.20240625
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 +13 -127
- package/package.json +1 -1
- package/readme.md +9 -9
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=v4
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240625
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -129,7 +129,7 @@ declare namespace gapi.client {
|
|
|
129
129
|
campaignFilter?: ObjectFilter;
|
|
130
130
|
/** Comments for this user profile. */
|
|
131
131
|
comments?: string;
|
|
132
|
-
/** Email of the user profile. The email
|
|
132
|
+
/** Email of the user profile. The email address must be linked to a Google Account. This field is required on insertion and is read-only after insertion. */
|
|
133
133
|
email?: string;
|
|
134
134
|
/** ID of the user profile. This is a read-only, auto-generated field. */
|
|
135
135
|
id?: string;
|
|
@@ -603,24 +603,6 @@ declare namespace gapi.client {
|
|
|
603
603
|
/** Pagination token to be used for the next list operation. */
|
|
604
604
|
nextPageToken?: string;
|
|
605
605
|
}
|
|
606
|
-
interface ChannelGrouping {
|
|
607
|
-
/** ChannelGrouping fallback name. */
|
|
608
|
-
fallbackName?: string;
|
|
609
|
-
/** The kind of resource this is, in this case dfareporting#channelGrouping. */
|
|
610
|
-
kind?: string;
|
|
611
|
-
/** ChannelGrouping name. */
|
|
612
|
-
name?: string;
|
|
613
|
-
/** The rules contained within this channel grouping. */
|
|
614
|
-
rules?: ChannelGroupingRule[];
|
|
615
|
-
}
|
|
616
|
-
interface ChannelGroupingRule {
|
|
617
|
-
/** The disjunctive match statements contained within this rule. */
|
|
618
|
-
disjunctiveMatchStatements?: DisjunctiveMatchStatement[];
|
|
619
|
-
/** The kind of resource this is, in this case dfareporting#channelGroupingRule. */
|
|
620
|
-
kind?: string;
|
|
621
|
-
/** Rule name. */
|
|
622
|
-
name?: string;
|
|
623
|
-
}
|
|
624
606
|
interface CitiesListResponse {
|
|
625
607
|
/** City collection. */
|
|
626
608
|
cities?: City[];
|
|
@@ -694,10 +676,6 @@ declare namespace gapi.client {
|
|
|
694
676
|
floodlightReportCompatibleFields?: FloodlightReportCompatibleFields;
|
|
695
677
|
/** The kind of resource this is, in this case dfareporting#compatibleFields. */
|
|
696
678
|
kind?: string;
|
|
697
|
-
/** Contains items that are compatible to be selected for a report of type "PATH_ATTRIBUTION". */
|
|
698
|
-
pathAttributionReportCompatibleFields?: PathReportCompatibleFields;
|
|
699
|
-
/** Contains items that are compatible to be selected for a report of type "PATH". */
|
|
700
|
-
pathReportCompatibleFields?: PathReportCompatibleFields;
|
|
701
679
|
/** Contains items that are compatible to be selected for a report of type "PATH_TO_CONVERSION". */
|
|
702
680
|
pathToConversionReportCompatibleFields?: PathToConversionReportCompatibleFields;
|
|
703
681
|
/** Contains items that are compatible to be selected for a report of type "REACH". */
|
|
@@ -1463,12 +1441,6 @@ declare namespace gapi.client {
|
|
|
1463
1441
|
/** Pagination token to be used for the next list operation. */
|
|
1464
1442
|
nextPageToken?: string;
|
|
1465
1443
|
}
|
|
1466
|
-
interface DisjunctiveMatchStatement {
|
|
1467
|
-
/** The event filters contained within this disjunctive match statement. */
|
|
1468
|
-
eventFilters?: EventFilter[];
|
|
1469
|
-
/** The kind of resource this is, in this case dfareporting#disjunctiveMatchStatement. */
|
|
1470
|
-
kind?: string;
|
|
1471
|
-
}
|
|
1472
1444
|
interface DynamicTargetingKey {
|
|
1473
1445
|
/** Identifies what kind of resource this is. Value: the fixed string "dfareporting#dynamicTargetingKey". */
|
|
1474
1446
|
kind?: string;
|
|
@@ -1495,14 +1467,6 @@ declare namespace gapi.client {
|
|
|
1495
1467
|
/** Identifies what kind of resource this is. Value: the fixed string "dfareporting#encryptionInfo". */
|
|
1496
1468
|
kind?: string;
|
|
1497
1469
|
}
|
|
1498
|
-
interface EventFilter {
|
|
1499
|
-
/** The dimension filter contained within this EventFilter. */
|
|
1500
|
-
dimensionFilter?: PathReportDimensionValue;
|
|
1501
|
-
/** The kind of resource this is, in this case dfareporting#eventFilter. */
|
|
1502
|
-
kind?: string;
|
|
1503
|
-
/** Filter on a custom variable. */
|
|
1504
|
-
uvarFilter?: UvarFilter;
|
|
1505
|
-
}
|
|
1506
1470
|
interface EventTag {
|
|
1507
1471
|
/** Account ID of this event tag. This is a read-only field that can be left blank. */
|
|
1508
1472
|
accountId?: string;
|
|
@@ -1599,9 +1563,9 @@ declare namespace gapi.client {
|
|
|
1599
1563
|
units?: string;
|
|
1600
1564
|
}
|
|
1601
1565
|
interface FloodlightActivitiesGenerateTagResponse {
|
|
1602
|
-
/** Generated tag for this Floodlight activity. For
|
|
1566
|
+
/** Generated tag for this Floodlight activity. For Google tags, this is the event snippet. */
|
|
1603
1567
|
floodlightActivityTag?: string;
|
|
1604
|
-
/** The global snippet section of a
|
|
1568
|
+
/** The global snippet section of a Google tag. The Google tag sets new cookies on your domain, which will store a unique identifier for a user or the ad click that brought the user to your site. Learn more. */
|
|
1605
1569
|
globalSiteTagGlobalSnippet?: string;
|
|
1606
1570
|
/** Identifies what kind of resource this is. Value: the fixed string "dfareporting#floodlightActivitiesGenerateTagResponse". */
|
|
1607
1571
|
kind?: string;
|
|
@@ -2241,38 +2205,6 @@ declare namespace gapi.client {
|
|
|
2241
2205
|
/** Order collection. */
|
|
2242
2206
|
orders?: Order[];
|
|
2243
2207
|
}
|
|
2244
|
-
interface PathFilter {
|
|
2245
|
-
/** Event filters in path report. */
|
|
2246
|
-
eventFilters?: EventFilter[];
|
|
2247
|
-
/** The kind of resource this is, in this case dfareporting#pathFilter. */
|
|
2248
|
-
kind?: string;
|
|
2249
|
-
/** Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. */
|
|
2250
|
-
pathMatchPosition?: string;
|
|
2251
|
-
}
|
|
2252
|
-
interface PathReportCompatibleFields {
|
|
2253
|
-
/** Dimensions which are compatible to be selected in the "channelGroupings" section of the report. */
|
|
2254
|
-
channelGroupings?: Dimension[];
|
|
2255
|
-
/** Dimensions which are compatible to be selected in the "dimensions" section of the report. */
|
|
2256
|
-
dimensions?: Dimension[];
|
|
2257
|
-
/** The kind of resource this is, in this case dfareporting#pathReportCompatibleFields. */
|
|
2258
|
-
kind?: string;
|
|
2259
|
-
/** Metrics which are compatible to be selected in the "metricNames" section of the report. */
|
|
2260
|
-
metrics?: Metric[];
|
|
2261
|
-
/** Dimensions which are compatible to be selected in the "pathFilters" section of the report. */
|
|
2262
|
-
pathFilters?: Dimension[];
|
|
2263
|
-
}
|
|
2264
|
-
interface PathReportDimensionValue {
|
|
2265
|
-
/** The name of the dimension. */
|
|
2266
|
-
dimensionName?: string;
|
|
2267
|
-
/** The possible ID's associated with the value if available. */
|
|
2268
|
-
ids?: string[];
|
|
2269
|
-
/** The kind of resource this is, in this case dfareporting#pathReportDimensionValue. */
|
|
2270
|
-
kind?: string;
|
|
2271
|
-
/** Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT. */
|
|
2272
|
-
matchType?: string;
|
|
2273
|
-
/** The possible values of the dimension. */
|
|
2274
|
-
values?: string[];
|
|
2275
|
-
}
|
|
2276
2208
|
interface PathToConversionReportCompatibleFields {
|
|
2277
2209
|
/** Conversion dimensions which are compatible to be selected in the "conversionDimensions" section of the report. */
|
|
2278
2210
|
conversionDimensions?: Dimension[];
|
|
@@ -2807,40 +2739,6 @@ declare namespace gapi.client {
|
|
|
2807
2739
|
name?: string;
|
|
2808
2740
|
/** The user profile id of the owner of this report. */
|
|
2809
2741
|
ownerProfileId?: string;
|
|
2810
|
-
/** The report criteria for a report of type "PATH_ATTRIBUTION". */
|
|
2811
|
-
pathAttributionCriteria?: {
|
|
2812
|
-
/** The list of 'dfa:activity' values to filter on. */
|
|
2813
|
-
activityFilters?: DimensionValue[];
|
|
2814
|
-
/** Channel Grouping. */
|
|
2815
|
-
customChannelGrouping?: ChannelGrouping;
|
|
2816
|
-
/** The date range this report should be run for. */
|
|
2817
|
-
dateRange?: DateRange;
|
|
2818
|
-
/** The list of dimensions the report should include. */
|
|
2819
|
-
dimensions?: SortedDimension[];
|
|
2820
|
-
/** The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'. */
|
|
2821
|
-
floodlightConfigId?: DimensionValue;
|
|
2822
|
-
/** The list of names of metrics the report should include. */
|
|
2823
|
-
metricNames?: string[];
|
|
2824
|
-
/** Path Filters. */
|
|
2825
|
-
pathFilters?: PathFilter[];
|
|
2826
|
-
};
|
|
2827
|
-
/** The report criteria for a report of type "PATH". */
|
|
2828
|
-
pathCriteria?: {
|
|
2829
|
-
/** The list of 'dfa:activity' values to filter on. */
|
|
2830
|
-
activityFilters?: DimensionValue[];
|
|
2831
|
-
/** Channel Grouping. */
|
|
2832
|
-
customChannelGrouping?: ChannelGrouping;
|
|
2833
|
-
/** The date range this report should be run for. */
|
|
2834
|
-
dateRange?: DateRange;
|
|
2835
|
-
/** The list of dimensions the report should include. */
|
|
2836
|
-
dimensions?: SortedDimension[];
|
|
2837
|
-
/** The floodlight ID for which to show data in this report. All advertisers associated with that ID will automatically be added. The dimension of the value needs to be 'dfa:floodlightConfigId'. */
|
|
2838
|
-
floodlightConfigId?: DimensionValue;
|
|
2839
|
-
/** The list of names of metrics the report should include. */
|
|
2840
|
-
metricNames?: string[];
|
|
2841
|
-
/** Path Filters. */
|
|
2842
|
-
pathFilters?: PathFilter[];
|
|
2843
|
-
};
|
|
2844
2742
|
/** The report criteria for a report of type "PATH_TO_CONVERSION". */
|
|
2845
2743
|
pathToConversionCriteria?: {
|
|
2846
2744
|
/** The list of 'dfa:activity' values to filter on. */
|
|
@@ -3378,18 +3276,6 @@ declare namespace gapi.client {
|
|
|
3378
3276
|
/** User role collection. */
|
|
3379
3277
|
userRoles?: UserRole[];
|
|
3380
3278
|
}
|
|
3381
|
-
interface UvarFilter {
|
|
3382
|
-
/** Return rows which don't match this filter. */
|
|
3383
|
-
complement?: boolean;
|
|
3384
|
-
/** Custom variable index the filter is applied to. */
|
|
3385
|
-
index?: string;
|
|
3386
|
-
/** The kind of resource this is, in this case dfareporting#uvarFilter. */
|
|
3387
|
-
kind?: string;
|
|
3388
|
-
/** Indicates how the filter should be matched to the values. */
|
|
3389
|
-
match?: string;
|
|
3390
|
-
/** Values to filter on. */
|
|
3391
|
-
values?: string[];
|
|
3392
|
-
}
|
|
3393
3279
|
interface VideoFormat {
|
|
3394
3280
|
/** File type of the video format. */
|
|
3395
3281
|
fileType?: string;
|
|
@@ -3906,7 +3792,7 @@ declare namespace gapi.client {
|
|
|
3906
3792
|
/** Select only user profiles with the specified user role ID. */
|
|
3907
3793
|
userRoleId?: string;
|
|
3908
3794
|
}): Request<AccountUserProfilesListResponse>;
|
|
3909
|
-
/** Updates an existing user
|
|
3795
|
+
/** Updates an existing account user profile. This method supports patch semantics. */
|
|
3910
3796
|
patch(request: {
|
|
3911
3797
|
/** V1 error format. */
|
|
3912
3798
|
'$.xgafv'?: string;
|
|
@@ -4188,7 +4074,7 @@ declare namespace gapi.client {
|
|
|
4188
4074
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4189
4075
|
uploadType?: string;
|
|
4190
4076
|
}): Request<AdsListResponse>;
|
|
4191
|
-
/** Updates an existing
|
|
4077
|
+
/** Updates an existing ad. This method supports patch semantics. */
|
|
4192
4078
|
patch(request: {
|
|
4193
4079
|
/** V1 error format. */
|
|
4194
4080
|
'$.xgafv'?: string;
|
|
@@ -4758,7 +4644,7 @@ declare namespace gapi.client {
|
|
|
4758
4644
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4759
4645
|
uploadType?: string;
|
|
4760
4646
|
}): Request<AdvertiserLandingPagesListResponse>;
|
|
4761
|
-
/** Updates an existing
|
|
4647
|
+
/** Updates an existing landing page. This method supports patch semantics. */
|
|
4762
4648
|
patch(request: {
|
|
4763
4649
|
/** V1 error format. */
|
|
4764
4650
|
'$.xgafv'?: string;
|
|
@@ -5668,7 +5554,7 @@ declare namespace gapi.client {
|
|
|
5668
5554
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
5669
5555
|
uploadType?: string;
|
|
5670
5556
|
}): Request<CampaignsListResponse>;
|
|
5671
|
-
/** Updates an existing
|
|
5557
|
+
/** Updates an existing campaign. This method supports patch semantics. */
|
|
5672
5558
|
patch(request: {
|
|
5673
5559
|
/** V1 error format. */
|
|
5674
5560
|
'$.xgafv'?: string;
|
|
@@ -8459,7 +8345,7 @@ declare namespace gapi.client {
|
|
|
8459
8345
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8460
8346
|
uploadType?: string;
|
|
8461
8347
|
}): Request<FloodlightActivitiesListResponse>;
|
|
8462
|
-
/** Updates an existing
|
|
8348
|
+
/** Updates an existing floodlight activity. This method supports patch semantics. */
|
|
8463
8349
|
patch(request: {
|
|
8464
8350
|
/** V1 error format. */
|
|
8465
8351
|
'$.xgafv'?: string;
|
|
@@ -8713,7 +8599,7 @@ declare namespace gapi.client {
|
|
|
8713
8599
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8714
8600
|
uploadType?: string;
|
|
8715
8601
|
}): Request<FloodlightActivityGroupsListResponse>;
|
|
8716
|
-
/** Updates an existing
|
|
8602
|
+
/** Updates an existing floodlight activity group. This method supports patch semantics. */
|
|
8717
8603
|
patch(request: {
|
|
8718
8604
|
/** V1 error format. */
|
|
8719
8605
|
'$.xgafv'?: string;
|
|
@@ -8893,7 +8779,7 @@ declare namespace gapi.client {
|
|
|
8893
8779
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8894
8780
|
uploadType?: string;
|
|
8895
8781
|
}): Request<FloodlightConfigurationsListResponse>;
|
|
8896
|
-
/** Updates an existing
|
|
8782
|
+
/** Updates an existing floodlight configuration. This method supports patch semantics. */
|
|
8897
8783
|
patch(request: {
|
|
8898
8784
|
/** V1 error format. */
|
|
8899
8785
|
'$.xgafv'?: string;
|
|
@@ -10682,7 +10568,7 @@ declare namespace gapi.client {
|
|
|
10682
10568
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10683
10569
|
uploadType?: string;
|
|
10684
10570
|
}): Request<RemarketingListsListResponse>;
|
|
10685
|
-
/** Updates an existing
|
|
10571
|
+
/** Updates an existing remarketing list. This method supports patch semantics. */
|
|
10686
10572
|
patch(request: {
|
|
10687
10573
|
/** V1 error format. */
|
|
10688
10574
|
'$.xgafv'?: string;
|
|
@@ -10833,7 +10719,7 @@ declare namespace gapi.client {
|
|
|
10833
10719
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10834
10720
|
uploadType?: string;
|
|
10835
10721
|
}): Request<RemarketingListShare>;
|
|
10836
|
-
/** Updates an existing
|
|
10722
|
+
/** Updates an existing remarketing list share. This method supports patch semantics. */
|
|
10837
10723
|
patch(request: {
|
|
10838
10724
|
/** V1 error format. */
|
|
10839
10725
|
'$.xgafv'?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -159,7 +159,7 @@ await gapi.client.dfareporting.accountUserProfiles.list({
|
|
|
159
159
|
});
|
|
160
160
|
|
|
161
161
|
/*
|
|
162
|
-
Updates an existing user
|
|
162
|
+
Updates an existing account user profile. This method supports patch semantics.
|
|
163
163
|
*/
|
|
164
164
|
await gapi.client.dfareporting.accountUserProfiles.patch({
|
|
165
165
|
id: 'id',
|
|
@@ -189,7 +189,7 @@ Retrieves a list of ads, possibly filtered. This method supports paging.
|
|
|
189
189
|
await gapi.client.dfareporting.ads.list({profileId: 'profileId'});
|
|
190
190
|
|
|
191
191
|
/*
|
|
192
|
-
Updates an existing
|
|
192
|
+
Updates an existing ad. This method supports patch semantics.
|
|
193
193
|
*/
|
|
194
194
|
await gapi.client.dfareporting.ads.patch({id: 'id', profileId: 'profileId'});
|
|
195
195
|
|
|
@@ -272,7 +272,7 @@ await gapi.client.dfareporting.advertiserLandingPages.list({
|
|
|
272
272
|
});
|
|
273
273
|
|
|
274
274
|
/*
|
|
275
|
-
Updates an existing
|
|
275
|
+
Updates an existing landing page. This method supports patch semantics.
|
|
276
276
|
*/
|
|
277
277
|
await gapi.client.dfareporting.advertiserLandingPages.patch({
|
|
278
278
|
id: 'id',
|
|
@@ -399,7 +399,7 @@ Retrieves a list of campaigns, possibly filtered. This method supports paging.
|
|
|
399
399
|
await gapi.client.dfareporting.campaigns.list({profileId: 'profileId'});
|
|
400
400
|
|
|
401
401
|
/*
|
|
402
|
-
Updates an existing
|
|
402
|
+
Updates an existing campaign. This method supports patch semantics.
|
|
403
403
|
*/
|
|
404
404
|
await gapi.client.dfareporting.campaigns.patch({
|
|
405
405
|
id: 'id',
|
|
@@ -809,7 +809,7 @@ await gapi.client.dfareporting.floodlightActivities.list({
|
|
|
809
809
|
});
|
|
810
810
|
|
|
811
811
|
/*
|
|
812
|
-
Updates an existing
|
|
812
|
+
Updates an existing floodlight activity. This method supports patch semantics.
|
|
813
813
|
*/
|
|
814
814
|
await gapi.client.dfareporting.floodlightActivities.patch({
|
|
815
815
|
id: 'id',
|
|
@@ -846,7 +846,7 @@ await gapi.client.dfareporting.floodlightActivityGroups.list({
|
|
|
846
846
|
});
|
|
847
847
|
|
|
848
848
|
/*
|
|
849
|
-
Updates an existing
|
|
849
|
+
Updates an existing floodlight activity group. This method supports patch semantics.
|
|
850
850
|
*/
|
|
851
851
|
await gapi.client.dfareporting.floodlightActivityGroups.patch({
|
|
852
852
|
id: 'id',
|
|
@@ -876,7 +876,7 @@ await gapi.client.dfareporting.floodlightConfigurations.list({
|
|
|
876
876
|
});
|
|
877
877
|
|
|
878
878
|
/*
|
|
879
|
-
Updates an existing
|
|
879
|
+
Updates an existing floodlight configuration. This method supports patch semantics.
|
|
880
880
|
*/
|
|
881
881
|
await gapi.client.dfareporting.floodlightConfigurations.patch({
|
|
882
882
|
id: 'id',
|
|
@@ -1167,7 +1167,7 @@ await gapi.client.dfareporting.remarketingLists.list({
|
|
|
1167
1167
|
});
|
|
1168
1168
|
|
|
1169
1169
|
/*
|
|
1170
|
-
Updates an existing
|
|
1170
|
+
Updates an existing remarketing list. This method supports patch semantics.
|
|
1171
1171
|
*/
|
|
1172
1172
|
await gapi.client.dfareporting.remarketingLists.patch({
|
|
1173
1173
|
id: 'id',
|
|
@@ -1190,7 +1190,7 @@ await gapi.client.dfareporting.remarketingListShares.get({
|
|
|
1190
1190
|
});
|
|
1191
1191
|
|
|
1192
1192
|
/*
|
|
1193
|
-
Updates an existing
|
|
1193
|
+
Updates an existing remarketing list share. This method supports patch semantics.
|
|
1194
1194
|
*/
|
|
1195
1195
|
await gapi.client.dfareporting.remarketingListShares.patch({
|
|
1196
1196
|
id: 'id',
|