Skip to content

Commit

Permalink
feat: add GetSubpropertyEventFilter, ListSubpropertyEventFilters …
Browse files Browse the repository at this point in the history 
…methods to the Admin API v1 alpha

feat: add the `default_conversion_value` field to the `ConversionEvent` type

fix!: remove values `PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK`, `PAID_AND_ORGANIC_CHANNELS_LINEAR`, `PAID_AND_ORGANIC_CHANNELS_POSITION_BASED`, `PAID_AND_ORGANIC_CHANNELS_TIME_DECAY` corresponding to the deprecated attribution models from the `ReportingAttributionModel` enum, as per announcement in https://support.google.com/analytics/answer/9164320#040623

docs: update the documentation for the `RunAccessReport` method

docs: update the documentation for `grouping_rule`, `system_defined` fields of the `ChannelGroup` type
PiperOrigin-RevId: 590895495
  • Loading branch information
Google APIs authored and Copybara-Service committed Dec 14, 2023
1 parent c8dbdd0 commit c329808
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 85 deletions.
5 changes: 1 addition & 4 deletions google/analytics/admin/v1alpha/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -175,14 +175,12 @@ py_gapic_library(
name = "admin_py_gapic",
srcs = [":admin_proto"],
grpc_service_config = "admin_grpc_service_config.json",
opt_args = ["autogen-snippets=False"],
rest_numeric_enums = True,
service_yaml = "analyticsadmin_v1alpha.yaml",
transport = "grpc+rest",
deps = [
],
opt_args = [
"autogen-snippets=False",
],
)

py_test(
Expand Down Expand Up @@ -336,7 +334,6 @@ load(

csharp_proto_library(
name = "admin_csharp_proto",
extra_opts = [],
deps = [":admin_proto"],
)

Expand Down
68 changes: 39 additions & 29 deletions google/analytics/admin/v1alpha/analytics_admin.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -842,8 +842,10 @@ service AnalyticsAdminService {
// records of each time a user reads Google Analytics reporting data. Access
// records are retained for up to 2 years.
//
// Data Access Reports can be requested for a property. The property must be
// in Google Analytics 360. This method is only available to Administrators.
// Data Access Reports can be requested for a property. Reports may be
// requested for any property, but dimensions that aren't related to quota can
// only be requested on Google Analytics 360 properties. This method is only
// available to Administrators.
//
// These data access records include GA4 UI Reporting, GA4 UI Explorations,
// GA4 Data API, and other products like Firebase & Admob that can retrieve
Expand Down Expand Up @@ -1341,45 +1343,53 @@ service AnalyticsAdminService {
};
}

// Deletes a subproperty event filter.
rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest)
returns (google.protobuf.Empty) {
// Creates a subproperty Event Filter.
rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest)
returns (SubpropertyEventFilter) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/subpropertyEventFilters/*}"
post: "/v1alpha/{parent=properties/*}/subpropertyEventFilters"
body: "subproperty_event_filter"
};
option (google.api.method_signature) = "name";
option (google.api.method_signature) = "parent,subproperty_event_filter";
}

// Lookup for a single subproperty Event Filter.
rpc GetSubpropertyEventFilter(GetSubpropertyEventFilterRequest)
returns (SubpropertyEventFilter) {
option (google.api.http) = {
get: "/v1alpha/{name=properties/*/subpropertyEventFilters/*}"
};
option (google.api.method_signature) = "name";
}

// List all subproperty Event Filters on a property.
rpc ListSubpropertyEventFilters(ListSubpropertyEventFiltersRequest)
returns (ListSubpropertyEventFiltersResponse) {
option (google.api.http) = {
get: "/v1alpha/{parent=properties/*}/subpropertyEventFilters"
};
option (google.api.method_signature) = "parent";
}



















// Creates a subproperty Event Filter.
rpc CreateSubpropertyEventFilter(CreateSubpropertyEventFilterRequest)
// Updates a subproperty Event Filter.
rpc UpdateSubpropertyEventFilter(UpdateSubpropertyEventFilterRequest)
returns (SubpropertyEventFilter) {
option (google.api.http) = {
post: "/v1alpha/{parent=properties/*}/subpropertyEventFilters"
patch: "/v1alpha/{subproperty_event_filter.name=properties/*/subpropertyEventFilters/*}"
body: "subproperty_event_filter"
};
option (google.api.method_signature) = "parent,subproperty_event_filter";
option (google.api.method_signature) =
"subproperty_event_filter,update_mask";
}

// Deletes a subproperty event filter.
rpc DeleteSubpropertyEventFilter(DeleteSubpropertyEventFilterRequest)
returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1alpha/{name=properties/*/subpropertyEventFilters/*}"
};
option (google.api.method_signature) = "name";
}
}

// The request for a Data Access Record Report.
Expand Down
7 changes: 4 additions & 3 deletions google/analytics/admin/v1alpha/channel_group.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,12 @@ message ChannelGroup {
// The description of the Channel Group. Max length of 256 characters.
string description = 3;

// Required. The grouping rules of channels. Maximum number of rules is 25.
// Required. The grouping rules of channels. Maximum number of rules is 50.
repeated GroupingRule grouping_rule = 4
[(google.api.field_behavior) = REQUIRED];

// Output only. Default Channel Group defined by Google, which cannot be
// updated.
// Output only. If true, then this channel group is the Default Channel Group
// predefined by Google Analytics. Display name and grouping rules cannot be
// updated for this channel group.
bool system_defined = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}
67 changes: 18 additions & 49 deletions google/analytics/admin/v1alpha/resources.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1157,6 +1157,20 @@ message ConversionEvent {
pattern: "properties/{property}/conversionEvents/{conversion_event}"
};

// Defines a default value/currency for a conversion event. Both value and
// currency must be provided.
message DefaultConversionValue {
// This value will be used to populate the value for all conversions
// of the specified event_name where the event "value" parameter is unset.
optional double value = 1;

// When a conversion event for this event_name has no set currency,
// this currency will be applied as the default. Must be in ISO 4217
// currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for
// more.
optional string currency_code = 2;
}

// The method by which conversions will be counted across multiple events
// within a session.
enum ConversionCountingMethod {
Expand Down Expand Up @@ -1200,6 +1214,10 @@ message ConversionEvent {
// `ONCE_PER_EVENT`.
ConversionCountingMethod counting_method = 6
[(google.api.field_behavior) = OPTIONAL];

// Optional. Defines a default value/currency for a conversion event.
optional DefaultConversionValue default_conversion_value = 7
[(google.api.field_behavior) = OPTIONAL];
}

// Settings values for Google Signals. This is a singleton resource.
Expand Down Expand Up @@ -1500,55 +1518,6 @@ message AttributionSettings {
// Previously CROSS_CHANNEL_LAST_CLICK
PAID_AND_ORGANIC_CHANNELS_LAST_CLICK = 2;

// Starting in June 2023, new properties can no longer use this model.
// See
// [Analytics
// Help](https://support.google.com/analytics/answer/9164320#040623)
// for more details.
// Starting in September 2023, we will sunset this model for all properties.
//
// Gives all credit for the conversion to the first channel that a customer
// clicked (or engaged view through for YouTube) before converting.
// Previously CROSS_CHANNEL_FIRST_CLICK
PAID_AND_ORGANIC_CHANNELS_FIRST_CLICK = 3;

// Starting in June 2023, new properties can no longer use this model.
// See
// [Analytics
// Help](https://support.google.com/analytics/answer/9164320#040623)
// for more details.
// Starting in September 2023, we will sunset this model for all properties.
//
// Distributes the credit for the conversion equally across all the channels
// a customer clicked (or engaged view through for YouTube) before
// converting.
// Previously CROSS_CHANNEL_LINEAR
PAID_AND_ORGANIC_CHANNELS_LINEAR = 4;

// Starting in June 2023, new properties can no longer use this model.
// See
// [Analytics
// Help](https://support.google.com/analytics/answer/9164320#040623)
// for more details.
// Starting in September 2023, we will sunset this model for all properties.
//
// Attributes 40% credit to the first and last interaction, and the
// remaining 20% credit is distributed evenly to the middle interactions.
// Previously CROSS_CHANNEL_POSITION_BASED
PAID_AND_ORGANIC_CHANNELS_POSITION_BASED = 5;

// Starting in June 2023, new properties can no longer use this model.
// See
// [Analytics
// Help](https://support.google.com/analytics/answer/9164320#040623)
// for more details.
// Starting in September 2023, we will sunset this model for all properties.
//
// Gives more credit to the touchpoints that happened closer in time to
// the conversion.
// Previously CROSS_CHANNEL_TIME_DECAY
PAID_AND_ORGANIC_CHANNELS_TIME_DECAY = 6;

// Attributes 100% of the conversion value to the last Google Paid channel
// that the customer clicked through before converting.
// Previously ADS_PREFERRED_LAST_CLICK
Expand Down

0 comments on commit c329808

Please sign in to comment.