Package google.analytics.admin.v1beta

NumericValue

Begins with this number.

NumericValue

Ends with this number.

string

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.

string

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.

string

The API name of the dimension. See Data Access Schema for the list of dimensions supported in this API.

Dimensions are referenced by name in dimensionFilter and orderBys.

string

The dimension's name; for example 'userEmail'.

string

The dimension value. For example, this value may be 'France' for the 'country' dimension.

string

The dimension name or metric name.

AccessStringFilter

Strings related filter.

AccessInListFilter

A filter for in list values.

AccessNumericFilter

A filter for numeric or date values.

AccessBetweenFilter

A filter for two values.

AccessFilterExpressionList

Each of the FilterExpressions in the and_group has an AND relationship.

AccessFilterExpressionList

Each of the FilterExpressions in the or_group has an OR relationship.

AccessFilterExpression

The FilterExpression is NOT of not_expression.

AccessFilter

A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics.

AccessFilterExpression

A list of filter expressions.

string

The list of string values. Must be non-empty.

bool

If true, the string value is case sensitive.

string

The API name of the metric. See Data Access Schema for the list of metrics supported in this API.

Metrics are referenced by name in metricFilter & orderBys.

string

The metric's name; for example 'accessCount'.

string

The measurement value. For example, this value may be '13'.

Operation

The operation type for this filter.

NumericValue

A numeric value or a date value.

bool

If true, sorts by descending order. If false or unspecified, sorts in ascending order.

MetricOrderBy

Sorts results by a metric's values.

DimensionOrderBy

Sorts results by a dimension's values.

string

A dimension name in the request to order by.

OrderType

Controls the rule for dimension value ordering.

string

A metric name in the request to order by.

AccessQuotaStatus

Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens.

AccessQuotaStatus

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.

AccessQuotaStatus

Properties can use up to 50 concurrent requests.

AccessQuotaStatus

Properties and cloud project pairs can have up to 50 server errors per hour.

AccessQuotaStatus

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.

int32

Quota consumed by this request.

int32

Quota remaining after this request.

AccessDimensionValue

List of dimension values. These values are in the same order as specified in the request.

AccessMetricValue

List of metric values. These values are in the same order as specified in the request.

MatchType

The match type for this filter.

string

The string value used for the matching.

bool

If true, the string value is case sensitive.

string

Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"

Timestamp

Output only. Time when this account was originally created.

Timestamp

Output only. Time when account payload fields were last updated.

string

Required. Human-readable display name for this account.

string

Country of business. Must be a Unicode CLDR region code.

bool

Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.

string

Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"

string

Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000"

string

Display name for the account referred to in this account summary.

PropertySummary

List of summaries for child accounts of this account.

string

Required. The property for which to acknowledge user data collection.

string

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."

string

Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678

string

Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678

string

Resource name of the resource whose changes are described by this entry.

ActionType

The type of action that changed this resource.

ChangeHistoryResource

Resource contents from before the change was made. If this resource was created in this change, this field will be missing.

ChangeHistoryResource

Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing.

Account

A snapshot of an Account resource in change history.

Property

A snapshot of a Property resource in change history.

FirebaseLink

A snapshot of a FirebaseLink resource in change history.

GoogleAdsLink

A snapshot of a GoogleAdsLink resource in change history.

ConversionEvent

A snapshot of a ConversionEvent resource in change history.

MeasurementProtocolSecret

A snapshot of a MeasurementProtocolSecret resource in change history.

DataRetentionSettings

A snapshot of a data retention settings resource in change history.

DataStream

A snapshot of a DataStream resource in change history.

string

ID of this change history event. This ID is unique across Google Analytics.

Timestamp

Time when change was made.

ActorType

The type of actor that made this change.

string

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.

bool

If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.

ChangeHistoryChange

A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.

string

Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}

string

Immutable. The event name for this conversion event. Examples: 'click', 'purchase'

Timestamp

Output only. Time when this conversion event was created in the property.

bool

Output only. If set, this event can currently be deleted with DeleteConversionEvent.

bool

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.

ConversionCountingMethod

Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to ONCE_PER_EVENT.

DefaultConversionValue

Optional. Defines a default value/currency for a conversion event.

double

This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset.

string

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

ConversionEvent

Required. The conversion event to create.

string

Required. The resource name of the parent property where this conversion event will be created. Format: properties/123

string

Required. Example format: properties/1234

CustomDimension

Required. The CustomDimension to create.

string

Required. Example format: properties/1234

CustomMetric

Required. The CustomMetric to create.

string

Required. Example format: properties/1234

DataStream

Required. The DataStream to create.

string

Required. Format: properties/{property_id} Example: properties/1234

FirebaseLink

Required. The Firebase link to create.

string

Required. Example format: properties/1234

GoogleAdsLink

Required. The GoogleAdsLink to create.

string

Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}

MeasurementProtocolSecret

Required. The measurement protocol secret to create.

Property

Required. The property to create. Note: the supplied property must specify its parent.

string

Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}

string

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.

If this is an item-scoped dimension, then this is the parameter name found in the eCommerce items array.

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.

string

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.

string

Optional. Description for this custom dimension. Max length of 150 characters.

DimensionScope

Required. Immutable. The scope of this dimension.

bool

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.

string

Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}

string

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.

string

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.

string

Optional. Description for this custom dimension. Max length of 150 characters.

MeasurementUnit

Required. The type for the custom metric's value.

MetricScope

Required. Immutable. The scope of this custom metric.

RestrictedMetricType

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.

string

Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings

RetentionDuration

The length of time that event-level data is retained.

bool

If true, reset the retention period for the user identifier with every event from that user.

string

Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

bool

Allows Google support to access the data in order to help troubleshoot issues.

bool

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.

bool

Allows any of Google sales to access the data in order to suggest configuration changes to improve results.

bool

Allows Google to use the data to improve other Google products or services.

bool

Allows Google to share the data anonymously in aggregate form with others.

string

Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"

DataStreamType

Required. Immutable. The type of this DataStream resource.

string

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.

Timestamp

Output only. Time when this stream was originally created.

Timestamp

Output only. Time when stream payload fields were last updated.

WebStreamData

Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.

AndroidAppStreamData

Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.

IosAppStreamData

Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.

string

Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.

string

Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"

string

Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.

string

Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"

string

Output only. Analytics Measurement ID.

Example: "G-1A2BCD345E"

string

Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.

string

Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"

string

Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"

string

Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

string

Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678

string

Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678

string

Required. Example format: properties/1234/googleAdsLinks/5678

string

Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

string

Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"

string

Output only. Example format: properties/1234/firebaseLinks/5678

string

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'

Timestamp

Output only. Time when this FirebaseLink was originally created.

string

Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"

string

Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"

string

Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678

string

Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678

string

Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"

string

Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"

string

Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678

string

Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}

string

Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"

string

Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId}

Note: googleAdsLinkId is not the Google Ads customer ID.

string

Immutable. Google Ads customer ID.

bool

Output only. If true, this link is for a Google Ads manager account.

BoolValue

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.

Timestamp

Output only. Time when this link was originally created.

Timestamp

Output only. Time when this link was last updated.

string

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.

int32

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)

string

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.

AccountSummary

Account summaries of all accounts the caller has access to.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

int32

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)

string

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.

bool

Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.

Account

Results that were accessible to the caller.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The resource name of the parent property. Example: 'properties/123'

int32

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)

string

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.

ConversionEvent

The requested conversion events

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. Example format: properties/1234

int32

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).

string

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.

CustomDimension

List of CustomDimensions.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. Example format: properties/1234

int32

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).

string

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.

CustomMetric

List of CustomMetrics.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. Example format: properties/1234

int32

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).

string

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.

DataStream

List of DataStreams.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. Format: properties/{property_id} Example: properties/1234

int32

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)

string

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.

FirebaseLink

List of FirebaseLinks. This will have at most one value.

string

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.

string

Required. Example format: properties/1234

int32

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).

string

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.

GoogleAdsLink

List of GoogleAdsLinks.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets

int32

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.

string

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.

MeasurementProtocolSecret

A list of secrets for the parent stream specified in the request.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

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.    |

int32

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)

string

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.

bool

Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.

Property

Results that matched the filter criteria and were accessible to the caller.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

string

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}

string

Required. Human-readable display name for this secret.

string

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.

int64

Integer value

double

Double value

string

Output only. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"

PropertyType

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.

Timestamp

Output only. Time when the entity was originally created.

Timestamp

Output only. Time when entity payload fields were last updated.

string

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"

string

Required. Human-readable display name for this property.

The max allowed display name length is 100 UTF-16 code units.

IndustryCategory

Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK

string

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"

string

The currency type used in reports involving monetary values.

Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"

ServiceLevel

Output only. The Google Analytics service level that applies to this property.

Timestamp

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.

Timestamp

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.

string

Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"

string

Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000"

string

Display name for the property referred to in this property summary.

PropertyType

The property's property type.

string

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"

Account

The account to create.

string

Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI.

string

The param to be passed in the ToS link.

string

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.

AccessDimension

The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.

AccessMetric

The metrics requested and displayed in the response. Requests are allowed up to 10 metrics.

AccessDateRange

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.

AccessFilterExpression

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 for examples. Metrics cannot be used in this filter.

AccessFilterExpression

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.

int64

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.

int64

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.

string

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".

AccessOrderBy

Specifies how rows are ordered in the response.

bool

Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in AccessQuota. For account-level requests, this field must be false.

bool

Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.

bool

Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.

AccessDimensionHeader

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.

AccessMetricHeader

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.

AccessRow

Rows of dimension value combinations and metric values in the report.

int32

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.

AccessQuota

The quota state for this Analytics property including this request. This field doesn't work with account-level requests.

string

Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100"

string

Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100"

ChangeHistoryResourceType

Optional. If set, only return changes if they are for a resource that matches at least one of these types.

ActionType

Optional. If set, only return changes that match one or more of these types of actions.

string

Optional. If set, only return changes if they are made by a user in this list.

Timestamp

Optional. If set, only return changes made after this time (inclusive).

Timestamp

Optional. If set, only return changes made before this time (inclusive).

int32

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).

string

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.

ChangeHistoryEvent

Results that were accessible to the caller.

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Account

Required. The account to update. The account's name field is used to identify the account.

FieldMask

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.

ConversionEvent

Required. The conversion event to update. The name field is used to identify the settings to be updated.

FieldMask

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.

CustomDimension

The CustomDimension to update

FieldMask

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.

CustomMetric

The CustomMetric to update

FieldMask

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.

DataRetentionSettings

Required. The settings to update. The name field is used to identify the settings to be updated.

FieldMask

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.

DataStream

The DataStream to update

FieldMask

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.

GoogleAdsLink

The GoogleAdsLink to update

FieldMask

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.

MeasurementProtocolSecret

Required. The measurement protocol secret to update.

FieldMask

Required. The list of fields to be updated. Omitted fields will not be updated.

Property

Required. The property to update. The property's name field is used to identify the property to be updated.

FieldMask

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.