openapi: 3.1.0 info: title: Google Analytics Admin API description: 'Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.' version: v1alpha contact: name: Google url: http://code.google.com/apis/analytics/docs/mgmt/home.html x-discovery-revision: '20260810' servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API tags: - name: accountSummaries - name: accounts - name: properties security: - BearerAuth: [] paths: /v1alpha/accountSummaries: get: operationId: accountSummaries_list summary: Returns summaries of all accounts accessible by the caller tags: - accountSummaries description: Returns summaries of all accounts accessible by the caller. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListAccountSummariesResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /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: [] /v1alpha/properties/{propertiesId}:acknowledgeUserDataCollection: post: operationId: properties_acknowledgeUserDataCollection summary: Acknowledges the terms of user data collection for the specified property tags: - properties description: Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created. parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: Required. The property for which to acknowledge user data collection. - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties: post: operationId: properties_create summary: Creates a Google Analytics property with the specified location and attributes tags: - properties description: Creates a Google Analytics property with the specified location and attributes. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_list summary: Returns child Properties under the specified parent Account tags: - properties description: 'Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: "trashed") properties are excluded by default. Returns an empty list if no relevant properties are found.' parameters: - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token. - name: showDeleted in: query required: false schema: type: boolean description: 'Whether to include soft-deleted (ie: "trashed") Properties in the results. Properties can be inspected to determine whether they are deleted or not.' - name: filter in: query required: false schema: type: string description: 'Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```' - 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/GoogleAnalyticsAdminV1alphaListPropertiesResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties:createRollupProperty: post: operationId: properties_createRollupProperty summary: Create a roll-up property and all roll-up property source links tags: - properties description: Create a roll-up property and all roll-up property source links. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}: delete: operationId: properties_delete summary: 'Marks target Property as soft-deleted (ie: "trashed") and returns it' tags: - properties description: 'Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, 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: ^properties/[^/]+$ description: 'Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: "properties/1000"' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_get summary: Lookup for a single GA Property tags: - properties description: Lookup for a single GA Property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The name of the property to lookup. Format: properties/{property_id} Example: "properties/1000"' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_patch summary: Updates a property tags: - properties description: Updates a property. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/attributionSettings: get: operationId: properties_getAttributionSettings summary: Lookup for a AttributionSettings singleton tags: - properties description: Lookup for a AttributionSettings singleton. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/attributionSettings$ description: 'Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAttributionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_updateAttributionSettings summary: Updates attribution settings on a property tags: - properties description: Updates attribution settings on a property. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/attributionSettings$ description: 'Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAttributionSettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAttributionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataRetentionSettings: get: operationId: properties_getDataRetentionSettings summary: Returns the singleton data retention settings for this property tags: - properties description: Returns the singleton data retention settings for this property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataRetentionSettings$ description: 'Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: "properties/1000/dataRetentionSettings"' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRetentionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_updateDataRetentionSettings summary: Updates the singleton data retention settings for this property tags: - properties description: Updates the singleton data retention settings for this property. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataRetentionSettings$ description: 'Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRetentionSettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRetentionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/googleSignalsSettings: get: operationId: properties_getGoogleSignalsSettings summary: Lookup for Google Signals settings for a property tags: - properties description: Lookup for Google Signals settings for a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/googleSignalsSettings$ description: 'Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleSignalsSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_updateGoogleSignalsSettings summary: Updates Google Signals settings for a property tags: - properties description: Updates Google Signals settings for a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/googleSignalsSettings$ description: 'Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleSignalsSettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleSignalsSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/reportingIdentitySettings: get: operationId: properties_getReportingIdentitySettings summary: Returns the reporting identity settings for this property tags: - properties description: Returns the reporting identity settings for this property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/reportingIdentitySettings$ description: 'Required. The name of the settings to lookup. Format: properties/{property}/reportingIdentitySettings Example: "properties/1000/reportingIdentitySettings"' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingIdentitySettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_updateReportingIdentitySettings summary: Updates the reporting identity settings for this property tags: - properties description: Updates the reporting identity settings for this property. parameters: - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Optional. 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. If omitted, the service will treat it as an implied field mask equivalent to all fields that are populated. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/reportingIdentitySettings$ description: 'Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: "properties/1234/reportingIdentitySettings"' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingIdentitySettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingIdentitySettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/userProvidedDataSettings: get: operationId: properties_getUserProvidedDataSettings summary: Looks up settings related to user-provided data for a property tags: - properties description: Looks up settings related to user-provided data for a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/userProvidedDataSettings$ description: 'Required. The name of the user provided data settings to retrieve. Format: properties/{property}/userProvidedDataSettings' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaUserProvidedDataSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties:provisionSubproperty: post: operationId: properties_provisionSubproperty summary: Create a subproperty and a subproperty event filter that applies to the created subproperty tags: - properties description: Create a subproperty and a subproperty event filter that applies to the created subproperty. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}:runAccessReport: post: operationId: properties_runAccessReport summary: Returns a customized report of data access records tags: - properties 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: ^properties/[^/]+$ 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: propertiesId 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: [] /v1alpha/properties/{propertiesId}:submitUserDeletion: post: operationId: properties_submitUserDeletion summary: Submits a request for user deletion for a property tags: - properties description: Submits a request for user deletion for a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: Required. The name of the property to submit user deletion for. - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubmitUserDeletionRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubmitUserDeletionResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/accessBindings:batchCreate: post: operationId: properties_accessBindings_batchCreate summary: Creates information about multiple access bindings to an account or property tags: - properties 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: ^properties/[^/]+$ 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: propertiesId 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: [] /v1alpha/properties/{propertiesId}/accessBindings:batchDelete: post: operationId: properties_accessBindings_batchDelete summary: Deletes information about multiple users' links to an account or property tags: - properties description: Deletes information about multiple users' links to an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ 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: propertiesId 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: [] /v1alpha/properties/{propertiesId}/accessBindings:batchGet: get: operationId: properties_accessBindings_batchGet summary: Gets information about multiple access bindings to an account or property tags: - properties description: Gets information about multiple access bindings to an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ 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: 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: propertiesId 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: [] /v1alpha/properties/{propertiesId}/accessBindings:batchUpdate: post: operationId: properties_accessBindings_batchUpdate summary: Updates information about multiple access bindings to an account or property tags: - properties description: Updates information about multiple access bindings to an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ 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: propertiesId 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: [] /v1alpha/properties/{propertiesId}/accessBindings: post: operationId: properties_accessBindings_create summary: Creates an access binding on an account or property tags: - properties description: Creates an access binding on an account or property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Formats: - accounts/{account} - properties/{property}' - name: propertiesId 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: properties_accessBindings_list summary: Lists all access bindings on an account or property tags: - properties description: Lists all access bindings on an account or property. parameters: - 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: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Formats: - accounts/{account} - properties/{property}' - 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: propertiesId 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: [] /v1alpha/properties/{propertiesId}/accessBindings/{accessBindingsId}: delete: operationId: properties_accessBindings_delete summary: Deletes an access binding on an account or property tags: - properties description: Deletes an access binding on an account or property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/accessBindings/[^/]+$ description: 'Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' - name: accessBindingsId in: path required: true schema: type: string - name: propertiesId 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: properties_accessBindings_get summary: Gets information about an access binding tags: - properties description: Gets information about an access binding. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/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: propertiesId 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: properties_accessBindings_patch summary: Updates an access binding on an account or property tags: - properties description: Updates an access binding on an account or property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/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: propertiesId 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: [] /v1alpha/properties/{propertiesId}/adSenseLinks: post: operationId: properties_adSenseLinks_create summary: Creates an AdSenseLink tags: - properties description: Creates an AdSenseLink. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAdSenseLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAdSenseLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_adSenseLinks_list summary: Lists AdSenseLinks on a property tags: - properties description: Lists AdSenseLinks on a property. parameters: - name: pageToken in: query required: false schema: type: string description: A page token received from a previous `ListAdSenseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdSenseLinks` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234' - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListAdSenseLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/adSenseLinks/{adSenseLinksId}: delete: operationId: properties_adSenseLinks_delete summary: Deletes an AdSenseLink tags: - properties description: Deletes an AdSenseLink. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/adSenseLinks/[^/]+$ description: 'Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678' - name: adSenseLinksId in: path required: true schema: type: string - name: propertiesId 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: properties_adSenseLinks_get summary: Looks up a single AdSenseLink tags: - properties description: Looks up a single AdSenseLink. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/adSenseLinks/[^/]+$ description: 'Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678' - name: adSenseLinksId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAdSenseLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/audiences/{audiencesId}:archive: post: operationId: properties_audiences_archive summary: Archives an Audience on a property tags: - properties description: Archives an Audience on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audiences/[^/]+$ description: 'Required. Example format: properties/1234/audiences/5678' - name: audiencesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaArchiveAudienceRequest' 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: [] /v1alpha/properties/{propertiesId}/audiences: post: operationId: properties_audiences_create summary: Creates an Audience tags: - properties description: Creates an Audience. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_audiences_list summary: Lists Audiences on a property tags: - properties description: Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListAudiences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudiences` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListAudiencesResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/audiences/{audiencesId}: get: operationId: properties_audiences_get summary: Lookup for a single Audience tags: - properties description: Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audiences/[^/]+$ description: 'Required. The name of the Audience to get. Example format: properties/1234/audiences/5678' - name: audiencesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_audiences_patch summary: Updates an Audience on a property tags: - properties description: Updates an Audience on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audiences/[^/]+$ description: 'Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: audiencesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/bigQueryLinks: post: operationId: properties_bigQueryLinks_create summary: Creates a BigQueryLink tags: - properties description: Creates a BigQueryLink. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_bigQueryLinks_list summary: Lists BigQuery Links on a property tags: - properties description: Lists BigQuery Links on a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: 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: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/bigQueryLinks/{bigQueryLinksId}: delete: operationId: properties_bigQueryLinks_delete summary: Deletes a BigQueryLink on a property tags: - properties description: Deletes a BigQueryLink on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/bigQueryLinks/[^/]+$ description: 'Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678' - name: bigQueryLinksId in: path required: true schema: type: string - name: propertiesId 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: properties_bigQueryLinks_get summary: Lookup for a single BigQuery Link tags: - properties description: Lookup for a single BigQuery Link. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/bigQueryLinks/[^/]+$ description: 'Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456' - name: bigQueryLinksId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_bigQueryLinks_patch summary: Updates a BigQueryLink tags: - properties description: Updates a BigQueryLink. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/bigQueryLinks/[^/]+$ description: 'Output only. Resource name of this BigQuery link. Format: ''properties/{property_id}/bigQueryLinks/{bigquery_link_id}'' Format: ''properties/1234/bigQueryLinks/abc567''' - name: bigQueryLinksId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/calculatedMetrics: post: operationId: properties_calculatedMetrics_create summary: Creates a CalculatedMetric tags: - properties description: Creates a CalculatedMetric. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Format: properties/{property_id} Example: properties/1234' - name: calculatedMetricId in: query required: false schema: type: string description: Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, "calcMetric:{calculated_metric_id}". - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_calculatedMetrics_list summary: Lists CalculatedMetrics on a property tags: - properties description: Lists CalculatedMetrics on a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListCalculatedMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedMetrics` must match the call that provided the page token. - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/calculatedMetrics/{calculatedMetricsId}: delete: operationId: properties_calculatedMetrics_delete summary: Deletes a CalculatedMetric on a property tags: - properties description: Deletes a CalculatedMetric on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/calculatedMetrics/[^/]+$ description: 'Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01' - name: calculatedMetricsId in: path required: true schema: type: string - name: propertiesId 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: properties_calculatedMetrics_get summary: Lookup for a single CalculatedMetric tags: - properties description: Lookup for a single CalculatedMetric. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/calculatedMetrics/[^/]+$ description: 'Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01' - name: calculatedMetricsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_calculatedMetrics_patch summary: Updates a CalculatedMetric on a property tags: - properties description: Updates a CalculatedMetric on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/calculatedMetrics/[^/]+$ description: 'Identifier. Resource name for this CalculatedMetric. Format: ''properties/{property_id}/calculatedMetrics/{calculated_metric_id}''' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: calculatedMetricsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/channelGroups: post: operationId: properties_channelGroups_create summary: Creates a ChannelGroup tags: - properties description: Creates a ChannelGroup. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The property for which to create a ChannelGroup. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_channelGroups_list summary: Lists ChannelGroups on a property tags: - properties description: Lists ChannelGroups on a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListChannelGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannelGroups` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The property for which to list ChannelGroups. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListChannelGroupsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/channelGroups/{channelGroupsId}: delete: operationId: properties_channelGroups_delete summary: Deletes a ChannelGroup on a property tags: - properties description: Deletes a ChannelGroup on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/channelGroups/[^/]+$ description: 'Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678' - name: channelGroupsId in: path required: true schema: type: string - name: propertiesId 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: properties_channelGroups_get summary: Lookup for a single ChannelGroup tags: - properties description: Lookup for a single ChannelGroup. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/channelGroups/[^/]+$ description: 'Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678' - name: channelGroupsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_channelGroups_patch summary: Updates a ChannelGroup tags: - properties description: Updates a ChannelGroup. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/channelGroups/[^/]+$ description: 'Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: channelGroupsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/conversionEvents: post: operationId: properties_conversionEvents_create summary: 'Deprecated: Use `CreateKeyEvent` instead' tags: - properties description: 'Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.' deprecated: true parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The resource name of the parent property where this conversion event will be created. Format: properties/123' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_conversionEvents_list summary: 'Deprecated: Use `ListKeyEvents` instead' tags: - properties description: 'Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.' deprecated: true parameters: - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The resource name of the parent property. Example: ''properties/123''' - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListConversionEventsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}: delete: operationId: properties_conversionEvents_delete summary: 'Deprecated: Use `DeleteKeyEvent` instead' tags: - properties description: 'Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.' deprecated: true parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/conversionEvents/[^/]+$ description: 'Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"' - name: conversionEventsId in: path required: true schema: type: string - name: propertiesId 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: properties_conversionEvents_get summary: 'Deprecated: Use `GetKeyEvent` instead' tags: - properties description: 'Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.' deprecated: true parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/conversionEvents/[^/]+$ description: 'Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456"' - name: conversionEventsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_conversionEvents_patch summary: 'Deprecated: Use `UpdateKeyEvent` instead' tags: - properties description: 'Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.' deprecated: true parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/conversionEvents/[^/]+$ description: 'Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: conversionEventsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive: post: operationId: properties_customDimensions_archive summary: Archives a CustomDimension on a property tags: - properties description: Archives a CustomDimension on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/customDimensions/[^/]+$ description: 'Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678' - name: customDimensionsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest' 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: [] /v1alpha/properties/{propertiesId}/customDimensions: post: operationId: properties_customDimensions_create summary: Creates a CustomDimension tags: - properties description: 'Creates a CustomDimension. Warning: It''s not permissible to use this method to collect data on individual users. In particular, sending user IDs in custom dimensions violates the [Google Analytics Terms of Service](https://www.google.com/analytics/terms/).' parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_customDimensions_list summary: Lists CustomDimensions on a property tags: - properties description: Lists CustomDimensions on a property. parameters: - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}: get: operationId: properties_customDimensions_get summary: Lookup for a single CustomDimension tags: - properties description: Lookup for a single CustomDimension. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/customDimensions/[^/]+$ description: 'Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678' - name: customDimensionsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_customDimensions_patch summary: Updates a CustomDimension on a property tags: - properties description: Updates a CustomDimension on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/customDimensions/[^/]+$ description: 'Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: customDimensionsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}:archive: post: operationId: properties_customMetrics_archive summary: Archives a CustomMetric on a property tags: - properties description: Archives a CustomMetric on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/customMetrics/[^/]+$ description: 'Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678' - name: customMetricsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest' 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: [] /v1alpha/properties/{propertiesId}/customMetrics: post: operationId: properties_customMetrics_create summary: Creates a CustomMetric tags: - properties description: Creates a CustomMetric. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_customMetrics_list summary: Lists CustomMetrics on a property tags: - properties description: Lists CustomMetrics on a property. parameters: - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListCustomMetricsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}: get: operationId: properties_customMetrics_get summary: Lookup for a single CustomMetric tags: - properties description: Lookup for a single CustomMetric. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/customMetrics/[^/]+$ description: 'Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678' - name: customMetricsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_customMetrics_patch summary: Updates a CustomMetric on a property tags: - properties description: Updates a CustomMetric on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/customMetrics/[^/]+$ description: 'Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: customMetricsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams: post: operationId: properties_dataStreams_create summary: Creates a DataStream tags: - properties description: Creates a DataStream. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_dataStreams_list summary: Lists DataStreams on a property tags: - properties description: Lists DataStreams on a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListDataStreamsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}: delete: operationId: properties_dataStreams_delete summary: Deletes a DataStream on a property tags: - properties description: Deletes a DataStream on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId 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: properties_dataStreams_get summary: Lookup for a single DataStream tags: - properties description: Lookup for a single DataStream. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_patch summary: Updates a DataStream on a property tags: - properties description: Updates a DataStream on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/dataRedactionSettings: get: operationId: properties_dataStreams_getDataRedactionSettings summary: Lookup for a single DataRedactionSettings tags: - properties description: Lookup for a single DataRedactionSettings. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/dataRedactionSettings$ description: 'Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRedactionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_updateDataRedactionSettings summary: Updates a DataRedactionSettings on a property tags: - properties description: Updates a DataRedactionSettings on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/dataRedactionSettings$ description: 'Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings"' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRedactionSettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataRedactionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/enhancedMeasurementSettings: get: operationId: properties_dataStreams_getEnhancedMeasurementSettings summary: Returns the enhanced measurement settings for this data stream tags: - properties description: Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/enhancedMeasurementSettings$ description: 'Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_updateEnhancedMeasurementSettings summary: Updates the enhanced measurement settings for this data stream tags: - properties description: Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/enhancedMeasurementSettings$ description: 'Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: "properties/1000/dataStreams/2000/enhancedMeasurementSettings"' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEnhancedMeasurementSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/globalSiteTag: get: operationId: properties_dataStreams_getGlobalSiteTag summary: Returns the Site Tag for the specified web stream tags: - properties description: Returns the Site Tag for the specified web stream. Site Tags are immutable singletons. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/globalSiteTag$ description: 'Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag`' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGlobalSiteTag' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules: post: operationId: properties_dataStreams_eventCreateRules_create summary: Creates an EventCreateRule tags: - properties description: Creates an EventCreateRule. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_dataStreams_eventCreateRules_list summary: Lists EventCreateRules on a web data stream tags: - properties description: Lists EventCreateRules on a web data stream. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventCreateRules` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventCreateRules/{eventCreateRulesId}: delete: operationId: properties_dataStreams_eventCreateRules_delete summary: Deletes an EventCreateRule tags: - properties description: Deletes an EventCreateRule. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/eventCreateRules/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456/eventCreateRules/789' - name: dataStreamsId in: path required: true schema: type: string - name: eventCreateRulesId in: path required: true schema: type: string - name: propertiesId 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: properties_dataStreams_eventCreateRules_get summary: Lookup for a single EventCreateRule tags: - properties description: Lookup for a single EventCreateRule. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/eventCreateRules/[^/]+$ description: 'Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789' - name: dataStreamsId in: path required: true schema: type: string - name: eventCreateRulesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_eventCreateRules_patch summary: Updates an EventCreateRule tags: - properties description: Updates an EventCreateRule. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/eventCreateRules/[^/]+$ description: 'Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: dataStreamsId in: path required: true schema: type: string - name: eventCreateRulesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules: post: operationId: properties_dataStreams_eventEditRules_create summary: Creates an EventEditRule tags: - properties description: Creates an EventEditRule. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventEditRule' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventEditRule' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_dataStreams_eventEditRules_list summary: Lists EventEditRules on a web data stream tags: - properties description: Lists EventEditRules on a web data stream. parameters: - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListEventEditRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventEditRules` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456' - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListEventEditRulesResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules/{eventEditRulesId}: delete: operationId: properties_dataStreams_eventEditRules_delete summary: Deletes an EventEditRule tags: - properties description: Deletes an EventEditRule. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/eventEditRules/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456/eventEditRules/789' - name: dataStreamsId in: path required: true schema: type: string - name: eventEditRulesId in: path required: true schema: type: string - name: propertiesId 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: properties_dataStreams_eventEditRules_get summary: Lookup for a single EventEditRule tags: - properties description: Lookup for a single EventEditRule. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/eventEditRules/[^/]+$ description: 'Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789' - name: dataStreamsId in: path required: true schema: type: string - name: eventEditRulesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventEditRule' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_eventEditRules_patch summary: Updates an EventEditRule tags: - properties description: Updates an EventEditRule. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/eventEditRules/[^/]+$ description: 'Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}' - name: dataStreamsId in: path required: true schema: type: string - name: eventEditRulesId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventEditRule' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventEditRule' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder: post: operationId: properties_dataStreams_eventEditRules_reorder summary: Changes the processing order of event edit rules on the specified stream tags: - properties description: Changes the processing order of event edit rules on the specified stream. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. Example format: properties/123/dataStreams/456' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest' 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: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets: post: operationId: properties_dataStreams_measurementProtocolSecrets_create summary: Creates a measurement protocol secret tags: - properties description: Creates a measurement protocol secret. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_dataStreams_measurementProtocolSecrets_list summary: Returns child MeasurementProtocolSecrets under the specified parent Property tags: - properties description: Returns child MeasurementProtocolSecrets under the specified parent Property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token. - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum. - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}: delete: operationId: properties_dataStreams_measurementProtocolSecrets_delete summary: Deletes target MeasurementProtocolSecret tags: - properties description: Deletes target MeasurementProtocolSecret. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$ description: 'Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}' - name: dataStreamsId in: path required: true schema: type: string - name: measurementProtocolSecretsId in: path required: true schema: type: string - name: propertiesId 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: properties_dataStreams_measurementProtocolSecrets_get summary: Lookup for a single MeasurementProtocolSecret tags: - properties description: Lookup for a single MeasurementProtocolSecret. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$ description: 'Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}' - name: dataStreamsId in: path required: true schema: type: string - name: measurementProtocolSecretsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_measurementProtocolSecrets_patch summary: Updates a measurement protocol secret tags: - properties description: Updates a measurement protocol secret. parameters: - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$ 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}' - name: dataStreamsId in: path required: true schema: type: string - name: measurementProtocolSecretsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema: post: operationId: properties_dataStreams_sKAdNetworkConversionValueSchema_create summary: Creates a SKAdNetworkConversionValueSchema tags: - properties description: Creates a SKAdNetworkConversionValueSchema. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_dataStreams_sKAdNetworkConversionValueSchema_list summary: Lists SKAdNetworkConversionValueSchema on a stream tags: - properties description: Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema. 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: parent in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+$ description: 'Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token. - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListSKAdNetworkConversionValueSchemasResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] ? /v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/sKAdNetworkConversionValueSchema/{sKAdNetworkConversionValueSchemaId} : delete: operationId: properties_dataStreams_sKAdNetworkConversionValueSchema_delete summary: Deletes target SKAdNetworkConversionValueSchema tags: - properties description: Deletes target SKAdNetworkConversionValueSchema. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/sKAdNetworkConversionValueSchema/[^/]+$ description: 'Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string - name: sKAdNetworkConversionValueSchemaId 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: properties_dataStreams_sKAdNetworkConversionValueSchema_get summary: Looks up a single SKAdNetworkConversionValueSchema tags: - properties description: Looks up a single SKAdNetworkConversionValueSchema. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/sKAdNetworkConversionValueSchema/[^/]+$ description: 'Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string - name: sKAdNetworkConversionValueSchemaId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_dataStreams_sKAdNetworkConversionValueSchema_patch summary: Updates a SKAdNetworkConversionValueSchema tags: - properties description: Updates a SKAdNetworkConversionValueSchema. parameters: - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/dataStreams/[^/]+/sKAdNetworkConversionValueSchema/[^/]+$ 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' - name: dataStreamsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string - name: sKAdNetworkConversionValueSchemaId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] ? /v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}:approve : post: operationId: properties_displayVideo360AdvertiserLinkProposals_approve summary: Approves a DisplayVideo360AdvertiserLinkProposal tags: - properties description: Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$ description: 'Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678' - name: displayVideo360AdvertiserLinkProposalsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] ? /v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}:cancel : post: operationId: properties_displayVideo360AdvertiserLinkProposals_cancel summary: Cancels a DisplayVideo360AdvertiserLinkProposal tags: - properties description: 'Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.' parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$ description: 'Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678' - name: displayVideo360AdvertiserLinkProposalsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals: post: operationId: properties_displayVideo360AdvertiserLinkProposals_create summary: Creates a DisplayVideo360AdvertiserLinkProposal tags: - properties description: Creates a DisplayVideo360AdvertiserLinkProposal. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_displayVideo360AdvertiserLinkProposals_list summary: Lists DisplayVideo360AdvertiserLinkProposals on a property tags: - properties description: Lists DisplayVideo360AdvertiserLinkProposals on a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinkProposals` must match the call that provided the page token. - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}: delete: operationId: properties_displayVideo360AdvertiserLinkProposals_delete summary: Deletes a DisplayVideo360AdvertiserLinkProposal on a property tags: - properties description: Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$ description: 'Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678' - name: displayVideo360AdvertiserLinkProposalsId in: path required: true schema: type: string - name: propertiesId 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: properties_displayVideo360AdvertiserLinkProposals_get summary: Lookup for a single DisplayVideo360AdvertiserLinkProposal tags: - properties description: Lookup for a single DisplayVideo360AdvertiserLinkProposal. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$ description: 'Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678' - name: displayVideo360AdvertiserLinkProposalsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks: post: operationId: properties_displayVideo360AdvertiserLinks_create summary: Creates a DisplayVideo360AdvertiserLink tags: - properties description: Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_displayVideo360AdvertiserLinks_list summary: Lists all DisplayVideo360AdvertiserLinks on a property tags: - properties description: Lists all DisplayVideo360AdvertiserLinks on a property. parameters: - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListDisplayVideo360AdvertiserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinks` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}: delete: operationId: properties_displayVideo360AdvertiserLinks_delete summary: Deletes a DisplayVideo360AdvertiserLink on a property tags: - properties description: Deletes a DisplayVideo360AdvertiserLink on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$ description: 'Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678' - name: displayVideo360AdvertiserLinksId in: path required: true schema: type: string - name: propertiesId 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: properties_displayVideo360AdvertiserLinks_get summary: Look up a single DisplayVideo360AdvertiserLink tags: - properties description: Look up a single DisplayVideo360AdvertiserLink parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$ description: 'Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678' - name: displayVideo360AdvertiserLinksId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_displayVideo360AdvertiserLinks_patch summary: Updates a DisplayVideo360AdvertiserLink on a property tags: - properties description: Updates a DisplayVideo360AdvertiserLink on a property. parameters: - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$ description: 'Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID' - name: displayVideo360AdvertiserLinksId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/expandedDataSets: post: operationId: properties_expandedDataSets_create summary: Creates a ExpandedDataSet tags: - properties description: Creates a ExpandedDataSet. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_expandedDataSets_list summary: Lists ExpandedDataSets on a property tags: - properties description: Lists ExpandedDataSets on a property. parameters: - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListExpandedDataSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExpandedDataSet` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/expandedDataSets/{expandedDataSetsId}: delete: operationId: properties_expandedDataSets_delete summary: Deletes a ExpandedDataSet on a property tags: - properties description: Deletes a ExpandedDataSet on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/expandedDataSets/[^/]+$ description: 'Required. Example format: properties/1234/expandedDataSets/5678' - name: expandedDataSetsId in: path required: true schema: type: string - name: propertiesId 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: properties_expandedDataSets_get summary: Lookup for a single ExpandedDataSet tags: - properties description: Lookup for a single ExpandedDataSet. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/expandedDataSets/[^/]+$ description: 'Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678' - name: expandedDataSetsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_expandedDataSets_patch summary: Updates a ExpandedDataSet on a property tags: - properties description: Updates a ExpandedDataSet on a property. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/expandedDataSets/[^/]+$ description: 'Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}' - name: expandedDataSetsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/firebaseLinks: post: operationId: properties_firebaseLinks_create summary: Creates a FirebaseLink tags: - properties description: Creates a FirebaseLink. Properties can have at most one FirebaseLink. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Format: properties/{property_id} Example: `properties/1234`' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaFirebaseLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaFirebaseLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_firebaseLinks_list summary: Lists FirebaseLinks on a property tags: - properties description: Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Format: properties/{property_id} Example: `properties/1234`' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token. - 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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}: delete: operationId: properties_firebaseLinks_delete summary: Deletes a FirebaseLink on a property tags: - properties description: Deletes a FirebaseLink on a property parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/firebaseLinks/[^/]+$ description: 'Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`' - name: firebaseLinksId in: path required: true schema: type: string - name: propertiesId 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: [] /v1alpha/properties/{propertiesId}/googleAdsLinks: post: operationId: properties_googleAdsLinks_create summary: Creates a GoogleAdsLink tags: - properties description: Creates a GoogleAdsLink. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleAdsLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleAdsLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_googleAdsLinks_list summary: Lists GoogleAdsLinks on a property tags: - properties description: Lists GoogleAdsLinks on a property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token. - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}: delete: operationId: properties_googleAdsLinks_delete summary: Deletes a GoogleAdsLink on a property tags: - properties description: Deletes a GoogleAdsLink on a property parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/googleAdsLinks/[^/]+$ description: 'Required. Example format: properties/1234/googleAdsLinks/5678' - name: googleAdsLinksId in: path required: true schema: type: string - name: propertiesId 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: [] patch: operationId: properties_googleAdsLinks_patch summary: Updates a GoogleAdsLink on a property tags: - properties description: Updates a GoogleAdsLink on a property parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/googleAdsLinks/[^/]+$ description: 'Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.' - 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: googleAdsLinksId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleAdsLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleAdsLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/keyEvents: post: operationId: properties_keyEvents_create summary: Creates a Key Event tags: - properties description: Creates a Key Event. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The resource name of the parent property where this Key Event will be created. Format: properties/123' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_keyEvents_list summary: Returns a list of Key Events in the specified parent property tags: - properties description: Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The resource name of the parent property. Example: ''properties/123''' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token. - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListKeyEventsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/keyEvents/{keyEventsId}: delete: operationId: properties_keyEvents_delete summary: Deletes a Key Event tags: - properties description: Deletes a Key Event. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/keyEvents/[^/]+$ description: 'Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"' - name: keyEventsId in: path required: true schema: type: string - name: propertiesId 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: properties_keyEvents_get summary: Retrieve a single Key Event tags: - properties description: Retrieve a single Key Event. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/keyEvents/[^/]+$ description: 'Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: "properties/123/keyEvents/456"' - name: keyEventsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_keyEvents_patch summary: Updates a Key Event tags: - properties description: Updates a Key Event. 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 (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/keyEvents/[^/]+$ description: 'Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}' - name: keyEventsId in: path required: true schema: type: string - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/reportingDataAnnotations: post: operationId: properties_reportingDataAnnotations_create summary: Creates a Reporting Data Annotation tags: - properties description: Creates a Reporting Data Annotation. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_reportingDataAnnotations_list summary: List all Reporting Data Annotations on a property tags: - properties description: List all Reporting Data Annotations on a property. parameters: - name: filter in: query required: false schema: type: string description: 'Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: * ''name'' * `title` * `description` * `annotation_date` * `annotation_date_range` * `color` Additionally, this API provides the following helper functions: * annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. * is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the `start_date` and `end_date`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: * `=` : equals * `!=` : not equals * `<` : less than * `>` : greater than * `<=` : less than or equals * `>=` : greater than or equals * `:` : has operator * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match * `NOT` : Logical not * `AND` : Logical and * `OR` : Logical or Examples: 1. `title="Holiday Sale"` 2. `description=~"[Bb]ig [Gg]ame.*[Ss]ale"` 3. `is_annotation_in_range("2025-12-25", "2026-01-16") = true` 4. `annotation_duration() >= 172800s AND title:BOGO`' - 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: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListReportingDataAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportingDataAnnotations` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Resource name of the property. Format: properties/property_id Example: properties/123' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/reportingDataAnnotations/{reportingDataAnnotationsId}: delete: operationId: properties_reportingDataAnnotations_delete summary: Deletes a Reporting Data Annotation tags: - properties description: Deletes a Reporting Data Annotation. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/reportingDataAnnotations/[^/]+$ description: 'Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456' - name: propertiesId in: path required: true schema: type: string - name: reportingDataAnnotationsId 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: properties_reportingDataAnnotations_get summary: Lookup a single Reporting Data Annotation tags: - properties description: Lookup a single Reporting Data Annotation. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/reportingDataAnnotations/[^/]+$ description: 'Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456' - name: propertiesId in: path required: true schema: type: string - name: reportingDataAnnotationsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_reportingDataAnnotations_patch summary: Updates a Reporting Data Annotation tags: - properties description: Updates a Reporting Data Annotation. parameters: - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Optional. The list of fields to update. 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: ^properties/[^/]+/reportingDataAnnotations/[^/]+$ description: 'Required. Identifier. Resource name of this Reporting Data Annotation. Format: ''properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}'' Format: ''properties/123/reportingDataAnnotations/456''' - name: propertiesId in: path required: true schema: type: string - name: reportingDataAnnotationsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/rollupPropertySourceLinks: post: operationId: properties_rollupPropertySourceLinks_create summary: Creates a roll-up property source link tags: - properties description: Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Format: properties/{property_id} Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRollupPropertySourceLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRollupPropertySourceLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_rollupPropertySourceLinks_list summary: Lists roll-up property source Links on a property tags: - properties description: Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListRollupPropertySourceLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollupPropertySourceLinks` must match the call that provided the page token. - 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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}: delete: operationId: properties_rollupPropertySourceLinks_delete summary: Deletes a roll-up property source link tags: - properties description: Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/rollupPropertySourceLinks/[^/]+$ description: 'Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678' - name: propertiesId in: path required: true schema: type: string - name: rollupPropertySourceLinksId 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: properties_rollupPropertySourceLinks_get summary: Lookup for a single roll-up property source Link tags: - properties description: Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/rollupPropertySourceLinks/[^/]+$ description: 'Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456' - name: propertiesId in: path required: true schema: type: string - name: rollupPropertySourceLinksId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRollupPropertySourceLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/searchAds360Links: post: operationId: properties_searchAds360Links_create summary: Creates a SearchAds360Link tags: - properties description: Creates a SearchAds360Link. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_searchAds360Links_list summary: Lists all SearchAds360Links on a property tags: - properties description: Lists all SearchAds360Links on a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). - name: pageToken in: query required: false schema: type: string description: A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Example format: properties/1234' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}: delete: operationId: properties_searchAds360Links_delete summary: Deletes a SearchAds360Link on a property tags: - properties description: Deletes a SearchAds360Link on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/searchAds360Links/[^/]+$ description: 'Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678' - name: propertiesId in: path required: true schema: type: string - name: searchAds360LinksId 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: properties_searchAds360Links_get summary: Look up a single SearchAds360Link tags: - properties description: Look up a single SearchAds360Link parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/searchAds360Links/[^/]+$ description: 'Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678' - name: propertiesId in: path required: true schema: type: string - name: searchAds360LinksId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_searchAds360Links_patch summary: Updates a SearchAds360Link on a property tags: - properties description: Updates a SearchAds360Link on a property. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/searchAds360Links/[^/]+$ description: 'Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - name: propertiesId in: path required: true schema: type: string - name: searchAds360LinksId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/subpropertyEventFilters: post: operationId: properties_subpropertyEventFilters_create summary: Creates a subproperty Event Filter tags: - properties description: Creates a subproperty Event Filter. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] get: operationId: properties_subpropertyEventFilters_list summary: List all subproperty Event Filters on a property tags: - properties description: List all subproperty Event Filters on a property. 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: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] /v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}: delete: operationId: properties_subpropertyEventFilters_delete summary: Deletes a subproperty event filter tags: - properties description: Deletes a subproperty event filter. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/subpropertyEventFilters/[^/]+$ description: 'Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456' - name: propertiesId in: path required: true schema: type: string - name: subpropertyEventFiltersId 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: properties_subpropertyEventFilters_get summary: Lookup for a single subproperty Event Filter tags: - properties description: Lookup for a single subproperty Event Filter. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/subpropertyEventFilters/[^/]+$ description: 'Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456' - name: propertiesId in: path required: true schema: type: string - name: subpropertyEventFiltersId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_subpropertyEventFilters_patch summary: Updates a subproperty Event Filter tags: - properties description: Updates a subproperty Event Filter. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/subpropertyEventFilters/[^/]+$ description: 'Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Required. The list of fields to update. 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: propertiesId in: path required: true schema: type: string - name: subpropertyEventFiltersId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/subpropertySyncConfigs/{subpropertySyncConfigsId}: get: operationId: properties_subpropertySyncConfigs_get summary: Lookup for a single `SubpropertySyncConfig` tags: - properties description: Lookup for a single `SubpropertySyncConfig`. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/subpropertySyncConfigs/[^/]+$ description: 'Required. Resource name of the SubpropertySyncConfig to lookup. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678' - name: propertiesId in: path required: true schema: type: string - name: subpropertySyncConfigsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertySyncConfig' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] patch: operationId: properties_subpropertySyncConfigs_patch summary: Updates a `SubpropertySyncConfig` tags: - properties description: Updates a `SubpropertySyncConfig`. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/subpropertySyncConfigs/[^/]+$ description: 'Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678' - name: updateMask in: query required: false schema: type: string format: google-fieldmask description: Optional. The list of fields to update. 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: propertiesId in: path required: true schema: type: string - name: subpropertySyncConfigsId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertySyncConfig' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertySyncConfig' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] /v1alpha/properties/{propertiesId}/subpropertySyncConfigs: get: operationId: properties_subpropertySyncConfigs_list summary: List all `SubpropertySyncConfig` resources for a property tags: - properties description: List all `SubpropertySyncConfig` resources for a property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Resource name of the property. Format: properties/property_id Example: properties/123' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertySyncConfig` must match the call that provided the page token. - 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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaListSubpropertySyncConfigsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] components: schemas: 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. 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 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 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 GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse: description: Response message for ListGoogleAdsLinks RPC. properties: googleAdsLinks: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGoogleAdsLink' description: List of GoogleAdsLinks. 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 type: object 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 GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse: description: Response message for ListMeasurementProtocolSecret RPC properties: measurementProtocolSecrets: description: A list of secrets for the parent stream specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret' 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 type: object GoogleAnalyticsAdminV1alphaListKeyEventsResponse: description: Response message for ListKeyEvents RPC. properties: 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. keyEvents: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEvent' description: The requested Key Events 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 GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition: description: A specific filter expression properties: nullFilter: description: A filter for null values. type: boolean stringFilter: description: A filter for a string-type dimension that matches a particular pattern. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter' fieldName: description: Required. The field that is being filtered. 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. 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 GoogleAnalyticsAdminV1alphaSubmitUserDeletionResponse: description: Response message for SubmitUserDeletion RPC. properties: deletionRequestTime: type: string description: Marks the moment for which all visitor data before this point should be deleted. This is set to the time at which the deletion request was received. format: google-datetime 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' 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 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 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. 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 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 GoogleAnalyticsAdminV1alphaListEventEditRulesResponse: type: object description: Response message for ListEventEditRules RPC. properties: eventEditRules: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventEditRule' description: List of EventEditRules. These will be ordered stably, but in an arbitrary order. 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. GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse: description: Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. properties: displayVideo360AdvertiserLink: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' description: The DisplayVideo360AdvertiserLink created as a result of approving the proposal. type: object 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 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. 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: {} 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. GoogleAnalyticsAdminV1alphaListBigQueryLinksResponse: description: Response message for ListBigQueryLinks RPC properties: bigqueryLinks: description: List of BigQueryLinks. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaBigQueryLink' 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 type: object 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. GoogleAnalyticsAdminV1alphaListAdSenseLinksResponse: description: Response message for ListAdSenseLinks method. properties: adsenseLinks: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAdSenseLink' description: List of AdSenseLinks. 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 type: object 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 GoogleAnalyticsAdminV1alphaGlobalSiteTag: description: Read-only resource with the tag for sending data from a website to a DataStream. Only present for web DataStream resources. properties: name: type: string description: 'Identifier. Resource name for this GlobalSiteTag resource. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag"' snippet: type: string description: Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure. 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' 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 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 GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression: description: A logical expression of Subproperty event filters. properties: orGroup: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList' description: A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions. notExpression: description: A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression' filterCondition: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition' description: Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression. type: object 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 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. 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. GoogleAnalyticsAdminV1alphaEventEditRule: type: object description: An Event Edit 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 Create rules, Event Edit Rules are applied in their defined order. Event Edit rules can't be used to modify an event created from an Event Create rule. properties: displayName: type: string description: Required. The display name of this event edit rule. Maximum of 255 characters. parameterMutations: description: Required. Parameter mutations define parameter behavior on the new event, and are applied in order. A maximum of 20 mutations can be applied. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaParameterMutation' name: description: 'Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}' type: string eventConditions: description: Required. Conditions on the source event must match for this rule to be applied. Must have at least one condition, and can have up to 10 max. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaMatchingCondition' processingOrder: description: Output only. The order for which this rule will be processed. Rules with an order value lower than this will be processed before this rule, rules with an order value higher than this will be processed after this rule. New event edit rules will be assigned an order value at the end of the order. This value does not apply to event create rules. format: int64 type: string 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 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 GoogleAnalyticsAdminV1alphaListSKAdNetworkConversionValueSchemasResponse: type: object description: Response message for ListSKAdNetworkConversionValueSchemas RPC properties: skadnetworkConversionValueSchemas: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema' description: List of SKAdNetworkConversionValueSchemas. This will have at most one value. 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. Currently, Google Analytics supports only one SKAdNetworkConversionValueSchema per dataStream, so this will never be populated. type: string 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 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 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 GoogleAnalyticsAdminV1alphaListDataStreamsResponse: description: Response message for ListDataStreams 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 dataStreams: description: List of DataStreams. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStream' type: object 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 GoogleAnalyticsAdminV1alphaListAudiencesResponse: description: Response message for ListAudiences RPC. properties: audiences: description: List of Audiences. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudience' 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 type: object GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse: description: Response message for ListSearchAds360Links RPC. properties: searchAds360Links: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSearchAds360Link' description: List of SearchAds360Links. 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 type: object GoogleAnalyticsAdminV1alphaListCalculatedMetricsResponse: description: Response message for ListCalculatedMetrics RPC. properties: calculatedMetrics: description: List of CalculatedMetrics. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCalculatedMetric' 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 type: object GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse: type: object description: Response message for ListDisplayVideo360AdvertiserLinkProposals RPC. properties: 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. displayVideo360AdvertiserLinkProposals: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal' description: List of DisplayVideo360AdvertiserLinkProposals. GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy: type: object description: Sorts by metric values. properties: metricName: description: A metric name in the request to order by. type: string 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 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 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 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 GoogleAnalyticsAdminV1alphaListChannelGroupsResponse: description: Response message for ListChannelGroups RPC. properties: channelGroups: description: List of ChannelGroup. These will be ordered stably, but in an arbitrary order. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroup' 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 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 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 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' 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 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' GoogleAnalyticsAdminV1alphaArchiveAudienceRequest: type: object description: Request message for ArchiveAudience RPC. properties: {} 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 GoogleAnalyticsAdminV1alphaRollupPropertySourceLink: description: A link that references a source property under the parent rollup property. properties: name: description: 'Output only. Resource name of this RollupPropertySourceLink. Format: ''properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link}'' Format: ''properties/123/rollupPropertySourceLinks/456''' type: string sourceProperty: type: string description: 'Immutable. Resource name of the source property. Format: properties/{property_id} Example: "properties/789"' 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 GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse: type: object description: Response message for ProvisionAccountTicket RPC. properties: accountTicketId: description: The param to be passed in the ToS link. type: string 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 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 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 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 GoogleAnalyticsAdminV1alphaListAccountSummariesResponse: description: Response message for ListAccountSummaries RPC. properties: accountSummaries: description: Account summaries of all accounts the caller has access to. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccountSummary' 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 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 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. 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' 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' 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. 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 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 GoogleAnalyticsAdminV1alphaListEventCreateRulesResponse: type: object description: Response message for ListEventCreateRules RPC. properties: 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. eventCreateRules: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventCreateRule' description: List of EventCreateRules. These will be ordered stably, but in an arbitrary order. 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 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 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 GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter: description: A filter for a string-type dimension that matches a particular pattern. properties: value: type: string description: Required. The string value used for the matching. matchType: type: string x-enumDescriptions: - Match type unknown or not specified. - 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. - Partial 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 - PARTIAL_REGEXP caseSensitive: type: boolean description: Optional. If true, the string value is case sensitive. If false, the match is case-insensitive. type: object GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse: type: object description: Response message for ListCustomDimensions 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 customDimensions: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomDimension' description: List of CustomDimensions. GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse: description: Response message for AcknowledgeUserDataCollection RPC. properties: {} type: object GoogleAnalyticsAdminV1alphaSubmitUserDeletionRequest: description: Request message for SubmitUserDeletion RPC. properties: userId: type: string description: Google Analytics [user ID](https://firebase.google.com/docs/analytics/userid). userProvidedData: type: string description: '[User-provided data](https://support.google.com/analytics/answer/14077171). May contain either one email address or one phone number. Email addresses should be normalized as such: * lowercase * remove periods before @ for gmail.com/googlemail.com addresses * remove all spaces Phone numbers should be normalized as such: * remove all non digit characters * add + prefix' clientId: description: Google Analytics [client ID](https://support.google.com/analytics/answer/11593727). type: string appInstanceId: type: string description: Firebase [application instance ID](https://firebase.google.com/docs/reference/android/com/google/firebase/analytics/FirebaseAnalytics.html#getAppInstanceId). type: object 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' 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 GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList: type: object description: A list of Subproperty event filter expressions. properties: filterExpressions: description: Required. Unordered list. A list of Subproperty event filter expressions type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression' 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' GoogleAnalyticsAdminV1alphaListExpandedDataSetsResponse: description: Response message for ListExpandedDataSets RPC. properties: expandedDataSets: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSet' description: List of ExpandedDataSet. These will be ordered stably, but in an arbitrary order. 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 type: object 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 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 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 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 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 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 GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse: description: Response message for BatchGetAccessBindings RPC. properties: accessBindings: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: The requested access bindings. 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 GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause: type: object description: A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data). properties: filterClauseType: x-enumDescriptions: - Filter clause type unknown or not specified. - Events will be included in the Sub property if the filter clause is met. - Events will be excluded from the Sub property if the filter clause is met. description: Required. The type for the filter clause. enum: - FILTER_CLAUSE_TYPE_UNSPECIFIED - INCLUDE - EXCLUDE type: string filterExpression: description: Required. The logical expression for what events are sent to the subproperty. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression' GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest: type: object description: Request message for AcknowledgeUserDataCollection RPC. properties: acknowledgement: description: 'Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: "I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property."' type: string GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse: description: Response message for ListDisplayVideo360AdvertiserLinks RPC. properties: 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. displayVideo360AdvertiserLinks: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink' description: List of DisplayVideo360AdvertiserLinks. type: object GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse: description: Response message for ListFirebaseLinks RPC properties: firebaseLinks: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaFirebaseLink' description: List of FirebaseLinks. This will have at most one value. 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. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated. 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 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' 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 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. 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'. 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"' GoogleAnalyticsAdminV1alphaAccessMetricValue: description: The value of a metric. properties: value: description: The measurement value. For example, this value may be '13'. type: string 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. 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 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 GoogleAnalyticsAdminV1alphaListReportingDataAnnotationsResponse: description: Response message for ListReportingDataAnnotation RPC. properties: reportingDataAnnotations: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotation' description: List of Reporting Data Annotations. 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 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 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 GoogleAnalyticsAdminV1alphaListSubpropertySyncConfigsResponse: type: object description: Response message for ListSubpropertySyncConfigs RPC. properties: subpropertySyncConfigs: description: List of `SubpropertySyncConfig` resources. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertySyncConfig' 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. GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest: type: object description: Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC. properties: {} GoogleAnalyticsAdminV1alphaListPropertiesResponse: description: Response message for ListProperties RPC. properties: properties: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' description: Results that matched the filter criteria and 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 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 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 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. 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' 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 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. GoogleAnalyticsAdminV1alphaSubpropertyEventFilter: type: object description: A resource message representing a Google Analytics subproperty event filter. properties: name: type: string description: 'Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678' filterClauses: description: Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause' applyToProperty: type: string description: Immutable. Resource name of the Subproperty that uses this filter. GoogleAnalyticsAdminV1alphaProvisionSubpropertyResponse: type: object description: Response message for ProvisionSubproperty RPC. properties: subpropertyEventFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' description: The created subproperty event filter. subproperty: description: The created subproperty. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest: description: Request message for ArchiveCustomDimension RPC. properties: {} type: object GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest: type: object description: Request message for ArchiveCustomMetric RPC. properties: {} GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest: type: object description: Request message for UpdateAccessBinding RPC. properties: accessBinding: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: Required. The access binding to update. 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' GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse: type: object description: Response message for ListRollupPropertySourceLinks RPC. properties: rollupPropertySourceLinks: description: List of RollupPropertySourceLinks. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRollupPropertySourceLink' 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 GoogleAnalyticsAdminV1alphaProvisionSubpropertyRequest: type: object description: Request message for CreateSubproperty RPC. properties: subproperty: description: Required. The subproperty to create. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' customDimensionAndMetricSynchronizationMode: description: Optional. The subproperty feature synchronization mode for Custom Dimensions and Metrics 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 subpropertyEventFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' description: Optional. The subproperty event filter to create on an ordinary property. 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. 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"' 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''' 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 GoogleAnalyticsAdminV1alphaPropertySummary: type: object description: A virtual resource representing metadata for a Google Analytics property. properties: property: type: string description: 'Resource name of property referred to by this property summary Format: properties/{property_id} Example: "properties/1000"' canEdit: description: If true, then the user has a Google Analytics role that permits them to edit the property. type: boolean parent: description: 'Resource name of this property''s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/200"' type: string displayName: description: Display name for the property referred to in this property summary. type: string propertyType: type: string x-enumDescriptions: - Unknown or unspecified property type - Ordinary Google Analytics property - Google Analytics subproperty - Google Analytics rollup property description: The property's property type. enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP 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 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. 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 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 GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest: description: Request message for DeleteAccessBinding RPC. properties: name: description: 'Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' type: string type: object GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse: description: Response message for CreateRollupProperty RPC. properties: rollupProperty: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' description: The created roll-up property. rollupPropertySourceLinks: description: The created roll-up property source links. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaRollupPropertySourceLink' type: object GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse: type: object description: Response message for ListSubpropertyEventFilter RPC. properties: subpropertyEventFilters: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaSubpropertyEventFilter' description: List of subproperty event filters. 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 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 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 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 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 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. 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 GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest: type: object description: Request message for CreateRollupProperty RPC. properties: rollupProperty: description: Required. The roll-up property to create. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaProperty' sourceProperties: type: array items: type: string description: Optional. The resource names of properties that will be sources to the created roll-up property. GoogleAnalyticsAdminV1alphaAccountSummary: description: A virtual resource representing an overview of an account and all its child Google Analytics properties. properties: account: description: 'Resource name of account referred to by this account summary Format: accounts/{account_id} Example: "accounts/1000"' type: string name: description: 'Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: "accountSummaries/1000"' type: string displayName: description: Display name for the account referred to in this account summary. type: string propertySummaries: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPropertySummary' description: List of summaries for child accounts of this account. type: object GoogleAnalyticsAdminV1alphaListCustomMetricsResponse: description: Response message for ListCustomMetrics RPC. properties: 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. customMetrics: description: List of CustomMetrics. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaCustomMetric' 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 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 GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest: type: object description: Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. properties: {} 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 GoogleAnalyticsAdminV1alphaListConversionEventsResponse: description: Response message for ListConversionEvents RPC. properties: conversionEvents: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEvent' description: The requested conversion events 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 type: object GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest: type: object description: Request message for ReorderEventEditRules RPC. properties: eventEditRules: description: Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list. type: array items: type: string 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 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 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. 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 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.