Enum value maps for AccessStringFilter_MatchType.
var (
AccessStringFilter_MatchType_name = map[int32]string{
0: "MATCH_TYPE_UNSPECIFIED",
1: "EXACT",
2: "BEGINS_WITH",
3: "ENDS_WITH",
4: "CONTAINS",
5: "FULL_REGEXP",
6: "PARTIAL_REGEXP",
}
AccessStringFilter_MatchType_value = map[string]int32{
"MATCH_TYPE_UNSPECIFIED": 0,
"EXACT": 1,
"BEGINS_WITH": 2,
"ENDS_WITH": 3,
"CONTAINS": 4,
"FULL_REGEXP": 5,
"PARTIAL_REGEXP": 6,
}
)
Enum value maps for AccessNumericFilter_Operation.
var (
AccessNumericFilter_Operation_name = map[int32]string{
0: "OPERATION_UNSPECIFIED",
1: "EQUAL",
2: "LESS_THAN",
3: "LESS_THAN_OR_EQUAL",
4: "GREATER_THAN",
5: "GREATER_THAN_OR_EQUAL",
}
AccessNumericFilter_Operation_value = map[string]int32{
"OPERATION_UNSPECIFIED": 0,
"EQUAL": 1,
"LESS_THAN": 2,
"LESS_THAN_OR_EQUAL": 3,
"GREATER_THAN": 4,
"GREATER_THAN_OR_EQUAL": 5,
}
)
Enum value maps for AccessOrderBy_DimensionOrderBy_OrderType.
var (
AccessOrderBy_DimensionOrderBy_OrderType_name = map[int32]string{
0: "ORDER_TYPE_UNSPECIFIED",
1: "ALPHANUMERIC",
2: "CASE_INSENSITIVE_ALPHANUMERIC",
3: "NUMERIC",
}
AccessOrderBy_DimensionOrderBy_OrderType_value = map[string]int32{
"ORDER_TYPE_UNSPECIFIED": 0,
"ALPHANUMERIC": 1,
"CASE_INSENSITIVE_ALPHANUMERIC": 2,
"NUMERIC": 3,
}
)
Enum value maps for IndustryCategory.
var (
IndustryCategory_name = map[int32]string{
0: "INDUSTRY_CATEGORY_UNSPECIFIED",
1: "AUTOMOTIVE",
2: "BUSINESS_AND_INDUSTRIAL_MARKETS",
3: "FINANCE",
4: "HEALTHCARE",
5: "TECHNOLOGY",
6: "TRAVEL",
7: "OTHER",
8: "ARTS_AND_ENTERTAINMENT",
9: "BEAUTY_AND_FITNESS",
10: "BOOKS_AND_LITERATURE",
11: "FOOD_AND_DRINK",
12: "GAMES",
13: "HOBBIES_AND_LEISURE",
14: "HOME_AND_GARDEN",
15: "INTERNET_AND_TELECOM",
16: "LAW_AND_GOVERNMENT",
17: "NEWS",
18: "ONLINE_COMMUNITIES",
19: "PEOPLE_AND_SOCIETY",
20: "PETS_AND_ANIMALS",
21: "REAL_ESTATE",
22: "REFERENCE",
23: "SCIENCE",
24: "SPORTS",
25: "JOBS_AND_EDUCATION",
26: "SHOPPING",
}
IndustryCategory_value = map[string]int32{
"INDUSTRY_CATEGORY_UNSPECIFIED": 0,
"AUTOMOTIVE": 1,
"BUSINESS_AND_INDUSTRIAL_MARKETS": 2,
"FINANCE": 3,
"HEALTHCARE": 4,
"TECHNOLOGY": 5,
"TRAVEL": 6,
"OTHER": 7,
"ARTS_AND_ENTERTAINMENT": 8,
"BEAUTY_AND_FITNESS": 9,
"BOOKS_AND_LITERATURE": 10,
"FOOD_AND_DRINK": 11,
"GAMES": 12,
"HOBBIES_AND_LEISURE": 13,
"HOME_AND_GARDEN": 14,
"INTERNET_AND_TELECOM": 15,
"LAW_AND_GOVERNMENT": 16,
"NEWS": 17,
"ONLINE_COMMUNITIES": 18,
"PEOPLE_AND_SOCIETY": 19,
"PETS_AND_ANIMALS": 20,
"REAL_ESTATE": 21,
"REFERENCE": 22,
"SCIENCE": 23,
"SPORTS": 24,
"JOBS_AND_EDUCATION": 25,
"SHOPPING": 26,
}
)
Enum value maps for ServiceLevel.
var (
ServiceLevel_name = map[int32]string{
0: "SERVICE_LEVEL_UNSPECIFIED",
1: "GOOGLE_ANALYTICS_STANDARD",
2: "GOOGLE_ANALYTICS_360",
}
ServiceLevel_value = map[string]int32{
"SERVICE_LEVEL_UNSPECIFIED": 0,
"GOOGLE_ANALYTICS_STANDARD": 1,
"GOOGLE_ANALYTICS_360": 2,
}
)
Enum value maps for ActorType.
var (
ActorType_name = map[int32]string{
0: "ACTOR_TYPE_UNSPECIFIED",
1: "USER",
2: "SYSTEM",
3: "SUPPORT",
}
ActorType_value = map[string]int32{
"ACTOR_TYPE_UNSPECIFIED": 0,
"USER": 1,
"SYSTEM": 2,
"SUPPORT": 3,
}
)
Enum value maps for ActionType.
var (
ActionType_name = map[int32]string{
0: "ACTION_TYPE_UNSPECIFIED",
1: "CREATED",
2: "UPDATED",
3: "DELETED",
}
ActionType_value = map[string]int32{
"ACTION_TYPE_UNSPECIFIED": 0,
"CREATED": 1,
"UPDATED": 2,
"DELETED": 3,
}
)
Enum value maps for ChangeHistoryResourceType.
var (
ChangeHistoryResourceType_name = map[int32]string{
0: "CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED",
1: "ACCOUNT",
2: "PROPERTY",
6: "FIREBASE_LINK",
7: "GOOGLE_ADS_LINK",
8: "GOOGLE_SIGNALS_SETTINGS",
9: "CONVERSION_EVENT",
10: "MEASUREMENT_PROTOCOL_SECRET",
13: "DATA_RETENTION_SETTINGS",
14: "DISPLAY_VIDEO_360_ADVERTISER_LINK",
15: "DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL",
18: "DATA_STREAM",
20: "ATTRIBUTION_SETTINGS",
}
ChangeHistoryResourceType_value = map[string]int32{
"CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED": 0,
"ACCOUNT": 1,
"PROPERTY": 2,
"FIREBASE_LINK": 6,
"GOOGLE_ADS_LINK": 7,
"GOOGLE_SIGNALS_SETTINGS": 8,
"CONVERSION_EVENT": 9,
"MEASUREMENT_PROTOCOL_SECRET": 10,
"DATA_RETENTION_SETTINGS": 13,
"DISPLAY_VIDEO_360_ADVERTISER_LINK": 14,
"DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL": 15,
"DATA_STREAM": 18,
"ATTRIBUTION_SETTINGS": 20,
}
)
Enum value maps for PropertyType.
var (
PropertyType_name = map[int32]string{
0: "PROPERTY_TYPE_UNSPECIFIED",
1: "PROPERTY_TYPE_ORDINARY",
2: "PROPERTY_TYPE_SUBPROPERTY",
3: "PROPERTY_TYPE_ROLLUP",
}
PropertyType_value = map[string]int32{
"PROPERTY_TYPE_UNSPECIFIED": 0,
"PROPERTY_TYPE_ORDINARY": 1,
"PROPERTY_TYPE_SUBPROPERTY": 2,
"PROPERTY_TYPE_ROLLUP": 3,
}
)
Enum value maps for DataStream_DataStreamType.
var (
DataStream_DataStreamType_name = map[int32]string{
0: "DATA_STREAM_TYPE_UNSPECIFIED",
1: "WEB_DATA_STREAM",
2: "ANDROID_APP_DATA_STREAM",
3: "IOS_APP_DATA_STREAM",
}
DataStream_DataStreamType_value = map[string]int32{
"DATA_STREAM_TYPE_UNSPECIFIED": 0,
"WEB_DATA_STREAM": 1,
"ANDROID_APP_DATA_STREAM": 2,
"IOS_APP_DATA_STREAM": 3,
}
)
Enum value maps for CustomDimension_DimensionScope.
var (
CustomDimension_DimensionScope_name = map[int32]string{
0: "DIMENSION_SCOPE_UNSPECIFIED",
1: "EVENT",
2: "USER",
}
CustomDimension_DimensionScope_value = map[string]int32{
"DIMENSION_SCOPE_UNSPECIFIED": 0,
"EVENT": 1,
"USER": 2,
}
)
Enum value maps for CustomMetric_MeasurementUnit.
var (
CustomMetric_MeasurementUnit_name = map[int32]string{
0: "MEASUREMENT_UNIT_UNSPECIFIED",
1: "STANDARD",
2: "CURRENCY",
3: "FEET",
4: "METERS",
5: "KILOMETERS",
6: "MILES",
7: "MILLISECONDS",
8: "SECONDS",
9: "MINUTES",
10: "HOURS",
}
CustomMetric_MeasurementUnit_value = map[string]int32{
"MEASUREMENT_UNIT_UNSPECIFIED": 0,
"STANDARD": 1,
"CURRENCY": 2,
"FEET": 3,
"METERS": 4,
"KILOMETERS": 5,
"MILES": 6,
"MILLISECONDS": 7,
"SECONDS": 8,
"MINUTES": 9,
"HOURS": 10,
}
)
Enum value maps for CustomMetric_MetricScope.
var (
CustomMetric_MetricScope_name = map[int32]string{
0: "METRIC_SCOPE_UNSPECIFIED",
1: "EVENT",
}
CustomMetric_MetricScope_value = map[string]int32{
"METRIC_SCOPE_UNSPECIFIED": 0,
"EVENT": 1,
}
)
Enum value maps for CustomMetric_RestrictedMetricType.
var (
CustomMetric_RestrictedMetricType_name = map[int32]string{
0: "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
1: "COST_DATA",
2: "REVENUE_DATA",
}
CustomMetric_RestrictedMetricType_value = map[string]int32{
"RESTRICTED_METRIC_TYPE_UNSPECIFIED": 0,
"COST_DATA": 1,
"REVENUE_DATA": 2,
}
)
Enum value maps for DataRetentionSettings_RetentionDuration.
var (
DataRetentionSettings_RetentionDuration_name = map[int32]string{
0: "RETENTION_DURATION_UNSPECIFIED",
1: "TWO_MONTHS",
3: "FOURTEEN_MONTHS",
4: "TWENTY_SIX_MONTHS",
5: "THIRTY_EIGHT_MONTHS",
6: "FIFTY_MONTHS",
}
DataRetentionSettings_RetentionDuration_value = map[string]int32{
"RETENTION_DURATION_UNSPECIFIED": 0,
"TWO_MONTHS": 1,
"FOURTEEN_MONTHS": 3,
"TWENTY_SIX_MONTHS": 4,
"THIRTY_EIGHT_MONTHS": 5,
"FIFTY_MONTHS": 6,
}
)
var File_google_analytics_admin_v1beta_access_report_proto protoreflect.FileDescriptor
var File_google_analytics_admin_v1beta_analytics_admin_proto protoreflect.FileDescriptor
var File_google_analytics_admin_v1beta_resources_proto protoreflect.FileDescriptor
func RegisterAnalyticsAdminServiceServer(s *grpc.Server, srv AnalyticsAdminServiceServer)
To express that the result needs to be between two numbers (inclusive).
type AccessBetweenFilter struct {
// Begins with this number.
FromValue *NumericValue `protobuf:"bytes,1,opt,name=from_value,json=fromValue,proto3" json:"from_value,omitempty"`
// Ends with this number.
ToValue *NumericValue `protobuf:"bytes,2,opt,name=to_value,json=toValue,proto3" json:"to_value,omitempty"`
// contains filtered or unexported fields
}
func (*AccessBetweenFilter) Descriptor() ([]byte, []int)
Deprecated: Use AccessBetweenFilter.ProtoReflect.Descriptor instead.
func (x *AccessBetweenFilter) GetFromValue() *NumericValue
func (x *AccessBetweenFilter) GetToValue() *NumericValue
func (*AccessBetweenFilter) ProtoMessage()
func (x *AccessBetweenFilter) ProtoReflect() protoreflect.Message
func (x *AccessBetweenFilter) Reset()
func (x *AccessBetweenFilter) String() string
A contiguous range of days: startDate, startDate + 1, ..., endDate.
type AccessDateRange struct {
// The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot
// be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also
// accepted, and in that case, the date is inferred based on the current time
// in the request's time zone.
StartDate string `protobuf:"bytes,1,opt,name=start_date,json=startDate,proto3" json:"start_date,omitempty"`
// The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot
// be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is
// also accepted, and in that case, the date is inferred based on the current
// time in the request's time zone.
EndDate string `protobuf:"bytes,2,opt,name=end_date,json=endDate,proto3" json:"end_date,omitempty"`
// contains filtered or unexported fields
}
func (*AccessDateRange) Descriptor() ([]byte, []int)
Deprecated: Use AccessDateRange.ProtoReflect.Descriptor instead.
func (x *AccessDateRange) GetEndDate() string
func (x *AccessDateRange) GetStartDate() string
func (*AccessDateRange) ProtoMessage()
func (x *AccessDateRange) ProtoReflect() protoreflect.Message
func (x *AccessDateRange) Reset()
func (x *AccessDateRange) String() string
Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings.
type AccessDimension struct {
// The API name of the dimension. See [Data Access
// Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema)
// for the list of dimensions supported in this API.
//
// Dimensions are referenced by name in `dimensionFilter` and `orderBys`.
DimensionName string `protobuf:"bytes,1,opt,name=dimension_name,json=dimensionName,proto3" json:"dimension_name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessDimension) Descriptor() ([]byte, []int)
Deprecated: Use AccessDimension.ProtoReflect.Descriptor instead.
func (x *AccessDimension) GetDimensionName() string
func (*AccessDimension) ProtoMessage()
func (x *AccessDimension) ProtoReflect() protoreflect.Message
func (x *AccessDimension) Reset()
func (x *AccessDimension) String() string
Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers.
type AccessDimensionHeader struct {
// The dimension's name; for example 'userEmail'.
DimensionName string `protobuf:"bytes,1,opt,name=dimension_name,json=dimensionName,proto3" json:"dimension_name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessDimensionHeader) Descriptor() ([]byte, []int)
Deprecated: Use AccessDimensionHeader.ProtoReflect.Descriptor instead.
func (x *AccessDimensionHeader) GetDimensionName() string
func (*AccessDimensionHeader) ProtoMessage()
func (x *AccessDimensionHeader) ProtoReflect() protoreflect.Message
func (x *AccessDimensionHeader) Reset()
func (x *AccessDimensionHeader) String() string
The value of a dimension.
type AccessDimensionValue struct {
// The dimension value. For example, this value may be 'France' for the
// 'country' dimension.
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*AccessDimensionValue) Descriptor() ([]byte, []int)
Deprecated: Use AccessDimensionValue.ProtoReflect.Descriptor instead.
func (x *AccessDimensionValue) GetValue() string
func (*AccessDimensionValue) ProtoMessage()
func (x *AccessDimensionValue) ProtoReflect() protoreflect.Message
func (x *AccessDimensionValue) Reset()
func (x *AccessDimensionValue) String() string
An expression to filter dimension or metric values.
type AccessFilter struct {
// Specify one type of filter for `Filter`.
//
// Types that are assignable to OneFilter:
//
// *AccessFilter_StringFilter
// *AccessFilter_InListFilter
// *AccessFilter_NumericFilter
// *AccessFilter_BetweenFilter
OneFilter isAccessFilter_OneFilter `protobuf_oneof:"one_filter"`
// The dimension name or metric name.
FieldName string `protobuf:"bytes,1,opt,name=field_name,json=fieldName,proto3" json:"field_name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessFilter) Descriptor() ([]byte, []int)
Deprecated: Use AccessFilter.ProtoReflect.Descriptor instead.
func (x *AccessFilter) GetBetweenFilter() *AccessBetweenFilter
func (x *AccessFilter) GetFieldName() string
func (x *AccessFilter) GetInListFilter() *AccessInListFilter
func (x *AccessFilter) GetNumericFilter() *AccessNumericFilter
func (m *AccessFilter) GetOneFilter() isAccessFilter_OneFilter
func (x *AccessFilter) GetStringFilter() *AccessStringFilter
func (*AccessFilter) ProtoMessage()
func (x *AccessFilter) ProtoReflect() protoreflect.Message
func (x *AccessFilter) Reset()
func (x *AccessFilter) String() string
Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
type AccessFilterExpression struct {
// Specify one type of filter expression for `FilterExpression`.
//
// Types that are assignable to OneExpression:
//
// *AccessFilterExpression_AndGroup
// *AccessFilterExpression_OrGroup
// *AccessFilterExpression_NotExpression
// *AccessFilterExpression_AccessFilter
OneExpression isAccessFilterExpression_OneExpression `protobuf_oneof:"one_expression"`
// contains filtered or unexported fields
}
func (*AccessFilterExpression) Descriptor() ([]byte, []int)
Deprecated: Use AccessFilterExpression.ProtoReflect.Descriptor instead.
func (x *AccessFilterExpression) GetAccessFilter() *AccessFilter
func (x *AccessFilterExpression) GetAndGroup() *AccessFilterExpressionList
func (x *AccessFilterExpression) GetNotExpression() *AccessFilterExpression
func (m *AccessFilterExpression) GetOneExpression() isAccessFilterExpression_OneExpression
func (x *AccessFilterExpression) GetOrGroup() *AccessFilterExpressionList
func (*AccessFilterExpression) ProtoMessage()
func (x *AccessFilterExpression) ProtoReflect() protoreflect.Message
func (x *AccessFilterExpression) Reset()
func (x *AccessFilterExpression) String() string
A list of filter expressions.
type AccessFilterExpressionList struct {
// A list of filter expressions.
Expressions []*AccessFilterExpression `protobuf:"bytes,1,rep,name=expressions,proto3" json:"expressions,omitempty"`
// contains filtered or unexported fields
}
func (*AccessFilterExpressionList) Descriptor() ([]byte, []int)
Deprecated: Use AccessFilterExpressionList.ProtoReflect.Descriptor instead.
func (x *AccessFilterExpressionList) GetExpressions() []*AccessFilterExpression
func (*AccessFilterExpressionList) ProtoMessage()
func (x *AccessFilterExpressionList) ProtoReflect() protoreflect.Message
func (x *AccessFilterExpressionList) Reset()
func (x *AccessFilterExpressionList) String() string
type AccessFilterExpression_AccessFilter struct {
// A primitive filter. In the same FilterExpression, all of the filter's
// field names need to be either all dimensions or all metrics.
AccessFilter *AccessFilter `protobuf:"bytes,4,opt,name=access_filter,json=accessFilter,proto3,oneof"`
}
type AccessFilterExpression_AndGroup struct {
// Each of the FilterExpressions in the and_group has an AND relationship.
AndGroup *AccessFilterExpressionList `protobuf:"bytes,1,opt,name=and_group,json=andGroup,proto3,oneof"`
}
type AccessFilterExpression_NotExpression struct {
// The FilterExpression is NOT of not_expression.
NotExpression *AccessFilterExpression `protobuf:"bytes,3,opt,name=not_expression,json=notExpression,proto3,oneof"`
}
type AccessFilterExpression_OrGroup struct {
// Each of the FilterExpressions in the or_group has an OR relationship.
OrGroup *AccessFilterExpressionList `protobuf:"bytes,2,opt,name=or_group,json=orGroup,proto3,oneof"`
}
type AccessFilter_BetweenFilter struct {
// A filter for two values.
BetweenFilter *AccessBetweenFilter `protobuf:"bytes,5,opt,name=between_filter,json=betweenFilter,proto3,oneof"`
}
type AccessFilter_InListFilter struct {
// A filter for in list values.
InListFilter *AccessInListFilter `protobuf:"bytes,3,opt,name=in_list_filter,json=inListFilter,proto3,oneof"`
}
type AccessFilter_NumericFilter struct {
// A filter for numeric or date values.
NumericFilter *AccessNumericFilter `protobuf:"bytes,4,opt,name=numeric_filter,json=numericFilter,proto3,oneof"`
}
type AccessFilter_StringFilter struct {
// Strings related filter.
StringFilter *AccessStringFilter `protobuf:"bytes,2,opt,name=string_filter,json=stringFilter,proto3,oneof"`
}
The result needs to be in a list of string values.
type AccessInListFilter struct {
// The list of string values. Must be non-empty.
Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
// If true, the string value is case sensitive.
CaseSensitive bool `protobuf:"varint,2,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
// contains filtered or unexported fields
}
func (*AccessInListFilter) Descriptor() ([]byte, []int)
Deprecated: Use AccessInListFilter.ProtoReflect.Descriptor instead.
func (x *AccessInListFilter) GetCaseSensitive() bool
func (x *AccessInListFilter) GetValues() []string
func (*AccessInListFilter) ProtoMessage()
func (x *AccessInListFilter) ProtoReflect() protoreflect.Message
func (x *AccessInListFilter) Reset()
func (x *AccessInListFilter) String() string
The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records.
type AccessMetric struct {
// The API name of the metric. See [Data Access
// Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema)
// for the list of metrics supported in this API.
//
// Metrics are referenced by name in `metricFilter` & `orderBys`.
MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessMetric) Descriptor() ([]byte, []int)
Deprecated: Use AccessMetric.ProtoReflect.Descriptor instead.
func (x *AccessMetric) GetMetricName() string
func (*AccessMetric) ProtoMessage()
func (x *AccessMetric) ProtoReflect() protoreflect.Message
func (x *AccessMetric) Reset()
func (x *AccessMetric) String() string
Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers.
type AccessMetricHeader struct {
// The metric's name; for example 'accessCount'.
MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessMetricHeader) Descriptor() ([]byte, []int)
Deprecated: Use AccessMetricHeader.ProtoReflect.Descriptor instead.
func (x *AccessMetricHeader) GetMetricName() string
func (*AccessMetricHeader) ProtoMessage()
func (x *AccessMetricHeader) ProtoReflect() protoreflect.Message
func (x *AccessMetricHeader) Reset()
func (x *AccessMetricHeader) String() string
The value of a metric.
type AccessMetricValue struct {
// The measurement value. For example, this value may be '13'.
Value string `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*AccessMetricValue) Descriptor() ([]byte, []int)
Deprecated: Use AccessMetricValue.ProtoReflect.Descriptor instead.
func (x *AccessMetricValue) GetValue() string
func (*AccessMetricValue) ProtoMessage()
func (x *AccessMetricValue) ProtoReflect() protoreflect.Message
func (x *AccessMetricValue) Reset()
func (x *AccessMetricValue) String() string
Filters for numeric or date values.
type AccessNumericFilter struct {
// The operation type for this filter.
Operation AccessNumericFilter_Operation `protobuf:"varint,1,opt,name=operation,proto3,enum=google.analytics.admin.v1beta.AccessNumericFilter_Operation" json:"operation,omitempty"`
// A numeric value or a date value.
Value *NumericValue `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}
func (*AccessNumericFilter) Descriptor() ([]byte, []int)
Deprecated: Use AccessNumericFilter.ProtoReflect.Descriptor instead.
func (x *AccessNumericFilter) GetOperation() AccessNumericFilter_Operation
func (x *AccessNumericFilter) GetValue() *NumericValue
func (*AccessNumericFilter) ProtoMessage()
func (x *AccessNumericFilter) ProtoReflect() protoreflect.Message
func (x *AccessNumericFilter) Reset()
func (x *AccessNumericFilter) String() string
The operation applied to a numeric filter.
type AccessNumericFilter_Operation int32
const (
// Unspecified.
AccessNumericFilter_OPERATION_UNSPECIFIED AccessNumericFilter_Operation = 0
// Equal
AccessNumericFilter_EQUAL AccessNumericFilter_Operation = 1
// Less than
AccessNumericFilter_LESS_THAN AccessNumericFilter_Operation = 2
// Less than or equal
AccessNumericFilter_LESS_THAN_OR_EQUAL AccessNumericFilter_Operation = 3
// Greater than
AccessNumericFilter_GREATER_THAN AccessNumericFilter_Operation = 4
// Greater than or equal
AccessNumericFilter_GREATER_THAN_OR_EQUAL AccessNumericFilter_Operation = 5
)
func (AccessNumericFilter_Operation) Descriptor() protoreflect.EnumDescriptor
func (x AccessNumericFilter_Operation) Enum() *AccessNumericFilter_Operation
func (AccessNumericFilter_Operation) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccessNumericFilter_Operation.Descriptor instead.
func (x AccessNumericFilter_Operation) Number() protoreflect.EnumNumber
func (x AccessNumericFilter_Operation) String() string
func (AccessNumericFilter_Operation) Type() protoreflect.EnumType
Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering.
type AccessOrderBy struct {
// Specify one type of order by for `OrderBy`.
//
// Types that are assignable to OneOrderBy:
//
// *AccessOrderBy_Metric
// *AccessOrderBy_Dimension
OneOrderBy isAccessOrderBy_OneOrderBy `protobuf_oneof:"one_order_by"`
// If true, sorts by descending order. If false or unspecified, sorts in
// ascending order.
Desc bool `protobuf:"varint,3,opt,name=desc,proto3" json:"desc,omitempty"`
// contains filtered or unexported fields
}
func (*AccessOrderBy) Descriptor() ([]byte, []int)
Deprecated: Use AccessOrderBy.ProtoReflect.Descriptor instead.
func (x *AccessOrderBy) GetDesc() bool
func (x *AccessOrderBy) GetDimension() *AccessOrderBy_DimensionOrderBy
func (x *AccessOrderBy) GetMetric() *AccessOrderBy_MetricOrderBy
func (m *AccessOrderBy) GetOneOrderBy() isAccessOrderBy_OneOrderBy
func (*AccessOrderBy) ProtoMessage()
func (x *AccessOrderBy) ProtoReflect() protoreflect.Message
func (x *AccessOrderBy) Reset()
func (x *AccessOrderBy) String() string
type AccessOrderBy_Dimension struct {
// Sorts results by a dimension's values.
Dimension *AccessOrderBy_DimensionOrderBy `protobuf:"bytes,2,opt,name=dimension,proto3,oneof"`
}
Sorts by dimension values.
type AccessOrderBy_DimensionOrderBy struct {
// A dimension name in the request to order by.
DimensionName string `protobuf:"bytes,1,opt,name=dimension_name,json=dimensionName,proto3" json:"dimension_name,omitempty"`
// Controls the rule for dimension value ordering.
OrderType AccessOrderBy_DimensionOrderBy_OrderType `protobuf:"varint,2,opt,name=order_type,json=orderType,proto3,enum=google.analytics.admin.v1beta.AccessOrderBy_DimensionOrderBy_OrderType" json:"order_type,omitempty"`
// contains filtered or unexported fields
}
func (*AccessOrderBy_DimensionOrderBy) Descriptor() ([]byte, []int)
Deprecated: Use AccessOrderBy_DimensionOrderBy.ProtoReflect.Descriptor instead.
func (x *AccessOrderBy_DimensionOrderBy) GetDimensionName() string
func (x *AccessOrderBy_DimensionOrderBy) GetOrderType() AccessOrderBy_DimensionOrderBy_OrderType
func (*AccessOrderBy_DimensionOrderBy) ProtoMessage()
func (x *AccessOrderBy_DimensionOrderBy) ProtoReflect() protoreflect.Message
func (x *AccessOrderBy_DimensionOrderBy) Reset()
func (x *AccessOrderBy_DimensionOrderBy) String() string
Rule to order the string dimension values by.
type AccessOrderBy_DimensionOrderBy_OrderType int32
const (
// Unspecified.
AccessOrderBy_DimensionOrderBy_ORDER_TYPE_UNSPECIFIED AccessOrderBy_DimensionOrderBy_OrderType = 0
// Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" <
// "b" < "z".
AccessOrderBy_DimensionOrderBy_ALPHANUMERIC AccessOrderBy_DimensionOrderBy_OrderType = 1
// Case insensitive alphanumeric sort by lower case Unicode code point.
// For example, "2" < "A" < "b" < "X" < "z".
AccessOrderBy_DimensionOrderBy_CASE_INSENSITIVE_ALPHANUMERIC AccessOrderBy_DimensionOrderBy_OrderType = 2
// Dimension values are converted to numbers before sorting. For example
// in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" <
// "25". Non-numeric dimension values all have equal ordering value below
// all numeric values.
AccessOrderBy_DimensionOrderBy_NUMERIC AccessOrderBy_DimensionOrderBy_OrderType = 3
)
func (AccessOrderBy_DimensionOrderBy_OrderType) Descriptor() protoreflect.EnumDescriptor
func (x AccessOrderBy_DimensionOrderBy_OrderType) Enum() *AccessOrderBy_DimensionOrderBy_OrderType
func (AccessOrderBy_DimensionOrderBy_OrderType) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccessOrderBy_DimensionOrderBy_OrderType.Descriptor instead.
func (x AccessOrderBy_DimensionOrderBy_OrderType) Number() protoreflect.EnumNumber
func (x AccessOrderBy_DimensionOrderBy_OrderType) String() string
func (AccessOrderBy_DimensionOrderBy_OrderType) Type() protoreflect.EnumType
type AccessOrderBy_Metric struct {
// Sorts results by a metric's values.
Metric *AccessOrderBy_MetricOrderBy `protobuf:"bytes,1,opt,name=metric,proto3,oneof"`
}
Sorts by metric values.
type AccessOrderBy_MetricOrderBy struct {
// A metric name in the request to order by.
MetricName string `protobuf:"bytes,1,opt,name=metric_name,json=metricName,proto3" json:"metric_name,omitempty"`
// contains filtered or unexported fields
}
func (*AccessOrderBy_MetricOrderBy) Descriptor() ([]byte, []int)
Deprecated: Use AccessOrderBy_MetricOrderBy.ProtoReflect.Descriptor instead.
func (x *AccessOrderBy_MetricOrderBy) GetMetricName() string
func (*AccessOrderBy_MetricOrderBy) ProtoMessage()
func (x *AccessOrderBy_MetricOrderBy) ProtoReflect() protoreflect.Message
func (x *AccessOrderBy_MetricOrderBy) Reset()
func (x *AccessOrderBy_MetricOrderBy) String() string
Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors.
type AccessQuota struct {
// Properties can use 250,000 tokens per day. Most requests consume fewer than
// 10 tokens.
TokensPerDay *AccessQuotaStatus `protobuf:"bytes,1,opt,name=tokens_per_day,json=tokensPerDay,proto3" json:"tokens_per_day,omitempty"`
// Properties can use 50,000 tokens 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.
TokensPerHour *AccessQuotaStatus `protobuf:"bytes,2,opt,name=tokens_per_hour,json=tokensPerHour,proto3" json:"tokens_per_hour,omitempty"`
// Properties can use up to 50 concurrent requests.
ConcurrentRequests *AccessQuotaStatus `protobuf:"bytes,3,opt,name=concurrent_requests,json=concurrentRequests,proto3" json:"concurrent_requests,omitempty"`
// Properties and cloud project pairs can have up to 50 server errors per
// hour.
ServerErrorsPerProjectPerHour *AccessQuotaStatus `protobuf:"bytes,4,opt,name=server_errors_per_project_per_hour,json=serverErrorsPerProjectPerHour,proto3" json:"server_errors_per_project_per_hour,omitempty"`
// 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.
TokensPerProjectPerHour *AccessQuotaStatus `protobuf:"bytes,5,opt,name=tokens_per_project_per_hour,json=tokensPerProjectPerHour,proto3" json:"tokens_per_project_per_hour,omitempty"`
// contains filtered or unexported fields
}
func (*AccessQuota) Descriptor() ([]byte, []int)
Deprecated: Use AccessQuota.ProtoReflect.Descriptor instead.
func (x *AccessQuota) GetConcurrentRequests() *AccessQuotaStatus
func (x *AccessQuota) GetServerErrorsPerProjectPerHour() *AccessQuotaStatus
func (x *AccessQuota) GetTokensPerDay() *AccessQuotaStatus
func (x *AccessQuota) GetTokensPerHour() *AccessQuotaStatus
func (x *AccessQuota) GetTokensPerProjectPerHour() *AccessQuotaStatus
func (*AccessQuota) ProtoMessage()
func (x *AccessQuota) ProtoReflect() protoreflect.Message
func (x *AccessQuota) Reset()
func (x *AccessQuota) String() string
Current state for a particular quota group.
type AccessQuotaStatus struct {
// Quota consumed by this request.
Consumed int32 `protobuf:"varint,1,opt,name=consumed,proto3" json:"consumed,omitempty"`
// Quota remaining after this request.
Remaining int32 `protobuf:"varint,2,opt,name=remaining,proto3" json:"remaining,omitempty"`
// contains filtered or unexported fields
}
func (*AccessQuotaStatus) Descriptor() ([]byte, []int)
Deprecated: Use AccessQuotaStatus.ProtoReflect.Descriptor instead.
func (x *AccessQuotaStatus) GetConsumed() int32
func (x *AccessQuotaStatus) GetRemaining() int32
func (*AccessQuotaStatus) ProtoMessage()
func (x *AccessQuotaStatus) ProtoReflect() protoreflect.Message
func (x *AccessQuotaStatus) Reset()
func (x *AccessQuotaStatus) String() string
Access report data for each row.
type AccessRow struct {
// List of dimension values. These values are in the same order as specified
// in the request.
DimensionValues []*AccessDimensionValue `protobuf:"bytes,1,rep,name=dimension_values,json=dimensionValues,proto3" json:"dimension_values,omitempty"`
// List of metric values. These values are in the same order as specified
// in the request.
MetricValues []*AccessMetricValue `protobuf:"bytes,2,rep,name=metric_values,json=metricValues,proto3" json:"metric_values,omitempty"`
// contains filtered or unexported fields
}
func (*AccessRow) Descriptor() ([]byte, []int)
Deprecated: Use AccessRow.ProtoReflect.Descriptor instead.
func (x *AccessRow) GetDimensionValues() []*AccessDimensionValue
func (x *AccessRow) GetMetricValues() []*AccessMetricValue
func (*AccessRow) ProtoMessage()
func (x *AccessRow) ProtoReflect() protoreflect.Message
func (x *AccessRow) Reset()
func (x *AccessRow) String() string
The filter for strings.
type AccessStringFilter struct {
// The match type for this filter.
MatchType AccessStringFilter_MatchType `protobuf:"varint,1,opt,name=match_type,json=matchType,proto3,enum=google.analytics.admin.v1beta.AccessStringFilter_MatchType" json:"match_type,omitempty"`
// The string value used for the matching.
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// If true, the string value is case sensitive.
CaseSensitive bool `protobuf:"varint,3,opt,name=case_sensitive,json=caseSensitive,proto3" json:"case_sensitive,omitempty"`
// contains filtered or unexported fields
}
func (*AccessStringFilter) Descriptor() ([]byte, []int)
Deprecated: Use AccessStringFilter.ProtoReflect.Descriptor instead.
func (x *AccessStringFilter) GetCaseSensitive() bool
func (x *AccessStringFilter) GetMatchType() AccessStringFilter_MatchType
func (x *AccessStringFilter) GetValue() string
func (*AccessStringFilter) ProtoMessage()
func (x *AccessStringFilter) ProtoReflect() protoreflect.Message
func (x *AccessStringFilter) Reset()
func (x *AccessStringFilter) String() string
The match type of a string filter.
type AccessStringFilter_MatchType int32
const (
// Unspecified
AccessStringFilter_MATCH_TYPE_UNSPECIFIED AccessStringFilter_MatchType = 0
// Exact match of the string value.
AccessStringFilter_EXACT AccessStringFilter_MatchType = 1
// Begins with the string value.
AccessStringFilter_BEGINS_WITH AccessStringFilter_MatchType = 2
// Ends with the string value.
AccessStringFilter_ENDS_WITH AccessStringFilter_MatchType = 3
// Contains the string value.
AccessStringFilter_CONTAINS AccessStringFilter_MatchType = 4
// Full match for the regular expression with the string value.
AccessStringFilter_FULL_REGEXP AccessStringFilter_MatchType = 5
// Partial match for the regular expression with the string value.
AccessStringFilter_PARTIAL_REGEXP AccessStringFilter_MatchType = 6
)
func (AccessStringFilter_MatchType) Descriptor() protoreflect.EnumDescriptor
func (x AccessStringFilter_MatchType) Enum() *AccessStringFilter_MatchType
func (AccessStringFilter_MatchType) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccessStringFilter_MatchType.Descriptor instead.
func (x AccessStringFilter_MatchType) Number() protoreflect.EnumNumber
func (x AccessStringFilter_MatchType) String() string
func (AccessStringFilter_MatchType) Type() protoreflect.EnumType
A resource message representing a Google Analytics account.
type Account struct {
// Output only. Resource name of this account.
// Format: accounts/{account}
// Example: "accounts/100"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. Time when this account was originally created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time when account payload fields were last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Required. Human-readable display name for this account.
DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Country of business. Must be a Unicode CLDR region code.
RegionCode string `protobuf:"bytes,5,opt,name=region_code,json=regionCode,proto3" json:"region_code,omitempty"`
// Output only. Indicates whether this Account is soft-deleted or not. Deleted
// accounts are excluded from List results unless specifically requested.
Deleted bool `protobuf:"varint,6,opt,name=deleted,proto3" json:"deleted,omitempty"`
// contains filtered or unexported fields
}
func (*Account) Descriptor() ([]byte, []int)
Deprecated: Use Account.ProtoReflect.Descriptor instead.
func (x *Account) GetCreateTime() *timestamppb.Timestamp
func (x *Account) GetDeleted() bool
func (x *Account) GetDisplayName() string
func (x *Account) GetName() string
func (x *Account) GetRegionCode() string
func (x *Account) GetUpdateTime() *timestamppb.Timestamp
func (*Account) ProtoMessage()
func (x *Account) ProtoReflect() protoreflect.Message
func (x *Account) Reset()
func (x *Account) String() string
A virtual resource representing an overview of an account and all its child GA4 properties.
type AccountSummary struct {
// Resource name for this account summary.
// Format: accountSummaries/{account_id}
// Example: "accountSummaries/1000"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Resource name of account referred to by this account summary
// Format: accounts/{account_id}
// Example: "accounts/1000"
Account string `protobuf:"bytes,2,opt,name=account,proto3" json:"account,omitempty"`
// Display name for the account referred to in this account summary.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// List of summaries for child accounts of this account.
PropertySummaries []*PropertySummary `protobuf:"bytes,4,rep,name=property_summaries,json=propertySummaries,proto3" json:"property_summaries,omitempty"`
// contains filtered or unexported fields
}
func (*AccountSummary) Descriptor() ([]byte, []int)
Deprecated: Use AccountSummary.ProtoReflect.Descriptor instead.
func (x *AccountSummary) GetAccount() string
func (x *AccountSummary) GetDisplayName() string
func (x *AccountSummary) GetName() string
func (x *AccountSummary) GetPropertySummaries() []*PropertySummary
func (*AccountSummary) ProtoMessage()
func (x *AccountSummary) ProtoReflect() protoreflect.Message
func (x *AccountSummary) Reset()
func (x *AccountSummary) String() string
Request message for AcknowledgeUserDataCollection RPC.
type AcknowledgeUserDataCollectionRequest struct {
// Required. The property for which to acknowledge user data collection.
Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// Required. An acknowledgement that the caller of this method understands the
// terms of user data collection.
//
// This field must contain the exact value:
// "I acknowledge that I have the necessary privacy disclosures and rights
// from my end users for the collection and processing of their data,
// including the association of such data with the visitation information
// Google Analytics collects from my site and/or app property."
Acknowledgement string `protobuf:"bytes,2,opt,name=acknowledgement,proto3" json:"acknowledgement,omitempty"`
// contains filtered or unexported fields
}
func (*AcknowledgeUserDataCollectionRequest) Descriptor() ([]byte, []int)
Deprecated: Use AcknowledgeUserDataCollectionRequest.ProtoReflect.Descriptor instead.
func (x *AcknowledgeUserDataCollectionRequest) GetAcknowledgement() string
func (x *AcknowledgeUserDataCollectionRequest) GetProperty() string
func (*AcknowledgeUserDataCollectionRequest) ProtoMessage()
func (x *AcknowledgeUserDataCollectionRequest) ProtoReflect() protoreflect.Message
func (x *AcknowledgeUserDataCollectionRequest) Reset()
func (x *AcknowledgeUserDataCollectionRequest) String() string
Response message for AcknowledgeUserDataCollection RPC.
type AcknowledgeUserDataCollectionResponse struct {
// contains filtered or unexported fields
}
func (*AcknowledgeUserDataCollectionResponse) Descriptor() ([]byte, []int)
Deprecated: Use AcknowledgeUserDataCollectionResponse.ProtoReflect.Descriptor instead.
func (*AcknowledgeUserDataCollectionResponse) ProtoMessage()
func (x *AcknowledgeUserDataCollectionResponse) ProtoReflect() protoreflect.Message
func (x *AcknowledgeUserDataCollectionResponse) Reset()
func (x *AcknowledgeUserDataCollectionResponse) String() string
Types of actions that may change a resource.
type ActionType int32
const (
// Action type unknown or not specified.
ActionType_ACTION_TYPE_UNSPECIFIED ActionType = 0
// Resource was created in this change.
ActionType_CREATED ActionType = 1
// Resource was updated in this change.
ActionType_UPDATED ActionType = 2
// Resource was deleted in this change.
ActionType_DELETED ActionType = 3
)
func (ActionType) Descriptor() protoreflect.EnumDescriptor
func (x ActionType) Enum() *ActionType
func (ActionType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ActionType.Descriptor instead.
func (x ActionType) Number() protoreflect.EnumNumber
func (x ActionType) String() string
func (ActionType) Type() protoreflect.EnumType
Different kinds of actors that can make changes to Google Analytics resources.
type ActorType int32
const (
// Unknown or unspecified actor type.
ActorType_ACTOR_TYPE_UNSPECIFIED ActorType = 0
// Changes made by the user specified in actor_email.
ActorType_USER ActorType = 1
// Changes made by the Google Analytics system.
ActorType_SYSTEM ActorType = 2
// Changes made by Google Analytics support team staff.
ActorType_SUPPORT ActorType = 3
)
func (ActorType) Descriptor() protoreflect.EnumDescriptor
func (x ActorType) Enum() *ActorType
func (ActorType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ActorType.Descriptor instead.
func (x ActorType) Number() protoreflect.EnumNumber
func (x ActorType) String() string
func (ActorType) Type() protoreflect.EnumType
AnalyticsAdminServiceClient is the client API for AnalyticsAdminService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
type AnalyticsAdminServiceClient interface {
// Lookup for a single Account.
GetAccount(ctx context.Context, in *GetAccountRequest, opts ...grpc.CallOption) (*Account, error)
// Returns all accounts accessible by the caller.
//
// Note that these accounts might not currently have GA4 properties.
// Soft-deleted (ie: "trashed") accounts are excluded by default.
// Returns an empty list if no relevant accounts are found.
ListAccounts(ctx context.Context, in *ListAccountsRequest, opts ...grpc.CallOption) (*ListAccountsResponse, error)
// Marks target Account as soft-deleted (ie: "trashed") and returns it.
//
// This API does not have a method to restore soft-deleted accounts.
// However, they can be restored using the Trash Can UI.
//
// If the accounts are not restored before the expiration time, the account
// and all child resources (eg: Properties, GoogleAdsLinks, Streams,
// UserLinks) will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
// Returns an error if the target is not found.
DeleteAccount(ctx context.Context, in *DeleteAccountRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates an account.
UpdateAccount(ctx context.Context, in *UpdateAccountRequest, opts ...grpc.CallOption) (*Account, error)
// Requests a ticket for creating an account.
ProvisionAccountTicket(ctx context.Context, in *ProvisionAccountTicketRequest, opts ...grpc.CallOption) (*ProvisionAccountTicketResponse, error)
// Returns summaries of all accounts accessible by the caller.
ListAccountSummaries(ctx context.Context, in *ListAccountSummariesRequest, opts ...grpc.CallOption) (*ListAccountSummariesResponse, error)
// Lookup for a single "GA4" Property.
GetProperty(ctx context.Context, in *GetPropertyRequest, opts ...grpc.CallOption) (*Property, error)
// Returns child Properties under the specified parent Account.
//
// Only "GA4" properties will be returned.
// Properties will be excluded if the caller does not have access.
// Soft-deleted (ie: "trashed") properties are excluded by default.
// Returns an empty list if no relevant properties are found.
ListProperties(ctx context.Context, in *ListPropertiesRequest, opts ...grpc.CallOption) (*ListPropertiesResponse, error)
// Creates an "GA4" property with the specified location and attributes.
CreateProperty(ctx context.Context, in *CreatePropertyRequest, opts ...grpc.CallOption) (*Property, error)
// Marks target Property as soft-deleted (ie: "trashed") and returns it.
//
// This API does not have a method to restore soft-deleted properties.
// However, they can be restored using the Trash Can UI.
//
// If the properties are not restored before the expiration time, the Property
// and all child resources (eg: GoogleAdsLinks, Streams, UserLinks)
// will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
// Returns an error if the target is not found, or is not a GA4 Property.
DeleteProperty(ctx context.Context, in *DeletePropertyRequest, opts ...grpc.CallOption) (*Property, error)
// Updates a property.
UpdateProperty(ctx context.Context, in *UpdatePropertyRequest, opts ...grpc.CallOption) (*Property, error)
// Creates a FirebaseLink.
//
// Properties can have at most one FirebaseLink.
CreateFirebaseLink(ctx context.Context, in *CreateFirebaseLinkRequest, opts ...grpc.CallOption) (*FirebaseLink, error)
// Deletes a FirebaseLink on a property
DeleteFirebaseLink(ctx context.Context, in *DeleteFirebaseLinkRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists FirebaseLinks on a property.
// Properties can have at most one FirebaseLink.
ListFirebaseLinks(ctx context.Context, in *ListFirebaseLinksRequest, opts ...grpc.CallOption) (*ListFirebaseLinksResponse, error)
// Creates a GoogleAdsLink.
CreateGoogleAdsLink(ctx context.Context, in *CreateGoogleAdsLinkRequest, opts ...grpc.CallOption) (*GoogleAdsLink, error)
// Updates a GoogleAdsLink on a property
UpdateGoogleAdsLink(ctx context.Context, in *UpdateGoogleAdsLinkRequest, opts ...grpc.CallOption) (*GoogleAdsLink, error)
// Deletes a GoogleAdsLink on a property
DeleteGoogleAdsLink(ctx context.Context, in *DeleteGoogleAdsLinkRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lists GoogleAdsLinks on a property.
ListGoogleAdsLinks(ctx context.Context, in *ListGoogleAdsLinksRequest, opts ...grpc.CallOption) (*ListGoogleAdsLinksResponse, error)
// Get data sharing settings on an account.
// Data sharing settings are singletons.
GetDataSharingSettings(ctx context.Context, in *GetDataSharingSettingsRequest, opts ...grpc.CallOption) (*DataSharingSettings, error)
// Lookup for a single "GA4" MeasurementProtocolSecret.
GetMeasurementProtocolSecret(ctx context.Context, in *GetMeasurementProtocolSecretRequest, opts ...grpc.CallOption) (*MeasurementProtocolSecret, error)
// Returns child MeasurementProtocolSecrets under the specified parent
// Property.
ListMeasurementProtocolSecrets(ctx context.Context, in *ListMeasurementProtocolSecretsRequest, opts ...grpc.CallOption) (*ListMeasurementProtocolSecretsResponse, error)
// Creates a measurement protocol secret.
CreateMeasurementProtocolSecret(ctx context.Context, in *CreateMeasurementProtocolSecretRequest, opts ...grpc.CallOption) (*MeasurementProtocolSecret, error)
// Deletes target MeasurementProtocolSecret.
DeleteMeasurementProtocolSecret(ctx context.Context, in *DeleteMeasurementProtocolSecretRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a measurement protocol secret.
UpdateMeasurementProtocolSecret(ctx context.Context, in *UpdateMeasurementProtocolSecretRequest, opts ...grpc.CallOption) (*MeasurementProtocolSecret, error)
// Acknowledges the terms of user data collection for the specified property.
//
// This acknowledgement must be completed (either in the Google Analytics UI
// or through this API) before MeasurementProtocolSecret resources may be
// created.
AcknowledgeUserDataCollection(ctx context.Context, in *AcknowledgeUserDataCollectionRequest, opts ...grpc.CallOption) (*AcknowledgeUserDataCollectionResponse, error)
// Searches through all changes to an account or its children given the
// specified set of filters.
SearchChangeHistoryEvents(ctx context.Context, in *SearchChangeHistoryEventsRequest, opts ...grpc.CallOption) (*SearchChangeHistoryEventsResponse, error)
// Creates a conversion event with the specified attributes.
CreateConversionEvent(ctx context.Context, in *CreateConversionEventRequest, opts ...grpc.CallOption) (*ConversionEvent, error)
// Retrieve a single conversion event.
GetConversionEvent(ctx context.Context, in *GetConversionEventRequest, opts ...grpc.CallOption) (*ConversionEvent, error)
// Deletes a conversion event in a property.
DeleteConversionEvent(ctx context.Context, in *DeleteConversionEventRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Returns a list of conversion events in the specified parent property.
//
// Returns an empty list if no conversion events are found.
ListConversionEvents(ctx context.Context, in *ListConversionEventsRequest, opts ...grpc.CallOption) (*ListConversionEventsResponse, error)
// Creates a CustomDimension.
CreateCustomDimension(ctx context.Context, in *CreateCustomDimensionRequest, opts ...grpc.CallOption) (*CustomDimension, error)
// Updates a CustomDimension on a property.
UpdateCustomDimension(ctx context.Context, in *UpdateCustomDimensionRequest, opts ...grpc.CallOption) (*CustomDimension, error)
// Lists CustomDimensions on a property.
ListCustomDimensions(ctx context.Context, in *ListCustomDimensionsRequest, opts ...grpc.CallOption) (*ListCustomDimensionsResponse, error)
// Archives a CustomDimension on a property.
ArchiveCustomDimension(ctx context.Context, in *ArchiveCustomDimensionRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lookup for a single CustomDimension.
GetCustomDimension(ctx context.Context, in *GetCustomDimensionRequest, opts ...grpc.CallOption) (*CustomDimension, error)
// Creates a CustomMetric.
CreateCustomMetric(ctx context.Context, in *CreateCustomMetricRequest, opts ...grpc.CallOption) (*CustomMetric, error)
// Updates a CustomMetric on a property.
UpdateCustomMetric(ctx context.Context, in *UpdateCustomMetricRequest, opts ...grpc.CallOption) (*CustomMetric, error)
// Lists CustomMetrics on a property.
ListCustomMetrics(ctx context.Context, in *ListCustomMetricsRequest, opts ...grpc.CallOption) (*ListCustomMetricsResponse, error)
// Archives a CustomMetric on a property.
ArchiveCustomMetric(ctx context.Context, in *ArchiveCustomMetricRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Lookup for a single CustomMetric.
GetCustomMetric(ctx context.Context, in *GetCustomMetricRequest, opts ...grpc.CallOption) (*CustomMetric, error)
// Returns the singleton data retention settings for this property.
GetDataRetentionSettings(ctx context.Context, in *GetDataRetentionSettingsRequest, opts ...grpc.CallOption) (*DataRetentionSettings, error)
// Updates the singleton data retention settings for this property.
UpdateDataRetentionSettings(ctx context.Context, in *UpdateDataRetentionSettingsRequest, opts ...grpc.CallOption) (*DataRetentionSettings, error)
// Creates a DataStream.
CreateDataStream(ctx context.Context, in *CreateDataStreamRequest, opts ...grpc.CallOption) (*DataStream, error)
// Deletes a DataStream on a property.
DeleteDataStream(ctx context.Context, in *DeleteDataStreamRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Updates a DataStream on a property.
UpdateDataStream(ctx context.Context, in *UpdateDataStreamRequest, opts ...grpc.CallOption) (*DataStream, error)
// Lists DataStreams on a property.
ListDataStreams(ctx context.Context, in *ListDataStreamsRequest, opts ...grpc.CallOption) (*ListDataStreamsResponse, error)
// Lookup for a single DataStream.
GetDataStream(ctx context.Context, in *GetDataStreamRequest, opts ...grpc.CallOption) (*DataStream, error)
// Returns a customized report of data access records. The report provides
// 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.
//
// These data access records include GA4 UI Reporting, GA4 UI Explorations,
// GA4 Data API, and other products like Firebase & Admob that can retrieve
// data from Google Analytics through a linkage. These records don't include
// property configuration changes like adding a stream or changing a
// property's time zone. For configuration change history, see
// [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
RunAccessReport(ctx context.Context, in *RunAccessReportRequest, opts ...grpc.CallOption) (*RunAccessReportResponse, error)
}
func NewAnalyticsAdminServiceClient(cc grpc.ClientConnInterface) AnalyticsAdminServiceClient
AnalyticsAdminServiceServer is the server API for AnalyticsAdminService service.
type AnalyticsAdminServiceServer interface {
// Lookup for a single Account.
GetAccount(context.Context, *GetAccountRequest) (*Account, error)
// Returns all accounts accessible by the caller.
//
// Note that these accounts might not currently have GA4 properties.
// Soft-deleted (ie: "trashed") accounts are excluded by default.
// Returns an empty list if no relevant accounts are found.
ListAccounts(context.Context, *ListAccountsRequest) (*ListAccountsResponse, error)
// Marks target Account as soft-deleted (ie: "trashed") and returns it.
//
// This API does not have a method to restore soft-deleted accounts.
// However, they can be restored using the Trash Can UI.
//
// If the accounts are not restored before the expiration time, the account
// and all child resources (eg: Properties, GoogleAdsLinks, Streams,
// UserLinks) will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
// Returns an error if the target is not found.
DeleteAccount(context.Context, *DeleteAccountRequest) (*emptypb.Empty, error)
// Updates an account.
UpdateAccount(context.Context, *UpdateAccountRequest) (*Account, error)
// Requests a ticket for creating an account.
ProvisionAccountTicket(context.Context, *ProvisionAccountTicketRequest) (*ProvisionAccountTicketResponse, error)
// Returns summaries of all accounts accessible by the caller.
ListAccountSummaries(context.Context, *ListAccountSummariesRequest) (*ListAccountSummariesResponse, error)
// Lookup for a single "GA4" Property.
GetProperty(context.Context, *GetPropertyRequest) (*Property, error)
// Returns child Properties under the specified parent Account.
//
// Only "GA4" properties will be returned.
// Properties will be excluded if the caller does not have access.
// Soft-deleted (ie: "trashed") properties are excluded by default.
// Returns an empty list if no relevant properties are found.
ListProperties(context.Context, *ListPropertiesRequest) (*ListPropertiesResponse, error)
// Creates an "GA4" property with the specified location and attributes.
CreateProperty(context.Context, *CreatePropertyRequest) (*Property, error)
// Marks target Property as soft-deleted (ie: "trashed") and returns it.
//
// This API does not have a method to restore soft-deleted properties.
// However, they can be restored using the Trash Can UI.
//
// If the properties are not restored before the expiration time, the Property
// and all child resources (eg: GoogleAdsLinks, Streams, UserLinks)
// will be permanently purged.
// https://support.google.com/analytics/answer/6154772
//
// Returns an error if the target is not found, or is not a GA4 Property.
DeleteProperty(context.Context, *DeletePropertyRequest) (*Property, error)
// Updates a property.
UpdateProperty(context.Context, *UpdatePropertyRequest) (*Property, error)
// Creates a FirebaseLink.
//
// Properties can have at most one FirebaseLink.
CreateFirebaseLink(context.Context, *CreateFirebaseLinkRequest) (*FirebaseLink, error)
// Deletes a FirebaseLink on a property
DeleteFirebaseLink(context.Context, *DeleteFirebaseLinkRequest) (*emptypb.Empty, error)
// Lists FirebaseLinks on a property.
// Properties can have at most one FirebaseLink.
ListFirebaseLinks(context.Context, *ListFirebaseLinksRequest) (*ListFirebaseLinksResponse, error)
// Creates a GoogleAdsLink.
CreateGoogleAdsLink(context.Context, *CreateGoogleAdsLinkRequest) (*GoogleAdsLink, error)
// Updates a GoogleAdsLink on a property
UpdateGoogleAdsLink(context.Context, *UpdateGoogleAdsLinkRequest) (*GoogleAdsLink, error)
// Deletes a GoogleAdsLink on a property
DeleteGoogleAdsLink(context.Context, *DeleteGoogleAdsLinkRequest) (*emptypb.Empty, error)
// Lists GoogleAdsLinks on a property.
ListGoogleAdsLinks(context.Context, *ListGoogleAdsLinksRequest) (*ListGoogleAdsLinksResponse, error)
// Get data sharing settings on an account.
// Data sharing settings are singletons.
GetDataSharingSettings(context.Context, *GetDataSharingSettingsRequest) (*DataSharingSettings, error)
// Lookup for a single "GA4" MeasurementProtocolSecret.
GetMeasurementProtocolSecret(context.Context, *GetMeasurementProtocolSecretRequest) (*MeasurementProtocolSecret, error)
// Returns child MeasurementProtocolSecrets under the specified parent
// Property.
ListMeasurementProtocolSecrets(context.Context, *ListMeasurementProtocolSecretsRequest) (*ListMeasurementProtocolSecretsResponse, error)
// Creates a measurement protocol secret.
CreateMeasurementProtocolSecret(context.Context, *CreateMeasurementProtocolSecretRequest) (*MeasurementProtocolSecret, error)
// Deletes target MeasurementProtocolSecret.
DeleteMeasurementProtocolSecret(context.Context, *DeleteMeasurementProtocolSecretRequest) (*emptypb.Empty, error)
// Updates a measurement protocol secret.
UpdateMeasurementProtocolSecret(context.Context, *UpdateMeasurementProtocolSecretRequest) (*MeasurementProtocolSecret, error)
// Acknowledges the terms of user data collection for the specified property.
//
// This acknowledgement must be completed (either in the Google Analytics UI
// or through this API) before MeasurementProtocolSecret resources may be
// created.
AcknowledgeUserDataCollection(context.Context, *AcknowledgeUserDataCollectionRequest) (*AcknowledgeUserDataCollectionResponse, error)
// Searches through all changes to an account or its children given the
// specified set of filters.
SearchChangeHistoryEvents(context.Context, *SearchChangeHistoryEventsRequest) (*SearchChangeHistoryEventsResponse, error)
// Creates a conversion event with the specified attributes.
CreateConversionEvent(context.Context, *CreateConversionEventRequest) (*ConversionEvent, error)
// Retrieve a single conversion event.
GetConversionEvent(context.Context, *GetConversionEventRequest) (*ConversionEvent, error)
// Deletes a conversion event in a property.
DeleteConversionEvent(context.Context, *DeleteConversionEventRequest) (*emptypb.Empty, error)
// Returns a list of conversion events in the specified parent property.
//
// Returns an empty list if no conversion events are found.
ListConversionEvents(context.Context, *ListConversionEventsRequest) (*ListConversionEventsResponse, error)
// Creates a CustomDimension.
CreateCustomDimension(context.Context, *CreateCustomDimensionRequest) (*CustomDimension, error)
// Updates a CustomDimension on a property.
UpdateCustomDimension(context.Context, *UpdateCustomDimensionRequest) (*CustomDimension, error)
// Lists CustomDimensions on a property.
ListCustomDimensions(context.Context, *ListCustomDimensionsRequest) (*ListCustomDimensionsResponse, error)
// Archives a CustomDimension on a property.
ArchiveCustomDimension(context.Context, *ArchiveCustomDimensionRequest) (*emptypb.Empty, error)
// Lookup for a single CustomDimension.
GetCustomDimension(context.Context, *GetCustomDimensionRequest) (*CustomDimension, error)
// Creates a CustomMetric.
CreateCustomMetric(context.Context, *CreateCustomMetricRequest) (*CustomMetric, error)
// Updates a CustomMetric on a property.
UpdateCustomMetric(context.Context, *UpdateCustomMetricRequest) (*CustomMetric, error)
// Lists CustomMetrics on a property.
ListCustomMetrics(context.Context, *ListCustomMetricsRequest) (*ListCustomMetricsResponse, error)
// Archives a CustomMetric on a property.
ArchiveCustomMetric(context.Context, *ArchiveCustomMetricRequest) (*emptypb.Empty, error)
// Lookup for a single CustomMetric.
GetCustomMetric(context.Context, *GetCustomMetricRequest) (*CustomMetric, error)
// Returns the singleton data retention settings for this property.
GetDataRetentionSettings(context.Context, *GetDataRetentionSettingsRequest) (*DataRetentionSettings, error)
// Updates the singleton data retention settings for this property.
UpdateDataRetentionSettings(context.Context, *UpdateDataRetentionSettingsRequest) (*DataRetentionSettings, error)
// Creates a DataStream.
CreateDataStream(context.Context, *CreateDataStreamRequest) (*DataStream, error)
// Deletes a DataStream on a property.
DeleteDataStream(context.Context, *DeleteDataStreamRequest) (*emptypb.Empty, error)
// Updates a DataStream on a property.
UpdateDataStream(context.Context, *UpdateDataStreamRequest) (*DataStream, error)
// Lists DataStreams on a property.
ListDataStreams(context.Context, *ListDataStreamsRequest) (*ListDataStreamsResponse, error)
// Lookup for a single DataStream.
GetDataStream(context.Context, *GetDataStreamRequest) (*DataStream, error)
// Returns a customized report of data access records. The report provides
// 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.
//
// These data access records include GA4 UI Reporting, GA4 UI Explorations,
// GA4 Data API, and other products like Firebase & Admob that can retrieve
// data from Google Analytics through a linkage. These records don't include
// property configuration changes like adding a stream or changing a
// property's time zone. For configuration change history, see
// [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents).
RunAccessReport(context.Context, *RunAccessReportRequest) (*RunAccessReportResponse, error)
}
Request message for ArchiveCustomDimension RPC.
type ArchiveCustomDimensionRequest struct {
// Required. The name of the CustomDimension to archive.
// Example format: properties/1234/customDimensions/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*ArchiveCustomDimensionRequest) Descriptor() ([]byte, []int)
Deprecated: Use ArchiveCustomDimensionRequest.ProtoReflect.Descriptor instead.
func (x *ArchiveCustomDimensionRequest) GetName() string
func (*ArchiveCustomDimensionRequest) ProtoMessage()
func (x *ArchiveCustomDimensionRequest) ProtoReflect() protoreflect.Message
func (x *ArchiveCustomDimensionRequest) Reset()
func (x *ArchiveCustomDimensionRequest) String() string
Request message for ArchiveCustomMetric RPC.
type ArchiveCustomMetricRequest struct {
// Required. The name of the CustomMetric to archive.
// Example format: properties/1234/customMetrics/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*ArchiveCustomMetricRequest) Descriptor() ([]byte, []int)
Deprecated: Use ArchiveCustomMetricRequest.ProtoReflect.Descriptor instead.
func (x *ArchiveCustomMetricRequest) GetName() string
func (*ArchiveCustomMetricRequest) ProtoMessage()
func (x *ArchiveCustomMetricRequest) ProtoReflect() protoreflect.Message
func (x *ArchiveCustomMetricRequest) Reset()
func (x *ArchiveCustomMetricRequest) String() string
A description of a change to a single Google Analytics resource.
type ChangeHistoryChange struct {
// Resource name of the resource whose changes are described by this entry.
Resource string `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
// The type of action that changed this resource.
Action ActionType `protobuf:"varint,2,opt,name=action,proto3,enum=google.analytics.admin.v1beta.ActionType" json:"action,omitempty"`
// Resource contents from before the change was made. If this resource was
// created in this change, this field will be missing.
ResourceBeforeChange *ChangeHistoryChange_ChangeHistoryResource `protobuf:"bytes,3,opt,name=resource_before_change,json=resourceBeforeChange,proto3" json:"resource_before_change,omitempty"`
// Resource contents from after the change was made. If this resource was
// deleted in this change, this field will be missing.
ResourceAfterChange *ChangeHistoryChange_ChangeHistoryResource `protobuf:"bytes,4,opt,name=resource_after_change,json=resourceAfterChange,proto3" json:"resource_after_change,omitempty"`
// contains filtered or unexported fields
}
func (*ChangeHistoryChange) Descriptor() ([]byte, []int)
Deprecated: Use ChangeHistoryChange.ProtoReflect.Descriptor instead.
func (x *ChangeHistoryChange) GetAction() ActionType
func (x *ChangeHistoryChange) GetResource() string
func (x *ChangeHistoryChange) GetResourceAfterChange() *ChangeHistoryChange_ChangeHistoryResource
func (x *ChangeHistoryChange) GetResourceBeforeChange() *ChangeHistoryChange_ChangeHistoryResource
func (*ChangeHistoryChange) ProtoMessage()
func (x *ChangeHistoryChange) ProtoReflect() protoreflect.Message
func (x *ChangeHistoryChange) Reset()
func (x *ChangeHistoryChange) String() string
A snapshot of a resource as before or after the result of a change in change history.
type ChangeHistoryChange_ChangeHistoryResource struct {
// Types that are assignable to Resource:
//
// *ChangeHistoryChange_ChangeHistoryResource_Account
// *ChangeHistoryChange_ChangeHistoryResource_Property
// *ChangeHistoryChange_ChangeHistoryResource_FirebaseLink
// *ChangeHistoryChange_ChangeHistoryResource_GoogleAdsLink
// *ChangeHistoryChange_ChangeHistoryResource_ConversionEvent
// *ChangeHistoryChange_ChangeHistoryResource_MeasurementProtocolSecret
// *ChangeHistoryChange_ChangeHistoryResource_DataRetentionSettings
// *ChangeHistoryChange_ChangeHistoryResource_DataStream
Resource isChangeHistoryChange_ChangeHistoryResource_Resource `protobuf_oneof:"resource"`
// contains filtered or unexported fields
}
func (*ChangeHistoryChange_ChangeHistoryResource) Descriptor() ([]byte, []int)
Deprecated: Use ChangeHistoryChange_ChangeHistoryResource.ProtoReflect.Descriptor instead.
func (x *ChangeHistoryChange_ChangeHistoryResource) GetAccount() *Account
func (x *ChangeHistoryChange_ChangeHistoryResource) GetConversionEvent() *ConversionEvent
func (x *ChangeHistoryChange_ChangeHistoryResource) GetDataRetentionSettings() *DataRetentionSettings
func (x *ChangeHistoryChange_ChangeHistoryResource) GetDataStream() *DataStream
func (x *ChangeHistoryChange_ChangeHistoryResource) GetFirebaseLink() *FirebaseLink
func (x *ChangeHistoryChange_ChangeHistoryResource) GetGoogleAdsLink() *GoogleAdsLink
func (x *ChangeHistoryChange_ChangeHistoryResource) GetMeasurementProtocolSecret() *MeasurementProtocolSecret
func (x *ChangeHistoryChange_ChangeHistoryResource) GetProperty() *Property
func (m *ChangeHistoryChange_ChangeHistoryResource) GetResource() isChangeHistoryChange_ChangeHistoryResource_Resource
func (*ChangeHistoryChange_ChangeHistoryResource) ProtoMessage()
func (x *ChangeHistoryChange_ChangeHistoryResource) ProtoReflect() protoreflect.Message
func (x *ChangeHistoryChange_ChangeHistoryResource) Reset()
func (x *ChangeHistoryChange_ChangeHistoryResource) String() string
type ChangeHistoryChange_ChangeHistoryResource_Account struct {
// A snapshot of an Account resource in change history.
Account *Account `protobuf:"bytes,1,opt,name=account,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_ConversionEvent struct {
// A snapshot of a ConversionEvent resource in change history.
ConversionEvent *ConversionEvent `protobuf:"bytes,11,opt,name=conversion_event,json=conversionEvent,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_DataRetentionSettings struct {
// A snapshot of a data retention settings resource in change history.
DataRetentionSettings *DataRetentionSettings `protobuf:"bytes,15,opt,name=data_retention_settings,json=dataRetentionSettings,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_DataStream struct {
// A snapshot of a DataStream resource in change history.
DataStream *DataStream `protobuf:"bytes,18,opt,name=data_stream,json=dataStream,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_FirebaseLink struct {
// A snapshot of a FirebaseLink resource in change history.
FirebaseLink *FirebaseLink `protobuf:"bytes,6,opt,name=firebase_link,json=firebaseLink,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_GoogleAdsLink struct {
// A snapshot of a GoogleAdsLink resource in change history.
GoogleAdsLink *GoogleAdsLink `protobuf:"bytes,7,opt,name=google_ads_link,json=googleAdsLink,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_MeasurementProtocolSecret struct {
// A snapshot of a MeasurementProtocolSecret resource in change history.
MeasurementProtocolSecret *MeasurementProtocolSecret `protobuf:"bytes,12,opt,name=measurement_protocol_secret,json=measurementProtocolSecret,proto3,oneof"`
}
type ChangeHistoryChange_ChangeHistoryResource_Property struct {
// A snapshot of a Property resource in change history.
Property *Property `protobuf:"bytes,2,opt,name=property,proto3,oneof"`
}
A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.
type ChangeHistoryEvent struct {
// ID of this change history event. This ID is unique across Google Analytics.
Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
// Time when change was made.
ChangeTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=change_time,json=changeTime,proto3" json:"change_time,omitempty"`
// The type of actor that made this change.
ActorType ActorType `protobuf:"varint,3,opt,name=actor_type,json=actorType,proto3,enum=google.analytics.admin.v1beta.ActorType" json:"actor_type,omitempty"`
// Email address of the Google account that made the change. This will be a
// valid email address if the actor field is set to USER, and empty otherwise.
// Google accounts that have been deleted will cause an error.
UserActorEmail string `protobuf:"bytes,4,opt,name=user_actor_email,json=userActorEmail,proto3" json:"user_actor_email,omitempty"`
// If true, then the list of changes returned was filtered, and does not
// represent all changes that occurred in this event.
ChangesFiltered bool `protobuf:"varint,5,opt,name=changes_filtered,json=changesFiltered,proto3" json:"changes_filtered,omitempty"`
// A list of changes made in this change history event that fit the filters
// specified in SearchChangeHistoryEventsRequest.
Changes []*ChangeHistoryChange `protobuf:"bytes,6,rep,name=changes,proto3" json:"changes,omitempty"`
// contains filtered or unexported fields
}
func (*ChangeHistoryEvent) Descriptor() ([]byte, []int)
Deprecated: Use ChangeHistoryEvent.ProtoReflect.Descriptor instead.
func (x *ChangeHistoryEvent) GetActorType() ActorType
func (x *ChangeHistoryEvent) GetChangeTime() *timestamppb.Timestamp
func (x *ChangeHistoryEvent) GetChanges() []*ChangeHistoryChange
func (x *ChangeHistoryEvent) GetChangesFiltered() bool
func (x *ChangeHistoryEvent) GetId() string
func (x *ChangeHistoryEvent) GetUserActorEmail() string
func (*ChangeHistoryEvent) ProtoMessage()
func (x *ChangeHistoryEvent) ProtoReflect() protoreflect.Message
func (x *ChangeHistoryEvent) Reset()
func (x *ChangeHistoryEvent) String() string
Types of resources whose changes may be returned from change history.
type ChangeHistoryResourceType int32
const (
// Resource type unknown or not specified.
ChangeHistoryResourceType_CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED ChangeHistoryResourceType = 0
// Account resource
ChangeHistoryResourceType_ACCOUNT ChangeHistoryResourceType = 1
// Property resource
ChangeHistoryResourceType_PROPERTY ChangeHistoryResourceType = 2
// FirebaseLink resource
ChangeHistoryResourceType_FIREBASE_LINK ChangeHistoryResourceType = 6
// GoogleAdsLink resource
ChangeHistoryResourceType_GOOGLE_ADS_LINK ChangeHistoryResourceType = 7
// GoogleSignalsSettings resource
ChangeHistoryResourceType_GOOGLE_SIGNALS_SETTINGS ChangeHistoryResourceType = 8
// ConversionEvent resource
ChangeHistoryResourceType_CONVERSION_EVENT ChangeHistoryResourceType = 9
// MeasurementProtocolSecret resource
ChangeHistoryResourceType_MEASUREMENT_PROTOCOL_SECRET ChangeHistoryResourceType = 10
// DataRetentionSettings resource
ChangeHistoryResourceType_DATA_RETENTION_SETTINGS ChangeHistoryResourceType = 13
// DisplayVideo360AdvertiserLink resource
ChangeHistoryResourceType_DISPLAY_VIDEO_360_ADVERTISER_LINK ChangeHistoryResourceType = 14
// DisplayVideo360AdvertiserLinkProposal resource
ChangeHistoryResourceType_DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL ChangeHistoryResourceType = 15
// DataStream resource
ChangeHistoryResourceType_DATA_STREAM ChangeHistoryResourceType = 18
// AttributionSettings resource
ChangeHistoryResourceType_ATTRIBUTION_SETTINGS ChangeHistoryResourceType = 20
)
func (ChangeHistoryResourceType) Descriptor() protoreflect.EnumDescriptor
func (x ChangeHistoryResourceType) Enum() *ChangeHistoryResourceType
func (ChangeHistoryResourceType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ChangeHistoryResourceType.Descriptor instead.
func (x ChangeHistoryResourceType) Number() protoreflect.EnumNumber
func (x ChangeHistoryResourceType) String() string
func (ChangeHistoryResourceType) Type() protoreflect.EnumType
A conversion event in a Google Analytics property.
type ConversionEvent struct {
// Output only. Resource name of this conversion event.
// Format: properties/{property}/conversionEvents/{conversion_event}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The event name for this conversion event.
// Examples: 'click', 'purchase'
EventName string `protobuf:"bytes,2,opt,name=event_name,json=eventName,proto3" json:"event_name,omitempty"`
// Output only. Time when this conversion event was created in the property.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. If set, this event can currently be deleted with
// DeleteConversionEvent.
Deletable bool `protobuf:"varint,4,opt,name=deletable,proto3" json:"deletable,omitempty"`
// Output only. If set to true, this conversion event refers to a custom
// event. If set to false, this conversion 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 conversion events that may be created per property.
Custom bool `protobuf:"varint,5,opt,name=custom,proto3" json:"custom,omitempty"`
// contains filtered or unexported fields
}
func (*ConversionEvent) Descriptor() ([]byte, []int)
Deprecated: Use ConversionEvent.ProtoReflect.Descriptor instead.
func (x *ConversionEvent) GetCreateTime() *timestamppb.Timestamp
func (x *ConversionEvent) GetCustom() bool
func (x *ConversionEvent) GetDeletable() bool
func (x *ConversionEvent) GetEventName() string
func (x *ConversionEvent) GetName() string
func (*ConversionEvent) ProtoMessage()
func (x *ConversionEvent) ProtoReflect() protoreflect.Message
func (x *ConversionEvent) Reset()
func (x *ConversionEvent) String() string
Request message for CreateConversionEvent RPC
type CreateConversionEventRequest struct {
// Required. The conversion event to create.
ConversionEvent *ConversionEvent `protobuf:"bytes,1,opt,name=conversion_event,json=conversionEvent,proto3" json:"conversion_event,omitempty"`
// Required. The resource name of the parent property where this conversion
// event will be created. Format: properties/123
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}
func (*CreateConversionEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateConversionEventRequest.ProtoReflect.Descriptor instead.
func (x *CreateConversionEventRequest) GetConversionEvent() *ConversionEvent
func (x *CreateConversionEventRequest) GetParent() string
func (*CreateConversionEventRequest) ProtoMessage()
func (x *CreateConversionEventRequest) ProtoReflect() protoreflect.Message
func (x *CreateConversionEventRequest) Reset()
func (x *CreateConversionEventRequest) String() string
Request message for CreateCustomDimension RPC.
type CreateCustomDimensionRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The CustomDimension to create.
CustomDimension *CustomDimension `protobuf:"bytes,2,opt,name=custom_dimension,json=customDimension,proto3" json:"custom_dimension,omitempty"`
// contains filtered or unexported fields
}
func (*CreateCustomDimensionRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateCustomDimensionRequest.ProtoReflect.Descriptor instead.
func (x *CreateCustomDimensionRequest) GetCustomDimension() *CustomDimension
func (x *CreateCustomDimensionRequest) GetParent() string
func (*CreateCustomDimensionRequest) ProtoMessage()
func (x *CreateCustomDimensionRequest) ProtoReflect() protoreflect.Message
func (x *CreateCustomDimensionRequest) Reset()
func (x *CreateCustomDimensionRequest) String() string
Request message for CreateCustomMetric RPC.
type CreateCustomMetricRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The CustomMetric to create.
CustomMetric *CustomMetric `protobuf:"bytes,2,opt,name=custom_metric,json=customMetric,proto3" json:"custom_metric,omitempty"`
// contains filtered or unexported fields
}
func (*CreateCustomMetricRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateCustomMetricRequest.ProtoReflect.Descriptor instead.
func (x *CreateCustomMetricRequest) GetCustomMetric() *CustomMetric
func (x *CreateCustomMetricRequest) GetParent() string
func (*CreateCustomMetricRequest) ProtoMessage()
func (x *CreateCustomMetricRequest) ProtoReflect() protoreflect.Message
func (x *CreateCustomMetricRequest) Reset()
func (x *CreateCustomMetricRequest) String() string
Request message for CreateDataStream RPC.
type CreateDataStreamRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The DataStream to create.
DataStream *DataStream `protobuf:"bytes,2,opt,name=data_stream,json=dataStream,proto3" json:"data_stream,omitempty"`
// contains filtered or unexported fields
}
func (*CreateDataStreamRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateDataStreamRequest.ProtoReflect.Descriptor instead.
func (x *CreateDataStreamRequest) GetDataStream() *DataStream
func (x *CreateDataStreamRequest) GetParent() string
func (*CreateDataStreamRequest) ProtoMessage()
func (x *CreateDataStreamRequest) ProtoReflect() protoreflect.Message
func (x *CreateDataStreamRequest) Reset()
func (x *CreateDataStreamRequest) String() string
Request message for CreateFirebaseLink RPC
type CreateFirebaseLinkRequest struct {
// Required. Format: properties/{property_id}
// Example: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The Firebase link to create.
FirebaseLink *FirebaseLink `protobuf:"bytes,2,opt,name=firebase_link,json=firebaseLink,proto3" json:"firebase_link,omitempty"`
// contains filtered or unexported fields
}
func (*CreateFirebaseLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateFirebaseLinkRequest.ProtoReflect.Descriptor instead.
func (x *CreateFirebaseLinkRequest) GetFirebaseLink() *FirebaseLink
func (x *CreateFirebaseLinkRequest) GetParent() string
func (*CreateFirebaseLinkRequest) ProtoMessage()
func (x *CreateFirebaseLinkRequest) ProtoReflect() protoreflect.Message
func (x *CreateFirebaseLinkRequest) Reset()
func (x *CreateFirebaseLinkRequest) String() string
Request message for CreateGoogleAdsLink RPC
type CreateGoogleAdsLinkRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The GoogleAdsLink to create.
GoogleAdsLink *GoogleAdsLink `protobuf:"bytes,2,opt,name=google_ads_link,json=googleAdsLink,proto3" json:"google_ads_link,omitempty"`
// contains filtered or unexported fields
}
func (*CreateGoogleAdsLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateGoogleAdsLinkRequest.ProtoReflect.Descriptor instead.
func (x *CreateGoogleAdsLinkRequest) GetGoogleAdsLink() *GoogleAdsLink
func (x *CreateGoogleAdsLinkRequest) GetParent() string
func (*CreateGoogleAdsLinkRequest) ProtoMessage()
func (x *CreateGoogleAdsLinkRequest) ProtoReflect() protoreflect.Message
func (x *CreateGoogleAdsLinkRequest) Reset()
func (x *CreateGoogleAdsLinkRequest) String() string
Request message for CreateMeasurementProtocolSecret RPC
type CreateMeasurementProtocolSecretRequest struct {
// Required. The parent resource where this secret will be created.
// Format: properties/{property}/dataStreams/{dataStream}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The measurement protocol secret to create.
MeasurementProtocolSecret *MeasurementProtocolSecret `protobuf:"bytes,2,opt,name=measurement_protocol_secret,json=measurementProtocolSecret,proto3" json:"measurement_protocol_secret,omitempty"`
// contains filtered or unexported fields
}
func (*CreateMeasurementProtocolSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateMeasurementProtocolSecretRequest.ProtoReflect.Descriptor instead.
func (x *CreateMeasurementProtocolSecretRequest) GetMeasurementProtocolSecret() *MeasurementProtocolSecret
func (x *CreateMeasurementProtocolSecretRequest) GetParent() string
func (*CreateMeasurementProtocolSecretRequest) ProtoMessage()
func (x *CreateMeasurementProtocolSecretRequest) ProtoReflect() protoreflect.Message
func (x *CreateMeasurementProtocolSecretRequest) Reset()
func (x *CreateMeasurementProtocolSecretRequest) String() string
Request message for CreateProperty RPC.
type CreatePropertyRequest struct {
// Required. The property to create.
// Note: the supplied property must specify its parent.
Property *Property `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// contains filtered or unexported fields
}
func (*CreatePropertyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreatePropertyRequest.ProtoReflect.Descriptor instead.
func (x *CreatePropertyRequest) GetProperty() *Property
func (*CreatePropertyRequest) ProtoMessage()
func (x *CreatePropertyRequest) ProtoReflect() protoreflect.Message
func (x *CreatePropertyRequest) Reset()
func (x *CreatePropertyRequest) String() string
A definition for a CustomDimension.
type CustomDimension struct {
// Output only. Resource name for this CustomDimension resource.
// Format: properties/{property}/customDimensions/{customDimension}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. Tagging parameter name for this custom dimension.
//
// If this is a user-scoped dimension, then this is the user property name.
// If this is an event-scoped dimension, then this is the event parameter
// name.
//
// May only contain alphanumeric and underscore characters, starting with a
// letter. Max length of 24 characters for user-scoped dimensions, 40
// characters for event-scoped dimensions.
ParameterName string `protobuf:"bytes,2,opt,name=parameter_name,json=parameterName,proto3" json:"parameter_name,omitempty"`
// Required. Display name for this custom dimension as shown in the Analytics
// UI. Max length of 82 characters, alphanumeric plus space and underscore
// starting with a letter. Legacy system-generated display names may contain
// square brackets, but updates to this field will never permit square
// brackets.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Description for this custom dimension. Max length of 150
// characters.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Required. Immutable. The scope of this dimension.
Scope CustomDimension_DimensionScope `protobuf:"varint,5,opt,name=scope,proto3,enum=google.analytics.admin.v1beta.CustomDimension_DimensionScope" json:"scope,omitempty"`
// Optional. If set to true, sets this dimension as NPA and excludes it from
// ads personalization.
//
// This is currently only supported by user-scoped custom dimensions.
DisallowAdsPersonalization bool `protobuf:"varint,6,opt,name=disallow_ads_personalization,json=disallowAdsPersonalization,proto3" json:"disallow_ads_personalization,omitempty"`
// contains filtered or unexported fields
}
func (*CustomDimension) Descriptor() ([]byte, []int)
Deprecated: Use CustomDimension.ProtoReflect.Descriptor instead.
func (x *CustomDimension) GetDescription() string
func (x *CustomDimension) GetDisallowAdsPersonalization() bool
func (x *CustomDimension) GetDisplayName() string
func (x *CustomDimension) GetName() string
func (x *CustomDimension) GetParameterName() string
func (x *CustomDimension) GetScope() CustomDimension_DimensionScope
func (*CustomDimension) ProtoMessage()
func (x *CustomDimension) ProtoReflect() protoreflect.Message
func (x *CustomDimension) Reset()
func (x *CustomDimension) String() string
Valid values for the scope of this dimension.
type CustomDimension_DimensionScope int32
const (
// Scope unknown or not specified.
CustomDimension_DIMENSION_SCOPE_UNSPECIFIED CustomDimension_DimensionScope = 0
// Dimension scoped to an event.
CustomDimension_EVENT CustomDimension_DimensionScope = 1
// Dimension scoped to a user.
CustomDimension_USER CustomDimension_DimensionScope = 2
)
func (CustomDimension_DimensionScope) Descriptor() protoreflect.EnumDescriptor
func (x CustomDimension_DimensionScope) Enum() *CustomDimension_DimensionScope
func (CustomDimension_DimensionScope) EnumDescriptor() ([]byte, []int)
Deprecated: Use CustomDimension_DimensionScope.Descriptor instead.
func (x CustomDimension_DimensionScope) Number() protoreflect.EnumNumber
func (x CustomDimension_DimensionScope) String() string
func (CustomDimension_DimensionScope) Type() protoreflect.EnumType
A definition for a custom metric.
type CustomMetric struct {
// Output only. Resource name for this CustomMetric resource.
// Format: properties/{property}/customMetrics/{customMetric}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. Tagging name for this custom metric.
//
// If this is an event-scoped metric, then this is the event parameter
// name.
//
// May only contain alphanumeric and underscore charactes, starting with a
// letter. Max length of 40 characters for event-scoped metrics.
ParameterName string `protobuf:"bytes,2,opt,name=parameter_name,json=parameterName,proto3" json:"parameter_name,omitempty"`
// Required. Display name for this custom metric as shown in the Analytics UI.
// Max length of 82 characters, alphanumeric plus space and underscore
// starting with a letter. Legacy system-generated display names may contain
// square brackets, but updates to this field will never permit square
// brackets.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Optional. Description for this custom dimension.
// Max length of 150 characters.
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// Required. The type for the custom metric's value.
MeasurementUnit CustomMetric_MeasurementUnit `protobuf:"varint,5,opt,name=measurement_unit,json=measurementUnit,proto3,enum=google.analytics.admin.v1beta.CustomMetric_MeasurementUnit" json:"measurement_unit,omitempty"`
// Required. Immutable. The scope of this custom metric.
Scope CustomMetric_MetricScope `protobuf:"varint,6,opt,name=scope,proto3,enum=google.analytics.admin.v1beta.CustomMetric_MetricScope" json:"scope,omitempty"`
// Optional. Types of restricted data that this metric may contain. Required
// for metrics with CURRENCY measurement unit. Must be empty for metrics with
// a non-CURRENCY measurement unit.
RestrictedMetricType []CustomMetric_RestrictedMetricType `protobuf:"varint,8,rep,packed,name=restricted_metric_type,json=restrictedMetricType,proto3,enum=google.analytics.admin.v1beta.CustomMetric_RestrictedMetricType" json:"restricted_metric_type,omitempty"`
// contains filtered or unexported fields
}
func (*CustomMetric) Descriptor() ([]byte, []int)
Deprecated: Use CustomMetric.ProtoReflect.Descriptor instead.
func (x *CustomMetric) GetDescription() string
func (x *CustomMetric) GetDisplayName() string
func (x *CustomMetric) GetMeasurementUnit() CustomMetric_MeasurementUnit
func (x *CustomMetric) GetName() string
func (x *CustomMetric) GetParameterName() string
func (x *CustomMetric) GetRestrictedMetricType() []CustomMetric_RestrictedMetricType
func (x *CustomMetric) GetScope() CustomMetric_MetricScope
func (*CustomMetric) ProtoMessage()
func (x *CustomMetric) ProtoReflect() protoreflect.Message
func (x *CustomMetric) Reset()
func (x *CustomMetric) String() string
Possible types of representing the custom metric's value.
Currency representation may change in the future, requiring a breaking API change.
type CustomMetric_MeasurementUnit int32
const (
// MeasurementUnit unspecified or missing.
CustomMetric_MEASUREMENT_UNIT_UNSPECIFIED CustomMetric_MeasurementUnit = 0
// This metric uses default units.
CustomMetric_STANDARD CustomMetric_MeasurementUnit = 1
// This metric measures a currency.
CustomMetric_CURRENCY CustomMetric_MeasurementUnit = 2
// This metric measures feet.
CustomMetric_FEET CustomMetric_MeasurementUnit = 3
// This metric measures meters.
CustomMetric_METERS CustomMetric_MeasurementUnit = 4
// This metric measures kilometers.
CustomMetric_KILOMETERS CustomMetric_MeasurementUnit = 5
// This metric measures miles.
CustomMetric_MILES CustomMetric_MeasurementUnit = 6
// This metric measures milliseconds.
CustomMetric_MILLISECONDS CustomMetric_MeasurementUnit = 7
// This metric measures seconds.
CustomMetric_SECONDS CustomMetric_MeasurementUnit = 8
// This metric measures minutes.
CustomMetric_MINUTES CustomMetric_MeasurementUnit = 9
// This metric measures hours.
CustomMetric_HOURS CustomMetric_MeasurementUnit = 10
)
func (CustomMetric_MeasurementUnit) Descriptor() protoreflect.EnumDescriptor
func (x CustomMetric_MeasurementUnit) Enum() *CustomMetric_MeasurementUnit
func (CustomMetric_MeasurementUnit) EnumDescriptor() ([]byte, []int)
Deprecated: Use CustomMetric_MeasurementUnit.Descriptor instead.
func (x CustomMetric_MeasurementUnit) Number() protoreflect.EnumNumber
func (x CustomMetric_MeasurementUnit) String() string
func (CustomMetric_MeasurementUnit) Type() protoreflect.EnumType
The scope of this metric.
type CustomMetric_MetricScope int32
const (
// Scope unknown or not specified.
CustomMetric_METRIC_SCOPE_UNSPECIFIED CustomMetric_MetricScope = 0
// Metric scoped to an event.
CustomMetric_EVENT CustomMetric_MetricScope = 1
)
func (CustomMetric_MetricScope) Descriptor() protoreflect.EnumDescriptor
func (x CustomMetric_MetricScope) Enum() *CustomMetric_MetricScope
func (CustomMetric_MetricScope) EnumDescriptor() ([]byte, []int)
Deprecated: Use CustomMetric_MetricScope.Descriptor instead.
func (x CustomMetric_MetricScope) Number() protoreflect.EnumNumber
func (x CustomMetric_MetricScope) String() string
func (CustomMetric_MetricScope) Type() protoreflect.EnumType
Labels that mark the data in this custom metric as data that should be restricted to specific users.
type CustomMetric_RestrictedMetricType int32
const (
// Type unknown or unspecified.
CustomMetric_RESTRICTED_METRIC_TYPE_UNSPECIFIED CustomMetric_RestrictedMetricType = 0
// Metric reports cost data.
CustomMetric_COST_DATA CustomMetric_RestrictedMetricType = 1
// Metric reports revenue data.
CustomMetric_REVENUE_DATA CustomMetric_RestrictedMetricType = 2
)
func (CustomMetric_RestrictedMetricType) Descriptor() protoreflect.EnumDescriptor
func (x CustomMetric_RestrictedMetricType) Enum() *CustomMetric_RestrictedMetricType
func (CustomMetric_RestrictedMetricType) EnumDescriptor() ([]byte, []int)
Deprecated: Use CustomMetric_RestrictedMetricType.Descriptor instead.
func (x CustomMetric_RestrictedMetricType) Number() protoreflect.EnumNumber
func (x CustomMetric_RestrictedMetricType) String() string
func (CustomMetric_RestrictedMetricType) Type() protoreflect.EnumType
Settings values for data retention. This is a singleton resource.
type DataRetentionSettings struct {
// Output only. Resource name for this DataRetentionSetting resource.
// Format: properties/{property}/dataRetentionSettings
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The length of time that event-level data is retained.
EventDataRetention DataRetentionSettings_RetentionDuration `protobuf:"varint,2,opt,name=event_data_retention,json=eventDataRetention,proto3,enum=google.analytics.admin.v1beta.DataRetentionSettings_RetentionDuration" json:"event_data_retention,omitempty"`
// If true, reset the retention period for the user identifier with every
// event from that user.
ResetUserDataOnNewActivity bool `protobuf:"varint,3,opt,name=reset_user_data_on_new_activity,json=resetUserDataOnNewActivity,proto3" json:"reset_user_data_on_new_activity,omitempty"`
// contains filtered or unexported fields
}
func (*DataRetentionSettings) Descriptor() ([]byte, []int)
Deprecated: Use DataRetentionSettings.ProtoReflect.Descriptor instead.
func (x *DataRetentionSettings) GetEventDataRetention() DataRetentionSettings_RetentionDuration
func (x *DataRetentionSettings) GetName() string
func (x *DataRetentionSettings) GetResetUserDataOnNewActivity() bool
func (*DataRetentionSettings) ProtoMessage()
func (x *DataRetentionSettings) ProtoReflect() protoreflect.Message
func (x *DataRetentionSettings) Reset()
func (x *DataRetentionSettings) String() string
Valid values for the data retention duration.
type DataRetentionSettings_RetentionDuration int32
const (
// Data retention time duration is not specified.
DataRetentionSettings_RETENTION_DURATION_UNSPECIFIED DataRetentionSettings_RetentionDuration = 0
// The data retention time duration is 2 months.
DataRetentionSettings_TWO_MONTHS DataRetentionSettings_RetentionDuration = 1
// The data retention time duration is 14 months.
DataRetentionSettings_FOURTEEN_MONTHS DataRetentionSettings_RetentionDuration = 3
// The data retention time duration is 26 months.
// Available to 360 properties only.
DataRetentionSettings_TWENTY_SIX_MONTHS DataRetentionSettings_RetentionDuration = 4
// The data retention time duration is 38 months.
// Available to 360 properties only.
DataRetentionSettings_THIRTY_EIGHT_MONTHS DataRetentionSettings_RetentionDuration = 5
// The data retention time duration is 50 months.
// Available to 360 properties only.
DataRetentionSettings_FIFTY_MONTHS DataRetentionSettings_RetentionDuration = 6
)
func (DataRetentionSettings_RetentionDuration) Descriptor() protoreflect.EnumDescriptor
func (x DataRetentionSettings_RetentionDuration) Enum() *DataRetentionSettings_RetentionDuration
func (DataRetentionSettings_RetentionDuration) EnumDescriptor() ([]byte, []int)
Deprecated: Use DataRetentionSettings_RetentionDuration.Descriptor instead.
func (x DataRetentionSettings_RetentionDuration) Number() protoreflect.EnumNumber
func (x DataRetentionSettings_RetentionDuration) String() string
func (DataRetentionSettings_RetentionDuration) Type() protoreflect.EnumType
A resource message representing data sharing settings of a Google Analytics account.
type DataSharingSettings struct {
// Output only. Resource name.
// Format: accounts/{account}/dataSharingSettings
// Example: "accounts/1000/dataSharingSettings"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Allows Google support to access the data in order to help troubleshoot
// issues.
SharingWithGoogleSupportEnabled bool `protobuf:"varint,2,opt,name=sharing_with_google_support_enabled,json=sharingWithGoogleSupportEnabled,proto3" json:"sharing_with_google_support_enabled,omitempty"`
// Allows Google sales teams that are assigned to the customer to access the
// data in order to suggest configuration changes to improve results.
// Sales team restrictions still apply when enabled.
SharingWithGoogleAssignedSalesEnabled bool `protobuf:"varint,3,opt,name=sharing_with_google_assigned_sales_enabled,json=sharingWithGoogleAssignedSalesEnabled,proto3" json:"sharing_with_google_assigned_sales_enabled,omitempty"`
// Allows any of Google sales to access the data in order to suggest
// configuration changes to improve results.
SharingWithGoogleAnySalesEnabled bool `protobuf:"varint,4,opt,name=sharing_with_google_any_sales_enabled,json=sharingWithGoogleAnySalesEnabled,proto3" json:"sharing_with_google_any_sales_enabled,omitempty"`
// Allows Google to use the data to improve other Google products or services.
SharingWithGoogleProductsEnabled bool `protobuf:"varint,5,opt,name=sharing_with_google_products_enabled,json=sharingWithGoogleProductsEnabled,proto3" json:"sharing_with_google_products_enabled,omitempty"`
// Allows Google to share the data anonymously in aggregate form with others.
SharingWithOthersEnabled bool `protobuf:"varint,6,opt,name=sharing_with_others_enabled,json=sharingWithOthersEnabled,proto3" json:"sharing_with_others_enabled,omitempty"`
// contains filtered or unexported fields
}
func (*DataSharingSettings) Descriptor() ([]byte, []int)
Deprecated: Use DataSharingSettings.ProtoReflect.Descriptor instead.
func (x *DataSharingSettings) GetName() string
func (x *DataSharingSettings) GetSharingWithGoogleAnySalesEnabled() bool
func (x *DataSharingSettings) GetSharingWithGoogleAssignedSalesEnabled() bool
func (x *DataSharingSettings) GetSharingWithGoogleProductsEnabled() bool
func (x *DataSharingSettings) GetSharingWithGoogleSupportEnabled() bool
func (x *DataSharingSettings) GetSharingWithOthersEnabled() bool
func (*DataSharingSettings) ProtoMessage()
func (x *DataSharingSettings) ProtoReflect() protoreflect.Message
func (x *DataSharingSettings) Reset()
func (x *DataSharingSettings) String() string
A resource message representing a data stream.
type DataStream struct {
// Data for specific data stream types. The message that will be
// set corresponds to the type of this stream.
//
// Types that are assignable to StreamData:
//
// *DataStream_WebStreamData_
// *DataStream_AndroidAppStreamData_
// *DataStream_IosAppStreamData_
StreamData isDataStream_StreamData `protobuf_oneof:"stream_data"`
// Output only. Resource name of this Data Stream.
// Format: properties/{property_id}/dataStreams/{stream_id}
// Example: "properties/1000/dataStreams/2000"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. The type of this DataStream resource.
Type DataStream_DataStreamType `protobuf:"varint,2,opt,name=type,proto3,enum=google.analytics.admin.v1beta.DataStream_DataStreamType" json:"type,omitempty"`
// Human-readable display name for the Data Stream.
//
// Required for web data streams.
//
// The max allowed display name length is 255 UTF-16 code units.
DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. Time when this stream was originally created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time when stream payload fields were last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// contains filtered or unexported fields
}
func (*DataStream) Descriptor() ([]byte, []int)
Deprecated: Use DataStream.ProtoReflect.Descriptor instead.
func (x *DataStream) GetAndroidAppStreamData() *DataStream_AndroidAppStreamData
func (x *DataStream) GetCreateTime() *timestamppb.Timestamp
func (x *DataStream) GetDisplayName() string
func (x *DataStream) GetIosAppStreamData() *DataStream_IosAppStreamData
func (x *DataStream) GetName() string
func (m *DataStream) GetStreamData() isDataStream_StreamData
func (x *DataStream) GetType() DataStream_DataStreamType
func (x *DataStream) GetUpdateTime() *timestamppb.Timestamp
func (x *DataStream) GetWebStreamData() *DataStream_WebStreamData
func (*DataStream) ProtoMessage()
func (x *DataStream) ProtoReflect() protoreflect.Message
func (x *DataStream) Reset()
func (x *DataStream) String() string
Data specific to Android app streams.
type DataStream_AndroidAppStreamData struct {
// Output only. ID of the corresponding Android app in Firebase, if any.
// This ID can change if the Android app is deleted and recreated.
FirebaseAppId string `protobuf:"bytes,1,opt,name=firebase_app_id,json=firebaseAppId,proto3" json:"firebase_app_id,omitempty"`
// Immutable. The package name for the app being measured.
// Example: "com.example.myandroidapp"
PackageName string `protobuf:"bytes,2,opt,name=package_name,json=packageName,proto3" json:"package_name,omitempty"`
// contains filtered or unexported fields
}
func (*DataStream_AndroidAppStreamData) Descriptor() ([]byte, []int)
Deprecated: Use DataStream_AndroidAppStreamData.ProtoReflect.Descriptor instead.
func (x *DataStream_AndroidAppStreamData) GetFirebaseAppId() string
func (x *DataStream_AndroidAppStreamData) GetPackageName() string
func (*DataStream_AndroidAppStreamData) ProtoMessage()
func (x *DataStream_AndroidAppStreamData) ProtoReflect() protoreflect.Message
func (x *DataStream_AndroidAppStreamData) Reset()
func (x *DataStream_AndroidAppStreamData) String() string
type DataStream_AndroidAppStreamData_ struct {
// Data specific to Android app streams. Must be populated if type is
// ANDROID_APP_DATA_STREAM.
AndroidAppStreamData *DataStream_AndroidAppStreamData `protobuf:"bytes,7,opt,name=android_app_stream_data,json=androidAppStreamData,proto3,oneof"`
}
The type of the data stream.
type DataStream_DataStreamType int32
const (
// Type unknown or not specified.
DataStream_DATA_STREAM_TYPE_UNSPECIFIED DataStream_DataStreamType = 0
// Web data stream.
DataStream_WEB_DATA_STREAM DataStream_DataStreamType = 1
// Android app data stream.
DataStream_ANDROID_APP_DATA_STREAM DataStream_DataStreamType = 2
// iOS app data stream.
DataStream_IOS_APP_DATA_STREAM DataStream_DataStreamType = 3
)
func (DataStream_DataStreamType) Descriptor() protoreflect.EnumDescriptor
func (x DataStream_DataStreamType) Enum() *DataStream_DataStreamType
func (DataStream_DataStreamType) EnumDescriptor() ([]byte, []int)
Deprecated: Use DataStream_DataStreamType.Descriptor instead.
func (x DataStream_DataStreamType) Number() protoreflect.EnumNumber
func (x DataStream_DataStreamType) String() string
func (DataStream_DataStreamType) Type() protoreflect.EnumType
Data specific to iOS app streams.
type DataStream_IosAppStreamData struct {
// Output only. ID of the corresponding iOS app in Firebase, if any.
// This ID can change if the iOS app is deleted and recreated.
FirebaseAppId string `protobuf:"bytes,1,opt,name=firebase_app_id,json=firebaseAppId,proto3" json:"firebase_app_id,omitempty"`
// Required. Immutable. The Apple App Store Bundle ID for the app
// Example: "com.example.myiosapp"
BundleId string `protobuf:"bytes,2,opt,name=bundle_id,json=bundleId,proto3" json:"bundle_id,omitempty"`
// contains filtered or unexported fields
}
func (*DataStream_IosAppStreamData) Descriptor() ([]byte, []int)
Deprecated: Use DataStream_IosAppStreamData.ProtoReflect.Descriptor instead.
func (x *DataStream_IosAppStreamData) GetBundleId() string
func (x *DataStream_IosAppStreamData) GetFirebaseAppId() string
func (*DataStream_IosAppStreamData) ProtoMessage()
func (x *DataStream_IosAppStreamData) ProtoReflect() protoreflect.Message
func (x *DataStream_IosAppStreamData) Reset()
func (x *DataStream_IosAppStreamData) String() string
type DataStream_IosAppStreamData_ struct {
// Data specific to iOS app streams. Must be populated if type is
// IOS_APP_DATA_STREAM.
IosAppStreamData *DataStream_IosAppStreamData `protobuf:"bytes,8,opt,name=ios_app_stream_data,json=iosAppStreamData,proto3,oneof"`
}
Data specific to web streams.
type DataStream_WebStreamData struct {
// Output only. Analytics "Measurement ID", without the "G-" prefix.
// Example: "G-1A2BCD345E" would just be "1A2BCD345E"
MeasurementId string `protobuf:"bytes,1,opt,name=measurement_id,json=measurementId,proto3" json:"measurement_id,omitempty"`
// Output only. ID of the corresponding web app in Firebase, if any.
// This ID can change if the web app is deleted and recreated.
FirebaseAppId string `protobuf:"bytes,2,opt,name=firebase_app_id,json=firebaseAppId,proto3" json:"firebase_app_id,omitempty"`
// Immutable. Domain name of the web app being measured, or empty.
// Example: "http://www.google.com", "https://www.google.com"
DefaultUri string `protobuf:"bytes,3,opt,name=default_uri,json=defaultUri,proto3" json:"default_uri,omitempty"`
// contains filtered or unexported fields
}
func (*DataStream_WebStreamData) Descriptor() ([]byte, []int)
Deprecated: Use DataStream_WebStreamData.ProtoReflect.Descriptor instead.
func (x *DataStream_WebStreamData) GetDefaultUri() string
func (x *DataStream_WebStreamData) GetFirebaseAppId() string
func (x *DataStream_WebStreamData) GetMeasurementId() string
func (*DataStream_WebStreamData) ProtoMessage()
func (x *DataStream_WebStreamData) ProtoReflect() protoreflect.Message
func (x *DataStream_WebStreamData) Reset()
func (x *DataStream_WebStreamData) String() string
type DataStream_WebStreamData_ struct {
// Data specific to web streams. Must be populated if type is
// WEB_DATA_STREAM.
WebStreamData *DataStream_WebStreamData `protobuf:"bytes,6,opt,name=web_stream_data,json=webStreamData,proto3,oneof"`
}
Request message for DeleteAccount RPC.
type DeleteAccountRequest struct {
// Required. The name of the Account to soft-delete.
// Format: accounts/{account}
// Example: "accounts/100"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteAccountRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteAccountRequest.ProtoReflect.Descriptor instead.
func (x *DeleteAccountRequest) GetName() string
func (*DeleteAccountRequest) ProtoMessage()
func (x *DeleteAccountRequest) ProtoReflect() protoreflect.Message
func (x *DeleteAccountRequest) Reset()
func (x *DeleteAccountRequest) String() string
Request message for DeleteConversionEvent RPC
type DeleteConversionEventRequest struct {
// Required. The resource name of the conversion event to delete.
// Format: properties/{property}/conversionEvents/{conversion_event}
// Example: "properties/123/conversionEvents/456"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteConversionEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteConversionEventRequest.ProtoReflect.Descriptor instead.
func (x *DeleteConversionEventRequest) GetName() string
func (*DeleteConversionEventRequest) ProtoMessage()
func (x *DeleteConversionEventRequest) ProtoReflect() protoreflect.Message
func (x *DeleteConversionEventRequest) Reset()
func (x *DeleteConversionEventRequest) String() string
Request message for DeleteDataStream RPC.
type DeleteDataStreamRequest struct {
// Required. The name of the DataStream to delete.
// Example format: properties/1234/dataStreams/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteDataStreamRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteDataStreamRequest.ProtoReflect.Descriptor instead.
func (x *DeleteDataStreamRequest) GetName() string
func (*DeleteDataStreamRequest) ProtoMessage()
func (x *DeleteDataStreamRequest) ProtoReflect() protoreflect.Message
func (x *DeleteDataStreamRequest) Reset()
func (x *DeleteDataStreamRequest) String() string
Request message for DeleteFirebaseLink RPC
type DeleteFirebaseLinkRequest struct {
// Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id}
// Example: properties/1234/firebaseLinks/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteFirebaseLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFirebaseLinkRequest.ProtoReflect.Descriptor instead.
func (x *DeleteFirebaseLinkRequest) GetName() string
func (*DeleteFirebaseLinkRequest) ProtoMessage()
func (x *DeleteFirebaseLinkRequest) ProtoReflect() protoreflect.Message
func (x *DeleteFirebaseLinkRequest) Reset()
func (x *DeleteFirebaseLinkRequest) String() string
Request message for DeleteGoogleAdsLink RPC.
type DeleteGoogleAdsLinkRequest struct {
// Required. Example format: properties/1234/googleAdsLinks/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteGoogleAdsLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteGoogleAdsLinkRequest.ProtoReflect.Descriptor instead.
func (x *DeleteGoogleAdsLinkRequest) GetName() string
func (*DeleteGoogleAdsLinkRequest) ProtoMessage()
func (x *DeleteGoogleAdsLinkRequest) ProtoReflect() protoreflect.Message
func (x *DeleteGoogleAdsLinkRequest) Reset()
func (x *DeleteGoogleAdsLinkRequest) String() string
Request message for DeleteMeasurementProtocolSecret RPC
type DeleteMeasurementProtocolSecretRequest struct {
// Required. The name of the MeasurementProtocolSecret to delete.
// Format:
// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeleteMeasurementProtocolSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteMeasurementProtocolSecretRequest.ProtoReflect.Descriptor instead.
func (x *DeleteMeasurementProtocolSecretRequest) GetName() string
func (*DeleteMeasurementProtocolSecretRequest) ProtoMessage()
func (x *DeleteMeasurementProtocolSecretRequest) ProtoReflect() protoreflect.Message
func (x *DeleteMeasurementProtocolSecretRequest) Reset()
func (x *DeleteMeasurementProtocolSecretRequest) String() string
Request message for DeleteProperty RPC.
type DeletePropertyRequest struct {
// Required. The name of the Property to soft-delete.
// Format: properties/{property_id}
// Example: "properties/1000"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*DeletePropertyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeletePropertyRequest.ProtoReflect.Descriptor instead.
func (x *DeletePropertyRequest) GetName() string
func (*DeletePropertyRequest) ProtoMessage()
func (x *DeletePropertyRequest) ProtoReflect() protoreflect.Message
func (x *DeletePropertyRequest) Reset()
func (x *DeletePropertyRequest) String() string
A link between a GA4 property and a Firebase project.
type FirebaseLink struct {
// Output only. Example format: properties/1234/firebaseLinks/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. Firebase project resource name. When creating a FirebaseLink,
// you may provide this resource name using either a project number or project
// ID. Once this resource has been created, returned FirebaseLinks will always
// have a project_name that contains a project number.
//
// Format: 'projects/{project number}'
// Example: 'projects/1234'
Project string `protobuf:"bytes,2,opt,name=project,proto3" json:"project,omitempty"`
// Output only. Time when this FirebaseLink was originally created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// contains filtered or unexported fields
}
func (*FirebaseLink) Descriptor() ([]byte, []int)
Deprecated: Use FirebaseLink.ProtoReflect.Descriptor instead.
func (x *FirebaseLink) GetCreateTime() *timestamppb.Timestamp
func (x *FirebaseLink) GetName() string
func (x *FirebaseLink) GetProject() string
func (*FirebaseLink) ProtoMessage()
func (x *FirebaseLink) ProtoReflect() protoreflect.Message
func (x *FirebaseLink) Reset()
func (x *FirebaseLink) String() string
Request message for GetAccount RPC.
type GetAccountRequest struct {
// Required. The name of the account to lookup.
// Format: accounts/{account}
// Example: "accounts/100"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetAccountRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetAccountRequest.ProtoReflect.Descriptor instead.
func (x *GetAccountRequest) GetName() string
func (*GetAccountRequest) ProtoMessage()
func (x *GetAccountRequest) ProtoReflect() protoreflect.Message
func (x *GetAccountRequest) Reset()
func (x *GetAccountRequest) String() string
Request message for GetConversionEvent RPC
type GetConversionEventRequest struct {
// Required. The resource name of the conversion event to retrieve.
// Format: properties/{property}/conversionEvents/{conversion_event}
// Example: "properties/123/conversionEvents/456"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetConversionEventRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetConversionEventRequest.ProtoReflect.Descriptor instead.
func (x *GetConversionEventRequest) GetName() string
func (*GetConversionEventRequest) ProtoMessage()
func (x *GetConversionEventRequest) ProtoReflect() protoreflect.Message
func (x *GetConversionEventRequest) Reset()
func (x *GetConversionEventRequest) String() string
Request message for GetCustomDimension RPC.
type GetCustomDimensionRequest struct {
// Required. The name of the CustomDimension to get.
// Example format: properties/1234/customDimensions/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetCustomDimensionRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetCustomDimensionRequest.ProtoReflect.Descriptor instead.
func (x *GetCustomDimensionRequest) GetName() string
func (*GetCustomDimensionRequest) ProtoMessage()
func (x *GetCustomDimensionRequest) ProtoReflect() protoreflect.Message
func (x *GetCustomDimensionRequest) Reset()
func (x *GetCustomDimensionRequest) String() string
Request message for GetCustomMetric RPC.
type GetCustomMetricRequest struct {
// Required. The name of the CustomMetric to get.
// Example format: properties/1234/customMetrics/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetCustomMetricRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetCustomMetricRequest.ProtoReflect.Descriptor instead.
func (x *GetCustomMetricRequest) GetName() string
func (*GetCustomMetricRequest) ProtoMessage()
func (x *GetCustomMetricRequest) ProtoReflect() protoreflect.Message
func (x *GetCustomMetricRequest) Reset()
func (x *GetCustomMetricRequest) String() string
Request message for GetDataRetentionSettings RPC.
type GetDataRetentionSettingsRequest struct {
// Required. The name of the settings to lookup.
// Format:
// properties/{property}/dataRetentionSettings
// Example: "properties/1000/dataRetentionSettings"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetDataRetentionSettingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDataRetentionSettingsRequest.ProtoReflect.Descriptor instead.
func (x *GetDataRetentionSettingsRequest) GetName() string
func (*GetDataRetentionSettingsRequest) ProtoMessage()
func (x *GetDataRetentionSettingsRequest) ProtoReflect() protoreflect.Message
func (x *GetDataRetentionSettingsRequest) Reset()
func (x *GetDataRetentionSettingsRequest) String() string
Request message for GetDataSharingSettings RPC.
type GetDataSharingSettingsRequest struct {
// Required. The name of the settings to lookup.
// Format: accounts/{account}/dataSharingSettings
// Example: "accounts/1000/dataSharingSettings"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetDataSharingSettingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDataSharingSettingsRequest.ProtoReflect.Descriptor instead.
func (x *GetDataSharingSettingsRequest) GetName() string
func (*GetDataSharingSettingsRequest) ProtoMessage()
func (x *GetDataSharingSettingsRequest) ProtoReflect() protoreflect.Message
func (x *GetDataSharingSettingsRequest) Reset()
func (x *GetDataSharingSettingsRequest) String() string
Request message for GetDataStream RPC.
type GetDataStreamRequest struct {
// Required. The name of the DataStream to get.
// Example format: properties/1234/dataStreams/5678
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetDataStreamRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetDataStreamRequest.ProtoReflect.Descriptor instead.
func (x *GetDataStreamRequest) GetName() string
func (*GetDataStreamRequest) ProtoMessage()
func (x *GetDataStreamRequest) ProtoReflect() protoreflect.Message
func (x *GetDataStreamRequest) Reset()
func (x *GetDataStreamRequest) String() string
Request message for GetMeasurementProtocolSecret RPC.
type GetMeasurementProtocolSecretRequest struct {
// Required. The name of the measurement protocol secret to lookup.
// Format:
// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetMeasurementProtocolSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetMeasurementProtocolSecretRequest.ProtoReflect.Descriptor instead.
func (x *GetMeasurementProtocolSecretRequest) GetName() string
func (*GetMeasurementProtocolSecretRequest) ProtoMessage()
func (x *GetMeasurementProtocolSecretRequest) ProtoReflect() protoreflect.Message
func (x *GetMeasurementProtocolSecretRequest) Reset()
func (x *GetMeasurementProtocolSecretRequest) String() string
Request message for GetProperty RPC.
type GetPropertyRequest struct {
// Required. The name of the property to lookup.
// Format: properties/{property_id}
// Example: "properties/1000"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
func (*GetPropertyRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetPropertyRequest.ProtoReflect.Descriptor instead.
func (x *GetPropertyRequest) GetName() string
func (*GetPropertyRequest) ProtoMessage()
func (x *GetPropertyRequest) ProtoReflect() protoreflect.Message
func (x *GetPropertyRequest) Reset()
func (x *GetPropertyRequest) String() string
A link between a GA4 property and a Google Ads account.
type GoogleAdsLink struct {
// Output only. Format:
// properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}
//
// Note: googleAdsLinkId is not the Google Ads customer ID.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. Google Ads customer ID.
CustomerId string `protobuf:"bytes,3,opt,name=customer_id,json=customerId,proto3" json:"customer_id,omitempty"`
// Output only. If true, this link is for a Google Ads manager account.
CanManageClients bool `protobuf:"varint,4,opt,name=can_manage_clients,json=canManageClients,proto3" json:"can_manage_clients,omitempty"`
// Enable personalized advertising features with this integration.
// Automatically publish my Google Analytics audience lists and Google
// Analytics remarketing events/parameters to the linked Google Ads account.
// If this field is not set on create/update, it will be defaulted to true.
AdsPersonalizationEnabled *wrapperspb.BoolValue `protobuf:"bytes,5,opt,name=ads_personalization_enabled,json=adsPersonalizationEnabled,proto3" json:"ads_personalization_enabled,omitempty"`
// Output only. Time when this link was originally created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time when this link was last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Output only. Email address of the user that created the link.
// An empty string will be returned if the email address can't be retrieved.
CreatorEmailAddress string `protobuf:"bytes,9,opt,name=creator_email_address,json=creatorEmailAddress,proto3" json:"creator_email_address,omitempty"`
// contains filtered or unexported fields
}
func (*GoogleAdsLink) Descriptor() ([]byte, []int)
Deprecated: Use GoogleAdsLink.ProtoReflect.Descriptor instead.
func (x *GoogleAdsLink) GetAdsPersonalizationEnabled() *wrapperspb.BoolValue
func (x *GoogleAdsLink) GetCanManageClients() bool
func (x *GoogleAdsLink) GetCreateTime() *timestamppb.Timestamp
func (x *GoogleAdsLink) GetCreatorEmailAddress() string
func (x *GoogleAdsLink) GetCustomerId() string
func (x *GoogleAdsLink) GetName() string
func (x *GoogleAdsLink) GetUpdateTime() *timestamppb.Timestamp
func (*GoogleAdsLink) ProtoMessage()
func (x *GoogleAdsLink) ProtoReflect() protoreflect.Message
func (x *GoogleAdsLink) Reset()
func (x *GoogleAdsLink) String() string
The category selected for this property, used for industry benchmarking.
type IndustryCategory int32
const (
// Industry category unspecified
IndustryCategory_INDUSTRY_CATEGORY_UNSPECIFIED IndustryCategory = 0
// Automotive
IndustryCategory_AUTOMOTIVE IndustryCategory = 1
// Business and industrial markets
IndustryCategory_BUSINESS_AND_INDUSTRIAL_MARKETS IndustryCategory = 2
// Finance
IndustryCategory_FINANCE IndustryCategory = 3
// Healthcare
IndustryCategory_HEALTHCARE IndustryCategory = 4
// Technology
IndustryCategory_TECHNOLOGY IndustryCategory = 5
// Travel
IndustryCategory_TRAVEL IndustryCategory = 6
// Other
IndustryCategory_OTHER IndustryCategory = 7
// Arts and entertainment
IndustryCategory_ARTS_AND_ENTERTAINMENT IndustryCategory = 8
// Beauty and fitness
IndustryCategory_BEAUTY_AND_FITNESS IndustryCategory = 9
// Books and literature
IndustryCategory_BOOKS_AND_LITERATURE IndustryCategory = 10
// Food and drink
IndustryCategory_FOOD_AND_DRINK IndustryCategory = 11
// Games
IndustryCategory_GAMES IndustryCategory = 12
// Hobbies and leisure
IndustryCategory_HOBBIES_AND_LEISURE IndustryCategory = 13
// Home and garden
IndustryCategory_HOME_AND_GARDEN IndustryCategory = 14
// Internet and telecom
IndustryCategory_INTERNET_AND_TELECOM IndustryCategory = 15
// Law and government
IndustryCategory_LAW_AND_GOVERNMENT IndustryCategory = 16
// News
IndustryCategory_NEWS IndustryCategory = 17
// Online communities
IndustryCategory_ONLINE_COMMUNITIES IndustryCategory = 18
// People and society
IndustryCategory_PEOPLE_AND_SOCIETY IndustryCategory = 19
// Pets and animals
IndustryCategory_PETS_AND_ANIMALS IndustryCategory = 20
// Real estate
IndustryCategory_REAL_ESTATE IndustryCategory = 21
// Reference
IndustryCategory_REFERENCE IndustryCategory = 22
// Science
IndustryCategory_SCIENCE IndustryCategory = 23
// Sports
IndustryCategory_SPORTS IndustryCategory = 24
// Jobs and education
IndustryCategory_JOBS_AND_EDUCATION IndustryCategory = 25
// Shopping
IndustryCategory_SHOPPING IndustryCategory = 26
)
func (IndustryCategory) Descriptor() protoreflect.EnumDescriptor
func (x IndustryCategory) Enum() *IndustryCategory
func (IndustryCategory) EnumDescriptor() ([]byte, []int)
Deprecated: Use IndustryCategory.Descriptor instead.
func (x IndustryCategory) Number() protoreflect.EnumNumber
func (x IndustryCategory) String() string
func (IndustryCategory) Type() protoreflect.EnumType
Request message for ListAccountSummaries RPC.
type ListAccountSummariesRequest struct {
// The maximum number of AccountSummary resources to return. The service may
// return fewer than this value, even if there are additional pages.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListAccountSummaries` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListAccountSummaries`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListAccountSummariesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAccountSummariesRequest.ProtoReflect.Descriptor instead.
func (x *ListAccountSummariesRequest) GetPageSize() int32
func (x *ListAccountSummariesRequest) GetPageToken() string
func (*ListAccountSummariesRequest) ProtoMessage()
func (x *ListAccountSummariesRequest) ProtoReflect() protoreflect.Message
func (x *ListAccountSummariesRequest) Reset()
func (x *ListAccountSummariesRequest) String() string
Response message for ListAccountSummaries RPC.
type ListAccountSummariesResponse struct {
// Account summaries of all accounts the caller has access to.
AccountSummaries []*AccountSummary `protobuf:"bytes,1,rep,name=account_summaries,json=accountSummaries,proto3" json:"account_summaries,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListAccountSummariesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAccountSummariesResponse.ProtoReflect.Descriptor instead.
func (x *ListAccountSummariesResponse) GetAccountSummaries() []*AccountSummary
func (x *ListAccountSummariesResponse) GetNextPageToken() string
func (*ListAccountSummariesResponse) ProtoMessage()
func (x *ListAccountSummariesResponse) ProtoReflect() protoreflect.Message
func (x *ListAccountSummariesResponse) Reset()
func (x *ListAccountSummariesResponse) String() string
Request message for ListAccounts RPC.
type ListAccountsRequest struct {
// The maximum number of resources to return. The service may return
// fewer than this value, even if there are additional pages.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
PageSize int32 `protobuf:"varint,1,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListAccounts` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListAccounts` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,2,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Whether to include soft-deleted (ie: "trashed") Accounts in the
// results. Accounts can be inspected to determine whether they are deleted or
// not.
ShowDeleted bool `protobuf:"varint,3,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`
// contains filtered or unexported fields
}
func (*ListAccountsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListAccountsRequest.ProtoReflect.Descriptor instead.
func (x *ListAccountsRequest) GetPageSize() int32
func (x *ListAccountsRequest) GetPageToken() string
func (x *ListAccountsRequest) GetShowDeleted() bool
func (*ListAccountsRequest) ProtoMessage()
func (x *ListAccountsRequest) ProtoReflect() protoreflect.Message
func (x *ListAccountsRequest) Reset()
func (x *ListAccountsRequest) String() string
Request message for ListAccounts RPC.
type ListAccountsResponse struct {
// Results that were accessible to the caller.
Accounts []*Account `protobuf:"bytes,1,rep,name=accounts,proto3" json:"accounts,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListAccountsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListAccountsResponse.ProtoReflect.Descriptor instead.
func (x *ListAccountsResponse) GetAccounts() []*Account
func (x *ListAccountsResponse) GetNextPageToken() string
func (*ListAccountsResponse) ProtoMessage()
func (x *ListAccountsResponse) ProtoReflect() protoreflect.Message
func (x *ListAccountsResponse) Reset()
func (x *ListAccountsResponse) String() string
Request message for ListConversionEvents RPC
type ListConversionEventsRequest struct {
// Required. The resource name of the parent property.
// Example: 'properties/123'
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListConversionEvents` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListConversionEvents`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListConversionEventsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListConversionEventsRequest.ProtoReflect.Descriptor instead.
func (x *ListConversionEventsRequest) GetPageSize() int32
func (x *ListConversionEventsRequest) GetPageToken() string
func (x *ListConversionEventsRequest) GetParent() string
func (*ListConversionEventsRequest) ProtoMessage()
func (x *ListConversionEventsRequest) ProtoReflect() protoreflect.Message
func (x *ListConversionEventsRequest) Reset()
func (x *ListConversionEventsRequest) String() string
Response message for ListConversionEvents RPC.
type ListConversionEventsResponse struct {
// The requested conversion events
ConversionEvents []*ConversionEvent `protobuf:"bytes,1,rep,name=conversion_events,json=conversionEvents,proto3" json:"conversion_events,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListConversionEventsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListConversionEventsResponse.ProtoReflect.Descriptor instead.
func (x *ListConversionEventsResponse) GetConversionEvents() []*ConversionEvent
func (x *ListConversionEventsResponse) GetNextPageToken() string
func (*ListConversionEventsResponse) ProtoMessage()
func (x *ListConversionEventsResponse) ProtoReflect() protoreflect.Message
func (x *ListConversionEventsResponse) Reset()
func (x *ListConversionEventsResponse) String() string
Request message for ListCustomDimensions RPC.
type ListCustomDimensionsRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200 (higher values will be coerced to the maximum).
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListCustomDimensions` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListCustomDimensions`
// must match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListCustomDimensionsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListCustomDimensionsRequest.ProtoReflect.Descriptor instead.
func (x *ListCustomDimensionsRequest) GetPageSize() int32
func (x *ListCustomDimensionsRequest) GetPageToken() string
func (x *ListCustomDimensionsRequest) GetParent() string
func (*ListCustomDimensionsRequest) ProtoMessage()
func (x *ListCustomDimensionsRequest) ProtoReflect() protoreflect.Message
func (x *ListCustomDimensionsRequest) Reset()
func (x *ListCustomDimensionsRequest) String() string
Response message for ListCustomDimensions RPC.
type ListCustomDimensionsResponse struct {
// List of CustomDimensions.
CustomDimensions []*CustomDimension `protobuf:"bytes,1,rep,name=custom_dimensions,json=customDimensions,proto3" json:"custom_dimensions,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListCustomDimensionsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListCustomDimensionsResponse.ProtoReflect.Descriptor instead.
func (x *ListCustomDimensionsResponse) GetCustomDimensions() []*CustomDimension
func (x *ListCustomDimensionsResponse) GetNextPageToken() string
func (*ListCustomDimensionsResponse) ProtoMessage()
func (x *ListCustomDimensionsResponse) ProtoReflect() protoreflect.Message
func (x *ListCustomDimensionsResponse) Reset()
func (x *ListCustomDimensionsResponse) String() string
Request message for ListCustomMetrics RPC.
type ListCustomMetricsRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200 (higher values will be coerced to the maximum).
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListCustomMetrics` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListCustomMetrics` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListCustomMetricsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListCustomMetricsRequest.ProtoReflect.Descriptor instead.
func (x *ListCustomMetricsRequest) GetPageSize() int32
func (x *ListCustomMetricsRequest) GetPageToken() string
func (x *ListCustomMetricsRequest) GetParent() string
func (*ListCustomMetricsRequest) ProtoMessage()
func (x *ListCustomMetricsRequest) ProtoReflect() protoreflect.Message
func (x *ListCustomMetricsRequest) Reset()
func (x *ListCustomMetricsRequest) String() string
Response message for ListCustomMetrics RPC.
type ListCustomMetricsResponse struct {
// List of CustomMetrics.
CustomMetrics []*CustomMetric `protobuf:"bytes,1,rep,name=custom_metrics,json=customMetrics,proto3" json:"custom_metrics,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListCustomMetricsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListCustomMetricsResponse.ProtoReflect.Descriptor instead.
func (x *ListCustomMetricsResponse) GetCustomMetrics() []*CustomMetric
func (x *ListCustomMetricsResponse) GetNextPageToken() string
func (*ListCustomMetricsResponse) ProtoMessage()
func (x *ListCustomMetricsResponse) ProtoReflect() protoreflect.Message
func (x *ListCustomMetricsResponse) Reset()
func (x *ListCustomMetricsResponse) String() string
Request message for ListDataStreams RPC.
type ListDataStreamsRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200 (higher values will be coerced to the maximum).
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListDataStreams` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListDataStreams` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListDataStreamsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListDataStreamsRequest.ProtoReflect.Descriptor instead.
func (x *ListDataStreamsRequest) GetPageSize() int32
func (x *ListDataStreamsRequest) GetPageToken() string
func (x *ListDataStreamsRequest) GetParent() string
func (*ListDataStreamsRequest) ProtoMessage()
func (x *ListDataStreamsRequest) ProtoReflect() protoreflect.Message
func (x *ListDataStreamsRequest) Reset()
func (x *ListDataStreamsRequest) String() string
Response message for ListDataStreams RPC.
type ListDataStreamsResponse struct {
// List of DataStreams.
DataStreams []*DataStream `protobuf:"bytes,1,rep,name=data_streams,json=dataStreams,proto3" json:"data_streams,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListDataStreamsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListDataStreamsResponse.ProtoReflect.Descriptor instead.
func (x *ListDataStreamsResponse) GetDataStreams() []*DataStream
func (x *ListDataStreamsResponse) GetNextPageToken() string
func (*ListDataStreamsResponse) ProtoMessage()
func (x *ListDataStreamsResponse) ProtoReflect() protoreflect.Message
func (x *ListDataStreamsResponse) Reset()
func (x *ListDataStreamsResponse) String() string
Request message for ListFirebaseLinks RPC
type ListFirebaseLinksRequest struct {
// Required. Format: properties/{property_id}
// Example: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return. The service may return
// fewer than this value, even if there are additional pages.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListFirebaseLinks` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListFirebaseLinks` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListFirebaseLinksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListFirebaseLinksRequest.ProtoReflect.Descriptor instead.
func (x *ListFirebaseLinksRequest) GetPageSize() int32
func (x *ListFirebaseLinksRequest) GetPageToken() string
func (x *ListFirebaseLinksRequest) GetParent() string
func (*ListFirebaseLinksRequest) ProtoMessage()
func (x *ListFirebaseLinksRequest) ProtoReflect() protoreflect.Message
func (x *ListFirebaseLinksRequest) Reset()
func (x *ListFirebaseLinksRequest) String() string
Response message for ListFirebaseLinks RPC
type ListFirebaseLinksResponse struct {
// List of FirebaseLinks. This will have at most one value.
FirebaseLinks []*FirebaseLink `protobuf:"bytes,1,rep,name=firebase_links,json=firebaseLinks,proto3" json:"firebase_links,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
// Currently, Google Analytics supports only one FirebaseLink per property,
// so this will never be populated.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListFirebaseLinksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListFirebaseLinksResponse.ProtoReflect.Descriptor instead.
func (x *ListFirebaseLinksResponse) GetFirebaseLinks() []*FirebaseLink
func (x *ListFirebaseLinksResponse) GetNextPageToken() string
func (*ListFirebaseLinksResponse) ProtoMessage()
func (x *ListFirebaseLinksResponse) ProtoReflect() protoreflect.Message
func (x *ListFirebaseLinksResponse) Reset()
func (x *ListFirebaseLinksResponse) String() string
Request message for ListGoogleAdsLinks RPC.
type ListGoogleAdsLinksRequest struct {
// Required. Example format: properties/1234
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200 (higher values will be coerced to the maximum).
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListGoogleAdsLinks` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListGoogleAdsLinks` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListGoogleAdsLinksRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListGoogleAdsLinksRequest.ProtoReflect.Descriptor instead.
func (x *ListGoogleAdsLinksRequest) GetPageSize() int32
func (x *ListGoogleAdsLinksRequest) GetPageToken() string
func (x *ListGoogleAdsLinksRequest) GetParent() string
func (*ListGoogleAdsLinksRequest) ProtoMessage()
func (x *ListGoogleAdsLinksRequest) ProtoReflect() protoreflect.Message
func (x *ListGoogleAdsLinksRequest) Reset()
func (x *ListGoogleAdsLinksRequest) String() string
Response message for ListGoogleAdsLinks RPC.
type ListGoogleAdsLinksResponse struct {
// List of GoogleAdsLinks.
GoogleAdsLinks []*GoogleAdsLink `protobuf:"bytes,1,rep,name=google_ads_links,json=googleAdsLinks,proto3" json:"google_ads_links,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListGoogleAdsLinksResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListGoogleAdsLinksResponse.ProtoReflect.Descriptor instead.
func (x *ListGoogleAdsLinksResponse) GetGoogleAdsLinks() []*GoogleAdsLink
func (x *ListGoogleAdsLinksResponse) GetNextPageToken() string
func (*ListGoogleAdsLinksResponse) ProtoMessage()
func (x *ListGoogleAdsLinksResponse) ProtoReflect() protoreflect.Message
func (x *ListGoogleAdsLinksResponse) Reset()
func (x *ListGoogleAdsLinksResponse) String() string
Request message for ListMeasurementProtocolSecret RPC
type ListMeasurementProtocolSecretsRequest struct {
// Required. The resource name of the parent stream.
// Format:
// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// The maximum number of resources to return.
// If unspecified, at most 10 resources will be returned.
// The maximum value is 10. Higher values will be coerced to the maximum.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListMeasurementProtocolSecrets`
// call. Provide this to retrieve the subsequent page. When paginating, all
// other parameters provided to `ListMeasurementProtocolSecrets` must match
// the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListMeasurementProtocolSecretsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListMeasurementProtocolSecretsRequest.ProtoReflect.Descriptor instead.
func (x *ListMeasurementProtocolSecretsRequest) GetPageSize() int32
func (x *ListMeasurementProtocolSecretsRequest) GetPageToken() string
func (x *ListMeasurementProtocolSecretsRequest) GetParent() string
func (*ListMeasurementProtocolSecretsRequest) ProtoMessage()
func (x *ListMeasurementProtocolSecretsRequest) ProtoReflect() protoreflect.Message
func (x *ListMeasurementProtocolSecretsRequest) Reset()
func (x *ListMeasurementProtocolSecretsRequest) String() string
Response message for ListMeasurementProtocolSecret RPC
type ListMeasurementProtocolSecretsResponse struct {
// A list of secrets for the parent stream specified in the request.
MeasurementProtocolSecrets []*MeasurementProtocolSecret `protobuf:"bytes,1,rep,name=measurement_protocol_secrets,json=measurementProtocolSecrets,proto3" json:"measurement_protocol_secrets,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListMeasurementProtocolSecretsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListMeasurementProtocolSecretsResponse.ProtoReflect.Descriptor instead.
func (x *ListMeasurementProtocolSecretsResponse) GetMeasurementProtocolSecrets() []*MeasurementProtocolSecret
func (x *ListMeasurementProtocolSecretsResponse) GetNextPageToken() string
func (*ListMeasurementProtocolSecretsResponse) ProtoMessage()
func (x *ListMeasurementProtocolSecretsResponse) ProtoReflect() protoreflect.Message
func (x *ListMeasurementProtocolSecretsResponse) Reset()
func (x *ListMeasurementProtocolSecretsResponse) String() string
Request message for ListProperties RPC.
type ListPropertiesRequest struct {
// Required. An expression for filtering the results of the request.
// Fields eligible for filtering are:
// `parent:`(The resource name of the parent account/property) or
// `ancestor:`(The resource name of the parent account) or
// `firebase_project:`(The id or number of the linked firebase project).
// Some examples of filters:
//
// ```
// | Filter | Description |
// |-----------------------------|-------------------------------------------|
// | parent:accounts/123 | The account with account id: 123. |
// | parent:properties/123 | The property with property id: 123. |
// | ancestor:accounts/123 | The account with account id: 123. |
// | firebase_project:project-id | The firebase project with id: project-id. |
// | firebase_project:123 | The firebase project with number: 123. |
// ```
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
// The maximum number of resources to return. The service may return
// fewer than this value, even if there are additional pages.
// If unspecified, at most 50 resources will be returned.
// The maximum value is 200; (higher values will be coerced to the maximum)
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// A page token, received from a previous `ListProperties` call.
// Provide this to retrieve the subsequent page.
// When paginating, all other parameters provided to `ListProperties` must
// match the call that provided the page token.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// Whether to include soft-deleted (ie: "trashed") Properties in the
// results. Properties can be inspected to determine whether they are deleted
// or not.
ShowDeleted bool `protobuf:"varint,4,opt,name=show_deleted,json=showDeleted,proto3" json:"show_deleted,omitempty"`
// contains filtered or unexported fields
}
func (*ListPropertiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListPropertiesRequest.ProtoReflect.Descriptor instead.
func (x *ListPropertiesRequest) GetFilter() string
func (x *ListPropertiesRequest) GetPageSize() int32
func (x *ListPropertiesRequest) GetPageToken() string
func (x *ListPropertiesRequest) GetShowDeleted() bool
func (*ListPropertiesRequest) ProtoMessage()
func (x *ListPropertiesRequest) ProtoReflect() protoreflect.Message
func (x *ListPropertiesRequest) Reset()
func (x *ListPropertiesRequest) String() string
Response message for ListProperties RPC.
type ListPropertiesResponse struct {
// Results that matched the filter criteria and were accessible to the caller.
Properties []*Property `protobuf:"bytes,1,rep,name=properties,proto3" json:"properties,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*ListPropertiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListPropertiesResponse.ProtoReflect.Descriptor instead.
func (x *ListPropertiesResponse) GetNextPageToken() string
func (x *ListPropertiesResponse) GetProperties() []*Property
func (*ListPropertiesResponse) ProtoMessage()
func (x *ListPropertiesResponse) ProtoReflect() protoreflect.Message
func (x *ListPropertiesResponse) Reset()
func (x *ListPropertiesResponse) String() string
A secret value used for sending hits to Measurement Protocol.
type MeasurementProtocolSecret struct {
// Output only. Resource name of this secret. This secret may be a child of
// any type of stream. Format:
// properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Human-readable display name for this secret.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Output only. The measurement protocol secret value. Pass this value to the
// api_secret field of the Measurement Protocol API when sending hits to this
// secret's parent property.
SecretValue string `protobuf:"bytes,3,opt,name=secret_value,json=secretValue,proto3" json:"secret_value,omitempty"`
// contains filtered or unexported fields
}
func (*MeasurementProtocolSecret) Descriptor() ([]byte, []int)
Deprecated: Use MeasurementProtocolSecret.ProtoReflect.Descriptor instead.
func (x *MeasurementProtocolSecret) GetDisplayName() string
func (x *MeasurementProtocolSecret) GetName() string
func (x *MeasurementProtocolSecret) GetSecretValue() string
func (*MeasurementProtocolSecret) ProtoMessage()
func (x *MeasurementProtocolSecret) ProtoReflect() protoreflect.Message
func (x *MeasurementProtocolSecret) Reset()
func (x *MeasurementProtocolSecret) String() string
To represent a number.
type NumericValue struct {
// One of a numeric value
//
// Types that are assignable to OneValue:
//
// *NumericValue_Int64Value
// *NumericValue_DoubleValue
OneValue isNumericValue_OneValue `protobuf_oneof:"one_value"`
// contains filtered or unexported fields
}
func (*NumericValue) Descriptor() ([]byte, []int)
Deprecated: Use NumericValue.ProtoReflect.Descriptor instead.
func (x *NumericValue) GetDoubleValue() float64
func (x *NumericValue) GetInt64Value() int64
func (m *NumericValue) GetOneValue() isNumericValue_OneValue
func (*NumericValue) ProtoMessage()
func (x *NumericValue) ProtoReflect() protoreflect.Message
func (x *NumericValue) Reset()
func (x *NumericValue) String() string
type NumericValue_DoubleValue struct {
// Double value
DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}
type NumericValue_Int64Value struct {
// Integer value
Int64Value int64 `protobuf:"varint,1,opt,name=int64_value,json=int64Value,proto3,oneof"`
}
A resource message representing a Google Analytics GA4 property.
type Property struct {
// Output only. Resource name of this property.
// Format: properties/{property_id}
// Example: "properties/1000"
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Immutable. The property type for this Property resource. When creating a
// property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then
// "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY"
// types cannot yet be created with the Google Analytics Admin API.
PropertyType PropertyType `protobuf:"varint,14,opt,name=property_type,json=propertyType,proto3,enum=google.analytics.admin.v1beta.PropertyType" json:"property_type,omitempty"`
// Output only. Time when the entity was originally created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. Time when entity payload fields were last updated.
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
// Immutable. Resource name of this property's logical parent.
//
// Note: The Property-Moving UI can be used to change the parent.
// Format: accounts/{account}, properties/{property}
// Example: "accounts/100", "properties/101"
Parent string `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Human-readable display name for this property.
//
// The max allowed display name length is 100 UTF-16 code units.
DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// Industry associated with this property
// Example: AUTOMOTIVE, FOOD_AND_DRINK
IndustryCategory IndustryCategory `protobuf:"varint,6,opt,name=industry_category,json=industryCategory,proto3,enum=google.analytics.admin.v1beta.IndustryCategory" json:"industry_category,omitempty"`
// Required. Reporting Time Zone, used as the day boundary for reports,
// regardless of where the data originates. If the time zone honors DST,
// Analytics will automatically adjust for the changes.
//
// NOTE: Changing the time zone only affects data going forward, and is not
// applied retroactively.
//
// Format: https://www.iana.org/time-zones
// Example: "America/Los_Angeles"
TimeZone string `protobuf:"bytes,7,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// The currency type used in reports involving monetary values.
//
// Format: https://en.wikipedia.org/wiki/ISO_4217
// Examples: "USD", "EUR", "JPY"
CurrencyCode string `protobuf:"bytes,8,opt,name=currency_code,json=currencyCode,proto3" json:"currency_code,omitempty"`
// Output only. The Google Analytics service level that applies to this
// property.
ServiceLevel ServiceLevel `protobuf:"varint,10,opt,name=service_level,json=serviceLevel,proto3,enum=google.analytics.admin.v1beta.ServiceLevel" json:"service_level,omitempty"`
// Output only. If set, the time at which this property was trashed. If not
// set, then this property is not currently in the trash can.
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
// Output only. If set, the time at which this trashed property will be
// permanently deleted. If not set, then this property is not currently in the
// trash can and is not slated to be deleted.
ExpireTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=expire_time,json=expireTime,proto3" json:"expire_time,omitempty"`
// Immutable. The resource name of the parent account
// Format: accounts/{account_id}
// Example: "accounts/123"
Account string `protobuf:"bytes,13,opt,name=account,proto3" json:"account,omitempty"`
// contains filtered or unexported fields
}
func (*Property) Descriptor() ([]byte, []int)
Deprecated: Use Property.ProtoReflect.Descriptor instead.
func (x *Property) GetAccount() string
func (x *Property) GetCreateTime() *timestamppb.Timestamp
func (x *Property) GetCurrencyCode() string
func (x *Property) GetDeleteTime() *timestamppb.Timestamp
func (x *Property) GetDisplayName() string
func (x *Property) GetExpireTime() *timestamppb.Timestamp
func (x *Property) GetIndustryCategory() IndustryCategory
func (x *Property) GetName() string
func (x *Property) GetParent() string
func (x *Property) GetPropertyType() PropertyType
func (x *Property) GetServiceLevel() ServiceLevel
func (x *Property) GetTimeZone() string
func (x *Property) GetUpdateTime() *timestamppb.Timestamp
func (*Property) ProtoMessage()
func (x *Property) ProtoReflect() protoreflect.Message
func (x *Property) Reset()
func (x *Property) String() string
A virtual resource representing metadata for a GA4 property.
type PropertySummary struct {
// Resource name of property referred to by this property summary
// Format: properties/{property_id}
// Example: "properties/1000"
Property string `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// Display name for the property referred to in this property summary.
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
// The property's property type.
PropertyType PropertyType `protobuf:"varint,3,opt,name=property_type,json=propertyType,proto3,enum=google.analytics.admin.v1beta.PropertyType" json:"property_type,omitempty"`
// Resource name of this property's logical parent.
//
// Note: The Property-Moving UI can be used to change the parent.
// Format: accounts/{account}, properties/{property}
// Example: "accounts/100", "properties/200"
Parent string `protobuf:"bytes,4,opt,name=parent,proto3" json:"parent,omitempty"`
// contains filtered or unexported fields
}
func (*PropertySummary) Descriptor() ([]byte, []int)
Deprecated: Use PropertySummary.ProtoReflect.Descriptor instead.
func (x *PropertySummary) GetDisplayName() string
func (x *PropertySummary) GetParent() string
func (x *PropertySummary) GetProperty() string
func (x *PropertySummary) GetPropertyType() PropertyType
func (*PropertySummary) ProtoMessage()
func (x *PropertySummary) ProtoReflect() protoreflect.Message
func (x *PropertySummary) Reset()
func (x *PropertySummary) String() string
Types of Property resources.
type PropertyType int32
const (
// Unknown or unspecified property type
PropertyType_PROPERTY_TYPE_UNSPECIFIED PropertyType = 0
// Ordinary GA4 property
PropertyType_PROPERTY_TYPE_ORDINARY PropertyType = 1
// GA4 subproperty
PropertyType_PROPERTY_TYPE_SUBPROPERTY PropertyType = 2
// GA4 rollup property
PropertyType_PROPERTY_TYPE_ROLLUP PropertyType = 3
)
func (PropertyType) Descriptor() protoreflect.EnumDescriptor
func (x PropertyType) Enum() *PropertyType
func (PropertyType) EnumDescriptor() ([]byte, []int)
Deprecated: Use PropertyType.Descriptor instead.
func (x PropertyType) Number() protoreflect.EnumNumber
func (x PropertyType) String() string
func (PropertyType) Type() protoreflect.EnumType
Request message for ProvisionAccountTicket RPC.
type ProvisionAccountTicketRequest struct {
// The account to create.
Account *Account `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
// Redirect URI where the user will be sent after accepting Terms of Service.
// Must be configured in Cloud Console as a Redirect URI.
RedirectUri string `protobuf:"bytes,2,opt,name=redirect_uri,json=redirectUri,proto3" json:"redirect_uri,omitempty"`
// contains filtered or unexported fields
}
func (*ProvisionAccountTicketRequest) Descriptor() ([]byte, []int)
Deprecated: Use ProvisionAccountTicketRequest.ProtoReflect.Descriptor instead.
func (x *ProvisionAccountTicketRequest) GetAccount() *Account
func (x *ProvisionAccountTicketRequest) GetRedirectUri() string
func (*ProvisionAccountTicketRequest) ProtoMessage()
func (x *ProvisionAccountTicketRequest) ProtoReflect() protoreflect.Message
func (x *ProvisionAccountTicketRequest) Reset()
func (x *ProvisionAccountTicketRequest) String() string
Response message for ProvisionAccountTicket RPC.
type ProvisionAccountTicketResponse struct {
// The param to be passed in the ToS link.
AccountTicketId string `protobuf:"bytes,1,opt,name=account_ticket_id,json=accountTicketId,proto3" json:"account_ticket_id,omitempty"`
// contains filtered or unexported fields
}
func (*ProvisionAccountTicketResponse) Descriptor() ([]byte, []int)
Deprecated: Use ProvisionAccountTicketResponse.ProtoReflect.Descriptor instead.
func (x *ProvisionAccountTicketResponse) GetAccountTicketId() string
func (*ProvisionAccountTicketResponse) ProtoMessage()
func (x *ProvisionAccountTicketResponse) ProtoReflect() protoreflect.Message
func (x *ProvisionAccountTicketResponse) Reset()
func (x *ProvisionAccountTicketResponse) String() string
The request for a Data Access Record Report.
type RunAccessReportRequest struct {
// The Data Access Report supports requesting at the property level or account
// level. If requested at the account level, Data Access Reports include all
// access for all properties under that account.
//
// To request at the property level, entity should be for example
// 'properties/123' if "123" is your GA4 property ID. To request at the
// account level, entity should be for example 'accounts/1234' if "1234" is
// your GA4 Account ID.
Entity string `protobuf:"bytes,1,opt,name=entity,proto3" json:"entity,omitempty"`
// The dimensions requested and displayed in the response. Requests are
// allowed up to 9 dimensions.
Dimensions []*AccessDimension `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
// The metrics requested and displayed in the response. Requests are allowed
// up to 10 metrics.
Metrics []*AccessMetric `protobuf:"bytes,3,rep,name=metrics,proto3" json:"metrics,omitempty"`
// Date ranges of access records to read. If multiple date ranges are
// requested, each response row will contain a zero based date range index. If
// two date ranges overlap, the access records for the overlapping days is
// included in the response rows for both date ranges. Requests are allowed up
// to 2 date ranges.
DateRanges []*AccessDateRange `protobuf:"bytes,4,rep,name=date_ranges,json=dateRanges,proto3" json:"date_ranges,omitempty"`
// Dimension filters let you restrict report response to specific
// dimension values which match the filter. For example, filtering on access
// records of a single user. To learn more, see [Fundamentals of Dimension
// Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters)
// for examples. Metrics cannot be used in this filter.
DimensionFilter *AccessFilterExpression `protobuf:"bytes,5,opt,name=dimension_filter,json=dimensionFilter,proto3" json:"dimension_filter,omitempty"`
// Metric filters allow you to restrict report response to specific metric
// values which match the filter. Metric filters are applied after aggregating
// the report's rows, similar to SQL having-clause. Dimensions cannot be used
// in this filter.
MetricFilter *AccessFilterExpression `protobuf:"bytes,6,opt,name=metric_filter,json=metricFilter,proto3" json:"metric_filter,omitempty"`
// The row count of the start row. The first row is counted as row 0. If
// offset is unspecified, it is treated as 0. If offset is zero, then this
// method will return the first page of results with `limit` entries.
//
// To learn more about this pagination parameter, see
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
Offset int64 `protobuf:"varint,7,opt,name=offset,proto3" json:"offset,omitempty"`
// The number of rows to return. If unspecified, 10,000 rows are returned. The
// API returns a maximum of 100,000 rows per request, no matter how many you
// ask for. `limit` must be positive.
//
// The API may return fewer rows than the requested `limit`, if there aren't
// as many remaining rows as the `limit`. For instance, there are fewer than
// 300 possible values for the dimension `country`, so when reporting on only
// `country`, you can't get more than 300 rows, even if you set `limit` to a
// higher value.
//
// To learn more about this pagination parameter, see
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
Limit int64 `protobuf:"varint,8,opt,name=limit,proto3" json:"limit,omitempty"`
// This request's time zone if specified. If unspecified, the property's time
// zone is used. The request's time zone is used to interpret the start & end
// dates of the report.
//
// Formatted as strings from the IANA Time Zone database
// (https://www.iana.org/time-zones); for example "America/New_York" or
// "Asia/Tokyo".
TimeZone string `protobuf:"bytes,9,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
// Specifies how rows are ordered in the response.
OrderBys []*AccessOrderBy `protobuf:"bytes,10,rep,name=order_bys,json=orderBys,proto3" json:"order_bys,omitempty"`
// Toggles whether to return the current state of this Analytics Property's
// quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level
// requests, this field must be false.
ReturnEntityQuota bool `protobuf:"varint,11,opt,name=return_entity_quota,json=returnEntityQuota,proto3" json:"return_entity_quota,omitempty"`
// contains filtered or unexported fields
}
func (*RunAccessReportRequest) Descriptor() ([]byte, []int)
Deprecated: Use RunAccessReportRequest.ProtoReflect.Descriptor instead.
func (x *RunAccessReportRequest) GetDateRanges() []*AccessDateRange
func (x *RunAccessReportRequest) GetDimensionFilter() *AccessFilterExpression
func (x *RunAccessReportRequest) GetDimensions() []*AccessDimension
func (x *RunAccessReportRequest) GetEntity() string
func (x *RunAccessReportRequest) GetLimit() int64
func (x *RunAccessReportRequest) GetMetricFilter() *AccessFilterExpression
func (x *RunAccessReportRequest) GetMetrics() []*AccessMetric
func (x *RunAccessReportRequest) GetOffset() int64
func (x *RunAccessReportRequest) GetOrderBys() []*AccessOrderBy
func (x *RunAccessReportRequest) GetReturnEntityQuota() bool
func (x *RunAccessReportRequest) GetTimeZone() string
func (*RunAccessReportRequest) ProtoMessage()
func (x *RunAccessReportRequest) ProtoReflect() protoreflect.Message
func (x *RunAccessReportRequest) Reset()
func (x *RunAccessReportRequest) String() string
The customized Data Access Record Report response.
type RunAccessReportResponse struct {
// The header for a column in the report that corresponds to a specific
// dimension. The number of DimensionHeaders and ordering of DimensionHeaders
// matches the dimensions present in rows.
DimensionHeaders []*AccessDimensionHeader `protobuf:"bytes,1,rep,name=dimension_headers,json=dimensionHeaders,proto3" json:"dimension_headers,omitempty"`
// The header for a column in the report that corresponds to a specific
// metric. The number of MetricHeaders and ordering of MetricHeaders matches
// the metrics present in rows.
MetricHeaders []*AccessMetricHeader `protobuf:"bytes,2,rep,name=metric_headers,json=metricHeaders,proto3" json:"metric_headers,omitempty"`
// Rows of dimension value combinations and metric values in the report.
Rows []*AccessRow `protobuf:"bytes,3,rep,name=rows,proto3" json:"rows,omitempty"`
// The total number of rows in the query result. `rowCount` is independent of
// the number of rows returned in the response, the `limit` request
// parameter, and the `offset` request parameter. For example if a query
// returns 175 rows and includes `limit` of 50 in the API request, the
// response will contain `rowCount` of 175 but only 50 rows.
//
// To learn more about this pagination parameter, see
// [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).
RowCount int32 `protobuf:"varint,4,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
// The quota state for this Analytics property including this request. This
// field doesn't work with account-level requests.
Quota *AccessQuota `protobuf:"bytes,5,opt,name=quota,proto3" json:"quota,omitempty"`
// contains filtered or unexported fields
}
func (*RunAccessReportResponse) Descriptor() ([]byte, []int)
Deprecated: Use RunAccessReportResponse.ProtoReflect.Descriptor instead.
func (x *RunAccessReportResponse) GetDimensionHeaders() []*AccessDimensionHeader
func (x *RunAccessReportResponse) GetMetricHeaders() []*AccessMetricHeader
func (x *RunAccessReportResponse) GetQuota() *AccessQuota
func (x *RunAccessReportResponse) GetRowCount() int32
func (x *RunAccessReportResponse) GetRows() []*AccessRow
func (*RunAccessReportResponse) ProtoMessage()
func (x *RunAccessReportResponse) ProtoReflect() protoreflect.Message
func (x *RunAccessReportResponse) Reset()
func (x *RunAccessReportResponse) String() string
Request message for SearchChangeHistoryEvents RPC.
type SearchChangeHistoryEventsRequest struct {
// Required. The account resource for which to return change history
// resources.
Account string `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
// Optional. Resource name for a child property. If set, only return changes
// made to this property or its child resources.
Property string `protobuf:"bytes,2,opt,name=property,proto3" json:"property,omitempty"`
// Optional. If set, only return changes if they are for a resource that
// matches at least one of these types.
ResourceType []ChangeHistoryResourceType `protobuf:"varint,3,rep,packed,name=resource_type,json=resourceType,proto3,enum=google.analytics.admin.v1beta.ChangeHistoryResourceType" json:"resource_type,omitempty"`
// Optional. If set, only return changes that match one or more of these types
// of actions.
Action []ActionType `protobuf:"varint,4,rep,packed,name=action,proto3,enum=google.analytics.admin.v1beta.ActionType" json:"action,omitempty"`
// Optional. If set, only return changes if they are made by a user in this
// list.
ActorEmail []string `protobuf:"bytes,5,rep,name=actor_email,json=actorEmail,proto3" json:"actor_email,omitempty"`
// Optional. If set, only return changes made after this time (inclusive).
EarliestChangeTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=earliest_change_time,json=earliestChangeTime,proto3" json:"earliest_change_time,omitempty"`
// Optional. If set, only return changes made before this time (inclusive).
LatestChangeTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=latest_change_time,json=latestChangeTime,proto3" json:"latest_change_time,omitempty"`
// Optional. The maximum number of ChangeHistoryEvent items to return.
// The service may return fewer than this value, even if there are additional
// pages. If unspecified, at most 50 items will be returned.
// The maximum value is 200 (higher values will be coerced to the maximum).
PageSize int32 `protobuf:"varint,8,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// Optional. A page token, received from a previous
// `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent
// page. When paginating, all other parameters provided to
// `SearchChangeHistoryEvents` must match the call that provided the page
// token.
PageToken string `protobuf:"bytes,9,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}
func (*SearchChangeHistoryEventsRequest) Descriptor() ([]byte, []int)
Deprecated: Use SearchChangeHistoryEventsRequest.ProtoReflect.Descriptor instead.
func (x *SearchChangeHistoryEventsRequest) GetAccount() string
func (x *SearchChangeHistoryEventsRequest) GetAction() []ActionType
func (x *SearchChangeHistoryEventsRequest) GetActorEmail() []string
func (x *SearchChangeHistoryEventsRequest) GetEarliestChangeTime() *timestamppb.Timestamp
func (x *SearchChangeHistoryEventsRequest) GetLatestChangeTime() *timestamppb.Timestamp
func (x *SearchChangeHistoryEventsRequest) GetPageSize() int32
func (x *SearchChangeHistoryEventsRequest) GetPageToken() string
func (x *SearchChangeHistoryEventsRequest) GetProperty() string
func (x *SearchChangeHistoryEventsRequest) GetResourceType() []ChangeHistoryResourceType
func (*SearchChangeHistoryEventsRequest) ProtoMessage()
func (x *SearchChangeHistoryEventsRequest) ProtoReflect() protoreflect.Message
func (x *SearchChangeHistoryEventsRequest) Reset()
func (x *SearchChangeHistoryEventsRequest) String() string
Response message for SearchAccounts RPC.
type SearchChangeHistoryEventsResponse struct {
// Results that were accessible to the caller.
ChangeHistoryEvents []*ChangeHistoryEvent `protobuf:"bytes,1,rep,name=change_history_events,json=changeHistoryEvents,proto3" json:"change_history_events,omitempty"`
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}
func (*SearchChangeHistoryEventsResponse) Descriptor() ([]byte, []int)
Deprecated: Use SearchChangeHistoryEventsResponse.ProtoReflect.Descriptor instead.
func (x *SearchChangeHistoryEventsResponse) GetChangeHistoryEvents() []*ChangeHistoryEvent
func (x *SearchChangeHistoryEventsResponse) GetNextPageToken() string
func (*SearchChangeHistoryEventsResponse) ProtoMessage()
func (x *SearchChangeHistoryEventsResponse) ProtoReflect() protoreflect.Message
func (x *SearchChangeHistoryEventsResponse) Reset()
func (x *SearchChangeHistoryEventsResponse) String() string
Various levels of service for Google Analytics.
type ServiceLevel int32
const (
// Service level not specified or invalid.
ServiceLevel_SERVICE_LEVEL_UNSPECIFIED ServiceLevel = 0
// The standard version of Google Analytics.
ServiceLevel_GOOGLE_ANALYTICS_STANDARD ServiceLevel = 1
// The paid, premium version of Google Analytics.
ServiceLevel_GOOGLE_ANALYTICS_360 ServiceLevel = 2
)
func (ServiceLevel) Descriptor() protoreflect.EnumDescriptor
func (x ServiceLevel) Enum() *ServiceLevel
func (ServiceLevel) EnumDescriptor() ([]byte, []int)
Deprecated: Use ServiceLevel.Descriptor instead.
func (x ServiceLevel) Number() protoreflect.EnumNumber
func (x ServiceLevel) String() string
func (ServiceLevel) Type() protoreflect.EnumType
UnimplementedAnalyticsAdminServiceServer can be embedded to have forward compatible implementations.
type UnimplementedAnalyticsAdminServiceServer struct {
}
func (*UnimplementedAnalyticsAdminServiceServer) AcknowledgeUserDataCollection(context.Context, *AcknowledgeUserDataCollectionRequest) (*AcknowledgeUserDataCollectionResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ArchiveCustomDimension(context.Context, *ArchiveCustomDimensionRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) ArchiveCustomMetric(context.Context, *ArchiveCustomMetricRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateConversionEvent(context.Context, *CreateConversionEventRequest) (*ConversionEvent, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateCustomDimension(context.Context, *CreateCustomDimensionRequest) (*CustomDimension, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateCustomMetric(context.Context, *CreateCustomMetricRequest) (*CustomMetric, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateDataStream(context.Context, *CreateDataStreamRequest) (*DataStream, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateFirebaseLink(context.Context, *CreateFirebaseLinkRequest) (*FirebaseLink, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateGoogleAdsLink(context.Context, *CreateGoogleAdsLinkRequest) (*GoogleAdsLink, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateMeasurementProtocolSecret(context.Context, *CreateMeasurementProtocolSecretRequest) (*MeasurementProtocolSecret, error)
func (*UnimplementedAnalyticsAdminServiceServer) CreateProperty(context.Context, *CreatePropertyRequest) (*Property, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteAccount(context.Context, *DeleteAccountRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteConversionEvent(context.Context, *DeleteConversionEventRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteDataStream(context.Context, *DeleteDataStreamRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteFirebaseLink(context.Context, *DeleteFirebaseLinkRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteGoogleAdsLink(context.Context, *DeleteGoogleAdsLinkRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteMeasurementProtocolSecret(context.Context, *DeleteMeasurementProtocolSecretRequest) (*emptypb.Empty, error)
func (*UnimplementedAnalyticsAdminServiceServer) DeleteProperty(context.Context, *DeletePropertyRequest) (*Property, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetAccount(context.Context, *GetAccountRequest) (*Account, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetConversionEvent(context.Context, *GetConversionEventRequest) (*ConversionEvent, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetCustomDimension(context.Context, *GetCustomDimensionRequest) (*CustomDimension, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetCustomMetric(context.Context, *GetCustomMetricRequest) (*CustomMetric, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetDataRetentionSettings(context.Context, *GetDataRetentionSettingsRequest) (*DataRetentionSettings, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetDataSharingSettings(context.Context, *GetDataSharingSettingsRequest) (*DataSharingSettings, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetDataStream(context.Context, *GetDataStreamRequest) (*DataStream, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetMeasurementProtocolSecret(context.Context, *GetMeasurementProtocolSecretRequest) (*MeasurementProtocolSecret, error)
func (*UnimplementedAnalyticsAdminServiceServer) GetProperty(context.Context, *GetPropertyRequest) (*Property, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListAccountSummaries(context.Context, *ListAccountSummariesRequest) (*ListAccountSummariesResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListAccounts(context.Context, *ListAccountsRequest) (*ListAccountsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListConversionEvents(context.Context, *ListConversionEventsRequest) (*ListConversionEventsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListCustomDimensions(context.Context, *ListCustomDimensionsRequest) (*ListCustomDimensionsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListCustomMetrics(context.Context, *ListCustomMetricsRequest) (*ListCustomMetricsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListDataStreams(context.Context, *ListDataStreamsRequest) (*ListDataStreamsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListFirebaseLinks(context.Context, *ListFirebaseLinksRequest) (*ListFirebaseLinksResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListGoogleAdsLinks(context.Context, *ListGoogleAdsLinksRequest) (*ListGoogleAdsLinksResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListMeasurementProtocolSecrets(context.Context, *ListMeasurementProtocolSecretsRequest) (*ListMeasurementProtocolSecretsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ListProperties(context.Context, *ListPropertiesRequest) (*ListPropertiesResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) ProvisionAccountTicket(context.Context, *ProvisionAccountTicketRequest) (*ProvisionAccountTicketResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) RunAccessReport(context.Context, *RunAccessReportRequest) (*RunAccessReportResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) SearchChangeHistoryEvents(context.Context, *SearchChangeHistoryEventsRequest) (*SearchChangeHistoryEventsResponse, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateAccount(context.Context, *UpdateAccountRequest) (*Account, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateCustomDimension(context.Context, *UpdateCustomDimensionRequest) (*CustomDimension, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateCustomMetric(context.Context, *UpdateCustomMetricRequest) (*CustomMetric, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateDataRetentionSettings(context.Context, *UpdateDataRetentionSettingsRequest) (*DataRetentionSettings, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateDataStream(context.Context, *UpdateDataStreamRequest) (*DataStream, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateGoogleAdsLink(context.Context, *UpdateGoogleAdsLinkRequest) (*GoogleAdsLink, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateMeasurementProtocolSecret(context.Context, *UpdateMeasurementProtocolSecretRequest) (*MeasurementProtocolSecret, error)
func (*UnimplementedAnalyticsAdminServiceServer) UpdateProperty(context.Context, *UpdatePropertyRequest) (*Property, error)
Request message for UpdateAccount RPC.
type UpdateAccountRequest struct {
// Required. The account to update.
// The account's `name` field is used to identify the account.
Account *Account `protobuf:"bytes,1,opt,name=account,proto3" json:"account,omitempty"`
// Required. The list of fields to be updated. Field names must be in snake
// case (for example, "field_to_update"). Omitted fields will not be updated.
// To replace the entire entity, use one path with the string "*" to match all
// fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateAccountRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateAccountRequest.ProtoReflect.Descriptor instead.
func (x *UpdateAccountRequest) GetAccount() *Account
func (x *UpdateAccountRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateAccountRequest) ProtoMessage()
func (x *UpdateAccountRequest) ProtoReflect() protoreflect.Message
func (x *UpdateAccountRequest) Reset()
func (x *UpdateAccountRequest) String() string
Request message for UpdateCustomDimension RPC.
type UpdateCustomDimensionRequest struct {
// The CustomDimension to update
CustomDimension *CustomDimension `protobuf:"bytes,1,opt,name=custom_dimension,json=customDimension,proto3" json:"custom_dimension,omitempty"`
// Required. The list of fields to be updated. Omitted fields will not be
// updated. To replace the entire entity, use one path with the string "*" to
// match all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateCustomDimensionRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateCustomDimensionRequest.ProtoReflect.Descriptor instead.
func (x *UpdateCustomDimensionRequest) GetCustomDimension() *CustomDimension
func (x *UpdateCustomDimensionRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateCustomDimensionRequest) ProtoMessage()
func (x *UpdateCustomDimensionRequest) ProtoReflect() protoreflect.Message
func (x *UpdateCustomDimensionRequest) Reset()
func (x *UpdateCustomDimensionRequest) String() string
Request message for UpdateCustomMetric RPC.
type UpdateCustomMetricRequest struct {
// The CustomMetric to update
CustomMetric *CustomMetric `protobuf:"bytes,1,opt,name=custom_metric,json=customMetric,proto3" json:"custom_metric,omitempty"`
// Required. The list of fields to be updated. Omitted fields will not be
// updated. To replace the entire entity, use one path with the string "*" to
// match all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateCustomMetricRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateCustomMetricRequest.ProtoReflect.Descriptor instead.
func (x *UpdateCustomMetricRequest) GetCustomMetric() *CustomMetric
func (x *UpdateCustomMetricRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateCustomMetricRequest) ProtoMessage()
func (x *UpdateCustomMetricRequest) ProtoReflect() protoreflect.Message
func (x *UpdateCustomMetricRequest) Reset()
func (x *UpdateCustomMetricRequest) String() string
Request message for UpdateDataRetentionSettings RPC.
type UpdateDataRetentionSettingsRequest struct {
// Required. The settings to update.
// The `name` field is used to identify the settings to be updated.
DataRetentionSettings *DataRetentionSettings `protobuf:"bytes,1,opt,name=data_retention_settings,json=dataRetentionSettings,proto3" json:"data_retention_settings,omitempty"`
// Required. The list of fields to be updated. Field names must be in snake
// case (e.g., "field_to_update"). Omitted fields will not be updated. To
// replace the entire entity, use one path with the string "*" to match all
// fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDataRetentionSettingsRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDataRetentionSettingsRequest.ProtoReflect.Descriptor instead.
func (x *UpdateDataRetentionSettingsRequest) GetDataRetentionSettings() *DataRetentionSettings
func (x *UpdateDataRetentionSettingsRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateDataRetentionSettingsRequest) ProtoMessage()
func (x *UpdateDataRetentionSettingsRequest) ProtoReflect() protoreflect.Message
func (x *UpdateDataRetentionSettingsRequest) Reset()
func (x *UpdateDataRetentionSettingsRequest) String() string
Request message for UpdateDataStream RPC.
type UpdateDataStreamRequest struct {
// The DataStream to update
DataStream *DataStream `protobuf:"bytes,1,opt,name=data_stream,json=dataStream,proto3" json:"data_stream,omitempty"`
// Required. The list of fields to be updated. Omitted fields will not be
// updated. To replace the entire entity, use one path with the string "*" to
// match all fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateDataStreamRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateDataStreamRequest.ProtoReflect.Descriptor instead.
func (x *UpdateDataStreamRequest) GetDataStream() *DataStream
func (x *UpdateDataStreamRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateDataStreamRequest) ProtoMessage()
func (x *UpdateDataStreamRequest) ProtoReflect() protoreflect.Message
func (x *UpdateDataStreamRequest) Reset()
func (x *UpdateDataStreamRequest) String() string
Request message for UpdateGoogleAdsLink RPC
type UpdateGoogleAdsLinkRequest struct {
// The GoogleAdsLink to update
GoogleAdsLink *GoogleAdsLink `protobuf:"bytes,1,opt,name=google_ads_link,json=googleAdsLink,proto3" json:"google_ads_link,omitempty"`
// Required. The list of fields to be updated. Field names must be in snake
// case (e.g., "field_to_update"). Omitted fields will not be updated. To
// replace the entire entity, use one path with the string "*" to match all
// fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateGoogleAdsLinkRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateGoogleAdsLinkRequest.ProtoReflect.Descriptor instead.
func (x *UpdateGoogleAdsLinkRequest) GetGoogleAdsLink() *GoogleAdsLink
func (x *UpdateGoogleAdsLinkRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateGoogleAdsLinkRequest) ProtoMessage()
func (x *UpdateGoogleAdsLinkRequest) ProtoReflect() protoreflect.Message
func (x *UpdateGoogleAdsLinkRequest) Reset()
func (x *UpdateGoogleAdsLinkRequest) String() string
Request message for UpdateMeasurementProtocolSecret RPC
type UpdateMeasurementProtocolSecretRequest struct {
// Required. The measurement protocol secret to update.
MeasurementProtocolSecret *MeasurementProtocolSecret `protobuf:"bytes,1,opt,name=measurement_protocol_secret,json=measurementProtocolSecret,proto3" json:"measurement_protocol_secret,omitempty"`
// The list of fields to be updated. Omitted fields will not be updated.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdateMeasurementProtocolSecretRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdateMeasurementProtocolSecretRequest.ProtoReflect.Descriptor instead.
func (x *UpdateMeasurementProtocolSecretRequest) GetMeasurementProtocolSecret() *MeasurementProtocolSecret
func (x *UpdateMeasurementProtocolSecretRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdateMeasurementProtocolSecretRequest) ProtoMessage()
func (x *UpdateMeasurementProtocolSecretRequest) ProtoReflect() protoreflect.Message
func (x *UpdateMeasurementProtocolSecretRequest) Reset()
func (x *UpdateMeasurementProtocolSecretRequest) String() string
Request message for UpdateProperty RPC.
type UpdatePropertyRequest struct {
// Required. The property to update.
// The property's `name` field is used to identify the property to be
// updated.
Property *Property `protobuf:"bytes,1,opt,name=property,proto3" json:"property,omitempty"`
// Required. The list of fields to be updated. Field names must be in snake
// case (e.g., "field_to_update"). Omitted fields will not be updated. To
// replace the entire entity, use one path with the string "*" to match all
// fields.
UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
// contains filtered or unexported fields
}
func (*UpdatePropertyRequest) Descriptor() ([]byte, []int)
Deprecated: Use UpdatePropertyRequest.ProtoReflect.Descriptor instead.
func (x *UpdatePropertyRequest) GetProperty() *Property
func (x *UpdatePropertyRequest) GetUpdateMask() *fieldmaskpb.FieldMask
func (*UpdatePropertyRequest) ProtoMessage()
func (x *UpdatePropertyRequest) ProtoReflect() protoreflect.Message
func (x *UpdatePropertyRequest) Reset()
func (x *UpdatePropertyRequest) String() string