openapi: 3.2.0 info: title: Google Analytics 4 Accounts API contact: name: Google url: http://code.google.com/apis/analytics/docs/mgmt/home.html x-discovery-revision: '20260810' version: '1.0' description: 'Operations tagged accounts across 2 of this provider''s published API definitions: google-analytics-4-admin-v1alpha-openapi.yml, google-analytics-4-admin-v1beta-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API security: - BearerAuth: [] tags: - name: accounts paths: /v1alpha/accounts/{accountsId}: delete: operationId: accounts_delete summary: 'Marks target Account as soft-deleted (ie: "trashed") and returns it' tags: - accounts description: '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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.' parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleProtobufEmpty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: accounts_get summary: Lookup for a single Account tags: - accounts description: Lookup for a single Account. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccount' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: accounts_patch summary: Updates an account tags: - accounts description: Updates an account. parameters: - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: 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. - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100"' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccount' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccount' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/dataSharingSettings: get: operationId: accounts_getDataSharingSettings summary: Get data sharing settings on an account tags: - accounts description: Get data sharing settings on an account. Data sharing settings are singletons. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+/dataSharingSettings$ description: 'Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataSharingSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts: get: operationId: accounts_list summary: Returns all accounts accessible by the caller tags: - accounts description: 'Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using `ListAccountSummaries`.' parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. 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) - name: showDeleted in: query required: false schema: type: boolean description: 'Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.' - name: pageToken in: query required: false schema: type: string description: Optional. 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. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListAccountsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts:provisionAccountTicket: post: operationId: accounts_provisionAccountTicket summary: Requests a ticket for creating an account tags: - accounts description: Requests a ticket for creating an account. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}:runAccessReport: post: operationId: accounts_runAccessReport summary: Returns a customized report of data access records tags: - accounts description: 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA 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). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. parameters: - name: entity in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRunAccessReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRunAccessReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}:searchChangeHistoryEvents: post: operationId: accounts_searchChangeHistoryEvents summary: Searches through all changes to an account or its children given the specified set of filters tags: - accounts description: Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes. parameters: - name: account in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/accessBindings:batchCreate: post: operationId: accounts_accessBindings_batchCreate summary: Creates information about multiple access bindings to an account or property tags: - accounts description: Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created. parameters: - name: parent in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/accessBindings:batchDelete: post: operationId: accounts_accessBindings_batchDelete summary: Deletes information about multiple users' links to an account or property tags: - accounts description: Deletes information about multiple users' links to an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The account or property that owns the access bindings. The parent of all provided values for the ''names'' field in DeleteAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleProtobufEmpty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/accessBindings:batchGet: get: operationId: accounts_accessBindings_batchGet summary: Gets information about multiple access bindings to an account or property tags: - accounts description: Gets information about multiple access bindings to an account or property. parameters: - name: names in: query required: false schema: type: array items: type: string description: 'Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' - name: parent in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The account or property that owns the access bindings. The parent of all provided values for the ''names'' field must match this field. Formats: - accounts/{account} - properties/{property}' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - analytics.manage.users.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/accessBindings:batchUpdate: post: operationId: accounts_accessBindings_batchUpdate summary: Updates information about multiple access bindings to an account or property tags: - accounts description: Updates information about multiple access bindings to an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/accessBindings: post: operationId: accounts_accessBindings_create summary: Creates an access binding on an account or property tags: - accounts description: Creates an access binding on an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. Formats: - accounts/{account} - properties/{property}' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - BearerAuth: [] get: operationId: accounts_accessBindings_list summary: Lists all access bindings on an account or property tags: - accounts description: Lists all access bindings on an account or property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500. - name: parent in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. Formats: - accounts/{account} - properties/{property}' - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListAccessBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccessBindings` must match the call that provided the page token. - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListAccessBindingsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - analytics.manage.users.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/accounts/{accountsId}/accessBindings/{accessBindingsId}: delete: operationId: accounts_accessBindings_delete summary: Deletes an access binding on an account or property tags: - accounts description: Deletes an access binding on an account or property. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+/accessBindings/[^/]+$ description: 'Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' - name: accessBindingsId in: path required: true schema: type: string - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleProtobufEmpty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - BearerAuth: [] get: operationId: accounts_accessBindings_get summary: Gets information about an access binding tags: - accounts description: Gets information about an access binding. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+/accessBindings/[^/]+$ description: 'Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' - name: accessBindingsId in: path required: true schema: type: string - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - analytics.manage.users.readonly - BearerAuth: [] patch: operationId: accounts_accessBindings_patch summary: Updates an access binding on an account or property tags: - accounts description: Updates an access binding on an account or property. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+/accessBindings/[^/]+$ description: 'Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"' - name: accessBindingsId in: path required: true schema: type: string - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.manage.users - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/accounts/{accountsId}: delete: operationId: accounts_delete summary: 'Marks target Account as soft-deleted (ie: "trashed") and returns it' tags: - accounts description: '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, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.' parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleProtobufEmpty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: accounts_get summary: Lookup for a single Account tags: - accounts description: Lookup for a single Account. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccount' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: accounts_patch summary: Updates an account tags: - accounts description: Updates an account. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100"' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: 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. - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccount' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccount' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/accounts/{accountsId}/dataSharingSettings: get: operationId: accounts_getDataSharingSettings summary: Get data sharing settings on an account tags: - accounts description: Get data sharing settings on an account. Data sharing settings are singletons. parameters: - name: name in: query required: true schema: type: string pattern: ^accounts/[^/]+/dataSharingSettings$ description: 'Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`' - name: accountsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataSharingSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/accounts: get: operationId: accounts_list summary: Returns all accounts accessible by the caller tags: - accounts description: 'Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using `ListAccountSummaries`.' parameters: - name: pageToken in: query required: false schema: type: string description: Optional. 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. - name: showDeleted in: query required: false schema: type: boolean description: 'Whether to include soft-deleted (ie: "trashed") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.' - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. 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) responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaListAccountsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/accounts:provisionAccountTicket: post: operationId: accounts_provisionAccountTicket summary: Requests a ticket for creating an account tags: - accounts description: Requests a ticket for creating an account. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/accounts/{accountsId}:runAccessReport: post: operationId: accounts_runAccessReport summary: Returns a customized report of data access records tags: - accounts description: 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. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Explorations, GA 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). To give your feedback on this API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1FAIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form. parameters: - name: entity in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 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 Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if "1234" is your Google Analytics Account ID. - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaRunAccessReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaRunAccessReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/accounts/{accountsId}:searchChangeHistoryEvents: post: operationId: accounts_searchChangeHistoryEvents summary: Searches through all changes to an account or its children given the specified set of filters tags: - accounts description: Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes. parameters: - name: account in: query required: true schema: type: string pattern: ^accounts/[^/]+$ description: 'Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`' - name: accountsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API components: schemas: GoogleTypeDate: description: 'Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp' properties: year: description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. format: int32 type: integer day: type: integer format: int32 description: Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. month: format: int32 description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. type: integer type: object GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter: type: object description: A filter for a string-type dimension that matches a particular pattern. properties: caseSensitive: type: boolean description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. value: type: string description: Required. The string value to be matched against. matchType: type: string x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full regular expression matches with the string value. description: Required. The match type for the string filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP GoogleAnalyticsAdminV1alphaFirebaseLink: description: A link between a Google Analytics property and a Firebase project. properties: name: type: string description: 'Identifier. Example format: properties/1234/firebaseLinks/5678' project: description: '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''' type: string createTime: type: string description: Output only. Time when this FirebaseLink was originally created. format: google-datetime type: object GoogleAnalyticsAdminV1alphaReportingDataAnnotation: type: object description: A Reporting Data Annotation is a comment connected to certain dates for reporting data. properties: color: type: string description: Required. The color used for display of this Reporting Data Annotation. enum: - COLOR_UNSPECIFIED - PURPLE - BROWN - BLUE - GREEN - RED - CYAN - ORANGE x-enumDescriptions: - Color unknown or not specified. - Purple color. - Brown color. - Blue color. - Green color. - Red color. - Cyan color. - Orange color. (Only used for system-generated annotations) name: type: string description: 'Required. Identifier. Resource name of this Reporting Data Annotation. Format: ''properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}'' Format: ''properties/123/reportingDataAnnotations/456''' title: type: string description: Required. Human-readable title for this Reporting Data Annotation. annotationDateRange: description: If set, the Reporting Data Annotation is for a range of dates represented by this field. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange' description: description: Optional. Description for this Reporting Data Annotation. type: string systemGenerated: type: boolean description: Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted. annotationDate: description: If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future. $ref: '#/components/schemas/GoogleTypeDate' GoogleAnalyticsAdminV1alphaConversionEventDefaultConversionValue: description: Defines a default value/currency for a conversion event. Both value and currency must be provided. properties: value: description: This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset. format: double type: number currencyCode: description: 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. type: string type: object GoogleAnalyticsAdminV1alphaListAccountsResponse: type: object description: Request message for ListAccounts RPC. properties: accounts: description: Results that were accessible to the caller. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccount' nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string GoogleAnalyticsAdminV1alphaAudienceSimpleFilter: description: Defines a simple filter that a user must satisfy to be a member of the Audience. properties: scope: description: Required. Immutable. Specifies the scope for this filter. enum: - AUDIENCE_FILTER_SCOPE_UNSPECIFIED - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION - AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS x-enumDescriptions: - Scope is not specified. - User joins the Audience if the filter condition is met within one event. - User joins the Audience if the filter condition is met within one session. - User joins the Audience if the filter condition is met by any event across any session. type: string filterExpression: description: Required. Immutable. A logical expression of Audience dimension, metric, or event filters. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpression' type: object GoogleAnalyticsAdminV1alphaChannelGroupFilter: description: A specific filter for a single dimension. properties: fieldName: type: string description: Required. Immutable. The dimension name to filter. inListFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter' description: A filter for a string dimension that matches a particular list of options. stringFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterStringFilter' description: A filter for a string-type dimension that matches a particular pattern. type: object GoogleAnalyticsAdminV1alphaBigQueryLink: description: A link between a Google Analytics property and BigQuery project. properties: dailyExportEnabled: description: If set true, enables daily data export to the linked Google Cloud project. type: boolean exportStreams: type: array items: type: string description: 'The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [''properties/1000/dataStreams/2000'']' datasetLocation: type: string description: Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. freshDailyExportEnabled: type: boolean description: If set true, enables fresh daily export to the linked Google Cloud project. name: description: 'Output only. Resource name of this BigQuery link. Format: ''properties/{property_id}/bigQueryLinks/{bigquery_link_id}'' Format: ''properties/1234/bigQueryLinks/abc567''' type: string project: type: string description: 'Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: ''projects/{project number}'' Example: ''projects/1234''' includeAdvertisingId: type: boolean description: If set true, exported data will include advertising identifiers for mobile app streams. excludedEvents: type: array items: type: string description: The list of event names that will be excluded from exports. streamingExportEnabled: description: If set true, enables streaming export to the linked Google Cloud project. type: boolean createTime: type: string format: google-datetime description: Output only. Time when the link was created. type: object GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsRequest: description: Request message for BatchCreateAccessBindings RPC. properties: requests: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCreateAccessBindingRequest' description: Required. The requests specifying the access bindings to create. A maximum of 1000 access bindings can be created in a batch. type: object GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList: description: A list of ExpandedDataSet filter expressions. properties: filterExpressions: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression' description: A list of ExpandedDataSet filter expressions. type: object GoogleAnalyticsAdminV1alphaExpandedDataSet: type: object description: A resource message representing an `ExpandedDataSet`. properties: dataCollectionStartTime: type: string format: google-datetime description: Output only. Time when expanded data set began (or will begin) collecing data. displayName: description: Required. The display name of the ExpandedDataSet. Max 200 chars. type: string dimensionNames: type: array items: type: string description: Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. description: description: Optional. The description of the ExpandedDataSet. Max 50 chars. type: string name: type: string description: 'Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}' metricNames: type: array items: type: string description: Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names. dimensionFilterExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression' description: Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering `other` row. GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest: type: object description: Request message for UpdateAccessBinding RPC. properties: accessBinding: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: Required. The access binding to update. GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest: description: Request message for DeleteAccessBinding RPC. properties: name: description: 'Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' type: string type: object GoogleAnalyticsAdminV1alphaRunAccessReportRequest: description: The request for a Data Access Record Report. properties: orderBys: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessOrderBy' description: Specifies how rows are ordered in the response. metrics: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessMetric' description: The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. metricFilter: description: 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. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' dimensions: description: The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessDimension' dimensionFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' description: 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. returnEntityQuota: type: boolean description: 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. includeAllUsers: description: 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. type: boolean timeZone: description: 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". type: string offset: type: string description: 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). format: int64 limit: type: string description: 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). format: int64 expandGroups: description: 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. type: boolean dateRanges: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessDateRange' description: 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. type: object GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse: type: object description: Response message for BatchCreateAccessBindings RPC. properties: accessBindings: description: The access bindings created. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' GoogleAnalyticsAdminV1alphaChangeHistoryChange: description: A description of a change to a single Google Analytics resource. properties: resource: description: Resource name of the resource whose changes are described by this entry. type: string resourceBeforeChange: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource' description: Resource contents from before the change was made. If this resource was created in this change, this field will be missing. action: x-enumDescriptions: - Action type unknown or not specified. - Resource was created in this change. - Resource was updated in this change. - Resource was deleted in this change. description: The type of action that changed this resource. enum: - ACTION_TYPE_UNSPECIFIED - CREATED - UPDATED - DELETED type: string resourceAfterChange: description: Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource' type: object GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest: type: object description: Request message for ProvisionAccountTicket RPC. properties: redirectUri: type: string description: Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. account: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccount' description: The account to create. GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression: type: object description: A logical expression of EnhancedDataSet dimension filters. properties: filter: description: A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilter' andGroup: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList' description: A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression. notExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression' description: A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression. GoogleAnalyticsAdminV1alphaExpandedDataSetFilter: description: A specific filter for a single dimension properties: fieldName: description: Required. The dimension name to filter. type: string stringFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter' description: A filter for a string-type dimension that matches a particular pattern. inListFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter' description: A filter for a string dimension that matches a particular list of options. type: object GoogleAnalyticsAdminV1alphaAudience: description: A resource message representing an Audience. properties: createTime: format: google-datetime description: Output only. Time when the Audience was created. type: string description: description: Required. The description of the Audience. type: string name: type: string description: 'Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}' eventTrigger: description: Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceEventTrigger' displayName: type: string description: Required. The display name of the Audience. membershipDurationDays: format: int32 description: Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. type: integer filterClauses: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterClause' description: Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. adsPersonalizationEnabled: type: boolean description: Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. exclusionDurationMode: description: Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. enum: - AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED - EXCLUDE_TEMPORARILY - EXCLUDE_PERMANENTLY x-enumDescriptions: - Not specified. - Exclude users from the Audience during periods when they meet the filter clause. - Exclude users from the Audience if they've ever met the filter clause. type: string type: object GoogleAnalyticsAdminV1alphaAccessNumericFilter: type: object description: Filters for numeric or date values. properties: operation: type: string x-enumDescriptions: - Unspecified. - Equal - Less than - Less than or equal - Greater than - Greater than or equal description: The operation type for this filter. enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL value: description: A numeric value or a date value. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaNumericValue' GoogleAnalyticsAdminV1alphaAttributionSettings: type: object description: The attribution settings used for a given property. This is a singleton resource. properties: reportingAttributionModel: x-enumDescriptions: - Reporting attribution model unspecified. - Data-driven attribution distributes credit for the conversion based on data for each conversion event. Each Data-driven model is specific to each advertiser and each conversion event. Previously CROSS_CHANNEL_DATA_DRIVEN - Ignores direct traffic and attributes 100% of the conversion value to the last channel that the customer clicked through (or engaged view through for YouTube) before converting. Previously CROSS_CHANNEL_LAST_CLICK - Attributes 100% of the conversion value to the last Google Paid channel that the customer clicked through before converting. Previously ADS_PREFERRED_LAST_CLICK description: Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected. enum: - REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED - PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN - PAID_AND_ORGANIC_CHANNELS_LAST_CLICK - GOOGLE_PAID_CHANNELS_LAST_CLICK type: string acquisitionConversionEventLookbackWindow: type: string description: Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days. enum: - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS x-enumDescriptions: - Lookback window size unspecified. - 7-day lookback window. - 30-day lookback window. name: type: string description: 'Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"' otherConversionEventLookbackWindow: x-enumDescriptions: - Lookback window size unspecified. - 30-day lookback window. - 60-day lookback window. - 90-day lookback window. description: Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. enum: - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS type: string adsWebConversionDataExportScope: type: string x-enumDescriptions: - Default value. This value is unused. - No data export scope selected yet. Export scope can never be changed back to this value. - Paid and organic channels are eligible to receive conversion credit, but only credit assigned to Google Ads channels will appear in your Ads accounts. To learn more, see [Paid and Organic channels](https://support.google.com/analytics/answer/10632359). - Only Google Ads paid channels are eligible to receive conversion credit. To learn more, see [Google Paid channels](https://support.google.com/analytics/answer/10632359). description: Required. The Conversion Export Scope for data exported to linked Ads Accounts. enum: - ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED - NOT_SELECTED_YET - PAID_AND_ORGANIC_CHANNELS - GOOGLE_PAID_CHANNELS GoogleAnalyticsAdminV1alphaSubpropertySyncConfig: description: Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. properties: name: description: 'Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678' type: string applyToProperty: type: string description: Output only. Immutable. Resource name of the subproperty that these settings apply to. customDimensionAndMetricSyncMode: description: Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. enum: - SYNCHRONIZATION_MODE_UNSPECIFIED - NONE - ALL x-enumDescriptions: - Synchronization mode unknown or not specified. - Entities are not synchronized. Local edits are allowed on the subproperty. - Entities are synchronized from parent property. Local mutations are not allowed on the subproperty (Create / Update / Delete) type: string type: object GoogleAnalyticsAdminV1alphaAccessBetweenFilter: description: To express that the result needs to be between two numbers (inclusive). properties: fromValue: description: Begins with this number. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaNumericValue' toValue: description: Ends with this number. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaNumericValue' type: object GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter: type: object description: A filter for numeric or date values on a dimension or metric. properties: operation: description: Required. The operation applied to a numeric filter. enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - GREATER_THAN x-enumDescriptions: - Unspecified. - Equal. - Less than. - Greater than. type: string value: description: Required. The numeric or date value to match against. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue' GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter: description: A filter for numeric or date values between certain values on a dimension or metric. properties: fromValue: description: Required. Begins with this number, inclusive. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue' toValue: description: Required. Ends with this number, inclusive. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue' type: object GoogleAnalyticsAdminV1alphaAccessFilter: type: object description: An expression to filter dimension or metric values. properties: stringFilter: description: Strings related filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessStringFilter' numericFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessNumericFilter' description: A filter for numeric or date values. betweenFilter: description: A filter for two values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBetweenFilter' fieldName: description: The dimension name or metric name. type: string inListFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessInListFilter' description: A filter for in list values. GoogleAnalyticsAdminV1alphaEventMapping: type: object description: Event setting conditions to match an event. properties: minEventValue: type: number description: The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked. format: double minEventCount: description: At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked. format: int64 type: string maxEventCount: type: string format: int64 description: The maximum number of times the event occurred. If not set, maximum event count won't be checked. eventName: description: Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units. type: string maxEventValue: type: number format: double description: The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked. GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest: description: Request message for SearchChangeHistoryEvents RPC. properties: latestChangeTime: format: google-datetime description: Optional. If set, only return changes made before this time (inclusive). type: string action: type: array items: type: string x-enumDescriptions: - Action type unknown or not specified. - Resource was created in this change. - Resource was updated in this change. - Resource was deleted in this change. enum: - ACTION_TYPE_UNSPECIFIED - CREATED - UPDATED - DELETED description: Optional. If set, only return changes that match one or more of these types of actions. property: type: string description: '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`' resourceType: type: array items: x-enumDescriptions: - Resource type unknown or not specified. - Account resource - Property resource - FirebaseLink resource - GoogleAdsLink resource - GoogleSignalsSettings resource - ConversionEvent resource - MeasurementProtocolSecret resource - CustomDimension resource - CustomMetric resource - DataRetentionSettings resource - DisplayVideo360AdvertiserLink resource - DisplayVideo360AdvertiserLinkProposal resource - SearchAds360Link resource - DataStream resource - AttributionSettings resource - ExpandedDataSet resource - ChannelGroup resource - BigQuery link resource - EnhancedMeasurementSettings resource - DataRedactionSettings resource - SKAdNetworkConversionValueSchema resource - AdSenseLink resource - Audience resource - EventCreateRule resource - KeyEvent resource - CalculatedMetric resource - ReportingDataAnnotation resource - SubpropertySyncConfig resource - ReportingIdentitySettings resource - UserProvidedDataSettings resource enum: - CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED - ACCOUNT - PROPERTY - FIREBASE_LINK - GOOGLE_ADS_LINK - GOOGLE_SIGNALS_SETTINGS - CONVERSION_EVENT - MEASUREMENT_PROTOCOL_SECRET - CUSTOM_DIMENSION - CUSTOM_METRIC - DATA_RETENTION_SETTINGS - DISPLAY_VIDEO_360_ADVERTISER_LINK - DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL - SEARCH_ADS_360_LINK - DATA_STREAM - ATTRIBUTION_SETTINGS - EXPANDED_DATA_SET - CHANNEL_GROUP - BIGQUERY_LINK - ENHANCED_MEASUREMENT_SETTINGS - DATA_REDACTION_SETTINGS - SKADNETWORK_CONVERSION_VALUE_SCHEMA - ADSENSE_LINK - AUDIENCE - EVENT_CREATE_RULE - KEY_EVENT - CALCULATED_METRIC - REPORTING_DATA_ANNOTATION - SUBPROPERTY_SYNC_CONFIG - REPORTING_IDENTITY_SETTINGS - USER_PROVIDED_DATA_SETTINGS type: string description: Optional. If set, only return changes if they are for a resource that matches at least one of these types. pageSize: type: integer description: Optional. The maximum number of ChangeHistoryEvent items to return. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). Note that the service may return a page with fewer items than this value specifies (potentially even zero), and that there still may be additional pages. If you want a particular number of items, you'll need to continue requesting additional pages using `page_token` until you get the needed number. format: int32 earliestChangeTime: description: Optional. If set, only return changes made after this time (inclusive). format: google-datetime type: string pageToken: type: string description: 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. actorEmail: description: Optional. If set, only return changes if they are made by a user in this list. type: array items: type: string type: object GoogleAnalyticsAdminV1alphaCustomDimension: type: object description: A definition for a CustomDimension. properties: displayName: description: 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. type: string scope: type: string description: Required. Immutable. The scope of this dimension. enum: - DIMENSION_SCOPE_UNSPECIFIED - EVENT - USER - ITEM x-enumDescriptions: - Scope unknown or not specified. - Dimension scoped to an event. - Dimension scoped to a user. - Dimension scoped to eCommerce items name: description: 'Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}' type: string parameterName: description: 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. type: string description: description: Optional. Description for this custom dimension. Max length of 150 characters. type: string disallowAdsPersonalization: type: boolean description: 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. GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy: type: object description: Sorts by metric values. properties: metricName: description: A metric name in the request to order by. type: string GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse: description: Response message for SearchAccounts RPC. properties: changeHistoryEvents: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChangeHistoryEvent' description: Results that were accessible to the caller. nextPageToken: type: string description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: object GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList: description: A list of Audience filter expressions. properties: filterExpressions: description: A list of Audience filter expressions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpression' type: object GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression: type: object description: A logical expression of Channel Group dimension filters. properties: filter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilter' description: A filter on a single dimension. This cannot be set on the top level ChannelGroupFilterExpression. andGroup: description: A list of expressions to be AND’ed together. It can only contain ChannelGroupFilterExpressions with or_group. This must be set for the top level ChannelGroupFilterExpression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList' orGroup: description: A list of expressions to OR’ed together. It cannot contain ChannelGroupFilterExpressions with and_group or or_group. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList' notExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression' description: A filter expression to be NOT'ed (that is inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level ChannelGroupFilterExpression. GoogleAnalyticsAdminV1alphaAudienceFilterClause: type: object description: 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). properties: clauseType: type: string x-enumDescriptions: - Unspecified clause type. - Users will be included in the Audience if the filter clause is met. - Users will be excluded from the Audience if the filter clause is met. description: Required. Specifies whether this is an include or exclude filter clause. enum: - AUDIENCE_CLAUSE_TYPE_UNSPECIFIED - INCLUDE - EXCLUDE sequenceFilter: description: Filters that must occur in a specific order for the user to be a member of the Audience. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceSequenceFilter' simpleFilter: description: A simple filter that a user must satisfy to be a member of the Audience. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceSimpleFilter' GoogleAnalyticsAdminV1alphaCalculatedMetric: type: object description: A definition for a calculated metric. properties: restrictedMetricType: type: array items: type: string enum: - RESTRICTED_METRIC_TYPE_UNSPECIFIED - COST_DATA - REVENUE_DATA x-enumDescriptions: - Type unknown or unspecified. - Metric reports cost data. - Metric reports revenue data. description: Output only. Types of restricted data that this metric contains. formula: type: string description: 'Required. The calculated metric''s definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations: + (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: "( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0"' displayName: type: string description: Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters. calculatedMetricId: description: Output only. The ID to use for the calculated metric. In the UI, this is referred to as the "API name." The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, "calcMetric:{calculated_metric_id}". type: string invalidMetricReference: description: Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results. type: boolean description: description: Optional. Description for this calculated metric. Max length of 4096 characters. type: string name: type: string description: 'Identifier. Resource name for this CalculatedMetric. Format: ''properties/{property_id}/calculatedMetrics/{calculated_metric_id}''' metricUnit: description: Required. The type for the calculated metric's value. enum: - METRIC_UNIT_UNSPECIFIED - STANDARD - CURRENCY - FEET - MILES - METERS - KILOMETERS - MILLISECONDS - SECONDS - MINUTES - HOURS x-enumDescriptions: - MetricUnit unspecified or missing. - This metric uses default units. - This metric measures a currency. - This metric measures feet. - This metric measures miles. - This metric measures meters. - This metric measures kilometers. - This metric measures milliseconds. - This metric measures seconds. - This metric measures minutes. - This metric measures hours. type: string GoogleAnalyticsAdminV1alphaAccessMetric: description: The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records. properties: metricName: description: 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`. type: string type: object GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter: description: A filter for a string dimension that matches a particular list of options. properties: caseSensitive: type: boolean description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true. values: type: array items: type: string description: Required. The list of possible string values to match against. Must be non-empty. type: object GoogleAnalyticsAdminV1alphaGoogleAdsLink: type: object description: A link between a Google Analytics property and a Google Ads account. properties: name: description: 'Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.' type: string createTime: type: string description: Output only. Time when this link was originally created. format: google-datetime creatorEmailAddress: description: 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. type: string canManageClients: description: Output only. If true, this link is for a Google Ads manager account. type: boolean adsPersonalizationEnabled: type: boolean description: 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. updateTime: type: string description: Output only. Time when this link was last updated. format: google-datetime customerId: type: string description: Immutable. Google Ads customer ID. GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse: type: object description: Response message for ProvisionAccountTicket RPC. properties: accountTicketId: description: The param to be passed in the ToS link. type: string GoogleAnalyticsAdminV1alphaDataRedactionSettings: description: Settings for client-side data redaction. Singleton resource under a Web Stream. properties: emailRedactionEnabled: type: boolean description: If enabled, any event parameter or user property values that look like an email will be redacted. queryParameterKeys: type: array items: type: string description: The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas. queryParameterRedactionEnabled: description: Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted. type: boolean name: description: 'Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"' type: string type: object GoogleAnalyticsAdminV1alphaDataSharingSettings: description: A resource message representing data sharing settings of a Google Analytics account. properties: sharingWithGoogleProductsEnabled: description: Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. type: boolean sharingWithGoogleAnySalesEnabled: description: Deprecated. This field is no longer used and always returns false. deprecated: true type: boolean name: type: string description: 'Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"' sharingWithGoogleAssignedSalesEnabled: description: Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. type: boolean sharingWithOthersEnabled: description: Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the "Modeling contributions & business insights" field in the Google Analytics Admin UI. type: boolean sharingWithGoogleSupportEnabled: description: Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the "Technical support" field in the Google Analytics Admin UI. type: boolean type: object GoogleAnalyticsAdminV1alphaCustomMetric: type: object description: A definition for a custom metric. properties: name: type: string description: 'Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}' parameterName: description: 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. type: string description: type: string description: Optional. Description for this custom dimension. Max length of 150 characters. displayName: description: 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. type: string measurementUnit: type: string description: Required. The type for the custom metric's value. enum: - MEASUREMENT_UNIT_UNSPECIFIED - STANDARD - CURRENCY - FEET - METERS - KILOMETERS - MILES - MILLISECONDS - SECONDS - MINUTES - HOURS x-enumDescriptions: - MeasurementUnit unspecified or missing. - This metric uses default units. - This metric measures a currency. - This metric measures feet. - This metric measures meters. - This metric measures kilometers. - This metric measures miles. - This metric measures milliseconds. - This metric measures seconds. - This metric measures minutes. - This metric measures hours. scope: description: Required. Immutable. The scope of this custom metric. enum: - METRIC_SCOPE_UNSPECIFIED - EVENT x-enumDescriptions: - Scope unknown or not specified. - Metric scoped to an event. type: string restrictedMetricType: type: array items: x-enumDescriptions: - Type unknown or unspecified. - Metric reports cost data. - Metric reports revenue data. enum: - RESTRICTED_METRIC_TYPE_UNSPECIFIED - COST_DATA - REVENUE_DATA type: string description: 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. GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter: type: object description: A filter for a string dimension that matches a particular list of options. properties: values: description: Required. The list of possible string values to match against. Must be non-empty. type: array items: type: string caseSensitive: type: boolean description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep: description: A condition that must occur in the specified step order for this user to match the sequence. properties: immediatelyFollows: description: Optional. If true, the event satisfying this step must be the very next event after the event satisfying the last step. If unset or false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. It is ignored for the first step. type: boolean scope: type: string x-enumDescriptions: - Scope is not specified. - User joins the Audience if the filter condition is met within one event. - User joins the Audience if the filter condition is met within one session. - User joins the Audience if the filter condition is met by any event across any session. description: Required. Immutable. Specifies the scope for this step. enum: - AUDIENCE_FILTER_SCOPE_UNSPECIFIED - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION - AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS filterExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpression' description: Required. Immutable. A logical expression of Audience dimension, metric, or event filters in each step. constraintDuration: type: string description: Optional. When set, this step must be satisfied within the constraint_duration of the previous step (For example, t[i] - t[i-1] <= constraint_duration). If not set, there is no duration requirement (the duration is effectively unlimited). It is ignored for the first step. format: google-duration type: object GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings: type: object description: Singleton resource under a web DataStream, configuring measurement of additional site interactions and content. properties: fileDownloadsEnabled: description: If enabled, capture a file download event each time a link is clicked with a common document, compressed file, application, video, or audio extension. type: boolean streamEnabled: type: boolean description: Indicates whether Enhanced Measurement Settings will be used to automatically measure interactions and content on this web stream. Changing this value does not affect the settings themselves, but determines whether they are respected. scrollsEnabled: description: If enabled, capture scroll events each time a visitor gets to the bottom of a page. type: boolean videoEngagementEnabled: description: If enabled, capture video play, progress, and complete events as visitors view embedded videos on your site. type: boolean pageChangesEnabled: type: boolean description: If enabled, capture a page view event each time the website changes the browser history state. formInteractionsEnabled: description: If enabled, capture a form interaction event each time a visitor interacts with a form on your website. False by default. type: boolean outboundClicksEnabled: type: boolean description: If enabled, capture an outbound click event each time a visitor clicks a link that leads them away from your domain. searchQueryParameter: description: Required. URL query parameters to interpret as site search parameters. Max length is 1024 characters. Must not be empty. type: string uriQueryParameter: type: string description: Additional URL query parameters. Max length is 1024 characters. siteSearchEnabled: description: If enabled, capture a view search results event each time a visitor performs a search on your site (based on a query parameter). type: boolean name: description: 'Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"' type: string GoogleAnalyticsAdminV1alphaChannelGroupFilterStringFilter: description: Filter where the field value is a String. The match is case insensitive. properties: matchType: description: Required. The match type for the string filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP x-enumDescriptions: - Default match type. - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full regular expression match with the string value. - Partial regular expression match with the string value. type: string value: type: string description: Required. The string value to be matched against. type: object GoogleAnalyticsAdminV1alphaAccessQuotaStatus: description: Current state for a particular quota group. properties: consumed: description: Quota consumed by this request. format: int32 type: integer remaining: description: Quota remaining after this request. format: int32 type: integer type: object GoogleAnalyticsAdminV1alphaChangeHistoryEvent: description: 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. properties: actorType: x-enumDescriptions: - Unknown or unspecified actor type. - Changes made by the user specified in actor_email. - Changes made by the Google Analytics system. - Changes made by Google Analytics support team staff. description: The type of actor that made this change. enum: - ACTOR_TYPE_UNSPECIFIED - USER - SYSTEM - SUPPORT type: string userActorEmail: description: 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. type: string id: type: string description: ID of this change history event. This ID is unique across Google Analytics. changeTime: format: google-datetime description: Time when change was made. type: string changesFiltered: description: If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event. type: boolean changes: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChangeHistoryChange' description: A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest. type: object GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink: description: A link between a Google Analytics property and a Display & Video 360 advertiser. properties: costDataSharingEnabled: description: Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. type: boolean adsPersonalizationEnabled: description: Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true. type: boolean advertiserDisplayName: type: string description: Output only. The display name of the Display & Video 360 Advertiser. campaignDataSharingEnabled: type: boolean description: Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. advertiserId: type: string description: Immutable. The Display & Video 360 Advertiser's advertiser ID. name: type: string description: 'Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID' type: object GoogleAnalyticsAdminV1alphaAdSenseLink: type: object description: A link between a Google Analytics property and an AdSense for Content ad client. properties: name: type: string description: 'Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789' adClientCode: type: string description: 'Immutable. The AdSense ad client code that the Google Analytics property is linked to. Example format: "ca-pub-1234567890"' GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData: description: Data specific to Android app streams. properties: firebaseAppId: description: Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated. type: string packageName: type: string description: 'Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"' type: object GoogleAnalyticsAdminV1alphaNumericValue: type: object description: To represent a number. properties: int64Value: type: string description: Integer value format: int64 doubleValue: type: number format: double description: Double value GoogleAnalyticsAdminV1alphaRunAccessReportResponse: description: The customized Data Access Record Report response. properties: rows: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessRow' description: Rows of dimension value combinations and metric values in the report. rowCount: type: integer format: int32 description: 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). quota: description: The quota state for this Analytics property including this request. This field doesn't work with account-level requests. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuota' dimensionHeaders: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessDimensionHeader' description: 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. metricHeaders: description: 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. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessMetricHeader' type: object GoogleAnalyticsAdminV1alphaDataStreamWebStreamData: description: Data specific to web streams. properties: firebaseAppId: description: Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. type: string measurementId: description: 'Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"' type: string defaultUri: description: 'Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"' type: string type: object GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse: description: Response message for BatchUpdateAccessBindings RPC. properties: accessBindings: description: The access bindings updated. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' type: object GoogleAnalyticsAdminV1alphaAccessStringFilter: type: object description: The filter for strings. properties: value: description: The string value used for the matching. type: string matchType: type: string description: The match type for this filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full match for the regular expression with the string value. - Partial match for the regular expression with the string value. caseSensitive: type: boolean description: If true, the string value is case sensitive. GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData: type: object description: Data specific to iOS app streams. properties: firebaseAppId: description: Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. type: string bundleId: type: string description: 'Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"' GoogleAnalyticsAdminV1alphaAccessRow: type: object description: Access report data for each row. properties: dimensionValues: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessDimensionValue' description: List of dimension values. These values are in the same order as specified in the request. metricValues: description: List of metric values. These values are in the same order as specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessMetricValue' GoogleAnalyticsAdminV1alphaAudienceSequenceFilter: type: object description: Defines filters that must occur in a specific order for the user to be a member of the Audience. properties: scope: x-enumDescriptions: - Scope is not specified. - User joins the Audience if the filter condition is met within one event. - User joins the Audience if the filter condition is met within one session. - User joins the Audience if the filter condition is met by any event across any session. description: Required. Immutable. Specifies the scope for this filter. enum: - AUDIENCE_FILTER_SCOPE_UNSPECIFIED - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT - AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION - AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS type: string sequenceSteps: description: Required. An ordered sequence of steps. A user must complete each step in order to join the sequence filter. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceSequenceFilterAudienceSequenceStep' sequenceMaximumDuration: type: string description: Optional. Defines the time period in which the whole sequence must occur. format: google-duration GoogleAnalyticsAdminV1alphaGroupingRule: description: The rules that govern how traffic is grouped into one channel. properties: displayName: type: string description: Required. Customer defined display name for the channel. expression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression' description: Required. The Filter Expression that defines the Grouping Rule. type: object GoogleAnalyticsAdminV1alphaAudienceEventFilter: type: object description: 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. properties: eventName: description: Required. Immutable. The name of the event to match against. type: string eventParameterFilterExpression: description: Optional. If specified, this filter matches events that match both the single event name and the parameter filter expressions. AudienceEventFilter inside the parameter filter expression cannot be set (For example, nested event filters are not supported). This should be a single and_group of dimension_or_metric_filter or not_expression; ANDs of ORs are not supported. Also, if it includes a filter for "eventCount", only that one will be considered; all the other filters will be ignored. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpression' GoogleAnalyticsAdminV1alphaParameterMutation: description: Defines an event parameter to mutate. properties: parameter: description: 'Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to ''event_name'' to modify the event_name in place.' type: string parameterValue: type: string description: Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters). type: object GoogleAnalyticsAdminV1alphaAccessOrderBy: type: object description: 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. properties: metric: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy' description: Sorts results by a metric's values. dimension: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy' description: Sorts results by a dimension's values. desc: description: If true, sorts by descending order. If false or unspecified, sorts in ascending order. type: boolean GoogleAnalyticsAdminV1alphaDataRetentionSettings: type: object description: Settings values for data retention. This is a singleton resource. properties: name: description: 'Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings' type: string userDataRetention: type: string x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that user-level data is retained. enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS eventDataRetention: x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that event-level data is retained. enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS type: string resetUserDataOnNewActivity: description: If true, reset the retention period for the user identifier with every event from that user. type: boolean GoogleAnalyticsAdminV1alphaUserProvidedDataSettings: type: object description: Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property. properties: automaticallyDetectedDataCollectionEnabled: type: boolean description: Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true. userProvidedDataCollectionEnabled: description: Optional. Whether this property accepts user-provided data sent to it. type: boolean name: description: 'Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: "properties/1000/userProvidedDataSettings"' type: string GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange: description: Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property. properties: startDate: $ref: '#/components/schemas/GoogleTypeDate' description: Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future. endDate: description: Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date. $ref: '#/components/schemas/GoogleTypeDate' type: object GoogleAnalyticsAdminV1alphaChannelGroup: type: object description: A resource message representing a Channel Group. properties: groupingRule: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGroupingRule' description: Required. The grouping rules of channels. Maximum number of rules is 50. description: type: string description: The description of the Channel Group. Max length of 256 characters. name: type: string description: 'Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}' systemDefined: type: boolean description: Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group. displayName: description: Required. The display name of the Channel Group. Max length of 80 characters. type: string primary: description: Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default. type: boolean GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal: type: object description: A proposal for a link between a Google Analytics 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. properties: costDataSharingEnabled: type: boolean description: Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true. advertiserDisplayName: type: string description: Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. linkProposalStatusDetails: description: Output only. The status information for this link proposal. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails' adsPersonalizationEnabled: description: Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. type: boolean advertiserId: description: Immutable. The Display & Video 360 Advertiser's advertiser ID. type: string validationEmail: description: Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. type: string campaignDataSharingEnabled: type: boolean description: Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true. name: type: string description: 'Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID' GoogleAnalyticsAdminV1alphaConversionValues: description: Conversion value settings for a postback window for SKAdNetwork conversion value schema. properties: displayName: description: Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units. type: string fineValue: type: integer description: The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect. format: int32 eventMappings: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventMapping' description: Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled. coarseValue: description: Required. A coarse grained conversion value. This value is not guaranteed to be unique. enum: - COARSE_VALUE_UNSPECIFIED - COARSE_VALUE_LOW - COARSE_VALUE_MEDIUM - COARSE_VALUE_HIGH x-enumDescriptions: - Coarse value not specified. - Coarse value of low. - Coarse value of medium. - Coarse value of high. type: string lockEnabled: description: If true, the SDK should lock to this conversion value for the current postback window. type: boolean type: object GoogleProtobufEmpty: type: object description: '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); }' properties: {} GoogleAnalyticsAdminV1alphaAccessFilterExpressionList: description: A list of filter expressions. properties: expressions: description: A list of filter expressions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' type: object GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy: description: Sorts by dimension values. properties: dimensionName: description: A dimension name in the request to order by. type: string orderType: type: string x-enumDescriptions: - Unspecified. - Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b" < "z". - Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z". - 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. description: Controls the rule for dimension value ordering. enum: - ORDER_TYPE_UNSPECIFIED - ALPHANUMERIC - CASE_INSENSITIVE_ALPHANUMERIC - NUMERIC type: object GoogleAnalyticsAdminV1alphaKeyEvent: type: object description: A key event in a Google Analytics property. properties: custom: description: Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property. type: boolean countingMethod: x-enumDescriptions: - Counting method not specified. - Each Event instance is considered a Key Event. - An Event instance is considered a Key Event at most once per session per user. description: Required. The method by which Key Events will be counted across multiple events within a session. enum: - COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION type: string name: description: 'Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}' type: string createTime: description: Output only. Time when this key event was created in the property. format: google-datetime type: string deletable: type: boolean description: Output only. If set to true, this event can be deleted. defaultValue: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEventDefaultValue' description: Optional. Defines a default value/currency for a key event. eventName: type: string description: 'Immutable. The event name for this key event. Examples: ''click'', ''purchase''' GoogleAnalyticsAdminV1alphaAccessInListFilter: description: The result needs to be in a list of string values. properties: values: description: The list of string values. Must be non-empty. type: array items: type: string caseSensitive: description: If true, the string value is case sensitive. type: boolean type: object GoogleAnalyticsAdminV1alphaAccessQuota: type: object description: 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. properties: tokensPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: 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. concurrentRequests: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties can use up to 50 concurrent requests. serverErrorsPerProjectPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties and cloud project pairs can have up to 50 server errors per hour. tokensPerDay: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. tokensPerProjectPerHour: description: 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. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' GoogleAnalyticsAdminV1alphaConversionEvent: description: A conversion event in a Google Analytics property. properties: custom: description: 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. type: boolean countingMethod: type: string x-enumDescriptions: - Counting method not specified. - Each Event instance is considered a Conversion. - An Event instance is considered a Conversion at most once per session per user. description: 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`. enum: - CONVERSION_COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION defaultConversionValue: description: Optional. Defines a default value/currency for a conversion event. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEventDefaultConversionValue' eventName: description: 'Immutable. The event name for this conversion event. Examples: ''click'', ''purchase''' type: string name: type: string description: 'Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}' createTime: type: string format: google-datetime description: Output only. Time when this conversion event was created in the property. deletable: description: Output only. If set, this event can currently be deleted with DeleteConversionEvent. type: boolean type: object GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema: type: object description: SKAdNetwork conversion value schema of an iOS stream. properties: name: description: 'Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema' type: string postbackWindowThree: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPostbackWindow' description: The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two. postbackWindowOne: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPostbackWindow' description: Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. applyConversionValues: description: If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. type: boolean postbackWindowTwo: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPostbackWindow' description: The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used. GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse: description: Response message for BatchGetAccessBindings RPC. properties: accessBindings: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: The requested access bindings. type: object GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue: type: object description: To represent a number. properties: int64Value: format: int64 description: Integer value. type: string doubleValue: format: double description: Double value. type: number GoogleAnalyticsAdminV1alphaPostbackWindow: description: Settings for a SKAdNetwork conversion postback window. properties: postbackWindowSettingsEnabled: description: If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. type: boolean conversionValues: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionValues' description: Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. type: object GoogleAnalyticsAdminV1alphaGoogleSignalsSettings: description: Settings values for Google Signals. This is a singleton resource. properties: name: type: string description: 'Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"' consent: enum: - GOOGLE_SIGNALS_CONSENT_UNSPECIFIED - GOOGLE_SIGNALS_CONSENT_CONSENTED - GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED type: string x-enumDescriptions: - Google Signals consent value defaults to GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED. - Terms of service have been accepted - Terms of service have not been accepted description: Output only. Terms of Service acceptance. state: type: string description: Status of this setting. enum: - GOOGLE_SIGNALS_STATE_UNSPECIFIED - GOOGLE_SIGNALS_ENABLED - GOOGLE_SIGNALS_DISABLED x-enumDescriptions: - Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice. - Google Signals is enabled. - Google Signals is disabled. type: object GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList: type: object description: A list of Channel Group filter expressions. properties: filterExpressions: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression' description: A list of Channel Group filter expressions. GoogleAnalyticsAdminV1alphaAccessDimensionValue: description: The value of a dimension. properties: value: type: string description: The dimension value. For example, this value may be 'France' for the 'country' dimension. type: object GoogleAnalyticsAdminV1alphaListAccessBindingsResponse: description: Response message for ListAccessBindings RPC. properties: nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string accessBindings: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: List of AccessBindings. These will be ordered stably, but in an arbitrary order. type: object GoogleAnalyticsAdminV1alphaEventCreateRule: description: 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. properties: eventConditions: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMatchingCondition' description: Required. Must have at least one condition, and can have up to 10 max. Conditions on the source event must match for this rule to be applied. name: description: 'Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}' type: string sourceCopyParameters: type: boolean description: If true, the source parameters are copied to the new event. If false, or unset, all non-internal parameters are not copied from the source event. Parameter mutations are applied after the parameters have been copied. parameterMutations: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaParameterMutation' description: Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. destinationEvent: type: string description: 'Required. The name of the new event to be created. This value must: * be less than 40 characters * consist only of letters, digits or _ (underscores) * start with a letter' type: object GoogleAnalyticsAdminV1alphaSearchAds360Link: description: A link between a Google Analytics property and a Search Ads 360 entity. properties: advertiserId: type: string description: Immutable. This field represents the Advertiser ID of the Search Ads 360 Advertiser. that has been linked. campaignDataSharingEnabled: type: boolean description: Immutable. Enables the import of campaign data from Search Ads 360 into the Google Analytics property. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. name: type: string description: 'Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID' siteStatsSharingEnabled: description: Enables export of site stats with this integration. If this field is not set on create, it will be defaulted to true. type: boolean costDataSharingEnabled: description: Immutable. Enables the import of cost data from Search Ads 360 to the Google Analytics property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Search Ads 360 product. If this field is not set on create, it will be defaulted to true. type: boolean advertiserDisplayName: description: Output only. The display name of the Search Ads 360 Advertiser. Allows users to easily identify the linked resource. type: string adsPersonalizationEnabled: description: Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. type: boolean type: object GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource: type: object description: A snapshot of a resource as before or after the result of a change in change history. properties: adsenseLink: description: A snapshot of an AdSenseLink resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAdSenseLink' attributionSettings: description: A snapshot of AttributionSettings resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAttributionSettings' displayVideo360AdvertiserLinkProposal: description: A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal' reportingIdentitySettings: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingIdentitySettings' description: A snapshot of a ReportingIdentitySettings resource in change history. keyEvent: description: A snapshot of a KeyEvent resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' conversionEvent: description: A snapshot of a ConversionEvent resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' bigqueryLink: description: A snapshot of a BigQuery link resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' userProvidedDataSettings: description: A snapshot of a UserProvidedDataSettings resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaUserProvidedDataSettings' calculatedMetric: description: A snapshot of a CalculatedMetric resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' customDimension: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' description: A snapshot of a CustomDimension resource in change history. dataStream: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' description: A snapshot of a DataStream resource in change history. skadnetworkConversionValueSchema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' description: A snapshot of SKAdNetworkConversionValueSchema resource in change history. reportingDataAnnotation: description: A snapshot of a ReportingDataAnnotation resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' googleAdsLink: description: A snapshot of a GoogleAdsLink resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleAdsLink' googleSignalsSettings: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleSignalsSettings' description: A snapshot of a GoogleSignalsSettings resource in change history. eventCreateRule: description: A snapshot of an EventCreateRule resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' expandedDataSet: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' description: A snapshot of an ExpandedDataSet resource in change history. audience: description: A snapshot of an Audience resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' subpropertySyncConfig: description: A snapshot of a SubpropertySyncConfig resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertySyncConfig' customMetric: description: A snapshot of a CustomMetric resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' dataRedactionSettings: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRedactionSettings' description: A snapshot of DataRedactionSettings resource in change history. searchAds360Link: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' description: A snapshot of a SearchAds360Link resource in change history. enhancedMeasurementSettings: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings' description: A snapshot of EnhancedMeasurementSettings resource in change history. measurementProtocolSecret: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' description: A snapshot of a MeasurementProtocolSecret resource in change history. displayVideo360AdvertiserLink: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' description: A snapshot of a DisplayVideo360AdvertiserLink resource in change history. firebaseLink: description: A snapshot of a FirebaseLink resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaFirebaseLink' account: description: A snapshot of an Account resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccount' channelGroup: description: A snapshot of a ChannelGroup resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' property: description: A snapshot of a Property resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' dataRetentionSettings: description: A snapshot of a data retention settings resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRetentionSettings' GoogleAnalyticsAdminV1alphaAccessMetricValue: description: The value of a metric. properties: value: description: The measurement value. For example, this value may be '13'. type: string type: object GoogleAnalyticsAdminV1alphaKeyEventDefaultValue: type: object description: Defines a default value/currency for a key event. properties: numericValue: type: number format: double description: Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset. currencyCode: type: string description: Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information. GoogleAnalyticsAdminV1alphaProperty: description: A resource message representing a Google Analytics property. properties: currencyCode: type: string description: 'The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"' deleteTime: description: 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. format: google-datetime type: string industryCategory: type: string x-enumDescriptions: - Industry category unspecified - Automotive - Business and industrial markets - Finance - Healthcare - Technology - Travel - Other - Arts and entertainment - Beauty and fitness - Books and literature - Food and drink - Games - Hobbies and leisure - Home and garden - Internet and telecom - Law and government - News - Online communities - People and society - Pets and animals - Real estate - Reference - Science - Sports - Jobs and education - Shopping description: 'Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK' enum: - INDUSTRY_CATEGORY_UNSPECIFIED - AUTOMOTIVE - BUSINESS_AND_INDUSTRIAL_MARKETS - FINANCE - HEALTHCARE - TECHNOLOGY - TRAVEL - OTHER - ARTS_AND_ENTERTAINMENT - BEAUTY_AND_FITNESS - BOOKS_AND_LITERATURE - FOOD_AND_DRINK - GAMES - HOBBIES_AND_LEISURE - HOME_AND_GARDEN - INTERNET_AND_TELECOM - LAW_AND_GOVERNMENT - NEWS - ONLINE_COMMUNITIES - PEOPLE_AND_SOCIETY - PETS_AND_ANIMALS - REAL_ESTATE - REFERENCE - SCIENCE - SPORTS - JOBS_AND_EDUCATION - SHOPPING name: type: string description: 'Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"' displayName: type: string description: Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. account: type: string description: 'Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"' expireTime: type: string description: 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. format: google-datetime createTime: description: Output only. Time when the entity was originally created. format: google-datetime type: string timeZone: description: '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"' type: string parent: description: '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"' type: string updateTime: format: google-datetime description: Output only. Time when entity payload fields were last updated. type: string propertyType: description: 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. enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP x-enumDescriptions: - Unknown or unspecified property type - Ordinary Google Analytics property - Google Analytics subproperty - Google Analytics rollup property type: string serviceLevel: description: Output only. The Google Analytics service level that applies to this property. x-enumDescriptions: - Service level not specified or invalid. - The standard version of Google Analytics. - The paid, premium version of Google Analytics. type: string enum: - SERVICE_LEVEL_UNSPECIFIED - GOOGLE_ANALYTICS_STANDARD - GOOGLE_ANALYTICS_360 type: object GoogleAnalyticsAdminV1alphaAudienceFilterExpression: type: object description: A logical expression of Audience dimension, metric, or event filters. properties: eventFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceEventFilter' description: Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. andGroup: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList' description: A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. orGroup: description: A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList' dimensionOrMetricFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter' description: A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. notExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpression' description: A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter: description: A filter for a string dimension that matches a particular list of options. The match is case insensitive. properties: values: description: Required. The list of possible string values to match against. Must be non-empty. type: array items: type: string type: object GoogleAnalyticsAdminV1alphaAccessBinding: description: A binding of a user to a set of roles. properties: user: type: string description: 'If set, the email address of the user to set roles for. Format: "someuser@gmail.com"' name: description: 'Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"' type: string roles: type: array items: type: string description: 'A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.' type: object GoogleAnalyticsAdminV1alphaCreateAccessBindingRequest: description: Request message for CreateAccessBinding RPC. properties: parent: description: 'Required. Formats: - accounts/{account} - properties/{property}' type: string accessBinding: description: Required. The access binding to create. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' type: object GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest: description: Request message for BatchDeleteAccessBindings RPC. properties: requests: description: Required. The requests specifying the access bindings to delete. A maximum of 1000 access bindings can be deleted in a batch. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest' type: object GoogleAnalyticsAdminV1alphaAccessDateRange: type: object description: 'A contiguous range of days: startDate, startDate + 1, ..., endDate.' properties: startDate: description: 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. type: string endDate: description: 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. type: string GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter: description: A specific filter for a single dimension or metric. properties: atAnyPointInTime: description: Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS. type: boolean inListFilter: description: A filter for a string dimension that matches a particular list of options. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter' betweenFilter: description: A filter for numeric or date values between certain values on a dimension or metric. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter' fieldName: type: string description: Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). stringFilter: description: A filter for a string-type dimension that matches a particular pattern. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter' numericFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter' description: A filter for numeric or date values on a dimension or metric. inAnyNDayPeriod: description: Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. format: int32 type: integer type: object GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest: type: object description: Request message for BatchUpdateAccessBindings RPC. properties: requests: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest' description: Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch. GoogleAnalyticsAdminV1alphaAudienceEventTrigger: description: Specifies an event to log when a user joins the Audience. properties: eventName: description: Required. The event name that will be logged. type: string logCondition: type: string x-enumDescriptions: - Log condition is not specified. - The event should be logged only when a user is joined. - The event should be logged whenever the Audience condition is met, even if the user is already a member of the Audience. description: Required. When to log the event. enum: - LOG_CONDITION_UNSPECIFIED - AUDIENCE_JOINED - AUDIENCE_MEMBERSHIP_RENEWED type: object GoogleAnalyticsAdminV1alphaAccessDimensionHeader: type: object description: 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. properties: dimensionName: type: string description: The dimension's name; for example 'userEmail'. GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails: description: Status information for a link proposal. properties: linkProposalInitiatingProduct: enum: - LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED - GOOGLE_ANALYTICS - LINKED_PRODUCT x-enumDescriptions: - Unspecified product. - This proposal was created by a user from Google Analytics. - This proposal was created by a user from a linked product (not Google Analytics). description: Output only. The source of this proposal. type: string requestorEmail: type: string description: Output only. The email address of the user that proposed this linkage. linkProposalState: type: string x-enumDescriptions: - Unspecified state - This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time. - This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time. - This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time. - This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time. - This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time. - This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time. description: Output only. The state of this proposal. enum: - LINK_PROPOSAL_STATE_UNSPECIFIED - AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS - AWAITING_REVIEW_FROM_LINKED_PRODUCT - WITHDRAWN - DECLINED - EXPIRED - OBSOLETE type: object GoogleAnalyticsAdminV1alphaDataStream: description: A resource message representing a data stream. properties: name: description: 'Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"' type: string createTime: type: string format: google-datetime description: Output only. Time when this stream was originally created. type: type: string description: Required. Immutable. The type of this DataStream resource. enum: - DATA_STREAM_TYPE_UNSPECIFIED - WEB_DATA_STREAM - ANDROID_APP_DATA_STREAM - IOS_APP_DATA_STREAM x-enumDescriptions: - Type unknown or not specified. - Web data stream. - Android app data stream. - iOS app data stream. iosAppStreamData: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData' description: Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. displayName: type: string description: 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. updateTime: description: Output only. Time when stream payload fields were last updated. format: google-datetime type: string androidAppStreamData: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData' description: Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. webStreamData: description: Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStreamWebStreamData' type: object GoogleAnalyticsAdminV1alphaAccount: type: object description: A resource message representing a Google Analytics account. properties: deleted: description: Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. type: boolean regionCode: description: Country of business. Must be a Unicode CLDR region code. type: string gmpOrganization: type: string description: 'Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}' updateTime: type: string description: Output only. Time when account payload fields were last updated. format: google-datetime displayName: type: string description: Required. Human-readable display name for this account. name: type: string description: 'Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100"' createTime: format: google-datetime description: Output only. Time when this account was originally created. type: string GoogleAnalyticsAdminV1alphaMatchingCondition: description: Defines a condition for when an Event Edit or Event Creation rule applies to an event. properties: field: description: Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces. type: string comparisonType: x-enumDescriptions: - Unknown - Equals, case sensitive - Equals, case insensitive - Contains, case sensitive - Contains, case insensitive - Starts with, case sensitive - Starts with, case insensitive - Ends with, case sensitive - Ends with, case insensitive - Greater than - Greater than or equal - Less than - Less than or equal - regular expression. Only supported for web streams. - regular expression, case insensitive. Only supported for web streams. description: Required. The type of comparison to be applied to the value. enum: - COMPARISON_TYPE_UNSPECIFIED - EQUALS - EQUALS_CASE_INSENSITIVE - CONTAINS - CONTAINS_CASE_INSENSITIVE - STARTS_WITH - STARTS_WITH_CASE_INSENSITIVE - ENDS_WITH - ENDS_WITH_CASE_INSENSITIVE - GREATER_THAN - GREATER_THAN_OR_EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - REGULAR_EXPRESSION - REGULAR_EXPRESSION_CASE_INSENSITIVE type: string value: type: string description: Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value. negated: type: boolean description: Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'. type: object GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret: type: object description: A secret value used for sending hits to Measurement Protocol. properties: secretValue: type: string description: 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. name: description: 'Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}' type: string displayName: type: string description: Required. Human-readable display name for this secret. GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter: description: A filter for a string-type dimension that matches a particular pattern. properties: value: type: string description: Required. The string value to be matched against. matchType: type: string description: Required. The match type for the string filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - CONTAINS x-enumDescriptions: - Unspecified - Exact match of the string value. - Contains the string value. caseSensitive: description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS. type: boolean type: object GoogleAnalyticsAdminV1alphaAccessDimension: description: 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. properties: dimensionName: type: string description: 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`. type: object GoogleAnalyticsAdminV1alphaAccessMetricHeader: description: 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. properties: metricName: description: The metric's name; for example 'accessCount'. type: string type: object GoogleRpcStatus: type: object description: Canonical google.rpc.Status error payload returned by Google APIs. properties: code: type: integer format: int32 message: type: string details: type: array items: type: object GoogleAnalyticsAdminV1alphaReportingIdentitySettings: type: object description: A resource containing settings related to reporting identity. properties: name: description: 'Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: "properties/1234/reportingIdentitySettings"' type: string reportingIdentity: type: string description: The strategy used for identifying user identities in reports. enum: - IDENTITY_BLENDING_STRATEGY_UNSPECIFIED - BLENDED - OBSERVED - DEVICE_BASED x-enumDescriptions: - Unspecified blending strategy. - Blended reporting identity strategy. - Observed reporting identity strategy. - Device-based reporting identity strategy. GoogleAnalyticsAdminV1alphaAccessFilterExpression: type: object description: Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. properties: andGroup: description: Each of the FilterExpressions in the and_group has an AND relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpressionList' orGroup: description: Each of the FilterExpressions in the or_group has an OR relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpressionList' notExpression: description: The FilterExpression is NOT of not_expression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' accessFilter: description: A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilter' GoogleAnalyticsAdminV1betaAccessDimensionValue: description: The value of a dimension. type: object properties: value: description: The dimension value. For example, this value may be 'France' for the 'country' dimension. type: string GoogleAnalyticsAdminV1betaDataRetentionSettings: description: Settings values for data retention. This is a singleton resource. type: object properties: userDataRetention: enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that user-level data is retained. type: string resetUserDataOnNewActivity: description: If true, reset the retention period for the user identifier with every event from that user. type: boolean name: description: 'Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings' type: string eventDataRetention: enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that event-level data is retained. type: string GoogleAnalyticsAdminV1betaNumericValue: description: To represent a number. type: object properties: int64Value: description: Integer value type: string format: int64 doubleValue: format: double description: Double value type: number GoogleAnalyticsAdminV1betaAccessMetricHeader: description: 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: object properties: metricName: description: The metric's name; for example 'accessCount'. type: string GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse: description: Response message for ProvisionAccountTicket RPC. type: object properties: accountTicketId: description: The param to be passed in the ToS link. type: string GoogleAnalyticsAdminV1betaAccessDateRange: description: 'A contiguous range of days: startDate, startDate + 1, ..., endDate.' type: object properties: startDate: description: 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. type: string endDate: description: 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. type: string GoogleAnalyticsAdminV1betaConversionEvent: properties: countingMethod: enum: - CONVERSION_COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION description: 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`. type: string x-enumDescriptions: - Counting method not specified. - Each Event instance is considered a Conversion. - An Event instance is considered a Conversion at most once per session per user. defaultConversionValue: description: Optional. Defines a default value/currency for a conversion event. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue' eventName: description: 'Immutable. The event name for this conversion event. Examples: ''click'', ''purchase''' type: string createTime: format: google-datetime description: Output only. Time when this conversion event was created in the property. type: string name: description: 'Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}' type: string custom: description: 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. type: boolean deletable: description: Output only. If set, this event can currently be deleted with DeleteConversionEvent. type: boolean description: A conversion event in a Google Analytics property. type: object GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy: properties: metricName: description: A metric name in the request to order by. type: string description: Sorts by metric values. type: object GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue: description: Defines a default value/currency for a conversion event. Both value and currency must be provided. type: object properties: currencyCode: description: 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. type: string value: description: This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset. type: number format: double GoogleAnalyticsAdminV1betaDataStreamWebStreamData: description: Data specific to web streams. type: object properties: measurementId: description: 'Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"' type: string defaultUri: description: 'Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"' type: string firebaseAppId: description: Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. type: string GoogleAnalyticsAdminV1betaRunAccessReportRequest: description: The request for a Data Access Record Report. type: object properties: offset: format: int64 description: 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). type: string metrics: description: The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetric' metricFilter: description: 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. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' includeAllUsers: description: 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. type: boolean limit: description: 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). type: string format: int64 timeZone: description: 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". type: string returnEntityQuota: description: 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. type: boolean orderBys: description: Specifies how rows are ordered in the response. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderBy' expandGroups: description: 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. type: boolean dimensionFilter: description: 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. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' dimensions: description: The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimension' dateRanges: description: 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. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDateRange' GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest: description: Request message for ProvisionAccountTicket RPC. type: object properties: account: description: The account to create. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccount' redirectUri: description: Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI. type: string GoogleAnalyticsAdminV1betaAccessFilterExpressionList: properties: expressions: description: A list of filter expressions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' description: A list of filter expressions. type: object GoogleAnalyticsAdminV1betaAccessFilterExpression: properties: andGroup: description: Each of the FilterExpressions in the and_group has an AND relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpressionList' orGroup: description: Each of the FilterExpressions in the or_group has an OR relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpressionList' notExpression: description: The FilterExpression is NOT of not_expression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' accessFilter: description: A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilter' description: Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. type: object GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData: description: Data specific to iOS app streams. type: object properties: firebaseAppId: description: Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. type: string bundleId: description: 'Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"' type: string GoogleAnalyticsAdminV1betaAccessMetricValue: properties: value: description: The measurement value. For example, this value may be '13'. type: string description: The value of a metric. type: object GoogleAnalyticsAdminV1betaFirebaseLink: properties: name: description: 'Identifier. Example format: properties/1234/firebaseLinks/5678' type: string project: description: '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''' type: string createTime: description: Output only. Time when this FirebaseLink was originally created. type: string format: google-datetime description: A link between a Google Analytics property and a Firebase project. type: object GoogleAnalyticsAdminV1betaMeasurementProtocolSecret: description: A secret value used for sending hits to Measurement Protocol. type: object properties: displayName: description: Required. Human-readable display name for this secret. type: string secretValue: description: 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. type: string name: description: 'Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}' type: string GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy: properties: dimensionName: description: A dimension name in the request to order by. type: string orderType: enum: - ORDER_TYPE_UNSPECIFIED - ALPHANUMERIC - CASE_INSENSITIVE_ALPHANUMERIC - NUMERIC x-enumDescriptions: - Unspecified. - Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b" < "z". - Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z". - 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. description: Controls the rule for dimension value ordering. type: string description: Sorts by dimension values. type: object GoogleAnalyticsAdminV1betaAccessRow: description: Access report data for each row. type: object properties: dimensionValues: description: List of dimension values. These values are in the same order as specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimensionValue' metricValues: description: List of metric values. These values are in the same order as specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetricValue' GoogleAnalyticsAdminV1betaAccessBetweenFilter: description: To express that the result needs to be between two numbers (inclusive). type: object properties: fromValue: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue' description: Begins with this number. toValue: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue' description: Ends with this number. GoogleAnalyticsAdminV1betaAccessMetric: description: The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records. type: object properties: metricName: description: 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`. type: string GoogleAnalyticsAdminV1betaAccessInListFilter: description: The result needs to be in a list of string values. type: object properties: values: description: The list of string values. Must be non-empty. type: array items: type: string caseSensitive: description: If true, the string value is case sensitive. type: boolean GoogleAnalyticsAdminV1betaChangeHistoryEvent: properties: id: description: ID of this change history event. This ID is unique across Google Analytics. type: string userActorEmail: description: 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. type: string changes: description: A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryChange' changeTime: format: google-datetime description: Time when change was made. type: string changesFiltered: description: If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event. type: boolean actorType: description: The type of actor that made this change. type: string x-enumDescriptions: - Unknown or unspecified actor type. - Changes made by the user specified in actor_email. - Changes made by the Google Analytics system. - Changes made by Google Analytics support team staff. enum: - ACTOR_TYPE_UNSPECIFIED - USER - SYSTEM - SUPPORT description: 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: object GoogleAnalyticsAdminV1betaChangeHistoryChange: properties: resourceBeforeChange: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource' description: Resource contents from before the change was made. If this resource was created in this change, this field will be missing. resourceAfterChange: description: Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource' resource: description: Resource name of the resource whose changes are described by this entry. type: string action: x-enumDescriptions: - Action type unknown or not specified. - Resource was created in this change. - Resource was updated in this change. - Resource was deleted in this change. description: The type of action that changed this resource. type: string enum: - ACTION_TYPE_UNSPECIFIED - CREATED - UPDATED - DELETED description: A description of a change to a single Google Analytics resource. type: object GoogleAnalyticsAdminV1betaAccessFilter: properties: inListFilter: description: A filter for in list values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessInListFilter' stringFilter: description: Strings related filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessStringFilter' fieldName: description: The dimension name or metric name. type: string numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessNumericFilter' betweenFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessBetweenFilter' description: A filter for two values. description: An expression to filter dimension or metric values. type: object GoogleAnalyticsAdminV1betaAccessQuota: description: 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: object properties: tokensPerHour: description: 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. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' serverErrorsPerProjectPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' description: Properties and cloud project pairs can have up to 50 server errors per hour. concurrentRequests: description: Properties can use up to 50 concurrent requests. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' tokensPerProjectPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' description: 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. tokensPerDay: description: Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' GoogleAnalyticsAdminV1betaAccessDimensionHeader: description: 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: object properties: dimensionName: description: The dimension's name; for example 'userEmail'. type: string GoogleAnalyticsAdminV1betaAccessDimension: properties: dimensionName: description: 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`. type: string description: 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: object GoogleAnalyticsAdminV1betaAccessStringFilter: properties: value: description: The string value used for the matching. type: string matchType: x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full match for the regular expression with the string value. - Partial match for the regular expression with the string value. description: The match type for this filter. type: string enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP caseSensitive: description: If true, the string value is case sensitive. type: boolean description: The filter for strings. type: object GoogleAnalyticsAdminV1betaListAccountsResponse: description: Request message for ListAccounts RPC. type: object properties: nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string accounts: description: Results that were accessible to the caller. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccount' GoogleAnalyticsAdminV1betaAccessNumericFilter: description: Filters for numeric or date values. type: object properties: operation: x-enumDescriptions: - Unspecified. - Equal - Less than - Less than or equal - Greater than - Greater than or equal description: The operation type for this filter. type: string enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL value: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue' description: A numeric value or a date value. GoogleAnalyticsAdminV1betaAccount: properties: regionCode: description: Country of business. Must be a Unicode CLDR region code. type: string displayName: description: Required. Human-readable display name for this account. type: string gmpOrganization: description: 'Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}' type: string name: description: 'Identifier. Resource name of this account. Format: accounts/{account} Example: "accounts/100"' type: string createTime: format: google-datetime description: Output only. Time when this account was originally created. type: string updateTime: description: Output only. Time when account payload fields were last updated. type: string format: google-datetime deleted: description: Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested. type: boolean description: A resource message representing a Google Analytics account. type: object GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData: properties: packageName: description: 'Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"' type: string firebaseAppId: description: Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated. type: string description: Data specific to Android app streams. type: object GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest: properties: pageToken: description: 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. type: string resourceType: description: Optional. If set, only return changes if they are for a resource that matches at least one of these types. type: array items: enum: - CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED - ACCOUNT - PROPERTY - FIREBASE_LINK - GOOGLE_ADS_LINK - GOOGLE_SIGNALS_SETTINGS - CONVERSION_EVENT - MEASUREMENT_PROTOCOL_SECRET - CUSTOM_DIMENSION - CUSTOM_METRIC - DATA_RETENTION_SETTINGS - DISPLAY_VIDEO_360_ADVERTISER_LINK - DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL - DATA_STREAM - ATTRIBUTION_SETTINGS x-enumDescriptions: - Resource type unknown or not specified. - Account resource - Property resource - FirebaseLink resource - GoogleAdsLink resource - GoogleSignalsSettings resource - ConversionEvent resource - MeasurementProtocolSecret resource - CustomDimension resource - CustomMetric resource - DataRetentionSettings resource - DisplayVideo360AdvertiserLink resource - DisplayVideo360AdvertiserLinkProposal resource - DataStream resource - AttributionSettings resource type: string property: description: '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`' type: string action: description: Optional. If set, only return changes that match one or more of these types of actions. type: array items: enum: - ACTION_TYPE_UNSPECIFIED - CREATED - UPDATED - DELETED x-enumDescriptions: - Action type unknown or not specified. - Resource was created in this change. - Resource was updated in this change. - Resource was deleted in this change. type: string earliestChangeTime: format: google-datetime description: Optional. If set, only return changes made after this time (inclusive). type: string latestChangeTime: format: google-datetime description: Optional. If set, only return changes made before this time (inclusive). type: string pageSize: format: int32 description: Optional. The maximum number of ChangeHistoryEvent items to return. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). Note that the service may return a page with fewer items than this value specifies (potentially even zero), and that there still may be additional pages. If you want a particular number of items, you'll need to continue requesting additional pages using `page_token` until you get the needed number. type: integer actorEmail: description: Optional. If set, only return changes if they are made by a user in this list. type: array items: type: string description: Request message for SearchChangeHistoryEvents RPC. type: object GoogleAnalyticsAdminV1betaDataStream: description: A resource message representing a data stream. type: object properties: type: enum: - DATA_STREAM_TYPE_UNSPECIFIED - WEB_DATA_STREAM - ANDROID_APP_DATA_STREAM - IOS_APP_DATA_STREAM description: Required. Immutable. The type of this DataStream resource. type: string x-enumDescriptions: - Type unknown or not specified. - Web data stream. - Android app data stream. - iOS app data stream. displayName: description: 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. type: string webStreamData: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamWebStreamData' description: Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. androidAppStreamData: description: Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData' iosAppStreamData: description: Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData' name: description: 'Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"' type: string createTime: description: Output only. Time when this stream was originally created. type: string format: google-datetime updateTime: format: google-datetime description: Output only. Time when stream payload fields were last updated. type: string GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse: description: Response message for SearchAccounts RPC. type: object properties: nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string changeHistoryEvents: description: Results that were accessible to the caller. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaChangeHistoryEvent' GoogleAnalyticsAdminV1betaAccessOrderBy: properties: metric: description: Sorts results by a metric's values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy' desc: description: If true, sorts by descending order. If false or unspecified, sorts in ascending order. type: boolean dimension: description: Sorts results by a dimension's values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy' description: 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: object GoogleAnalyticsAdminV1betaProperty: properties: expireTime: description: 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. type: string format: google-datetime deleteTime: description: 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. type: string format: google-datetime currencyCode: description: 'The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"' type: string updateTime: format: google-datetime description: Output only. Time when entity payload fields were last updated. type: string serviceLevel: x-enumDescriptions: - Service level not specified or invalid. - The standard version of Google Analytics. - The paid, premium version of Google Analytics. description: Output only. The Google Analytics service level that applies to this property. type: string enum: - SERVICE_LEVEL_UNSPECIFIED - GOOGLE_ANALYTICS_STANDARD - GOOGLE_ANALYTICS_360 industryCategory: enum: - INDUSTRY_CATEGORY_UNSPECIFIED - AUTOMOTIVE - BUSINESS_AND_INDUSTRIAL_MARKETS - FINANCE - HEALTHCARE - TECHNOLOGY - TRAVEL - OTHER - ARTS_AND_ENTERTAINMENT - BEAUTY_AND_FITNESS - BOOKS_AND_LITERATURE - FOOD_AND_DRINK - GAMES - HOBBIES_AND_LEISURE - HOME_AND_GARDEN - INTERNET_AND_TELECOM - LAW_AND_GOVERNMENT - NEWS - ONLINE_COMMUNITIES - PEOPLE_AND_SOCIETY - PETS_AND_ANIMALS - REAL_ESTATE - REFERENCE - SCIENCE - SPORTS - JOBS_AND_EDUCATION - SHOPPING description: 'Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK' type: string x-enumDescriptions: - Industry category unspecified - Automotive - Business and industrial markets - Finance - Healthcare - Technology - Travel - Other - Arts and entertainment - Beauty and fitness - Books and literature - Food and drink - Games - Hobbies and leisure - Home and garden - Internet and telecom - Law and government - News - Online communities - People and society - Pets and animals - Real estate - Reference - Science - Sports - Jobs and education - Shopping propertyType: x-enumDescriptions: - Unknown or unspecified property type - Ordinary Google Analytics property - Google Analytics subproperty - Google Analytics rollup property description: 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. type: string enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP name: description: 'Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"' type: string timeZone: description: '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"' type: string parent: description: '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"' type: string createTime: format: google-datetime description: Output only. Time when the entity was originally created. type: string displayName: description: Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. type: string account: description: 'Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"' type: string description: A resource message representing a Google Analytics property. type: object GoogleAnalyticsAdminV1betaGoogleAdsLink: description: A link between a Google Analytics property and a Google Ads account. type: object properties: adsPersonalizationEnabled: description: 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. type: boolean creatorEmailAddress: description: 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. type: string createTime: description: Output only. Time when this link was originally created. type: string format: google-datetime updateTime: description: Output only. Time when this link was last updated. type: string format: google-datetime name: description: 'Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.' type: string customerId: description: Immutable. Google Ads customer ID. type: string canManageClients: description: Output only. If true, this link is for a Google Ads manager account. type: boolean GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource: description: A snapshot of a resource as before or after the result of a change in change history. type: object properties: googleAdsLink: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink' description: A snapshot of a GoogleAdsLink resource in change history. conversionEvent: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent' description: A snapshot of a ConversionEvent resource in change history. property: description: A snapshot of a Property resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaProperty' account: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccount' description: A snapshot of an Account resource in change history. measurementProtocolSecret: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' description: A snapshot of a MeasurementProtocolSecret resource in change history. dataRetentionSettings: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataRetentionSettings' description: A snapshot of a data retention settings resource in change history. dataStream: description: A snapshot of a DataStream resource in change history. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStream' firebaseLink: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink' description: A snapshot of a FirebaseLink resource in change history. GoogleAnalyticsAdminV1betaRunAccessReportResponse: properties: rows: description: Rows of dimension value combinations and metric values in the report. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessRow' quota: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuota' description: The quota state for this Analytics property including this request. This field doesn't work with account-level requests. metricHeaders: description: 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. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetricHeader' dimensionHeaders: description: 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. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimensionHeader' rowCount: format: int32 description: 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). type: integer description: The customized Data Access Record Report response. type: object GoogleAnalyticsAdminV1betaDataSharingSettings: properties: name: description: 'Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings"' type: string sharingWithGoogleAnySalesEnabled: deprecated: true description: Deprecated. This field is no longer used and always returns false. type: boolean sharingWithOthersEnabled: description: Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the "Modeling contributions & business insights" field in the Google Analytics Admin UI. type: boolean sharingWithGoogleAssignedSalesEnabled: description: Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the "Recommendations for your business" field in the Google Analytics Admin UI. type: boolean sharingWithGoogleProductsEnabled: description: Allows Google to use the data to improve other Google products or services. This fields maps to the "Google products & services" field in the Google Analytics Admin UI. type: boolean sharingWithGoogleSupportEnabled: description: Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the "Technical support" field in the Google Analytics Admin UI. type: boolean description: A resource message representing data sharing settings of a Google Analytics account. type: object GoogleAnalyticsAdminV1betaAccessQuotaStatus: properties: remaining: format: int32 description: Quota remaining after this request. type: integer consumed: description: Quota consumed by this request. type: integer format: int32 description: Current state for a particular quota group. type: object securitySchemes: OAuth2: type: oauth2 description: Google OAuth 2.0. Scopes are the short form of the full https://www.googleapis.com/auth/ identifier. flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth tokenUrl: https://oauth2.googleapis.com/token scopes: analytics.edit: Edit Google Analytics management entities analytics.manage.users: Manage Google Analytics Account users by email address analytics.manage.users.readonly: View Google Analytics user permissions analytics.readonly: See and download your Google Analytics data BearerAuth: type: http scheme: bearer description: Google OAuth 2.0 access token presented as a bearer token. x-refined-from: - google-analytics-4-admin-v1alpha-openapi.yml - google-analytics-4-admin-v1beta-openapi.yml