Skip to content

Commit ba06e6c

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
fix!: rename the enterprise_daily_export_enabled field to fresh_daily_export_enabled in the BigQueryLink resource
feat: add `GetSKAdNetworkConversionValueSchema`, `CreateSKAdNetworkConversionValueSchema`, `DeleteSKAdNetworkConversionValueSchema`, `UpdateSKAdNetworkConversionValueSchema`, `ListSKAdNetworkConversionValueSchemas` methods to the Admin API v1 alpha feat: add the `skadnetwork_conversion_value_schema` field to the `ChangeHistoryResource.resource` oneof type feat: add the `SKADNETWORK_CONVERSION_VALUE_SCHEMA` option to the `ChangeHistoryResourceType` enum feat: add `CoarseValue`, `ConversionValues`, `EventMapping`, `SKAdNetworkConversionValueSchema` types PiperOrigin-RevId: 561159616
1 parent 8bc102a commit ba06e6c

4 files changed

Lines changed: 310 additions & 3 deletions

File tree

‎google/analytics/admin/v1alpha/BUILD.bazel‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -332,7 +332,6 @@ load(
332332

333333
csharp_proto_library(
334334
name = "admin_csharp_proto",
335-
extra_opts = [],
336335
deps = [":admin_proto"],
337336
)
338337

‎google/analytics/admin/v1alpha/analytics_admin.proto‎

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -440,6 +440,61 @@ service AnalyticsAdminService {
440440
};
441441
}
442442

443+
// Looks up a single SKAdNetworkConversionValueSchema.
444+
rpc GetSKAdNetworkConversionValueSchema(
445+
GetSKAdNetworkConversionValueSchemaRequest)
446+
returns (SKAdNetworkConversionValueSchema) {
447+
option (google.api.http) = {
448+
get: "/v1alpha/{name=properties/*/dataStreams/*/sKAdNetworkConversionValueSchema/*}"
449+
};
450+
option (google.api.method_signature) = "name";
451+
}
452+
453+
// Creates a SKAdNetworkConversionValueSchema.
454+
rpc CreateSKAdNetworkConversionValueSchema(
455+
CreateSKAdNetworkConversionValueSchemaRequest)
456+
returns (SKAdNetworkConversionValueSchema) {
457+
option (google.api.http) = {
458+
post: "/v1alpha/{parent=properties/*/dataStreams/*}/sKAdNetworkConversionValueSchema"
459+
body: "skadnetwork_conversion_value_schema"
460+
};
461+
option (google.api.method_signature) =
462+
"parent,skadnetwork_conversion_value_schema";
463+
}
464+
465+
// Deletes target SKAdNetworkConversionValueSchema.
466+
rpc DeleteSKAdNetworkConversionValueSchema(
467+
DeleteSKAdNetworkConversionValueSchemaRequest)
468+
returns (google.protobuf.Empty) {
469+
option (google.api.http) = {
470+
delete: "/v1alpha/{name=properties/*/dataStreams/*/sKAdNetworkConversionValueSchema/*}"
471+
};
472+
option (google.api.method_signature) = "name";
473+
}
474+
475+
// Updates a SKAdNetworkConversionValueSchema.
476+
rpc UpdateSKAdNetworkConversionValueSchema(
477+
UpdateSKAdNetworkConversionValueSchemaRequest)
478+
returns (SKAdNetworkConversionValueSchema) {
479+
option (google.api.http) = {
480+
patch: "/v1alpha/{skadnetwork_conversion_value_schema.name=properties/*/dataStreams/*/sKAdNetworkConversionValueSchema/*}"
481+
body: "skadnetwork_conversion_value_schema"
482+
};
483+
option (google.api.method_signature) =
484+
"skadnetwork_conversion_value_schema,update_mask";
485+
}
486+
487+
// Lists SKAdNetworkConversionValueSchema on a stream.
488+
// Properties can have at most one SKAdNetworkConversionValueSchema.
489+
rpc ListSKAdNetworkConversionValueSchemas(
490+
ListSKAdNetworkConversionValueSchemasRequest)
491+
returns (ListSKAdNetworkConversionValueSchemasResponse) {
492+
option (google.api.http) = {
493+
get: "/v1alpha/{parent=properties/*/dataStreams/*}/sKAdNetworkConversionValueSchema"
494+
};
495+
option (google.api.method_signature) = "parent";
496+
}
497+
443498
// Searches through all changes to an account or its children given the
444499
// specified set of filters.
445500
rpc SearchChangeHistoryEvents(SearchChangeHistoryEventsRequest)
@@ -2211,6 +2266,101 @@ message ListMeasurementProtocolSecretsResponse {
22112266
string next_page_token = 2;
22122267
}
22132268

2269+
// Request message for GetSKAdNetworkConversionValueSchema RPC.
2270+
message GetSKAdNetworkConversionValueSchemaRequest {
2271+
// Required. The resource name of SKAdNetwork conversion value schema to look
2272+
// up. Format:
2273+
// properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}
2274+
string name = 1 [
2275+
(google.api.field_behavior) = REQUIRED,
2276+
(google.api.resource_reference) = {
2277+
type: "analyticsadmin.googleapis.com/SKAdNetworkConversionValueSchema"
2278+
}
2279+
];
2280+
}
2281+
2282+
// Request message for CreateSKAdNetworkConversionValueSchema RPC.
2283+
message CreateSKAdNetworkConversionValueSchemaRequest {
2284+
// Required. The parent resource where this schema will be created.
2285+
// Format: properties/{property}/dataStreams/{dataStream}
2286+
string parent = 1 [
2287+
(google.api.field_behavior) = REQUIRED,
2288+
(google.api.resource_reference) = {
2289+
child_type: "analyticsadmin.googleapis.com/SKAdNetworkConversionValueSchema"
2290+
}
2291+
];
2292+
2293+
// Required. SKAdNetwork conversion value schema to create.
2294+
SKAdNetworkConversionValueSchema skadnetwork_conversion_value_schema = 2
2295+
[(google.api.field_behavior) = REQUIRED];
2296+
}
2297+
2298+
// Request message for DeleteSKAdNetworkConversionValueSchema RPC.
2299+
message DeleteSKAdNetworkConversionValueSchemaRequest {
2300+
// Required. The name of the SKAdNetworkConversionValueSchema to delete.
2301+
// Format:
2302+
// properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}
2303+
string name = 1 [
2304+
(google.api.field_behavior) = REQUIRED,
2305+
(google.api.resource_reference) = {
2306+
type: "analyticsadmin.googleapis.com/SKAdNetworkConversionValueSchema"
2307+
}
2308+
];
2309+
}
2310+
2311+
// Request message for UpdateSKAdNetworkConversionValueSchema RPC.
2312+
message UpdateSKAdNetworkConversionValueSchemaRequest {
2313+
// Required. SKAdNetwork conversion value schema to update.
2314+
SKAdNetworkConversionValueSchema skadnetwork_conversion_value_schema = 1
2315+
[(google.api.field_behavior) = REQUIRED];
2316+
2317+
// Required. The list of fields to be updated. Omitted fields will not be
2318+
// updated.
2319+
google.protobuf.FieldMask update_mask = 2
2320+
[(google.api.field_behavior) = REQUIRED];
2321+
}
2322+
2323+
// Request message for ListSKAdNetworkConversionValueSchemas RPC
2324+
message ListSKAdNetworkConversionValueSchemasRequest {
2325+
// Required. Format:
2326+
// properties/{property_id}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
2327+
// Example: properties/1234/dataStreams/5678/sKAdNetworkConversionValueSchema
2328+
string parent = 1 [
2329+
(google.api.field_behavior) = REQUIRED,
2330+
(google.api.resource_reference) = {
2331+
child_type: "analyticsadmin.googleapis.com/SKAdNetworkConversionValueSchema"
2332+
}
2333+
];
2334+
2335+
// The maximum number of resources to return. The service may return
2336+
// fewer than this value, even if there are additional pages.
2337+
// If unspecified, at most 50 resources will be returned.
2338+
// The maximum value is 200; (higher values will be coerced to the maximum)
2339+
int32 page_size = 2;
2340+
2341+
// A page token, received from a previous
2342+
// `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the
2343+
// subsequent page. When paginating, all other parameters provided to
2344+
// `ListSKAdNetworkConversionValueSchema` must match the call that provided
2345+
// the page token.
2346+
string page_token = 3;
2347+
}
2348+
2349+
// Response message for ListSKAdNetworkConversionValueSchemas RPC
2350+
message ListSKAdNetworkConversionValueSchemasResponse {
2351+
// List of SKAdNetworkConversionValueSchemas. This will have at most one
2352+
// value.
2353+
repeated SKAdNetworkConversionValueSchema
2354+
skadnetwork_conversion_value_schemas = 1;
2355+
2356+
// A token, which can be sent as `page_token` to retrieve the next page.
2357+
// If this field is omitted, there are no subsequent pages.
2358+
// Currently, Google Analytics supports only one
2359+
// SKAdNetworkConversionValueSchema per dataStream, so this will never be
2360+
// populated.
2361+
string next_page_token = 2;
2362+
}
2363+
22142364
// Request message for GetGoogleSignalsSettings RPC
22152365
message GetGoogleSignalsSettingsRequest {
22162366
// Required. The name of the google signals settings to retrieve.

‎google/analytics/admin/v1alpha/analyticsadmin_v1alpha.yaml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,11 @@ authentication:
192192
canonical_scopes: |-
193193
https://www.googleapis.com/auth/analytics.edit,
194194
https://www.googleapis.com/auth/analytics.readonly
195+
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetSKAdNetworkConversionValueSchema
196+
oauth:
197+
canonical_scopes: |-
198+
https://www.googleapis.com/auth/analytics.edit,
199+
https://www.googleapis.com/auth/analytics.readonly
195200
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.GetSearchAds360Link
196201
oauth:
197202
canonical_scopes: |-
@@ -297,6 +302,11 @@ authentication:
297302
canonical_scopes: |-
298303
https://www.googleapis.com/auth/analytics.edit,
299304
https://www.googleapis.com/auth/analytics.readonly
305+
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListSKAdNetworkConversionValueSchemas
306+
oauth:
307+
canonical_scopes: |-
308+
https://www.googleapis.com/auth/analytics.edit,
309+
https://www.googleapis.com/auth/analytics.readonly
300310
- selector: google.analytics.admin.v1alpha.AnalyticsAdminService.ListSearchAds360Links
301311
oauth:
302312
canonical_scopes: |-

‎google/analytics/admin/v1alpha/resources.proto‎

Lines changed: 150 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,9 @@ enum ChangeHistoryResourceType {
216216
// EnhancedMeasurementSettings resource
217217
ENHANCED_MEASUREMENT_SETTINGS = 24;
218218

219+
// SKAdNetworkConversionValueSchema resource
220+
SKADNETWORK_CONVERSION_VALUE_SCHEMA = 26;
221+
219222
// AdSenseLink resource
220223
ADSENSE_LINK = 27;
221224

@@ -313,6 +316,24 @@ enum PropertyType {
313316
PROPERTY_TYPE_ROLLUP = 3;
314317
}
315318

319+
// The coarse conversion value set on the updatePostbackConversionValue SDK call
320+
// when a ConversionValues.event_mappings conditions are satisfied. For
321+
// more information, see
322+
// [SKAdNetwork.CoarseConversionValue](https://developer.apple.com/documentation/storekit/skadnetwork/coarseconversionvalue).
323+
enum CoarseValue {
324+
// Coarse value not specified.
325+
COARSE_VALUE_UNSPECIFIED = 0;
326+
327+
// Coarse value of low.
328+
COARSE_VALUE_LOW = 1;
329+
330+
// Coarse value of medium.
331+
COARSE_VALUE_MEDIUM = 2;
332+
333+
// Coarse value of high.
334+
COARSE_VALUE_HIGH = 3;
335+
}
336+
316337
// A resource message representing a Google Analytics account.
317338
message Account {
318339
option (google.api.resource) = {
@@ -776,6 +797,129 @@ message MeasurementProtocolSecret {
776797
string secret_value = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
777798
}
778799

800+
// SKAdNetwork conversion value schema of an iOS stream.
801+
message SKAdNetworkConversionValueSchema {
802+
option (google.api.resource) = {
803+
type: "analyticsadmin.googleapis.com/SKAdNetworkConversionValueSchema"
804+
pattern: "properties/{property}/dataStreams/{data_stream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}"
805+
};
806+
807+
// Output only. Resource name of the schema. This will be child of ONLY an iOS
808+
// stream, and there can be at most one such child under an iOS stream.
809+
// Format:
810+
// properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema
811+
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
812+
813+
// Required. The conversion value settings for the first postback window.
814+
// These differ from values for postback window two and three in that they
815+
// contain a "Fine" grained conversion value (a numeric value).
816+
//
817+
// Conversion values for this postback window must be set. The other windows
818+
// are optional and may inherit this window's settings if unset or disabled.
819+
PostbackWindow postback_window_one = 2
820+
[(google.api.field_behavior) = REQUIRED];
821+
822+
// The conversion value settings for the second postback window.
823+
//
824+
// This field should only be configured if there is a need to define different
825+
// conversion values for this postback window.
826+
//
827+
// If enable_postback_window_settings is set to false for this postback
828+
// window, the values from postback_window_one will be used.
829+
PostbackWindow postback_window_two = 3;
830+
831+
// The conversion value settings for the third postback window.
832+
//
833+
// This field should only be set if the user chose to define different
834+
// conversion values for this postback window. It is allowed to configure
835+
// window 3 without setting window 2. In case window 1 & 2 settings are set
836+
// and enable_postback_window_settings for this postback window is set to
837+
// false, the schema will inherit settings from postback_window_two.
838+
PostbackWindow postback_window_three = 4;
839+
840+
// If enabled, the GA SDK will set conversion values using this schema
841+
// definition, and schema will be exported to any Google Ads accounts linked
842+
// to this property. If disabled, the GA SDK will not automatically set
843+
// conversion values, and also the schema will not be exported to Ads.
844+
bool apply_conversion_values = 5;
845+
}
846+
847+
// Settings for a SKAdNetwork conversion postback window.
848+
message PostbackWindow {
849+
// Ordering of the repeated field will be used to prioritize the conversion
850+
// value settings. Lower indexed entries are prioritized higher. The first
851+
// conversion value setting that evaluates to true will be selected. It must
852+
// have at least one entry if enable_postback_window_settings is set to
853+
// true. It can have maximum of 128 entries.
854+
repeated ConversionValues conversion_values = 1;
855+
856+
// If enable_postback_window_settings is true, conversion_values
857+
// must be populated and will be used for determining when and how to set the
858+
// Conversion Value on a client device and exporting schema to linked Ads
859+
// accounts. If false, the settings are not used, but are retained in case
860+
// they may be used in the future. This must always be true for
861+
// postback_window_one.
862+
bool postback_window_settings_enabled = 2;
863+
}
864+
865+
// Conversion value settings for a postback window for SKAdNetwork conversion
866+
// value schema.
867+
message ConversionValues {
868+
// Display name of the SKAdNetwork conversion value.
869+
// The max allowed display name length is 50 UTF-16 code units.
870+
string display_name = 1;
871+
872+
// The fine-grained conversion value. This is applicable only to the first
873+
// postback window. Its valid values are [0,63], both inclusive. It must be
874+
// set for postback window 1, and must not be set for postback window 2 & 3.
875+
// This value is not guaranteed to be unique.
876+
//
877+
// If the configuration for the first postback window is re-used for second or
878+
// third postback windows this field has no effect.
879+
optional int32 fine_value = 2;
880+
881+
// Required. A coarse grained conversion value.
882+
//
883+
// This value is not guaranteed to be unique.
884+
CoarseValue coarse_value = 3 [(google.api.field_behavior) = REQUIRED];
885+
886+
// Event conditions that must be met for this Conversion Value to be achieved.
887+
// The conditions in this list are ANDed together. It must have minimum of 1
888+
// entry and maximum of 3 entries, if the postback window is enabled.
889+
repeated EventMapping event_mappings = 4;
890+
891+
// If true, the SDK should lock to this conversion value for the current
892+
// postback window.
893+
bool lock_enabled = 5;
894+
}
895+
896+
// Event setting conditions to match an event.
897+
message EventMapping {
898+
// Required. Name of the GA4 event. It must always be set.
899+
// The max allowed display name length is 40 UTF-16 code units.
900+
string event_name = 1 [(google.api.field_behavior) = REQUIRED];
901+
902+
// At least one of the following four min/max values must be set. The
903+
// values set will be ANDed together to qualify an event.
904+
// The minimum number of times the event occurred. If not set, minimum event
905+
// count won't be checked.
906+
optional int64 min_event_count = 2;
907+
908+
// The maximum number of times the event occurred. If not set, maximum event
909+
// count won't be checked.
910+
optional int64 max_event_count = 3;
911+
912+
// The minimum revenue generated due to the event. Revenue currency will be
913+
// defined at the property level. If not set, minimum event value won't be
914+
// checked.
915+
optional double min_event_value = 4;
916+
917+
// The maximum revenue generated due to the event. Revenue currency will be
918+
// defined at the property level. If not set, maximum event value won't be
919+
// checked.
920+
optional double max_event_value = 5;
921+
}
922+
779923
// A set of changes within a Google Analytics account or its child properties
780924
// that resulted from the same cause. Common causes would be updates made in the
781925
// Google Analytics UI, changes from customer support, or automatic Google
@@ -870,6 +1014,10 @@ message ChangeHistoryChange {
8701014
// A snapshot of EnhancedMeasurementSettings resource in change history.
8711015
EnhancedMeasurementSettings enhanced_measurement_settings = 24;
8721016

1017+
// A snapshot of SKAdNetworkConversionValueSchema resource in change
1018+
// history.
1019+
SKAdNetworkConversionValueSchema skadnetwork_conversion_value_schema = 26;
1020+
8731021
// A snapshot of an AdSenseLink resource in change history.
8741022
AdSenseLink adsense_link = 27;
8751023

@@ -1579,8 +1727,8 @@ message BigQueryLink {
15791727
// If set true, enables streaming export to the linked Google Cloud project.
15801728
bool streaming_export_enabled = 5;
15811729

1582-
// If set true, enables enterprise export to the linked Google Cloud project.
1583-
bool enterprise_export_enabled = 9;
1730+
// If set true, enables fresh daily export to the linked Google Cloud project.
1731+
bool fresh_daily_export_enabled = 9;
15841732

15851733
// If set true, exported data will include advertising identifiers for mobile
15861734
// app streams.

0 commit comments

Comments
 (0)