@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.2.20260316 → 0.2.20260607
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 +106 -66
- package/package.json +1 -1
- package/readme.md +24 -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://analyticsadmin.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20260607
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -186,7 +186,7 @@ declare namespace gapi.client {
|
|
|
186
186
|
displayName?: string;
|
|
187
187
|
/** Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id} */
|
|
188
188
|
gmpOrganization?: string;
|
|
189
|
-
/**
|
|
189
|
+
/** Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" */
|
|
190
190
|
name?: string;
|
|
191
191
|
/** Country of business. Must be a Unicode CLDR region code. */
|
|
192
192
|
regionCode?: string;
|
|
@@ -198,7 +198,7 @@ declare namespace gapi.client {
|
|
|
198
198
|
account?: string;
|
|
199
199
|
/** Display name for the account referred to in this account summary. */
|
|
200
200
|
displayName?: string;
|
|
201
|
-
/** Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" */
|
|
201
|
+
/** Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000" */
|
|
202
202
|
name?: string;
|
|
203
203
|
/** List of summaries for child accounts of this account. */
|
|
204
204
|
propertySummaries?: GoogleAnalyticsAdminV1alphaPropertySummary[];
|
|
@@ -475,7 +475,7 @@ declare namespace gapi.client {
|
|
|
475
475
|
| 'SECONDS'
|
|
476
476
|
| 'MINUTES'
|
|
477
477
|
| 'HOURS';
|
|
478
|
-
/**
|
|
478
|
+
/** Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' */
|
|
479
479
|
name?: string;
|
|
480
480
|
/** Output only. Types of restricted data that this metric contains. */
|
|
481
481
|
restrictedMetricType?:
|
|
@@ -553,6 +553,8 @@ declare namespace gapi.client {
|
|
|
553
553
|
skadnetworkConversionValueSchema?: GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema;
|
|
554
554
|
/** A snapshot of a SubpropertySyncConfig resource in change history. */
|
|
555
555
|
subpropertySyncConfig?: GoogleAnalyticsAdminV1alphaSubpropertySyncConfig;
|
|
556
|
+
/** A snapshot of a UserProvidedDataSettings resource in change history. */
|
|
557
|
+
userProvidedDataSettings?: GoogleAnalyticsAdminV1alphaUserProvidedDataSettings;
|
|
556
558
|
}
|
|
557
559
|
interface GoogleAnalyticsAdminV1alphaChangeHistoryEvent {
|
|
558
560
|
/** The type of actor that made this change. */
|
|
@@ -637,7 +639,7 @@ declare namespace gapi.client {
|
|
|
637
639
|
deletable?: boolean;
|
|
638
640
|
/** Immutable. The event name for this conversion event. Examples: 'click', 'purchase' */
|
|
639
641
|
eventName?: string;
|
|
640
|
-
/**
|
|
642
|
+
/** Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} */
|
|
641
643
|
name?: string;
|
|
642
644
|
}
|
|
643
645
|
interface GoogleAnalyticsAdminV1alphaConversionEventDefaultConversionValue {
|
|
@@ -687,7 +689,7 @@ declare namespace gapi.client {
|
|
|
687
689
|
disallowAdsPersonalization?: boolean;
|
|
688
690
|
/** Required. Display name for this custom dimension as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. */
|
|
689
691
|
displayName?: string;
|
|
690
|
-
/**
|
|
692
|
+
/** Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} */
|
|
691
693
|
name?: string;
|
|
692
694
|
/** Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array. May only contain alphanumeric and underscore characters, starting with a letter. Max length of 24 characters for user-scoped dimensions, 40 characters for event-scoped dimensions. */
|
|
693
695
|
parameterName?: string;
|
|
@@ -712,7 +714,7 @@ declare namespace gapi.client {
|
|
|
712
714
|
| 'SECONDS'
|
|
713
715
|
| 'MINUTES'
|
|
714
716
|
| 'HOURS';
|
|
715
|
-
/**
|
|
717
|
+
/** Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} */
|
|
716
718
|
name?: string;
|
|
717
719
|
/** Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. */
|
|
718
720
|
parameterName?: string;
|
|
@@ -743,7 +745,7 @@ declare namespace gapi.client {
|
|
|
743
745
|
| 'TWENTY_SIX_MONTHS'
|
|
744
746
|
| 'THIRTY_EIGHT_MONTHS'
|
|
745
747
|
| 'FIFTY_MONTHS';
|
|
746
|
-
/**
|
|
748
|
+
/** Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings */
|
|
747
749
|
name?: string;
|
|
748
750
|
/** If true, reset the retention period for the user identifier with every event from that user. */
|
|
749
751
|
resetUserDataOnNewActivity?: boolean;
|
|
@@ -757,7 +759,7 @@ declare namespace gapi.client {
|
|
|
757
759
|
| 'FIFTY_MONTHS';
|
|
758
760
|
}
|
|
759
761
|
interface GoogleAnalyticsAdminV1alphaDataSharingSettings {
|
|
760
|
-
/**
|
|
762
|
+
/** Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" */
|
|
761
763
|
name?: string;
|
|
762
764
|
/** Deprecated. This field is no longer used and always returns false. */
|
|
763
765
|
sharingWithGoogleAnySalesEnabled?: boolean;
|
|
@@ -779,7 +781,7 @@ declare namespace gapi.client {
|
|
|
779
781
|
displayName?: string;
|
|
780
782
|
/** Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. */
|
|
781
783
|
iosAppStreamData?: GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData;
|
|
782
|
-
/**
|
|
784
|
+
/** Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" */
|
|
783
785
|
name?: string;
|
|
784
786
|
/** Required. Immutable. The type of this DataStream resource. */
|
|
785
787
|
type?:
|
|
@@ -827,7 +829,7 @@ declare namespace gapi.client {
|
|
|
827
829
|
campaignDataSharingEnabled?: boolean;
|
|
828
830
|
/** Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. */
|
|
829
831
|
costDataSharingEnabled?: boolean;
|
|
830
|
-
/**
|
|
832
|
+
/** Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID */
|
|
831
833
|
name?: string;
|
|
832
834
|
}
|
|
833
835
|
interface GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal {
|
|
@@ -843,7 +845,7 @@ declare namespace gapi.client {
|
|
|
843
845
|
costDataSharingEnabled?: boolean;
|
|
844
846
|
/** Output only. The status information for this link proposal. */
|
|
845
847
|
linkProposalStatusDetails?: GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails;
|
|
846
|
-
/**
|
|
848
|
+
/** Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID */
|
|
847
849
|
name?: string;
|
|
848
850
|
/** Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. */
|
|
849
851
|
validationEmail?: string;
|
|
@@ -961,13 +963,13 @@ declare namespace gapi.client {
|
|
|
961
963
|
interface GoogleAnalyticsAdminV1alphaFirebaseLink {
|
|
962
964
|
/** Output only. Time when this FirebaseLink was originally created. */
|
|
963
965
|
createTime?: string;
|
|
964
|
-
/**
|
|
966
|
+
/** Identifier. Example format: properties/1234/firebaseLinks/5678 */
|
|
965
967
|
name?: string;
|
|
966
968
|
/** Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: 'projects/{project number}' Example: 'projects/1234' */
|
|
967
969
|
project?: string;
|
|
968
970
|
}
|
|
969
971
|
interface GoogleAnalyticsAdminV1alphaGlobalSiteTag {
|
|
970
|
-
/**
|
|
972
|
+
/** Identifier. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" */
|
|
971
973
|
name?: string;
|
|
972
974
|
/** Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure. */
|
|
973
975
|
snippet?: string;
|
|
@@ -983,7 +985,7 @@ declare namespace gapi.client {
|
|
|
983
985
|
creatorEmailAddress?: string;
|
|
984
986
|
/** Immutable. Google Ads customer ID. */
|
|
985
987
|
customerId?: string;
|
|
986
|
-
/**
|
|
988
|
+
/** Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. */
|
|
987
989
|
name?: string;
|
|
988
990
|
/** Output only. Time when this link was last updated. */
|
|
989
991
|
updateTime?: string;
|
|
@@ -1247,7 +1249,7 @@ declare namespace gapi.client {
|
|
|
1247
1249
|
interface GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret {
|
|
1248
1250
|
/** Required. Human-readable display name for this secret. */
|
|
1249
1251
|
displayName?: string;
|
|
1250
|
-
/**
|
|
1252
|
+
/** Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} */
|
|
1251
1253
|
name?: string;
|
|
1252
1254
|
/** Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. */
|
|
1253
1255
|
secretValue?: string;
|
|
@@ -1312,7 +1314,7 @@ declare namespace gapi.client {
|
|
|
1312
1314
|
| 'SPORTS'
|
|
1313
1315
|
| 'JOBS_AND_EDUCATION'
|
|
1314
1316
|
| 'SHOPPING';
|
|
1315
|
-
/**
|
|
1317
|
+
/** Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" */
|
|
1316
1318
|
name?: string;
|
|
1317
1319
|
/** Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101" */
|
|
1318
1320
|
parent?: string;
|
|
@@ -1333,6 +1335,8 @@ declare namespace gapi.client {
|
|
|
1333
1335
|
updateTime?: string;
|
|
1334
1336
|
}
|
|
1335
1337
|
interface GoogleAnalyticsAdminV1alphaPropertySummary {
|
|
1338
|
+
/** If true, then the user has a Google Analytics role that permits them to edit the property. */
|
|
1339
|
+
canEdit?: boolean;
|
|
1336
1340
|
/** Display name for the property referred to in this property summary. */
|
|
1337
1341
|
displayName?: string;
|
|
1338
1342
|
/** Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/200" */
|
|
@@ -1472,7 +1476,7 @@ declare namespace gapi.client {
|
|
|
1472
1476
|
campaignDataSharingEnabled?: boolean;
|
|
1473
1477
|
/** Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. */
|
|
1474
1478
|
costDataSharingEnabled?: boolean;
|
|
1475
|
-
/**
|
|
1479
|
+
/** Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID */
|
|
1476
1480
|
name?: string;
|
|
1477
1481
|
/** Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. */
|
|
1478
1482
|
siteStatsSharingEnabled?: boolean;
|
|
@@ -1523,7 +1527,8 @@ declare namespace gapi.client {
|
|
|
1523
1527
|
| 'CALCULATED_METRIC'
|
|
1524
1528
|
| 'REPORTING_DATA_ANNOTATION'
|
|
1525
1529
|
| 'SUBPROPERTY_SYNC_CONFIG'
|
|
1526
|
-
| 'REPORTING_IDENTITY_SETTINGS'
|
|
1530
|
+
| 'REPORTING_IDENTITY_SETTINGS'
|
|
1531
|
+
| 'USER_PROVIDED_DATA_SETTINGS'[];
|
|
1527
1532
|
}
|
|
1528
1533
|
interface GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse {
|
|
1529
1534
|
/** Results that were accessible to the caller. */
|
|
@@ -1534,7 +1539,7 @@ declare namespace gapi.client {
|
|
|
1534
1539
|
interface GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema {
|
|
1535
1540
|
/** If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. */
|
|
1536
1541
|
applyConversionValues?: boolean;
|
|
1537
|
-
/**
|
|
1542
|
+
/** Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema */
|
|
1538
1543
|
name?: string;
|
|
1539
1544
|
/** Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. */
|
|
1540
1545
|
postbackWindowOne?: GoogleAnalyticsAdminV1alphaPostbackWindow;
|
|
@@ -1624,6 +1629,14 @@ declare namespace gapi.client {
|
|
|
1624
1629
|
/** Required. The access binding to update. */
|
|
1625
1630
|
accessBinding?: GoogleAnalyticsAdminV1alphaAccessBinding;
|
|
1626
1631
|
}
|
|
1632
|
+
interface GoogleAnalyticsAdminV1alphaUserProvidedDataSettings {
|
|
1633
|
+
/** Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true. */
|
|
1634
|
+
automaticallyDetectedDataCollectionEnabled?: boolean;
|
|
1635
|
+
/** Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: "properties/1000/userProvidedDataSettings" */
|
|
1636
|
+
name?: string;
|
|
1637
|
+
/** Optional. Whether this property accepts user-provided data sent to it. */
|
|
1638
|
+
userProvidedDataCollectionEnabled?: boolean;
|
|
1639
|
+
}
|
|
1627
1640
|
interface GoogleProtobufEmpty {}
|
|
1628
1641
|
interface GoogleTypeDate {
|
|
1629
1642
|
/** Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. */
|
|
@@ -2137,9 +2150,9 @@ declare namespace gapi.client {
|
|
|
2137
2150
|
key?: string;
|
|
2138
2151
|
/** OAuth 2.0 token for the current user. */
|
|
2139
2152
|
oauth_token?: string;
|
|
2140
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2153
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2141
2154
|
pageSize?: number;
|
|
2142
|
-
/** A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. */
|
|
2155
|
+
/** Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token. */
|
|
2143
2156
|
pageToken?: string;
|
|
2144
2157
|
/** Returns response with indentations and line breaks. */
|
|
2145
2158
|
prettyPrint?: boolean;
|
|
@@ -2166,7 +2179,7 @@ declare namespace gapi.client {
|
|
|
2166
2179
|
fields?: string;
|
|
2167
2180
|
/** 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. */
|
|
2168
2181
|
key?: string;
|
|
2169
|
-
/**
|
|
2182
|
+
/** Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" */
|
|
2170
2183
|
name: string;
|
|
2171
2184
|
/** OAuth 2.0 token for the current user. */
|
|
2172
2185
|
oauth_token?: string;
|
|
@@ -2197,7 +2210,7 @@ declare namespace gapi.client {
|
|
|
2197
2210
|
fields?: string;
|
|
2198
2211
|
/** 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. */
|
|
2199
2212
|
key?: string;
|
|
2200
|
-
/**
|
|
2213
|
+
/** Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100" */
|
|
2201
2214
|
name: string;
|
|
2202
2215
|
/** OAuth 2.0 token for the current user. */
|
|
2203
2216
|
oauth_token?: string;
|
|
@@ -2403,9 +2416,9 @@ declare namespace gapi.client {
|
|
|
2403
2416
|
key?: string;
|
|
2404
2417
|
/** OAuth 2.0 token for the current user. */
|
|
2405
2418
|
oauth_token?: string;
|
|
2406
|
-
/** The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2419
|
+
/** Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
2407
2420
|
pageSize?: number;
|
|
2408
|
-
/** A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. */
|
|
2421
|
+
/** Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. */
|
|
2409
2422
|
pageToken?: string;
|
|
2410
2423
|
/** Returns response with indentations and line breaks. */
|
|
2411
2424
|
prettyPrint?: boolean;
|
|
@@ -3575,7 +3588,7 @@ declare namespace gapi.client {
|
|
|
3575
3588
|
fields?: string;
|
|
3576
3589
|
/** 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. */
|
|
3577
3590
|
key?: string;
|
|
3578
|
-
/**
|
|
3591
|
+
/** Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' */
|
|
3579
3592
|
name: string;
|
|
3580
3593
|
/** OAuth 2.0 token for the current user. */
|
|
3581
3594
|
oauth_token?: string;
|
|
@@ -3606,7 +3619,7 @@ declare namespace gapi.client {
|
|
|
3606
3619
|
fields?: string;
|
|
3607
3620
|
/** 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. */
|
|
3608
3621
|
key?: string;
|
|
3609
|
-
/**
|
|
3622
|
+
/** Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}' */
|
|
3610
3623
|
name: string;
|
|
3611
3624
|
/** OAuth 2.0 token for the current user. */
|
|
3612
3625
|
oauth_token?: string;
|
|
@@ -3960,9 +3973,9 @@ declare namespace gapi.client {
|
|
|
3960
3973
|
key?: string;
|
|
3961
3974
|
/** OAuth 2.0 token for the current user. */
|
|
3962
3975
|
oauth_token?: string;
|
|
3963
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
3976
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
3964
3977
|
pageSize?: number;
|
|
3965
|
-
/** A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. */
|
|
3978
|
+
/** Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. */
|
|
3966
3979
|
pageToken?: string;
|
|
3967
3980
|
/** Required. The resource name of the parent property. Example: 'properties/123' */
|
|
3968
3981
|
parent: string;
|
|
@@ -3989,7 +4002,7 @@ declare namespace gapi.client {
|
|
|
3989
4002
|
fields?: string;
|
|
3990
4003
|
/** 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. */
|
|
3991
4004
|
key?: string;
|
|
3992
|
-
/**
|
|
4005
|
+
/** Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} */
|
|
3993
4006
|
name: string;
|
|
3994
4007
|
/** OAuth 2.0 token for the current user. */
|
|
3995
4008
|
oauth_token?: string;
|
|
@@ -4020,7 +4033,7 @@ declare namespace gapi.client {
|
|
|
4020
4033
|
fields?: string;
|
|
4021
4034
|
/** 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. */
|
|
4022
4035
|
key?: string;
|
|
4023
|
-
/**
|
|
4036
|
+
/** Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} */
|
|
4024
4037
|
name: string;
|
|
4025
4038
|
/** OAuth 2.0 token for the current user. */
|
|
4026
4039
|
oauth_token?: string;
|
|
@@ -4198,9 +4211,9 @@ declare namespace gapi.client {
|
|
|
4198
4211
|
key?: string;
|
|
4199
4212
|
/** OAuth 2.0 token for the current user. */
|
|
4200
4213
|
oauth_token?: string;
|
|
4201
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
4214
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
4202
4215
|
pageSize?: number;
|
|
4203
|
-
/** A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. */
|
|
4216
|
+
/** Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. */
|
|
4204
4217
|
pageToken?: string;
|
|
4205
4218
|
/** Required. Example format: properties/1234 */
|
|
4206
4219
|
parent: string;
|
|
@@ -4227,7 +4240,7 @@ declare namespace gapi.client {
|
|
|
4227
4240
|
fields?: string;
|
|
4228
4241
|
/** 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. */
|
|
4229
4242
|
key?: string;
|
|
4230
|
-
/**
|
|
4243
|
+
/** Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} */
|
|
4231
4244
|
name: string;
|
|
4232
4245
|
/** OAuth 2.0 token for the current user. */
|
|
4233
4246
|
oauth_token?: string;
|
|
@@ -4258,7 +4271,7 @@ declare namespace gapi.client {
|
|
|
4258
4271
|
fields?: string;
|
|
4259
4272
|
/** 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. */
|
|
4260
4273
|
key?: string;
|
|
4261
|
-
/**
|
|
4274
|
+
/** Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension} */
|
|
4262
4275
|
name: string;
|
|
4263
4276
|
/** OAuth 2.0 token for the current user. */
|
|
4264
4277
|
oauth_token?: string;
|
|
@@ -4465,7 +4478,7 @@ declare namespace gapi.client {
|
|
|
4465
4478
|
fields?: string;
|
|
4466
4479
|
/** 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. */
|
|
4467
4480
|
key?: string;
|
|
4468
|
-
/**
|
|
4481
|
+
/** Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} */
|
|
4469
4482
|
name: string;
|
|
4470
4483
|
/** OAuth 2.0 token for the current user. */
|
|
4471
4484
|
oauth_token?: string;
|
|
@@ -4496,7 +4509,7 @@ declare namespace gapi.client {
|
|
|
4496
4509
|
fields?: string;
|
|
4497
4510
|
/** 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. */
|
|
4498
4511
|
key?: string;
|
|
4499
|
-
/**
|
|
4512
|
+
/** Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} */
|
|
4500
4513
|
name: string;
|
|
4501
4514
|
/** OAuth 2.0 token for the current user. */
|
|
4502
4515
|
oauth_token?: string;
|
|
@@ -5115,9 +5128,9 @@ declare namespace gapi.client {
|
|
|
5115
5128
|
key?: string;
|
|
5116
5129
|
/** OAuth 2.0 token for the current user. */
|
|
5117
5130
|
oauth_token?: string;
|
|
5118
|
-
/** The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. */
|
|
5131
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. */
|
|
5119
5132
|
pageSize?: number;
|
|
5120
|
-
/** A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. */
|
|
5133
|
+
/** Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. */
|
|
5121
5134
|
pageToken?: string;
|
|
5122
5135
|
/** Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets */
|
|
5123
5136
|
parent: string;
|
|
@@ -5144,7 +5157,7 @@ declare namespace gapi.client {
|
|
|
5144
5157
|
fields?: string;
|
|
5145
5158
|
/** 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. */
|
|
5146
5159
|
key?: string;
|
|
5147
|
-
/**
|
|
5160
|
+
/** Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} */
|
|
5148
5161
|
name: string;
|
|
5149
5162
|
/** OAuth 2.0 token for the current user. */
|
|
5150
5163
|
oauth_token?: string;
|
|
@@ -5175,7 +5188,7 @@ declare namespace gapi.client {
|
|
|
5175
5188
|
fields?: string;
|
|
5176
5189
|
/** 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. */
|
|
5177
5190
|
key?: string;
|
|
5178
|
-
/**
|
|
5191
|
+
/** Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret} */
|
|
5179
5192
|
name: string;
|
|
5180
5193
|
/** OAuth 2.0 token for the current user. */
|
|
5181
5194
|
oauth_token?: string;
|
|
@@ -5322,9 +5335,9 @@ declare namespace gapi.client {
|
|
|
5322
5335
|
key?: string;
|
|
5323
5336
|
/** OAuth 2.0 token for the current user. */
|
|
5324
5337
|
oauth_token?: string;
|
|
5325
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
5338
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
5326
5339
|
pageSize?: number;
|
|
5327
|
-
/** A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token. */
|
|
5340
|
+
/** Optional. A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token. */
|
|
5328
5341
|
pageToken?: string;
|
|
5329
5342
|
/** Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678 */
|
|
5330
5343
|
parent: string;
|
|
@@ -5351,7 +5364,7 @@ declare namespace gapi.client {
|
|
|
5351
5364
|
fields?: string;
|
|
5352
5365
|
/** 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. */
|
|
5353
5366
|
key?: string;
|
|
5354
|
-
/**
|
|
5367
|
+
/** Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema */
|
|
5355
5368
|
name: string;
|
|
5356
5369
|
/** OAuth 2.0 token for the current user. */
|
|
5357
5370
|
oauth_token?: string;
|
|
@@ -5382,7 +5395,7 @@ declare namespace gapi.client {
|
|
|
5382
5395
|
fields?: string;
|
|
5383
5396
|
/** 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. */
|
|
5384
5397
|
key?: string;
|
|
5385
|
-
/**
|
|
5398
|
+
/** Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema */
|
|
5386
5399
|
name: string;
|
|
5387
5400
|
/** OAuth 2.0 token for the current user. */
|
|
5388
5401
|
oauth_token?: string;
|
|
@@ -5639,7 +5652,7 @@ declare namespace gapi.client {
|
|
|
5639
5652
|
fields?: string;
|
|
5640
5653
|
/** 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. */
|
|
5641
5654
|
key?: string;
|
|
5642
|
-
/**
|
|
5655
|
+
/** Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" */
|
|
5643
5656
|
name: string;
|
|
5644
5657
|
/** OAuth 2.0 token for the current user. */
|
|
5645
5658
|
oauth_token?: string;
|
|
@@ -5670,7 +5683,7 @@ declare namespace gapi.client {
|
|
|
5670
5683
|
fields?: string;
|
|
5671
5684
|
/** 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. */
|
|
5672
5685
|
key?: string;
|
|
5673
|
-
/**
|
|
5686
|
+
/** Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000" */
|
|
5674
5687
|
name: string;
|
|
5675
5688
|
/** OAuth 2.0 token for the current user. */
|
|
5676
5689
|
oauth_token?: string;
|
|
@@ -6235,7 +6248,7 @@ declare namespace gapi.client {
|
|
|
6235
6248
|
fields?: string;
|
|
6236
6249
|
/** 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. */
|
|
6237
6250
|
key?: string;
|
|
6238
|
-
/**
|
|
6251
|
+
/** Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID */
|
|
6239
6252
|
name: string;
|
|
6240
6253
|
/** OAuth 2.0 token for the current user. */
|
|
6241
6254
|
oauth_token?: string;
|
|
@@ -6266,7 +6279,7 @@ declare namespace gapi.client {
|
|
|
6266
6279
|
fields?: string;
|
|
6267
6280
|
/** 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. */
|
|
6268
6281
|
key?: string;
|
|
6269
|
-
/**
|
|
6282
|
+
/** Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID */
|
|
6270
6283
|
name: string;
|
|
6271
6284
|
/** OAuth 2.0 token for the current user. */
|
|
6272
6285
|
oauth_token?: string;
|
|
@@ -6593,9 +6606,9 @@ declare namespace gapi.client {
|
|
|
6593
6606
|
key?: string;
|
|
6594
6607
|
/** OAuth 2.0 token for the current user. */
|
|
6595
6608
|
oauth_token?: string;
|
|
6596
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
6609
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
6597
6610
|
pageSize?: number;
|
|
6598
|
-
/** A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. */
|
|
6611
|
+
/** Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. */
|
|
6599
6612
|
pageToken?: string;
|
|
6600
6613
|
/** Required. Format: properties/{property_id} Example: `properties/1234` */
|
|
6601
6614
|
parent: string;
|
|
@@ -6711,9 +6724,9 @@ declare namespace gapi.client {
|
|
|
6711
6724
|
key?: string;
|
|
6712
6725
|
/** OAuth 2.0 token for the current user. */
|
|
6713
6726
|
oauth_token?: string;
|
|
6714
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
6727
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). */
|
|
6715
6728
|
pageSize?: number;
|
|
6716
|
-
/** A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. */
|
|
6729
|
+
/** Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. */
|
|
6717
6730
|
pageToken?: string;
|
|
6718
6731
|
/** Required. Example format: properties/1234 */
|
|
6719
6732
|
parent: string;
|
|
@@ -6740,7 +6753,7 @@ declare namespace gapi.client {
|
|
|
6740
6753
|
fields?: string;
|
|
6741
6754
|
/** 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. */
|
|
6742
6755
|
key?: string;
|
|
6743
|
-
/**
|
|
6756
|
+
/** Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. */
|
|
6744
6757
|
name: string;
|
|
6745
6758
|
/** OAuth 2.0 token for the current user. */
|
|
6746
6759
|
oauth_token?: string;
|
|
@@ -6771,7 +6784,7 @@ declare namespace gapi.client {
|
|
|
6771
6784
|
fields?: string;
|
|
6772
6785
|
/** 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. */
|
|
6773
6786
|
key?: string;
|
|
6774
|
-
/**
|
|
6787
|
+
/** Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID. */
|
|
6775
6788
|
name: string;
|
|
6776
6789
|
/** OAuth 2.0 token for the current user. */
|
|
6777
6790
|
oauth_token?: string;
|
|
@@ -6918,9 +6931,9 @@ declare namespace gapi.client {
|
|
|
6918
6931
|
key?: string;
|
|
6919
6932
|
/** OAuth 2.0 token for the current user. */
|
|
6920
6933
|
oauth_token?: string;
|
|
6921
|
-
/** The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
6934
|
+
/** Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
6922
6935
|
pageSize?: number;
|
|
6923
|
-
/** A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. */
|
|
6936
|
+
/** Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. */
|
|
6924
6937
|
pageToken?: string;
|
|
6925
6938
|
/** Required. The resource name of the parent property. Example: 'properties/123' */
|
|
6926
6939
|
parent: string;
|
|
@@ -7508,7 +7521,7 @@ declare namespace gapi.client {
|
|
|
7508
7521
|
fields?: string;
|
|
7509
7522
|
/** 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. */
|
|
7510
7523
|
key?: string;
|
|
7511
|
-
/**
|
|
7524
|
+
/** Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID */
|
|
7512
7525
|
name: string;
|
|
7513
7526
|
/** OAuth 2.0 token for the current user. */
|
|
7514
7527
|
oauth_token?: string;
|
|
@@ -7539,7 +7552,7 @@ declare namespace gapi.client {
|
|
|
7539
7552
|
fields?: string;
|
|
7540
7553
|
/** 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. */
|
|
7541
7554
|
key?: string;
|
|
7542
|
-
/**
|
|
7555
|
+
/** Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID */
|
|
7543
7556
|
name: string;
|
|
7544
7557
|
/** OAuth 2.0 token for the current user. */
|
|
7545
7558
|
oauth_token?: string;
|
|
@@ -8215,6 +8228,33 @@ declare namespace gapi.client {
|
|
|
8215
8228
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8216
8229
|
uploadType?: string;
|
|
8217
8230
|
}): Request<GoogleAnalyticsAdminV1alphaReportingIdentitySettings>;
|
|
8231
|
+
/** Looks up settings related to user-provided data for a property. */
|
|
8232
|
+
getUserProvidedDataSettings(request?: {
|
|
8233
|
+
/** V1 error format. */
|
|
8234
|
+
'$.xgafv'?: '1' | '2';
|
|
8235
|
+
/** OAuth access token. */
|
|
8236
|
+
access_token?: string;
|
|
8237
|
+
/** Data format for response. */
|
|
8238
|
+
alt?: 'json' | 'media' | 'proto';
|
|
8239
|
+
/** JSONP */
|
|
8240
|
+
callback?: string;
|
|
8241
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
8242
|
+
fields?: string;
|
|
8243
|
+
/** 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. */
|
|
8244
|
+
key?: string;
|
|
8245
|
+
/** Required. The name of the user provided data settings to retrieve. Format: properties/{property}/userProvidedDataSettings */
|
|
8246
|
+
name: string;
|
|
8247
|
+
/** OAuth 2.0 token for the current user. */
|
|
8248
|
+
oauth_token?: string;
|
|
8249
|
+
/** Returns response with indentations and line breaks. */
|
|
8250
|
+
prettyPrint?: boolean;
|
|
8251
|
+
/** 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. */
|
|
8252
|
+
quotaUser?: string;
|
|
8253
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
8254
|
+
upload_protocol?: string;
|
|
8255
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
8256
|
+
uploadType?: string;
|
|
8257
|
+
}): Request<GoogleAnalyticsAdminV1alphaUserProvidedDataSettings>;
|
|
8218
8258
|
/** Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found. */
|
|
8219
8259
|
list(request?: {
|
|
8220
8260
|
/** V1 error format. */
|
|
@@ -8233,9 +8273,9 @@ declare namespace gapi.client {
|
|
|
8233
8273
|
key?: string;
|
|
8234
8274
|
/** OAuth 2.0 token for the current user. */
|
|
8235
8275
|
oauth_token?: string;
|
|
8236
|
-
/** The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
8276
|
+
/** Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */
|
|
8237
8277
|
pageSize?: number;
|
|
8238
|
-
/** A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. */
|
|
8278
|
+
/** Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. */
|
|
8239
8279
|
pageToken?: string;
|
|
8240
8280
|
/** Returns response with indentations and line breaks. */
|
|
8241
8281
|
prettyPrint?: boolean;
|
|
@@ -8262,7 +8302,7 @@ declare namespace gapi.client {
|
|
|
8262
8302
|
fields?: string;
|
|
8263
8303
|
/** 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. */
|
|
8264
8304
|
key?: string;
|
|
8265
|
-
/**
|
|
8305
|
+
/** Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" */
|
|
8266
8306
|
name: string;
|
|
8267
8307
|
/** OAuth 2.0 token for the current user. */
|
|
8268
8308
|
oauth_token?: string;
|
|
@@ -8293,7 +8333,7 @@ declare namespace gapi.client {
|
|
|
8293
8333
|
fields?: string;
|
|
8294
8334
|
/** 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. */
|
|
8295
8335
|
key?: string;
|
|
8296
|
-
/**
|
|
8336
|
+
/** Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000" */
|
|
8297
8337
|
name: string;
|
|
8298
8338
|
/** OAuth 2.0 token for the current user. */
|
|
8299
8339
|
oauth_token?: string;
|
|
@@ -8556,7 +8596,7 @@ declare namespace gapi.client {
|
|
|
8556
8596
|
fields?: string;
|
|
8557
8597
|
/** 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. */
|
|
8558
8598
|
key?: string;
|
|
8559
|
-
/**
|
|
8599
|
+
/** Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings */
|
|
8560
8600
|
name: string;
|
|
8561
8601
|
/** OAuth 2.0 token for the current user. */
|
|
8562
8602
|
oauth_token?: string;
|
|
@@ -8587,7 +8627,7 @@ declare namespace gapi.client {
|
|
|
8587
8627
|
fields?: string;
|
|
8588
8628
|
/** 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. */
|
|
8589
8629
|
key?: string;
|
|
8590
|
-
/**
|
|
8630
|
+
/** Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings */
|
|
8591
8631
|
name: string;
|
|
8592
8632
|
/** OAuth 2.0 token for the current user. */
|
|
8593
8633
|
oauth_token?: string;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -11,6 +11,23 @@ Install typings for Google Analytics Admin API:
|
|
|
11
11
|
npm install @types/gapi.client.analyticsadmin-v1alpha --save-dev
|
|
12
12
|
```
|
|
13
13
|
|
|
14
|
+
## TypeScript 6.0+
|
|
15
|
+
|
|
16
|
+
TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
|
|
17
|
+
|
|
18
|
+
```json
|
|
19
|
+
{
|
|
20
|
+
"compilerOptions": {
|
|
21
|
+
"types": [
|
|
22
|
+
"gapi",
|
|
23
|
+
"gapi.auth2",
|
|
24
|
+
"gapi.client",
|
|
25
|
+
"gapi.client.analyticsadmin-v1alpha"
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
```
|
|
30
|
+
|
|
14
31
|
## Usage
|
|
15
32
|
|
|
16
33
|
You need to initialize Google API client in your code:
|
|
@@ -182,6 +199,13 @@ await gapi.client.analyticsadmin.properties.getReportingIdentitySettings({
|
|
|
182
199
|
name: 'name',
|
|
183
200
|
});
|
|
184
201
|
|
|
202
|
+
/*
|
|
203
|
+
Looks up settings related to user-provided data for a property.
|
|
204
|
+
*/
|
|
205
|
+
await gapi.client.analyticsadmin.properties.getUserProvidedDataSettings({
|
|
206
|
+
name: 'name',
|
|
207
|
+
});
|
|
208
|
+
|
|
185
209
|
/*
|
|
186
210
|
Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.
|
|
187
211
|
*/
|