Skip to content

Commit

Permalink
feat: [analytics-admin] add GetKeyEvent, CreateKeyEvent, `ListKey…
Browse files Browse the repository at this point in the history
…Events`, `UpdateKeyEvent`, and `DeleteKeyEvent` methods (#5597)

* feat: add `GetKeyEvent`, `CreateKeyEvent`, `ListKeyEvents`, `UpdateKeyEvent`, and `DeleteKeyEvent` methods
feat: mark `GetConversionEvent`, `CreateConversionEvent`, `ListConversionEvents`, `UpdateConversionEvent`, and `DeleteConversionEvent` methods as deprecated
docs: add deprecation comment to `GetConversionEvent`, `CreateConversionEvent`, `ListConversionEvents`, `UpdateConversionEvent`, and `DeleteConversionEvent` methods
docs: improve comment formatting of the `parent` field in `CreateFirebaseLinkRequest` and `ListFirebaseLinksRequest`
docs: improve comment formatting of the `name` field in `DeleteFirebaseLinkRequest`, `GetGlobalSiteTagRequest`, and `GetDataSharingSettingsRequest`
docs: improve comment formatting of `account` and `property` fields in `SearchChangeHistoryEventsRequest`
feat: add the `create_time` field to the `Audience` resource
feat: add the `primary` field to the `ChannelGroup` resource
feat: add `CreateBigQueryLink`, `UpdateBigQueryLink`, and `DeleteBigQueryLink` methods
feat: add the `dataset_location` field to the `BigQueryLink` resource
feat: add the `BIGQUERY_LINK` option to the `ChangeHistoryResourceType` enum
feat: add the `gmp_organization` field to the `Account` resource
fix!: Rename custom method `CreateSubpropertyRequest` to `ProvisionSubpropertyRequest`
feat: add `GetEventEditRule`, `CreateEventEditRule`, `ListEventEditRules`, `UpdateEventEditRule`, `DeleteEventEditRule`, and `ReorderEventEditRules` methods to the Admin API v1 alpha

PiperOrigin-RevId: 658468819

Source-Link: googleapis/googleapis@b479bc2

Source-Link: googleapis/googleapis-gen@f7eacec
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1hZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiZjdlYWNlYzQyZDNiZjM2MzE1OGQzM2QyNDIyNDE0OWE4N2U4OWY4YyJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Daniel Bankhead <[email protected]>
  • Loading branch information
3 people authored Aug 9, 2024
1 parent 8ba7182 commit 178789b
Show file tree
Hide file tree
Showing 36 changed files with 37,601 additions and 22,567 deletions.
15 changes: 15 additions & 0 deletions packages/google-analytics-admin/README.md

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package google.analytics.admin.v1alpha;
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";

option go_package = "cloud.google.com/go/analytics/admin/apiv1alpha/adminpb;adminpb";
option java_multiple_files = true;
Expand Down Expand Up @@ -421,4 +422,8 @@ message Audience {
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = UNORDERED_LIST
];

// Output only. Time when the Audience was created.
google.protobuf.Timestamp create_time = 9
[(google.api.field_behavior) = OUTPUT_ONLY];
}
Original file line number Diff line number Diff line change
Expand Up @@ -150,4 +150,12 @@ message ChannelGroup {
// 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];

// Optional. If true, this channel group will be used as the default channel
// group for reports. Only one channel group can be set as `primary` at any
// time. If the `primary` field gets set on a channel group, it will get unset
// on the previous primary channel group.
//
// The Google Analytics predefined channel group is the primary by default.
bool primary = 6 [(google.api.field_behavior) = OPTIONAL];
}
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,51 @@ message EventCreateRule {
repeated ParameterMutation parameter_mutations = 5;
}

// An Event Edit Rule defines conditions that will trigger the creation of an
// entirely new event based upon matched criteria of a source event. Additional
// mutations of the parameters from the source event can be defined.
//
// Unlike Event Create rules, Event Edit Rules are applied in their defined
// order.
//
// Event Edit rules can't be used to modify an event created from an Event
// Create rule.
message EventEditRule {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/EventEditRule"
pattern: "properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}"
plural: "eventEditRules"
singular: "eventEditRule"
};

// Identifier. Resource name for this EventEditRule resource.
// Format:
// properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}
string name = 1 [(google.api.field_behavior) = IDENTIFIER];

// Required. The display name of this event edit rule. Maximum of 255
// characters.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];

// Required. Conditions on the source event must match for this rule to be
// applied. Must have at least one condition, and can have up to 10 max.
repeated MatchingCondition event_conditions = 3
[(google.api.field_behavior) = REQUIRED];

// Required. Parameter mutations define parameter behavior on the new event,
// and are applied in order. A maximum of 20 mutations can be applied.
repeated ParameterMutation parameter_mutations = 4
[(google.api.field_behavior) = REQUIRED];

// Output only. The order for which this rule will be processed. Rules with an
// order value lower than this will be processed before this rule, rules with
// an order value higher than this will be processed after this rule. New
// event edit rules will be assigned an order value at the end of the order.
//
// This value does not apply to event create rules.
int64 processing_order = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
}

// Defines a condition for when an Event Edit or Event Creation rule applies to
// an event.
message MatchingCondition {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,10 @@ option go_package = "cloud.google.com/go/analytics/admin/apiv1alpha/adminpb;admi
option java_multiple_files = true;
option java_outer_classname = "ResourcesProto";
option java_package = "com.google.analytics.admin.v1alpha";
option (google.api.resource_definition) = {
type: "marketingplatformadmin.googleapis.com/Organization"
pattern: "organizations/{organization}"
};

// The category selected for this property, used for industry benchmarking.
enum IndustryCategory {
Expand Down Expand Up @@ -213,6 +217,9 @@ enum ChangeHistoryResourceType {
// ChannelGroup resource
CHANNEL_GROUP = 22;

// BigQuery link resource
BIGQUERY_LINK = 23;

// EnhancedMeasurementSettings resource
ENHANCED_MEASUREMENT_SETTINGS = 24;

Expand Down Expand Up @@ -369,6 +376,16 @@ message Account {
// Output only. Indicates whether this Account is soft-deleted or not. Deleted
// accounts are excluded from List results unless specifically requested.
bool deleted = 6 [(google.api.field_behavior) = OUTPUT_ONLY];

// 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}
string gmp_organization = 7 [
(google.api.field_behavior) = OUTPUT_ONLY,
(google.api.resource_reference) = {
type: "marketingplatformadmin.googleapis.com/Organization"
}
];
}

// A resource message representing a Google Analytics GA4 property.
Expand Down Expand Up @@ -1226,6 +1243,75 @@ message ConversionEvent {
[(google.api.field_behavior) = OPTIONAL];
}

// A key event in a Google Analytics property.
message KeyEvent {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/KeyEvent"
pattern: "properties/{property}/keyEvents/{key_event}"
plural: "keyEvents"
singular: "keyEvent"
};

// Defines a default value/currency for a key event.
message DefaultValue {
// Required. This will be used to populate the "value" parameter for all
// occurrences of this Key Event (specified by event_name) where that
// parameter is unset.
double numeric_value = 1 [(google.api.field_behavior) = REQUIRED];

// Required. When an occurrence of this Key Event (specified by 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 information.
string currency_code = 2 [(google.api.field_behavior) = REQUIRED];
}

// The method by which Key Events will be counted across multiple events
// within a session.
enum CountingMethod {
// Counting method not specified.
COUNTING_METHOD_UNSPECIFIED = 0;

// Each Event instance is considered a Key Event.
ONCE_PER_EVENT = 1;

// An Event instance is considered a Key Event at most once per session per
// user.
ONCE_PER_SESSION = 2;
}

// Output only. Resource name of this key event.
// Format: properties/{property}/keyEvents/{key_event}
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Immutable. The event name for this key event.
// Examples: 'click', 'purchase'
string event_name = 2 [(google.api.field_behavior) = IMMUTABLE];

// Output only. Time when this key event was created in the property.
google.protobuf.Timestamp create_time = 3
[(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. If set to true, this event can be deleted.
bool deletable = 4 [(google.api.field_behavior) = OUTPUT_ONLY];

// Output only. If set to true, this key event refers to a custom event. If
// set to false, this key event refers to a default event in GA. Default
// events typically have special meaning in GA. Default events are usually
// created for you by the GA system, but in some cases can be created by
// property admins. Custom events count towards the maximum number of
// custom key events that may be created per property.
bool custom = 5 [(google.api.field_behavior) = OUTPUT_ONLY];

// Required. The method by which Key Events will be counted across multiple
// events within a session.
CountingMethod counting_method = 6 [(google.api.field_behavior) = REQUIRED];

// Optional. Defines a default value/currency for a key event.
DefaultValue default_value = 7 [(google.api.field_behavior) = OPTIONAL];
}

// Settings values for Google Signals. This is a singleton resource.
message GoogleSignalsSettings {
option (google.api.resource) = {
Expand Down Expand Up @@ -1765,6 +1851,14 @@ message BigQueryLink {

// The list of event names that will be excluded from exports.
repeated string excluded_events = 8;

// Required. Immutable. The geographic location where the created BigQuery
// dataset should reside. See https://cloud.google.com/bigquery/docs/locations
// for supported locations.
string dataset_location = 10 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = REQUIRED
];
}

// Singleton resource under a web DataStream, configuring measurement of
Expand Down
Loading

0 comments on commit 178789b

Please sign in to comment.