View Source API Reference google_api_analytics_admin v0.21.0
Modules
API client metadata for GoogleApi.AnalyticsAdmin.V1alpha.
API calls for all endpoints tagged AccountSummaries.
API calls for all endpoints tagged Accounts.
API calls for all endpoints tagged Properties.
Handle Tesla connections for GoogleApi.AnalyticsAdmin.V1alpha.
To express that the result needs to be between two numbers (inclusive).
A binding of a user to a set of roles.
A contiguous range of days: startDate, startDate + 1, ..., endDate.
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.
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.
The value of a dimension.
An expression to filter dimension or metric values.
Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
A list of filter expressions.
The result needs to be in a list of string values.
The quantitative measurements of a report. For example, the metric accessCount is the total number of data access records.
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.
The value of a metric.
Filters for numeric or date values.
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.
Sorts by dimension values.
Sorts by metric values.
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.
Current state for a particular quota group.
Access report data for each row.
The filter for strings.
A resource message representing a Google Analytics account.
A virtual resource representing an overview of an account and all its child GA4 properties.
Request message for AcknowledgeUserDataCollection RPC.
Response message for AcknowledgeUserDataCollection RPC.
A link between a GA4 Property and an AdSense for Content ad client.
Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.
Request message for ArchiveAudience RPC.
Request message for ArchiveCustomDimension RPC.
Request message for ArchiveCustomMetric RPC.
The attribution settings used for a given property. This is a singleton resource.
A resource message representing a GA4 Audience.
A specific filter for a single dimension or metric.
A filter for numeric or date values between certain values on a dimension or metric.
A filter for a string dimension that matches a particular list of options.
A filter for numeric or date values on a dimension or metric.
To represent a number.
A filter for a string-type dimension that matches a particular pattern.
A filter that matches events of a single event name. If an event parameter is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter.
Specifies an event to log when a user joins the Audience.
A clause for defining either a simple or sequence filter. A filter can be inclusive (For example, users satisfying the filter clause are included in the Audience) or exclusive (For example, users satisfying the filter clause are excluded from the Audience).
A logical expression of Audience dimension, metric, or event filters.
A list of Audience filter expressions.
Defines filters that must occur in a specific order for the user to be a member of the Audience.
A condition that must occur in the specified step order for this user to match the sequence.
Defines a simple filter that a user must satisfy to be a member of the Audience.
Request message for BatchCreateAccessBindings RPC.
Response message for BatchCreateAccessBindings RPC.
Request message for BatchDeleteAccessBindings RPC.
Response message for BatchGetAccessBindings RPC.
Request message for BatchUpdateAccessBindings RPC.
Response message for BatchUpdateAccessBindings RPC.
A link between a GA4 Property and BigQuery project.
A definition for a calculated metric.
Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.
A description of a change to a single Google Analytics resource.
A snapshot of a resource as before or after the result of a change in change history.
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.
A resource message representing a Channel Group.
A specific filter for a single dimension.
A logical expression of Channel Group dimension filters.
A list of Channel Group filter expressions.
A filter for a string dimension that matches a particular list of options. The match is case insensitive.
Filter where the field value is a String. The match is case insensitive.
Configuration for a specific Connected Site Tag.
A conversion event in a Google Analytics property.
Defines a default value/currency for a conversion event. Both value and currency must be provided.
Conversion value settings for a postback window for SKAdNetwork conversion value schema.
Request message for CreateAccessBinding RPC.
Request message for CreateConnectedSiteTag RPC.
Response message for CreateConnectedSiteTag RPC.
Request message for CreateRollupProperty RPC.
Response message for CreateRollupProperty RPC.
Request message for CreateSubproperty RPC.
Response message for CreateSubproperty RPC.
A definition for a CustomDimension.
A definition for a custom metric.
Settings for client-side data redaction. Singleton resource under a Web Stream.
Settings values for data retention. This is a singleton resource.
A resource message representing data sharing settings of a Google Analytics account.
A resource message representing a data stream.
Data specific to Android app streams.
Data specific to iOS app streams.
Data specific to web streams.
Request message for DeleteAccessBinding RPC.
Request message for DeleteConnectedSiteTag RPC.
A link between a GA4 property and a Display & Video 360 advertiser.
A proposal for a link between a GA4 property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.
Singleton resource under a web DataStream, configuring measurement of additional site interactions and content.
An Event Create Rule defines conditions that will trigger the creation of an entirely new event based upon matched criteria of a source event. Additional mutations of the parameters from the source event can be defined. Unlike Event Edit rules, Event Creation Rules have no defined order. They will all be run independently. Event Edit and Event Create rules can't be used to modify an event created from an Event Create rule.
Event setting conditions to match an event.
A resource message representing a GA4 ExpandedDataSet.
A specific filter for a single dimension
A logical expression of EnhancedDataSet dimension filters.
A list of ExpandedDataSet filter expressions.
A filter for a string dimension that matches a particular list of options.
A filter for a string-type dimension that matches a particular pattern.
Request for fetching the opt out status for the automated GA4 setup process.
Response message for fetching the opt out status for the automated GA4 setup process.
Response for looking up GA4 property connected to a UA property.
A link between a GA4 property and a Firebase project.
Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources.
A link between a GA4 property and a Google Ads account.
Settings values for Google Signals. This is a singleton resource.
The rules that govern how traffic is grouped into one channel.
A key event in a Google Analytics property.
Defines a default value/currency for a key event.
Status information for a link proposal.
Response message for ListAccessBindings RPC.
Response message for ListAccountSummaries RPC.
Request message for ListAccounts RPC.
Response message for ListAdSenseLinks method.
Response message for ListAudiences RPC.
Response message for ListBigQueryLinks RPC
Response message for ListCalculatedMetrics RPC.
Response message for ListChannelGroups RPC.
Request message for ListConnectedSiteTags RPC.
Response message for ListConnectedSiteTags RPC.
Response message for ListConversionEvents RPC.
Response message for ListCustomDimensions RPC.
Response message for ListCustomMetrics RPC.
Response message for ListDataStreams RPC.
Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.
Response message for ListDisplayVideo360AdvertiserLinks RPC.
Response message for ListEventCreateRules RPC.
Response message for ListExpandedDataSets RPC.
Response message for ListFirebaseLinks RPC
Response message for ListGoogleAdsLinks RPC.
Response message for ListKeyEvents RPC.
Response message for ListMeasurementProtocolSecret RPC
Response message for ListProperties RPC.
Response message for ListRollupPropertySourceLinks RPC.
Response message for ListSKAdNetworkConversionValueSchemas RPC
Response message for ListSearchAds360Links RPC.
Response message for ListSubpropertyEventFilter RPC.
Defines a condition for when an Event Edit or Event Creation rule applies to an event.
A secret value used for sending hits to Measurement Protocol.
To represent a number.
Defines an event parameter to mutate.
Settings for a SKAdNetwork conversion postback window.
A resource message representing a Google Analytics GA4 property.
A virtual resource representing metadata for a GA4 property.
Request message for ProvisionAccountTicket RPC.
Response message for ProvisionAccountTicket RPC.
A link that references a source property under the parent rollup property.
The request for a Data Access Record Report.
The customized Data Access Record Report response.
SKAdNetwork conversion value schema of an iOS stream.
A link between a GA4 property and a Search Ads 360 entity.
Request message for SearchChangeHistoryEvents RPC.
Response message for SearchAccounts RPC.
Request for setting the opt out status for the automated GA4 setup process.
Response message for setting the opt out status for the automated GA4 setup process.
A resource message representing a GA4 Subproperty event filter.
A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).
A specific filter expression
A filter for a string-type dimension that matches a particular pattern.
A logical expression of Subproperty event filters.
A list of Subproperty event filter expressions.
Request message for UpdateAccessBinding RPC.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
API client metadata for GoogleApi.AnalyticsAdmin.V1beta.
API calls for all endpoints tagged AccountSummaries.
API calls for all endpoints tagged Accounts.
API calls for all endpoints tagged Properties.
Handle Tesla connections for GoogleApi.AnalyticsAdmin.V1beta.
To express that the result needs to be between two numbers (inclusive).
A contiguous range of days: startDate, startDate + 1, ..., endDate.
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.
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.
The value of a dimension.
An expression to filter dimension or metric values.
Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.
A list of filter expressions.
The result needs to be in a list of string values.
The quantitative measurements of a report. For example, the metric accessCount is the total number of data access records.
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.
The value of a metric.
Filters for numeric or date values.
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.
Sorts by dimension values.
Sorts by metric values.
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.
Current state for a particular quota group.
Access report data for each row.
The filter for strings.
A resource message representing a Google Analytics account.
A virtual resource representing an overview of an account and all its child GA4 properties.
Request message for AcknowledgeUserDataCollection RPC.
Response message for AcknowledgeUserDataCollection RPC.
Request message for ArchiveCustomDimension RPC.
Request message for ArchiveCustomMetric RPC.
A description of a change to a single Google Analytics resource.
A snapshot of a resource as before or after the result of a change in change history.
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.
A conversion event in a Google Analytics property.
Defines a default value/currency for a conversion event. Both value and currency must be provided.
A definition for a CustomDimension.
A definition for a custom metric.
Settings values for data retention. This is a singleton resource.
A resource message representing data sharing settings of a Google Analytics account.
A resource message representing a data stream.
Data specific to Android app streams.
Data specific to iOS app streams.
Data specific to web streams.
A link between a GA4 property and a Firebase project.
A link between a GA4 property and a Google Ads account.
A key event in a Google Analytics property.
Defines a default value/currency for a key event.
Response message for ListAccountSummaries RPC.
Request message for ListAccounts RPC.
Response message for ListConversionEvents RPC.
Response message for ListCustomDimensions RPC.
Response message for ListCustomMetrics RPC.
Response message for ListDataStreams RPC.
Response message for ListFirebaseLinks RPC
Response message for ListGoogleAdsLinks RPC.
Response message for ListKeyEvents RPC.
Response message for ListMeasurementProtocolSecret RPC
Response message for ListProperties RPC.
A secret value used for sending hits to Measurement Protocol.
To represent a number.
A resource message representing a Google Analytics GA4 property.
A virtual resource representing metadata for a GA4 property.
Request message for ProvisionAccountTicket RPC.
Response message for ProvisionAccountTicket RPC.
The request for a Data Access Record Report.
The customized Data Access Record Report response.
Request message for SearchChangeHistoryEvents RPC.
Response message for SearchAccounts RPC.
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }