Skip to content

Commit

Permalink
feat: [analytics-admin] add GetSearchAds360Link, `ListSearchAds360L…
Browse files Browse the repository at this point in the history
…inks`, `CreateSearchAds360Link`, `DeleteSearchAds360Link`, `UpdateSearchAds360Link` methods to the Admin API v1alpha (#3971)

* feat: add `GetSearchAds360Link`, `ListSearchAds360Links`, `CreateSearchAds360Link`, `DeleteSearchAds360Link`, `UpdateSearchAds360Link` methods to the Admin API v1alpha
feat: add `SetAutomatedGa4ConfigurationOptOut`, `FetchAutomatedGa4ConfigurationOptOut` methods to the Admin API v1alpha
feat: add `GetBigQueryLink`, `ListBigQueryLinks` methods to the Admin API v1alpha
feat: add `tokens_per_project_per_hour` field to `AccessQuota` type
feat: add `EXPANDED_DATA_SET`, `CHANNEL_GROUP` values to `ChangeHistoryResourceType` enum
feat: add `search_ads_360_link`, `expanded_data_set`, `bigquery_link` values to ChangeHistoryResource.resource oneof field
feat: add `BigQueryLink`, `SearchAds360Link` resource types to the Admin API v1alpha
fix: remove `LESS_THAN_OR_EQUAL`, `GREATER_THAN_OR_EQUAL` values from NumericFilter.Operation enum
fix: remove `PARTIAL_REGEXP` value from StringFilter.MatchType enum

PiperOrigin-RevId: 507839187

Source-Link: googleapis/googleapis@b221f5f

Source-Link: googleapis/googleapis-gen@96b7c43
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWFuYWx5dGljcy1hZG1pbi8uT3dsQm90LnlhbWwiLCJoIjoiOTZiN2M0M2ZjM2RjYTZjODc2N2E2ZDczMWI1MTZkYWY5YWQ1MDY2OCJ9

* 🦉 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: sofisl <[email protected]>
  • Loading branch information
3 people authored Feb 9, 2023
1 parent 9825fa9 commit 4834b82
Show file tree
Hide file tree
Showing 42 changed files with 32,458 additions and 18,578 deletions.
9 changes: 9 additions & 0 deletions packages/google-analytics-admin/README.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -306,8 +306,8 @@ message AccessQuota {
AccessQuotaStatus tokens_per_day = 1;

// Properties can use 50,000 tokens per hour. An API request consumes a single
// number of tokens, and that number is deducted from both the hourly and
// daily quotas.
// number of tokens, and that number is deducted from all of the hourly,
// daily, and per project hourly quotas.
AccessQuotaStatus tokens_per_hour = 2;

// Properties can use up to 50 concurrent requests.
Expand All @@ -316,6 +316,12 @@ message AccessQuota {
// Properties and cloud project pairs can have up to 50 server errors per
// hour.
AccessQuotaStatus server_errors_per_project_per_hour = 4;

// Properties can use up to 25% of their tokens per project per hour. This
// amounts to Analytics 360 Properties can use 12,500 tokens per project per
// hour. An API request consumes a single number of tokens, and that number is
// deducted from all of the hourly, daily, and per project hourly quotas.
AccessQuotaStatus tokens_per_project_per_hour = 5;
}

// Current state for a particular quota group.
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,6 @@ message AudienceDimensionOrMetricFilter {

// Full regular expression matches with the string value.
FULL_REGEXP = 5;

// Partial regular expression matches with the string value.
PARTIAL_REGEXP = 6;
}

// Required. The match type for the string filter.
Expand All @@ -84,7 +81,8 @@ message AudienceDimensionOrMetricFilter {

// A filter for a string dimension that matches a particular list of options.
message InListFilter {
// Required. The list of possible string values to match against. Must be non-empty.
// Required. The list of possible string values to match against. Must be
// non-empty.
repeated string values = 1 [(google.api.field_behavior) = REQUIRED];

// Optional. If true, the match is case-sensitive. If false, the match is
Expand Down Expand Up @@ -117,14 +115,8 @@ message AudienceDimensionOrMetricFilter {
// Less than.
LESS_THAN = 2;

// Less than or equal.
LESS_THAN_OR_EQUAL = 3;

// Greater than.
GREATER_THAN = 4;

// Greater than or equal.
GREATER_THAN_OR_EQUAL = 5;
}

// Required. The operation applied to a numeric filter.
Expand Down Expand Up @@ -167,18 +159,18 @@ message AudienceDimensionOrMetricFilter {
(google.api.field_behavior) = IMMUTABLE
];

// Optional. Indicates whether this filter needs dynamic evaluation or not. If set to
// true, users join the Audience if they ever met the condition (static
// Optional. Indicates whether this filter needs dynamic evaluation or not. If
// set to true, users join the Audience if they ever met the condition (static
// evaluation). If unset or set to false, user evaluation for an Audience is
// dynamic; users are added to an Audience when they meet the conditions and
// then removed when they no longer meet them.
//
// This can only be set when Audience scope is ACROSS_ALL_SESSIONS.
bool at_any_point_in_time = 6 [(google.api.field_behavior) = OPTIONAL];

// Optional. If set, specifies the time window for which to evaluate data in number of
// days. If not set, then audience data is evaluated against lifetime data
// (i.e., infinite time window).
// Optional. If set, specifies the time window for which to evaluate data in
// number of days. If not set, then audience data is evaluated against
// lifetime data (i.e., infinite time window).
//
// For example, if set to 1 day, only the current day's data is evaluated. The
// reference point is the current day when at_any_point_in_time is unset or
Expand All @@ -199,14 +191,15 @@ message AudienceEventFilter {
(google.api.field_behavior) = IMMUTABLE
];

// Optional. If specified, this filter matches events that match both the single
// event name and the parameter filter expressions. AudienceEventFilter
// Optional. If specified, this filter matches events that match both the
// single event name and the parameter filter expressions. AudienceEventFilter
// inside the parameter filter expression cannot be set (i.e., nested
// event filters are not supported). This should be a single and_group of
// dimension_or_metric_filter or not_expression; ANDs of ORs are not
// supported. Also, if it includes a filter for "eventCount", only that one
// will be considered; all the other filters will be ignored.
AudienceFilterExpression event_parameter_filter_expression = 2 [(google.api.field_behavior) = OPTIONAL];
AudienceFilterExpression event_parameter_filter_expression = 2
[(google.api.field_behavior) = OPTIONAL];
}

// A logical expression of Audience dimension, metric, or event filters.
Expand Down Expand Up @@ -252,7 +245,8 @@ message AudienceSimpleFilter {
(google.api.field_behavior) = IMMUTABLE
];

// Required. Immutable. A logical expression of Audience dimension, metric, or event filters.
// Required. Immutable. A logical expression of Audience dimension, metric, or
// event filters.
AudienceFilterExpression filter_expression = 2 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
Expand All @@ -271,21 +265,22 @@ message AudienceSequenceFilter {
(google.api.field_behavior) = IMMUTABLE
];

// Optional. If true, the event satisfying this step must be the very next event
// after the event satisfying the last step. If unset or false, this
// Optional. If true, the event satisfying this step must be the very next
// event after the event satisfying the last step. If unset or false, this
// step indirectly follows the prior step; for example, there may be
// events between the prior step and this step. It is ignored for the
// first step.
bool immediately_follows = 2 [(google.api.field_behavior) = OPTIONAL];

// Optional. When set, this step must be satisfied within the constraint_duration of
// the previous step (i.e., t[i] - t[i-1] <= constraint_duration). If not
// set, there is no duration requirement (the duration is effectively
// unlimited). It is ignored for the first step.
google.protobuf.Duration constraint_duration = 3 [(google.api.field_behavior) = OPTIONAL];
// Optional. When set, this step must be satisfied within the
// constraint_duration of the previous step (i.e., t[i] - t[i-1] <=
// constraint_duration). If not set, there is no duration requirement (the
// duration is effectively unlimited). It is ignored for the first step.
google.protobuf.Duration constraint_duration = 3
[(google.api.field_behavior) = OPTIONAL];

// Required. Immutable. A logical expression of Audience dimension, metric, or event filters in
// each step.
// Required. Immutable. A logical expression of Audience dimension, metric,
// or event filters in each step.
AudienceFilterExpression filter_expression = 4 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
Expand All @@ -299,11 +294,13 @@ message AudienceSequenceFilter {
];

// Optional. Defines the time period in which the whole sequence must occur.
google.protobuf.Duration sequence_maximum_duration = 2 [(google.api.field_behavior) = OPTIONAL];
google.protobuf.Duration sequence_maximum_duration = 2
[(google.api.field_behavior) = OPTIONAL];

// Required. An ordered sequence of steps. A user must complete each step in order to
// join the sequence filter.
repeated AudienceSequenceStep sequence_steps = 3 [(google.api.field_behavior) = REQUIRED];
// Required. An ordered sequence of steps. A user must complete each step in
// order to join the sequence filter.
repeated AudienceSequenceStep sequence_steps = 3
[(google.api.field_behavior) = REQUIRED];
}

// A clause for defining either a simple or sequence filter. A filter can be
Expand Down Expand Up @@ -389,28 +386,31 @@ message Audience {
// Required. The description of the Audience.
string description = 3 [(google.api.field_behavior) = REQUIRED];

// Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more
// than 540 days.
// Required. Immutable. The duration a user should stay in an Audience. It
// cannot be set to more than 540 days.
int32 membership_duration_days = 4 [
(google.api.field_behavior) = REQUIRED,
(google.api.field_behavior) = IMMUTABLE
];

// Output only. It is automatically set by GA to false if this is an NPA Audience and is
// excluded from ads personalization.
bool ads_personalization_enabled = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. It is automatically set by GA to false if this is an NPA
// Audience and is excluded from ads personalization.
bool ads_personalization_enabled = 5
[(google.api.field_behavior) = OUTPUT_ONLY];

// Optional. Specifies an event to log when a user joins the Audience. If not set, no
// event is logged when a user joins the Audience.
AudienceEventTrigger event_trigger = 6 [(google.api.field_behavior) = OPTIONAL];
// Optional. Specifies an event to log when a user joins the Audience. If not
// set, no event is logged when a user joins the Audience.
AudienceEventTrigger event_trigger = 6
[(google.api.field_behavior) = OPTIONAL];

// Immutable. Specifies how long an exclusion lasts for users that meet the exclusion
// filter. It is applied to all EXCLUDE filter clauses and is ignored when
// there is no EXCLUDE filter clause in the Audience.
AudienceExclusionDurationMode exclusion_duration_mode = 7 [(google.api.field_behavior) = IMMUTABLE];
// Immutable. Specifies how long an exclusion lasts for users that meet the
// exclusion filter. It is applied to all EXCLUDE filter clauses and is
// ignored when there is no EXCLUDE filter clause in the Audience.
AudienceExclusionDurationMode exclusion_duration_mode = 7
[(google.api.field_behavior) = IMMUTABLE];

// Required. Immutable. null Filter clauses that define the Audience. All clauses will be AND’ed
// together.
// Required. Immutable. Unordered list. Filter clauses that define the
// Audience. All clauses will be AND’ed together.
repeated AudienceFilterClause filter_clauses = 8 [
(google.api.field_behavior) = IMMUTABLE,
(google.api.field_behavior) = REQUIRED,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

package google.analytics.admin.v1alpha;

import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/protobuf/timestamp.proto";

option go_package = "google.golang.org/genproto/googleapis/analytics/admin/v1alpha;admin";
option java_multiple_files = true;
option java_outer_classname = "ExpandedDataSetProto";
option java_package = "com.google.analytics.admin.v1alpha";

// A specific filter for a single dimension
message ExpandedDataSetFilter {
// A filter for a string-type dimension that matches a particular pattern.
message StringFilter {
// The match type for the string filter.
enum MatchType {
// Unspecified
MATCH_TYPE_UNSPECIFIED = 0;

// Exact match of the string value.
EXACT = 1;

// Contains the string value.
CONTAINS = 2;
}

// Required. The match type for the string filter.
MatchType match_type = 1 [(google.api.field_behavior) = REQUIRED];

// Required. The string value to be matched against.
string value = 2 [(google.api.field_behavior) = REQUIRED];

// Optional. If true, the match is case-sensitive. If false, the match is
// case-insensitive.
// Must be true when match_type is EXACT.
// Must be false when match_type is CONTAINS.
bool case_sensitive = 3 [(google.api.field_behavior) = OPTIONAL];
}

// A filter for a string dimension that matches a particular list of options.
message InListFilter {
// Required. The list of possible string values to match against. Must be
// non-empty.
repeated string values = 1 [(google.api.field_behavior) = REQUIRED];

// Optional. If true, the match is case-sensitive. If false, the match is
// case-insensitive.
// Must be true.
bool case_sensitive = 2 [(google.api.field_behavior) = OPTIONAL];
}

// One of the above filters.
oneof one_filter {
// A filter for a string-type dimension that matches a particular pattern.
StringFilter string_filter = 2;

// A filter for a string dimension that matches a particular list of
// options.
InListFilter in_list_filter = 3;
}

// Required. The dimension name to filter.
string field_name = 1 [(google.api.field_behavior) = REQUIRED];
}

// A logical expression of EnhancedDataSet dimension filters.
message ExpandedDataSetFilterExpression {
// The expression applied to a filter.
oneof expr {
// A list of expressions to be AND’ed together. It must contain a
// ExpandedDataSetFilterExpression with either not_expression or
// dimension_filter. This must be set for the top level
// ExpandedDataSetFilterExpression.
ExpandedDataSetFilterExpressionList and_group = 1;

// A filter expression to be NOT'ed (i.e., inverted, complemented). It
// must include a dimension_filter. This cannot be set on the
// top level ExpandedDataSetFilterExpression.
ExpandedDataSetFilterExpression not_expression = 2;

// A filter on a single dimension. This cannot be set on the top
// level ExpandedDataSetFilterExpression.
ExpandedDataSetFilter filter = 3;
}
}

// A list of ExpandedDataSet filter expressions.
message ExpandedDataSetFilterExpressionList {
// A list of ExpandedDataSet filter expressions.
repeated ExpandedDataSetFilterExpression filter_expressions = 1;
}

// A resource message representing a GA4 ExpandedDataSet.
message ExpandedDataSet {
option (google.api.resource) = {
type: "analyticsadmin.googleapis.com/ExpandedDataSet"
pattern: "properties/{property}/expandedDataSets/{expanded_data_set}"
};

// Output only. The resource name for this ExpandedDataSet resource.
// Format: properties/{property_id}/expandedDataSets/{expanded_data_set}
string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];

// Required. The display name of the ExpandedDataSet.
// Max 200 chars.
string display_name = 2 [(google.api.field_behavior) = REQUIRED];

// Optional. The description of the ExpandedDataSet.
// Max 50 chars.
string description = 3 [(google.api.field_behavior) = OPTIONAL];

// Immutable. The list of dimensions included in the ExpandedDataSet.
// See the [API
// Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions)
// for the list of dimension names.
repeated string dimension_names = 4 [(google.api.field_behavior) = IMMUTABLE];

// Immutable. The list of metrics included in the ExpandedDataSet.
// See the [API
// Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
// for the list of dimension names.
repeated string metric_names = 5 [(google.api.field_behavior) = IMMUTABLE];

// Immutable. A logical expression of ExpandedDataSet filters applied to
// dimension included in the ExpandedDataSet. This filter is used to reduce
// the number of rows and thus the change of encountering `other row`.
ExpandedDataSetFilterExpression dimension_filter_expression = 6
[(google.api.field_behavior) = IMMUTABLE];

// Output only. Time when expanded data set began (or will begin) collecing
// data.
google.protobuf.Timestamp data_collection_start_time = 7
[(google.api.field_behavior) = OUTPUT_ONLY];
}
Loading

0 comments on commit 4834b82

Please sign in to comment.