Skip to content

Commit 2032c33

Browse files
Google APIscopybara-github
authored andcommitted
fix!: remove the SetAutomatedGa4ConfigurationOptOut method
fix!: remove the `FetchAutomatedGa4ConfigurationOptOut` method fix!: remove the `CreateConnectedSiteTag` method fix!: remove the `DeleteConnectedSiteTag` method fix!: remove the `ListConnectedSiteTags` method fix!: remove the `FetchConnectedGa4Property` method feat: add the `GetReportingIdentitySettings` method fix!: remove the `SetAutomatedGa4ConfigurationOptOutRequest` resource fix!: remove the `SetAutomatedGa4ConfigurationOptOutResponse` resource fix!: remove the `FetchAutomatedGa4ConfigurationOptOutRequest` resource fix!: remove the `FetchAutomatedGa4ConfigurationOptOutResponse` resource fix!: remove the `CreateConnectedSiteTagRequest` resource fix!: remove the `CreateConnectedSiteTagResponse` resource fix!: remove the `DeleteConnectedSiteTagRequest` resource fix!: remove the `ListConnectedSiteTagsRequest` resource fix!: remove the `ListConnectedSiteTagsResponse` resource fix!: remove the `FetchConnectedGa4PropertyRequest` resource fix!: remove the `FetchConnectedGa4PropertyResponse` resource docs: provide additional guidelines for the `user_provided_data` field in the `SubmitUserDeletionRequest` resource feat: add the `GetReportingIdentitySettingsRequest` resource feat: add the `REPORTING_IDENTITY_SETTINGS` resource type to the `ChangeHistoryResourceType` enum feat: add reporting_identity_settings` fields to the `ChangeHistoryResource` resource fix!: remove the `ConnectedSiteTag` resource feat: add the `ReportingIdentitySettings` resource PiperOrigin-RevId: 796959165
1 parent 2e51d4d commit 2032c33

File tree

3 files changed

+97
-208
lines changed

3 files changed

+97
-208
lines changed

google/analytics/admin/v1alpha/analytics_admin.proto

Lines changed: 42 additions & 175 deletions
Original file line numberDiff line numberDiff line change
@@ -1132,30 +1132,6 @@ service AnalyticsAdminService {
11321132
option (google.api.method_signature) = "name";
11331133
}
11341134

1135-
// Sets the opt out status for the automated GA4 setup process for a UA
1136-
// property.
1137-
// Note: this has no effect on GA4 property.
1138-
rpc SetAutomatedGa4ConfigurationOptOut(
1139-
SetAutomatedGa4ConfigurationOptOutRequest)
1140-
returns (SetAutomatedGa4ConfigurationOptOutResponse) {
1141-
option (google.api.http) = {
1142-
post: "/v1alpha/properties:setAutomatedGa4ConfigurationOptOut"
1143-
body: "*"
1144-
};
1145-
}
1146-
1147-
// Fetches the opt out status for the automated GA4 setup process for a UA
1148-
// property.
1149-
// Note: this has no effect on GA4 property.
1150-
rpc FetchAutomatedGa4ConfigurationOptOut(
1151-
FetchAutomatedGa4ConfigurationOptOutRequest)
1152-
returns (FetchAutomatedGa4ConfigurationOptOutResponse) {
1153-
option (google.api.http) = {
1154-
post: "/v1alpha/properties:fetchAutomatedGa4ConfigurationOptOut"
1155-
body: "*"
1156-
};
1157-
}
1158-
11591135
// Creates a BigQueryLink.
11601136
rpc CreateBigQueryLink(CreateBigQueryLinkRequest) returns (BigQueryLink) {
11611137
option (google.api.http) = {
@@ -1225,47 +1201,6 @@ service AnalyticsAdminService {
12251201
"enhanced_measurement_settings,update_mask";
12261202
}
12271203

1228-
// Creates a connected site tag for a Universal Analytics property. You can
1229-
// create a maximum of 20 connected site tags per property.
1230-
// Note: This API cannot be used on GA4 properties.
1231-
rpc CreateConnectedSiteTag(CreateConnectedSiteTagRequest)
1232-
returns (CreateConnectedSiteTagResponse) {
1233-
option (google.api.http) = {
1234-
post: "/v1alpha/properties:createConnectedSiteTag"
1235-
body: "*"
1236-
};
1237-
}
1238-
1239-
// Deletes a connected site tag for a Universal Analytics property.
1240-
// Note: this has no effect on GA4 properties.
1241-
rpc DeleteConnectedSiteTag(DeleteConnectedSiteTagRequest)
1242-
returns (google.protobuf.Empty) {
1243-
option (google.api.http) = {
1244-
post: "/v1alpha/properties:deleteConnectedSiteTag"
1245-
body: "*"
1246-
};
1247-
}
1248-
1249-
// Lists the connected site tags for a Universal Analytics property. A maximum
1250-
// of 20 connected site tags will be returned. Note: this has no effect on GA4
1251-
// property.
1252-
rpc ListConnectedSiteTags(ListConnectedSiteTagsRequest)
1253-
returns (ListConnectedSiteTagsResponse) {
1254-
option (google.api.http) = {
1255-
post: "/v1alpha/properties:listConnectedSiteTags"
1256-
body: "*"
1257-
};
1258-
}
1259-
1260-
// Given a specified UA property, looks up the GA4 property connected to it.
1261-
// Note: this cannot be used with GA4 properties.
1262-
rpc FetchConnectedGa4Property(FetchConnectedGa4PropertyRequest)
1263-
returns (FetchConnectedGa4PropertyResponse) {
1264-
option (google.api.http) = {
1265-
get: "/v1alpha/properties:fetchConnectedGa4Property"
1266-
};
1267-
}
1268-
12691204
// Looks up a single AdSenseLink.
12701205
rpc GetAdSenseLink(GetAdSenseLinkRequest) returns (AdSenseLink) {
12711206
option (google.api.http) = {
@@ -1638,7 +1573,7 @@ service AnalyticsAdminService {
16381573
option (google.api.method_signature) = "name";
16391574
}
16401575

1641-
// List all Subproperty Sync Configs on a property.
1576+
// List all `SubpropertySyncConfig` resources for a property.
16421577
rpc ListSubpropertySyncConfigs(ListSubpropertySyncConfigsRequest)
16431578
returns (ListSubpropertySyncConfigsResponse) {
16441579
option (google.api.http) = {
@@ -1647,7 +1582,7 @@ service AnalyticsAdminService {
16471582
option (google.api.method_signature) = "parent";
16481583
}
16491584

1650-
// Updates a Subproperty Sync Config.
1585+
// Updates a `SubpropertySyncConfig`.
16511586
rpc UpdateSubpropertySyncConfig(UpdateSubpropertySyncConfigRequest)
16521587
returns (SubpropertySyncConfig) {
16531588
option (google.api.http) = {
@@ -1658,14 +1593,23 @@ service AnalyticsAdminService {
16581593
"subproperty_sync_config,update_mask";
16591594
}
16601595

1661-
// Lookup for a single Subproperty Sync Config.
1596+
// Lookup for a single `SubpropertySyncConfig`.
16621597
rpc GetSubpropertySyncConfig(GetSubpropertySyncConfigRequest)
16631598
returns (SubpropertySyncConfig) {
16641599
option (google.api.http) = {
16651600
get: "/v1alpha/{name=properties/*/subpropertySyncConfigs/*}"
16661601
};
16671602
option (google.api.method_signature) = "name";
16681603
}
1604+
1605+
// Returns the singleton data retention settings for this property.
1606+
rpc GetReportingIdentitySettings(GetReportingIdentitySettingsRequest)
1607+
returns (ReportingIdentitySettings) {
1608+
option (google.api.http) = {
1609+
get: "/v1alpha/{name=properties/*/reportingIdentitySettings}"
1610+
};
1611+
option (google.api.method_signature) = "name";
1612+
}
16691613
}
16701614

16711615
// The request for a Data Access Record Report.
@@ -3782,38 +3726,6 @@ message ListChannelGroupsResponse {
37823726
string next_page_token = 2;
37833727
}
37843728

3785-
// Request for setting the opt out status for the automated GA4 setup process.
3786-
message SetAutomatedGa4ConfigurationOptOutRequest {
3787-
// Required. The UA property to set the opt out status. Note this request uses
3788-
// the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
3789-
// Format: properties/{internalWebPropertyId}
3790-
// Example: properties/1234
3791-
string property = 1 [(google.api.field_behavior) = REQUIRED];
3792-
3793-
// The status to set.
3794-
bool opt_out = 2;
3795-
}
3796-
3797-
// Response message for setting the opt out status for the automated GA4 setup
3798-
// process.
3799-
message SetAutomatedGa4ConfigurationOptOutResponse {}
3800-
3801-
// Request for fetching the opt out status for the automated GA4 setup process.
3802-
message FetchAutomatedGa4ConfigurationOptOutRequest {
3803-
// Required. The UA property to get the opt out status. Note this request uses
3804-
// the internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
3805-
// Format: properties/{internalWebPropertyId}
3806-
// Example: properties/1234
3807-
string property = 1 [(google.api.field_behavior) = REQUIRED];
3808-
}
3809-
3810-
// Response message for fetching the opt out status for the automated GA4 setup
3811-
// process.
3812-
message FetchAutomatedGa4ConfigurationOptOutResponse {
3813-
// The opt out status for the UA property.
3814-
bool opt_out = 1;
3815-
}
3816-
38173729
// Request message for CreateBigQueryLink RPC.
38183730
message CreateBigQueryLinkRequest {
38193731
// Required. Example format: properties/1234
@@ -3960,51 +3872,6 @@ message UpdateDataRedactionSettingsRequest {
39603872
[(google.api.field_behavior) = REQUIRED];
39613873
}
39623874

3963-
// Request message for CreateConnectedSiteTag RPC.
3964-
message CreateConnectedSiteTagRequest {
3965-
// The Universal Analytics property to create connected site tags for.
3966-
// This API does not support GA4 properties.
3967-
// Format: properties/{universalAnalyticsPropertyId}
3968-
// Example: properties/1234
3969-
string property = 1;
3970-
3971-
// Required. The tag to add to the Universal Analytics property
3972-
ConnectedSiteTag connected_site_tag = 2
3973-
[(google.api.field_behavior) = REQUIRED];
3974-
}
3975-
3976-
// Response message for CreateConnectedSiteTag RPC.
3977-
message CreateConnectedSiteTagResponse {}
3978-
3979-
// Request message for DeleteConnectedSiteTag RPC.
3980-
message DeleteConnectedSiteTagRequest {
3981-
// The Universal Analytics property to delete connected site tags for.
3982-
// This API does not support GA4 properties.
3983-
// Format: properties/{universalAnalyticsPropertyId}
3984-
// Example: properties/1234
3985-
string property = 1;
3986-
3987-
// Tag ID to forward events to. Also known as the Measurement ID, or the
3988-
// "G-ID" (For example: G-12345).
3989-
string tag_id = 2;
3990-
}
3991-
3992-
// Request message for ListConnectedSiteTags RPC.
3993-
message ListConnectedSiteTagsRequest {
3994-
// The Universal Analytics property to fetch connected site tags for.
3995-
// This does not work on GA4 properties. A maximum of 20 connected site tags
3996-
// will be returned.
3997-
// Example Format: `properties/1234`
3998-
string property = 1;
3999-
}
4000-
4001-
// Response message for ListConnectedSiteTags RPC.
4002-
message ListConnectedSiteTagsResponse {
4003-
// The site tags for the Universal Analytics property. A maximum of 20
4004-
// connected site tags will be returned.
4005-
repeated ConnectedSiteTag connected_site_tags = 1;
4006-
}
4007-
40083875
// Request message to be passed to CreateAdSenseLink method.
40093876
message CreateAdSenseLinkRequest {
40103877
// Required. The property for which to create an AdSense Link.
@@ -4082,32 +3949,6 @@ message ListAdSenseLinksResponse {
40823949
string next_page_token = 2;
40833950
}
40843951

4085-
// Request for looking up GA4 property connected to a UA property.
4086-
message FetchConnectedGa4PropertyRequest {
4087-
// Required. The UA property for which to look up the connected GA4 property.
4088-
// Note this request uses the
4089-
// internal property ID, not the tracking ID of the form UA-XXXXXX-YY.
4090-
// Format: properties/{internal_web_property_id}
4091-
// Example: properties/1234
4092-
string property = 1 [
4093-
(google.api.field_behavior) = REQUIRED,
4094-
(google.api.resource_reference) = {
4095-
type: "analyticsadmin.googleapis.com/Property"
4096-
}
4097-
];
4098-
}
4099-
4100-
// Response for looking up GA4 property connected to a UA property.
4101-
message FetchConnectedGa4PropertyResponse {
4102-
// The GA4 property connected to the UA property. An empty string is returned
4103-
// when there is no connected GA4 property.
4104-
// Format: properties/{property_id}
4105-
// Example: properties/1234
4106-
string property = 1 [(google.api.resource_reference) = {
4107-
type: "analyticsadmin.googleapis.com/Property"
4108-
}];
4109-
}
4110-
41113952
// Request message for CreateEventCreateRule RPC.
41123953
message CreateEventCreateRuleRequest {
41133954
// Required. Example format: properties/123/dataStreams/456
@@ -4673,8 +4514,20 @@ message SubmitUserDeletionRequest {
46734514
// ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId).
46744515
string app_instance_id = 4;
46754516

4676-
// The un-hashed, unencrypted, [user-provided
4677-
// data](https://support.google.com/analytics/answer/14077171).
4517+
// [User-provided
4518+
// data](https://support.google.com/analytics/answer/14077171). May contain
4519+
// either one email address or one phone number.
4520+
//
4521+
// Email addresses should be normalized as such:
4522+
//
4523+
// * lowercase
4524+
// * remove periods before @ for gmail.com/googlemail.com addresses
4525+
// * remove all spaces
4526+
//
4527+
// Phone numbers should be normalized as such:
4528+
//
4529+
// * remove all non digit characters
4530+
// * add + prefix
46784531
string user_provided_data = 5;
46794532
}
46804533

@@ -4737,7 +4590,7 @@ message ListSubpropertySyncConfigsRequest {
47374590

47384591
// Response message for ListSubpropertySyncConfigs RPC.
47394592
message ListSubpropertySyncConfigsResponse {
4740-
// List of Subproperty Sync Configs.
4593+
// List of `SubpropertySyncConfig` resources.
47414594
repeated SubpropertySyncConfig subproperty_sync_configs = 1;
47424595

47434596
// A token, which can be sent as `page_token` to retrieve the next page. If
@@ -4747,7 +4600,7 @@ message ListSubpropertySyncConfigsResponse {
47474600

47484601
// Request message for UpdateSubpropertySyncConfig RPC.
47494602
message UpdateSubpropertySyncConfigRequest {
4750-
// Required. The SubpropertySyncConfig to update.
4603+
// Required. The `SubpropertySyncConfig` to update.
47514604
SubpropertySyncConfig subproperty_sync_config = 1
47524605
[(google.api.field_behavior) = REQUIRED];
47534606

@@ -4758,3 +4611,17 @@ message UpdateSubpropertySyncConfigRequest {
47584611
google.protobuf.FieldMask update_mask = 2
47594612
[(google.api.field_behavior) = OPTIONAL];
47604613
}
4614+
4615+
// Request message for GetReportingIdentitySettings RPC.
4616+
message GetReportingIdentitySettingsRequest {
4617+
// Required. The name of the settings to lookup.
4618+
// Format:
4619+
// properties/{property}/reportingIdentitySettings
4620+
// Example: "properties/1000/reportingIdentitySettings"
4621+
string name = 1 [
4622+
(google.api.field_behavior) = REQUIRED,
4623+
(google.api.resource_reference) = {
4624+
type: "analyticsadmin.googleapis.com/ReportingIdentitySettings"
4625+
}
4626+
];
4627+
}

google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -47,16 +47,6 @@ authentication:
4747
oauth:
4848
canonical_scopes: |-
4949
https://www.googleapis.com/auth/analytics.manage.users
50-
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.FetchAutomatedGa4ConfigurationOptOut
51-
oauth:
52-
canonical_scopes: |-
53-
https://www.googleapis.com/auth/analytics.edit,
54-
https://www.googleapis.com/auth/analytics.readonly
55-
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.FetchConnectedGa4Property
56-
oauth:
57-
canonical_scopes: |-
58-
https://www.googleapis.com/auth/analytics.edit,
59-
https://www.googleapis.com/auth/analytics.readonly
6050
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetAccessBinding
6151
oauth:
6252
canonical_scopes: |-
@@ -192,6 +182,11 @@ authentication:
192182
canonical_scopes: |-
193183
https://www.googleapis.com/auth/analytics.edit,
194184
https://www.googleapis.com/auth/analytics.readonly
185+
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetReportingIdentitySettings
186+
oauth:
187+
canonical_scopes: |-
188+
https://www.googleapis.com/auth/analytics.edit,
189+
https://www.googleapis.com/auth/analytics.readonly
195190
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetRollupPropertySourceLink
196191
oauth:
197192
canonical_scopes: |-
@@ -257,11 +252,6 @@ authentication:
257252
canonical_scopes: |-
258253
https://www.googleapis.com/auth/analytics.edit,
259254
https://www.googleapis.com/auth/analytics.readonly
260-
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListConnectedSiteTags
261-
oauth:
262-
canonical_scopes: |-
263-
https://www.googleapis.com/auth/analytics.edit,
264-
https://www.googleapis.com/auth/analytics.readonly
265255
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListConversionEvents
266256
oauth:
267257
canonical_scopes: |-

0 commit comments

Comments
 (0)