@maxim_mazurok/gapi.client.analyticsadmin-v1alpha 0.0.20220926 → 0.0.20220929
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 +244 -1
- package/package.json +1 -1
- package/tests.ts +40 -1
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: 20220929
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -477,6 +477,8 @@ declare namespace gapi.client {
|
|
|
477
477
|
measurementProtocolSecret?: GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret;
|
|
478
478
|
/** A snapshot of a Property resource in change history. */
|
|
479
479
|
property?: GoogleAnalyticsAdminV1alphaProperty;
|
|
480
|
+
/** A snapshot of a SearchAds360Link resource in change history. */
|
|
481
|
+
searchAds360Link?: GoogleAnalyticsAdminV1alphaSearchAds360Link;
|
|
480
482
|
}
|
|
481
483
|
interface GoogleAnalyticsAdminV1alphaChangeHistoryEvent {
|
|
482
484
|
/** The type of actor that made this change. */
|
|
@@ -816,6 +818,12 @@ declare namespace gapi.client {
|
|
|
816
818
|
/** Results that matched the filter criteria and were accessible to the caller. */
|
|
817
819
|
properties?: GoogleAnalyticsAdminV1alphaProperty[];
|
|
818
820
|
}
|
|
821
|
+
interface GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse {
|
|
822
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
823
|
+
nextPageToken?: string;
|
|
824
|
+
/** List of SearchAds360Links. */
|
|
825
|
+
searchAds360Links?: GoogleAnalyticsAdminV1alphaSearchAds360Link[];
|
|
826
|
+
}
|
|
819
827
|
interface GoogleAnalyticsAdminV1alphaListUserLinksResponse {
|
|
820
828
|
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
821
829
|
nextPageToken?: string;
|
|
@@ -964,6 +972,28 @@ declare namespace gapi.client {
|
|
|
964
972
|
/** Rows of dimension value combinations and metric values in the report. */
|
|
965
973
|
rows?: GoogleAnalyticsAdminV1alphaAccessRow[];
|
|
966
974
|
}
|
|
975
|
+
interface GoogleAnalyticsAdminV1alphaSearchAds360Link {
|
|
976
|
+
/** Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. */
|
|
977
|
+
adsPersonalizationEnabled?: boolean;
|
|
978
|
+
/** Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. */
|
|
979
|
+
advertiserDisplayName?: string;
|
|
980
|
+
/** Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. */
|
|
981
|
+
advertiserId?: string;
|
|
982
|
+
/**
|
|
983
|
+
* Immutable. Enables the import of campaign data from Search Ads 360 into the GA4 property. After link creation, this can only be updated from the Search Ads 360 product. If this
|
|
984
|
+
* field is not set on create, it will be defaulted to true.
|
|
985
|
+
*/
|
|
986
|
+
campaignDataSharingEnabled?: boolean;
|
|
987
|
+
/**
|
|
988
|
+
* Immutable. Enables the import of cost data from Search Ads 360 to the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this
|
|
989
|
+
* can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true.
|
|
990
|
+
*/
|
|
991
|
+
costDataSharingEnabled?: boolean;
|
|
992
|
+
/** Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID */
|
|
993
|
+
name?: string;
|
|
994
|
+
/** Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. */
|
|
995
|
+
siteStatsSharingEnabled?: boolean;
|
|
996
|
+
}
|
|
967
997
|
interface GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest {
|
|
968
998
|
/** Optional. If set, only return changes that match one or more of these types of actions. */
|
|
969
999
|
action?: string[];
|
|
@@ -3931,6 +3961,218 @@ declare namespace gapi.client {
|
|
|
3931
3961
|
},
|
|
3932
3962
|
body: GoogleAnalyticsAdminV1alphaGoogleAdsLink): Request<GoogleAnalyticsAdminV1alphaGoogleAdsLink>;
|
|
3933
3963
|
}
|
|
3964
|
+
interface SearchAds360LinksResource {
|
|
3965
|
+
/** Creates a SearchAds360Link. */
|
|
3966
|
+
create(request: {
|
|
3967
|
+
/** V1 error format. */
|
|
3968
|
+
"$.xgafv"?: string;
|
|
3969
|
+
/** OAuth access token. */
|
|
3970
|
+
access_token?: string;
|
|
3971
|
+
/** Data format for response. */
|
|
3972
|
+
alt?: string;
|
|
3973
|
+
/** JSONP */
|
|
3974
|
+
callback?: string;
|
|
3975
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
3976
|
+
fields?: string;
|
|
3977
|
+
/** 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. */
|
|
3978
|
+
key?: string;
|
|
3979
|
+
/** OAuth 2.0 token for the current user. */
|
|
3980
|
+
oauth_token?: string;
|
|
3981
|
+
/** Required. Example format: properties/1234 */
|
|
3982
|
+
parent: string;
|
|
3983
|
+
/** Returns response with indentations and line breaks. */
|
|
3984
|
+
prettyPrint?: boolean;
|
|
3985
|
+
/** 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. */
|
|
3986
|
+
quotaUser?: string;
|
|
3987
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
3988
|
+
upload_protocol?: string;
|
|
3989
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
3990
|
+
uploadType?: string;
|
|
3991
|
+
/** Request body */
|
|
3992
|
+
resource: GoogleAnalyticsAdminV1alphaSearchAds360Link;
|
|
3993
|
+
}): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
|
|
3994
|
+
create(request: {
|
|
3995
|
+
/** V1 error format. */
|
|
3996
|
+
"$.xgafv"?: string;
|
|
3997
|
+
/** OAuth access token. */
|
|
3998
|
+
access_token?: string;
|
|
3999
|
+
/** Data format for response. */
|
|
4000
|
+
alt?: string;
|
|
4001
|
+
/** JSONP */
|
|
4002
|
+
callback?: string;
|
|
4003
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4004
|
+
fields?: string;
|
|
4005
|
+
/** 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. */
|
|
4006
|
+
key?: string;
|
|
4007
|
+
/** OAuth 2.0 token for the current user. */
|
|
4008
|
+
oauth_token?: string;
|
|
4009
|
+
/** Required. Example format: properties/1234 */
|
|
4010
|
+
parent: string;
|
|
4011
|
+
/** Returns response with indentations and line breaks. */
|
|
4012
|
+
prettyPrint?: boolean;
|
|
4013
|
+
/** 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. */
|
|
4014
|
+
quotaUser?: string;
|
|
4015
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4016
|
+
upload_protocol?: string;
|
|
4017
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4018
|
+
uploadType?: string;
|
|
4019
|
+
},
|
|
4020
|
+
body: GoogleAnalyticsAdminV1alphaSearchAds360Link): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
|
|
4021
|
+
/** Deletes a SearchAds360Link on a property. */
|
|
4022
|
+
delete(request?: {
|
|
4023
|
+
/** V1 error format. */
|
|
4024
|
+
"$.xgafv"?: string;
|
|
4025
|
+
/** OAuth access token. */
|
|
4026
|
+
access_token?: string;
|
|
4027
|
+
/** Data format for response. */
|
|
4028
|
+
alt?: string;
|
|
4029
|
+
/** JSONP */
|
|
4030
|
+
callback?: string;
|
|
4031
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4032
|
+
fields?: string;
|
|
4033
|
+
/** 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. */
|
|
4034
|
+
key?: string;
|
|
4035
|
+
/** Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678 */
|
|
4036
|
+
name: string;
|
|
4037
|
+
/** OAuth 2.0 token for the current user. */
|
|
4038
|
+
oauth_token?: string;
|
|
4039
|
+
/** Returns response with indentations and line breaks. */
|
|
4040
|
+
prettyPrint?: boolean;
|
|
4041
|
+
/** 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. */
|
|
4042
|
+
quotaUser?: string;
|
|
4043
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4044
|
+
upload_protocol?: string;
|
|
4045
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4046
|
+
uploadType?: string;
|
|
4047
|
+
}): Request<{}>;
|
|
4048
|
+
/** Look up a single SearchAds360Link */
|
|
4049
|
+
get(request?: {
|
|
4050
|
+
/** V1 error format. */
|
|
4051
|
+
"$.xgafv"?: string;
|
|
4052
|
+
/** OAuth access token. */
|
|
4053
|
+
access_token?: string;
|
|
4054
|
+
/** Data format for response. */
|
|
4055
|
+
alt?: string;
|
|
4056
|
+
/** JSONP */
|
|
4057
|
+
callback?: string;
|
|
4058
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4059
|
+
fields?: string;
|
|
4060
|
+
/** 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. */
|
|
4061
|
+
key?: string;
|
|
4062
|
+
/** Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678 */
|
|
4063
|
+
name: string;
|
|
4064
|
+
/** OAuth 2.0 token for the current user. */
|
|
4065
|
+
oauth_token?: string;
|
|
4066
|
+
/** Returns response with indentations and line breaks. */
|
|
4067
|
+
prettyPrint?: boolean;
|
|
4068
|
+
/** 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. */
|
|
4069
|
+
quotaUser?: string;
|
|
4070
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4071
|
+
upload_protocol?: string;
|
|
4072
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4073
|
+
uploadType?: string;
|
|
4074
|
+
}): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
|
|
4075
|
+
/** Lists all SearchAds360Links on a property. */
|
|
4076
|
+
list(request?: {
|
|
4077
|
+
/** V1 error format. */
|
|
4078
|
+
"$.xgafv"?: string;
|
|
4079
|
+
/** OAuth access token. */
|
|
4080
|
+
access_token?: string;
|
|
4081
|
+
/** Data format for response. */
|
|
4082
|
+
alt?: string;
|
|
4083
|
+
/** JSONP */
|
|
4084
|
+
callback?: string;
|
|
4085
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4086
|
+
fields?: string;
|
|
4087
|
+
/** 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. */
|
|
4088
|
+
key?: string;
|
|
4089
|
+
/** OAuth 2.0 token for the current user. */
|
|
4090
|
+
oauth_token?: string;
|
|
4091
|
+
/** 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). */
|
|
4092
|
+
pageSize?: number;
|
|
4093
|
+
/**
|
|
4094
|
+
* A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to
|
|
4095
|
+
* `ListSearchAds360Links` must match the call that provided the page token.
|
|
4096
|
+
*/
|
|
4097
|
+
pageToken?: string;
|
|
4098
|
+
/** Required. Example format: properties/1234 */
|
|
4099
|
+
parent: string;
|
|
4100
|
+
/** Returns response with indentations and line breaks. */
|
|
4101
|
+
prettyPrint?: boolean;
|
|
4102
|
+
/** 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. */
|
|
4103
|
+
quotaUser?: string;
|
|
4104
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4105
|
+
upload_protocol?: string;
|
|
4106
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4107
|
+
uploadType?: string;
|
|
4108
|
+
}): Request<GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse>;
|
|
4109
|
+
/** Updates a SearchAds360Link on a property. */
|
|
4110
|
+
patch(request: {
|
|
4111
|
+
/** V1 error format. */
|
|
4112
|
+
"$.xgafv"?: string;
|
|
4113
|
+
/** OAuth access token. */
|
|
4114
|
+
access_token?: string;
|
|
4115
|
+
/** Data format for response. */
|
|
4116
|
+
alt?: string;
|
|
4117
|
+
/** JSONP */
|
|
4118
|
+
callback?: string;
|
|
4119
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4120
|
+
fields?: string;
|
|
4121
|
+
/** 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. */
|
|
4122
|
+
key?: string;
|
|
4123
|
+
/**
|
|
4124
|
+
* Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser
|
|
4125
|
+
* ID
|
|
4126
|
+
*/
|
|
4127
|
+
name: string;
|
|
4128
|
+
/** OAuth 2.0 token for the current user. */
|
|
4129
|
+
oauth_token?: string;
|
|
4130
|
+
/** Returns response with indentations and line breaks. */
|
|
4131
|
+
prettyPrint?: boolean;
|
|
4132
|
+
/** 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. */
|
|
4133
|
+
quotaUser?: string;
|
|
4134
|
+
/** Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. */
|
|
4135
|
+
updateMask?: string;
|
|
4136
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4137
|
+
upload_protocol?: string;
|
|
4138
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4139
|
+
uploadType?: string;
|
|
4140
|
+
/** Request body */
|
|
4141
|
+
resource: GoogleAnalyticsAdminV1alphaSearchAds360Link;
|
|
4142
|
+
}): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
|
|
4143
|
+
patch(request: {
|
|
4144
|
+
/** V1 error format. */
|
|
4145
|
+
"$.xgafv"?: string;
|
|
4146
|
+
/** OAuth access token. */
|
|
4147
|
+
access_token?: string;
|
|
4148
|
+
/** Data format for response. */
|
|
4149
|
+
alt?: string;
|
|
4150
|
+
/** JSONP */
|
|
4151
|
+
callback?: string;
|
|
4152
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
4153
|
+
fields?: string;
|
|
4154
|
+
/** 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. */
|
|
4155
|
+
key?: string;
|
|
4156
|
+
/**
|
|
4157
|
+
* Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser
|
|
4158
|
+
* ID
|
|
4159
|
+
*/
|
|
4160
|
+
name: string;
|
|
4161
|
+
/** OAuth 2.0 token for the current user. */
|
|
4162
|
+
oauth_token?: string;
|
|
4163
|
+
/** Returns response with indentations and line breaks. */
|
|
4164
|
+
prettyPrint?: boolean;
|
|
4165
|
+
/** 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. */
|
|
4166
|
+
quotaUser?: string;
|
|
4167
|
+
/** Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. */
|
|
4168
|
+
updateMask?: string;
|
|
4169
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
4170
|
+
upload_protocol?: string;
|
|
4171
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
4172
|
+
uploadType?: string;
|
|
4173
|
+
},
|
|
4174
|
+
body: GoogleAnalyticsAdminV1alphaSearchAds360Link): Request<GoogleAnalyticsAdminV1alphaSearchAds360Link>;
|
|
4175
|
+
}
|
|
3934
4176
|
interface UserLinksResource {
|
|
3935
4177
|
/**
|
|
3936
4178
|
* Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link
|
|
@@ -5055,6 +5297,7 @@ declare namespace gapi.client {
|
|
|
5055
5297
|
displayVideo360AdvertiserLinks: DisplayVideo360AdvertiserLinksResource;
|
|
5056
5298
|
firebaseLinks: FirebaseLinksResource;
|
|
5057
5299
|
googleAdsLinks: GoogleAdsLinksResource;
|
|
5300
|
+
searchAds360Links: SearchAds360LinksResource;
|
|
5058
5301
|
userLinks: UserLinksResource;
|
|
5059
5302
|
}
|
|
5060
5303
|
|
package/package.json
CHANGED
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20220929
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -1045,6 +1045,45 @@ gapi.load('client', async () => {
|
|
|
1045
1045
|
name: "Test string",
|
|
1046
1046
|
updateTime: "Test string",
|
|
1047
1047
|
});
|
|
1048
|
+
/** Creates a SearchAds360Link. */
|
|
1049
|
+
await gapi.client.analyticsadmin.properties.searchAds360Links.create({
|
|
1050
|
+
parent: "Test string",
|
|
1051
|
+
}, {
|
|
1052
|
+
adsPersonalizationEnabled: true,
|
|
1053
|
+
advertiserDisplayName: "Test string",
|
|
1054
|
+
advertiserId: "Test string",
|
|
1055
|
+
campaignDataSharingEnabled: true,
|
|
1056
|
+
costDataSharingEnabled: true,
|
|
1057
|
+
name: "Test string",
|
|
1058
|
+
siteStatsSharingEnabled: true,
|
|
1059
|
+
});
|
|
1060
|
+
/** Deletes a SearchAds360Link on a property. */
|
|
1061
|
+
await gapi.client.analyticsadmin.properties.searchAds360Links.delete({
|
|
1062
|
+
name: "Test string",
|
|
1063
|
+
});
|
|
1064
|
+
/** Look up a single SearchAds360Link */
|
|
1065
|
+
await gapi.client.analyticsadmin.properties.searchAds360Links.get({
|
|
1066
|
+
name: "Test string",
|
|
1067
|
+
});
|
|
1068
|
+
/** Lists all SearchAds360Links on a property. */
|
|
1069
|
+
await gapi.client.analyticsadmin.properties.searchAds360Links.list({
|
|
1070
|
+
pageSize: 42,
|
|
1071
|
+
pageToken: "Test string",
|
|
1072
|
+
parent: "Test string",
|
|
1073
|
+
});
|
|
1074
|
+
/** Updates a SearchAds360Link on a property. */
|
|
1075
|
+
await gapi.client.analyticsadmin.properties.searchAds360Links.patch({
|
|
1076
|
+
name: "Test string",
|
|
1077
|
+
updateMask: "Test string",
|
|
1078
|
+
}, {
|
|
1079
|
+
adsPersonalizationEnabled: true,
|
|
1080
|
+
advertiserDisplayName: "Test string",
|
|
1081
|
+
advertiserId: "Test string",
|
|
1082
|
+
campaignDataSharingEnabled: true,
|
|
1083
|
+
costDataSharingEnabled: true,
|
|
1084
|
+
name: "Test string",
|
|
1085
|
+
siteStatsSharingEnabled: true,
|
|
1086
|
+
});
|
|
1048
1087
|
/**
|
|
1049
1088
|
* Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does
|
|
1050
1089
|
* not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them
|