openapi: 3.2.0 info: title: Google Analytics 4 Properties API x-refined-note: - x-discovery-revision differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged properties across 4 of this provider''s published API definitions: google-analytics-4-admin-v1alpha-openapi.yml, google-analytics-4-admin-v1beta-openapi.yml, google-analytics-4-data-v1alpha-openapi.yml, google-analytics-4-data-v1beta-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API - url: https://analyticsdata.googleapis.com description: Google Analytics Data API security: - BearerAuth: [] tags: - name: properties paths: /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API ? /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API ? /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API ? /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaProperty' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaProperty' 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: 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) - 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: 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. responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaListPropertiesResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaProperty' 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/GoogleAnalyticsAdminV1betaProperty' 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/GoogleAnalyticsAdminV1betaProperty' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaProperty' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaDataRetentionSettings' 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/GoogleAnalyticsAdminV1betaDataRetentionSettings' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataRetentionSettings' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaRunAccessReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaRunAccessReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaConversionEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent' 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: 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: 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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaListConversionEventsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaConversionEvent' 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/GoogleAnalyticsAdminV1betaConversionEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest' 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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaCustomDimension' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaCustomDimension' 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: 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: 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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaListCustomDimensionsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaCustomDimension' 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/GoogleAnalyticsAdminV1betaCustomDimension' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaCustomDimension' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest' 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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaCustomMetric' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaCustomMetric' 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/GoogleAnalyticsAdminV1betaListCustomMetricsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaCustomMetric' 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/GoogleAnalyticsAdminV1betaCustomMetric' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaCustomMetric' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaDataStream' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStream' 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: 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: 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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaListDataStreamsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaDataStream' 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/GoogleAnalyticsAdminV1betaDataStream' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStream' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' 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: 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: 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: 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/GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' 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/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaFirebaseLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink' 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: 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: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. Format: properties/{property_id} Example: `properties/1234`' - 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/GoogleAnalyticsAdminV1betaListFirebaseLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaGoogleAdsLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink' 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: 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 `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: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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: 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/[^/]+/googleAdsLinks/[^/]+$ description: 'Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.' - 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/GoogleAnalyticsAdminV1betaGoogleAdsLink' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaKeyEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaKeyEvent' 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/GoogleAnalyticsAdminV1betaListKeyEventsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1beta/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/GoogleAnalyticsAdminV1betaKeyEvent' 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: 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: 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: 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/GoogleAnalyticsAdminV1betaKeyEvent' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaKeyEvent' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics.edit - BearerAuth: [] servers: - url: https://analyticsadmin.googleapis.com description: Google Analytics Admin API /v1alpha/properties/{propertiesId}/metadata: get: operationId: properties_getMetadata summary: Returns metadata for dimensions and metrics available in reporting methods tags: - properties description: Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/metadata$ description: 'Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Metadata' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/propertyQuotasSnapshot: get: operationId: properties_getPropertyQuotasSnapshot summary: Get all property quotas organized by quota category for a given property tags: - properties description: Get all property quotas organized by quota category for a given property. This will charge 1 property quota from the category with the most quota. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/propertyQuotasSnapshot$ description: 'Required. Quotas from this property will be listed in the response. Format: `properties/{property}/propertyQuotasSnapshot`' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/PropertyQuotasSnapshot' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}:runFunnelReport: post: operationId: properties_runFunnelReport summary: Returns a customized funnel report of your Google Analytics event data tags: - properties description: Returns a customized funnel report of your Google Analytics event data. The data returned from the API is as a table with columns for the requested dimensions and metrics. Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. To learn more, see [GA4 Funnel Explorations](https://support.google.com/analytics/answer/9327974). This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Data API Funnel Reporting Feedback](https://docs.google.com/forms/d/e/1FAIpQLSdwOlQDJAUoBiIgUZZ3S_Lwi8gr7Bb0k1jhvc-DEg7Rol3UjA/viewform). parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Optional. A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunFunnelReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RunFunnelReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}:runReport: post: operationId: properties_runReport summary: Returns a customized report of your Google Analytics event data tags: - properties description: Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RunReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/audienceLists: post: operationId: properties_audienceLists_create summary: Creates an audience list for later retrieval tags: - properties description: Creates an audience list for later retrieval. This method quickly returns the audience list's resource name and initiates a long running asynchronous request to form an audience list. To list the users in an audience list, first create the audience list through this method and then send the audience resource name to the `QueryAudienceList` method. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. An audience list is a snapshot of the users currently in the audience at the time of audience list creation. Creating audience lists for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience lists contain the users in each audience. This method is available at beta stability at [audienceExports.create](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/create). To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The parent resource where this audience list will be created. Format: `properties/{property}`' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AudienceList' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Operation' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] get: operationId: properties_audienceLists_list summary: Lists all audience lists for a property tags: - properties description: Lists all audience lists for a property. This method can be used for you to find and reuse existing audience lists rather than creating unnecessary new audience lists. The same audience can have multiple audience lists that represent the list of users that were in an audience on different days. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. This method is available at beta stability at [audienceExports.list](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/list). To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of audience lists to return. The service may return fewer than this value. If unspecified, at most 200 audience lists will be returned. The maximum value is 1000 (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 `ListAudienceLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudienceLists` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. All audience lists for this property will be listed in the response. Format: `properties/{property}`' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListAudienceListsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/audienceLists/{audienceListsId}: get: operationId: properties_audienceLists_get summary: Gets configuration metadata about a specific audience list tags: - properties description: Gets configuration metadata about a specific audience list. This method can be used to understand an audience list after it has been created. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. This method is available at beta stability at [audienceExports.get](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/get). To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audienceLists/[^/]+$ description: 'Required. The audience list resource name. Format: `properties/{property}/audienceLists/{audience_list}`' - name: audienceListsId 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/AudienceList' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/audienceLists/{audienceListsId}:query: post: operationId: properties_audienceLists_query summary: Retrieves an audience list of users tags: - properties description: Retrieves an audience list of users. After creating an audience, the users are not immediately available for listing. First, a request to `CreateAudienceList` is necessary to create an audience list of users, and then second, this method is used to retrieve the users in the audience list. See [Creating an Audience List](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Lists with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. This method is available at beta stability at [audienceExports.query](https://developers.google.com/analytics/devguides/reporting/data/v1/rest/v1beta/properties.audienceExports/query). To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audienceLists/[^/]+$ description: 'Required. The name of the audience list to retrieve users from. Format: `properties/{property}/audienceLists/{audience_list}`' - name: audienceListsId 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/QueryAudienceListRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/QueryAudienceListResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/recurringAudienceLists: post: operationId: properties_recurringAudienceLists_create summary: Creates a recurring audience list tags: - properties description: Creates a recurring audience list. Recurring audience lists produces new audience lists each day. Audience lists are users in an audience at the time of the list's creation. A recurring audience list ensures that you have audience list based on the most recent data available for use each day. If you manually create audience list, you don't know when an audience list based on an additional day's data is available. This recurring audience list automates the creation of an audience list when an additional day's data is available. You will consume fewer quota tokens by using recurring audience list versus manually creating audience list at various times of day trying to guess when an additional day's data is ready. This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The parent resource where this recurring audience list will be created. Format: `properties/{property}`' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RecurringAudienceList' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RecurringAudienceList' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] get: operationId: properties_recurringAudienceLists_list summary: Lists all recurring audience lists for a property tags: - properties description: Lists all recurring audience lists for a property. This method can be used for you to find and reuse existing recurring audience lists rather than creating unnecessary new recurring audience lists. The same audience can have multiple recurring audience lists that represent different dimension combinations; for example, just the dimension `deviceId` or both the dimensions `deviceId` and `userId`. This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of recurring audience lists to return. The service may return fewer than this value. If unspecified, at most 200 recurring audience lists will be returned. The maximum value is 1000 (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 `ListRecurringAudienceLists` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRecurringAudienceLists` must match the call that provided the page token. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. All recurring audience lists for this property will be listed in the response. Format: `properties/{property}`' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListRecurringAudienceListsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/recurringAudienceLists/{recurringAudienceListsId}: get: operationId: properties_recurringAudienceLists_get summary: Gets configuration metadata about a specific recurring audience list tags: - properties description: Gets configuration metadata about a specific recurring audience list. This method can be used to understand a recurring audience list's state after it has been created. For example, a recurring audience list resource will generate audience list instances for each day, and this method can be used to get the resource name of the most recent audience list instance. This method is introduced at alpha stability with the intention of gathering feedback on syntax and capabilities before entering beta. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/recurringAudienceLists/[^/]+$ description: 'Required. The recurring audience list resource name. Format: `properties/{property}/recurringAudienceLists/{recurring_audience_list}`' - name: propertiesId in: path required: true schema: type: string - name: recurringAudienceListsId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RecurringAudienceList' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/reportTasks: post: operationId: properties_reportTasks_create summary: Initiates the creation of a report task tags: - properties description: Initiates the creation of a report task. This method quickly returns a report task and initiates a long running asynchronous request to form a customized report of your Google Analytics event data. A report task will be retained and available for querying for 72 hours after it has been created. A report task created by one user can be listed and queried by all users who have access to the property. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The parent resource where this report task will be created. Format: `properties/{propertyId}`' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReportTask' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Operation' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] get: operationId: properties_reportTasks_list summary: Lists all report tasks for a property tags: - properties description: Lists all report tasks for a property. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of report tasks to return. - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListReportTasks` call. Provide this to retrieve the subsequent page. - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. All report tasks for this property will be listed in the response. Format: `properties/{property}`' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ListReportTasksResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/reportTasks/{reportTasksId}: get: operationId: properties_reportTasks_get summary: Gets report metadata about a specific report task tags: - properties description: Gets report metadata about a specific report task. After creating a report task, use this method to check its processing state or inspect its report definition. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/reportTasks/[^/]+$ description: 'Required. The report task resource name. Format: `properties/{property}/reportTasks/{report_task}`' - name: propertiesId in: path required: true schema: type: string - name: reportTasksId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/ReportTask' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1alpha/properties/{propertiesId}/reportTasks/{reportTasksId}:query: post: operationId: properties_reportTasks_query summary: Retrieves a report task's content tags: - properties description: Retrieves a report task's content. After requesting the `CreateReportTask`, you are able to retrieve the report content once the report is ACTIVE. This method will return an error if the report task's state is not `ACTIVE`. A query response will return the tabular row & column values of the report. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/reportTasks/[^/]+$ description: 'Required. The report source name. Format: `properties/{property}/reportTasks/{report}`' - name: propertiesId in: path required: true schema: type: string - name: reportTasksId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/QueryReportTaskRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/QueryReportTaskResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}:batchRunPivotReports: post: operationId: properties_batchRunPivotReports summary: Returns multiple pivot reports in a batch tags: - properties description: Returns multiple pivot reports in a batch. All reports must be for the same Google Analytics property. parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunPivotReportRequest may either be unspecified or consistent with this property. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchRunPivotReportsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BatchRunPivotReportsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}:batchRunReports: post: operationId: properties_batchRunReports summary: Returns multiple reports in a batch tags: - properties description: Returns multiple reports in a batch. All reports must be for the same Google Analytics property. parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). This property must be specified for the batch. The property within RunReportRequest may either be unspecified or consistent with this property. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchRunReportsRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/BatchRunReportsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}:checkCompatibility: post: operationId: properties_checkCompatibility summary: This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility tags: - properties description: This compatibility method lists dimensions and metrics that can be added to a report request and maintain compatibility. This method fails if the request's dimensions and metrics are incompatible. In Google Analytics, reports fail if they request incompatible dimensions and/or metrics; in that case, you will need to remove dimensions and/or metrics from the incompatible report until the report is compatible. The Realtime and Core reports have different compatibility rules. This method checks compatibility for Core reports. parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'A Google Analytics property identifier whose events are tracked. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). `property` should be the same value as in your `runReport` request. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CheckCompatibilityRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/CheckCompatibilityResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}/metadata: get: operationId: properties_getMetadata summary: Returns metadata for dimensions and metrics available in reporting methods tags: - properties description: Returns metadata for dimensions and metrics available in reporting methods. Used to explore the dimensions and metrics. In this method, a Google Analytics property identifier is specified in the request, and the metadata response includes Custom dimensions and metrics as well as Universal metadata. For example if a custom metric with parameter name `levels_unlocked` is registered to a property, the Metadata response will contain `customEvent:levels_unlocked`. Universal metadata are dimensions and metrics applicable to any property such as `country` and `totalUsers`. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/metadata$ description: 'Required. The resource name of the metadata to retrieve. This name field is specified in the URL path and not URL parameters. Property is a numeric Google Analytics property identifier. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234/metadata Set the Property ID to 0 for dimensions and metrics common to all properties. In this special mode, this method will not return custom dimensions and metrics.' - name: propertiesId in: path required: true schema: type: string responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Metadata_2' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}:runPivotReport: post: operationId: properties_runPivotReport summary: Returns a customized pivot report of your Google Analytics event data tags: - properties description: Returns a customized pivot report of your Google Analytics event data. Pivot reports are more advanced and expressive formats than regular reports. In a pivot report, dimensions are only visible if they are included in a pivot. Multiple pivots can be specified to further dissect your data. parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunPivotReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RunPivotReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}:runRealtimeReport: post: operationId: properties_runRealtimeReport summary: Returns a customized report of realtime event data for your property tags: - properties description: Returns a customized report of realtime event data for your property. Events appear in realtime reports seconds after they have been sent to the Google Analytics. Realtime reports show events and usage data for the periods of time ranging from the present moment to 30 minutes ago (up to 60 minutes for Google Analytics 360 properties). For a guide to constructing realtime requests & understanding responses, see [Creating a Realtime Report](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-basics). parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunRealtimeReportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RunRealtimeReportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}:runReport: post: operationId: properties_runReport summary: Returns a customized report of your Google Analytics event data tags: - properties description: Returns a customized report of your Google Analytics event data. Reports contain statistics derived from data collected by the Google Analytics tracking code. The data returned from the API is as a table with columns for the requested dimensions and metrics. Metrics are individual measurements of user activity on your property, such as active users or event count. Dimensions break down metrics across some common criteria, such as country or event name. For a guide to constructing requests & understanding responses, see [Creating a Report](https://developers.google.com/analytics/devguides/reporting/data/v1/basics). parameters: - name: property in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunReportRequest_2' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/RunReportResponse_2' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}/audienceExports: post: operationId: properties_audienceExports_create summary: Creates an audience export for later retrieval tags: - properties description: Creates an audience export for later retrieval. This method quickly returns the audience export's resource name and initiates a long running asynchronous request to form an audience export. To export the users in an audience export, first create the audience export through this method and then send the audience resource name to the `QueryAudienceExport` method. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. An audience export is a snapshot of the users currently in the audience at the time of audience export creation. Creating audience exports for one audience on different days will return different results as users enter and exit the audience. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience exports contain the users in each audience. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. The parent resource where this audience export will be created. Format: `properties/{property}`' - name: propertiesId in: path required: true schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AudienceExport' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/Operation' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] get: operationId: properties_audienceExports_list summary: Lists all audience exports for a property tags: - properties description: Lists all audience exports for a property. This method can be used for you to find and reuse existing audience exports rather than creating unnecessary new audience exports. The same audience can have multiple audience exports that represent the export of users that were in an audience on different days. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: pageSize in: query required: false schema: type: integer format: int32 description: Optional. The maximum number of audience exports to return. The service may return fewer than this value. If unspecified, at most 200 audience exports will be returned. The maximum value is 1000 (higher values will be coerced to the maximum). - name: parent in: query required: true schema: type: string pattern: ^properties/[^/]+$ description: 'Required. All audience exports for this property will be listed in the response. Format: `properties/{property}`' - name: pageToken in: query required: false schema: type: string description: Optional. A page token, received from a previous `ListAudienceExports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudienceExports` 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/ListAudienceExportsResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}: get: operationId: properties_audienceExports_get summary: Gets configuration metadata about a specific audience export tags: - properties description: Gets configuration metadata about a specific audience export. This method can be used to understand an audience export after it has been created. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audienceExports/[^/]+$ description: 'Required. The audience export resource name. Format: `properties/{property}/audienceExports/{audience_export}`' - name: audienceExportsId 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/AudienceExport' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API /v1beta/properties/{propertiesId}/audienceExports/{audienceExportsId}:query: post: operationId: properties_audienceExports_query summary: Retrieves an audience export of users tags: - properties description: Retrieves an audience export of users. After creating an audience, the users are not immediately available for exporting. First, a request to `CreateAudienceExport` is necessary to create an audience export of users, and then second, this method is used to retrieve the users in the audience export. See [Creating an Audience Export](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-basics) for an introduction to Audience Exports with examples. Audiences in Google Analytics 4 allow you to segment your users in the ways that are important to your business. To learn more, see https://support.google.com/analytics/answer/9267572. Audience Export APIs have some methods at alpha and other methods at beta stability. The intention is to advance methods to beta stability after some feedback and adoption. To give your feedback on this API, complete the [Google Analytics Audience Export API Feedback](https://forms.gle/EeA5u5LW6PEggtCEA) form. parameters: - name: name in: query required: true schema: type: string pattern: ^properties/[^/]+/audienceExports/[^/]+$ description: 'Required. The name of the audience export to retrieve users from. Format: `properties/{property}/audienceExports/{audience_export}`' - name: audienceExportsId 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/QueryAudienceExportRequest' responses: '200': description: Successful response content: application/json: schema: $ref: '#/components/schemas/QueryAudienceExportResponse' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/GoogleRpcStatus' security: - OAuth2: - analytics - analytics.readonly - BearerAuth: [] servers: - url: https://analyticsdata.googleapis.com description: Google Analytics Data API components: schemas: GoogleTypeDate: description: 'Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp' properties: year: description: Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. format: int32 type: integer day: type: integer format: int32 description: Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. month: format: int32 description: Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. type: integer type: object GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter: type: object description: A filter for a string-type dimension that matches a particular pattern. properties: caseSensitive: type: boolean description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. value: type: string description: Required. The string value to be matched against. matchType: type: string x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full regular expression matches with the string value. description: Required. The match type for the string filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP 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 GoogleAnalyticsAdminV1alphaFirebaseLink: description: A link between a Google Analytics property and a Firebase project. properties: name: type: string description: 'Identifier. Example format: properties/1234/firebaseLinks/5678' project: description: 'Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: ''projects/{project number}'' Example: ''projects/1234''' type: string createTime: type: string description: Output only. Time when this FirebaseLink was originally created. format: google-datetime type: object GoogleAnalyticsAdminV1alphaReportingDataAnnotation: type: object description: A Reporting Data Annotation is a comment connected to certain dates for reporting data. properties: color: type: string description: Required. The color used for display of this Reporting Data Annotation. enum: - COLOR_UNSPECIFIED - PURPLE - BROWN - BLUE - GREEN - RED - CYAN - ORANGE x-enumDescriptions: - Color unknown or not specified. - Purple color. - Brown color. - Blue color. - Green color. - Red color. - Cyan color. - Orange color. (Only used for system-generated annotations) name: type: string description: 'Required. Identifier. Resource name of this Reporting Data Annotation. Format: ''properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}'' Format: ''properties/123/reportingDataAnnotations/456''' title: type: string description: Required. Human-readable title for this Reporting Data Annotation. annotationDateRange: description: If set, the Reporting Data Annotation is for a range of dates represented by this field. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange' description: description: Optional. Description for this Reporting Data Annotation. type: string systemGenerated: type: boolean description: Output only. If true, this annotation was generated by the Google Analytics system. System-generated annotations cannot be updated or deleted. annotationDate: description: If set, the Reporting Data Annotation is for a specific date represented by this field. The date must be a valid date with year, month and day set. The date may be in the past, present, or future. $ref: '#/components/schemas/GoogleTypeDate' 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 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 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 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 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 GoogleAnalyticsAdminV1alphaChannelGroupFilter: description: A specific filter for a single dimension. properties: fieldName: type: string description: Required. Immutable. The dimension name to filter. inListFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter' description: A filter for a string dimension that matches a particular list of options. stringFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterStringFilter' description: A filter for a string-type dimension that matches a particular pattern. type: object GoogleAnalyticsAdminV1alphaBigQueryLink: description: A link between a Google Analytics property and BigQuery project. properties: dailyExportEnabled: description: If set true, enables daily data export to the linked Google Cloud project. type: boolean exportStreams: type: array items: type: string description: 'The list of streams under the parent property for which data will be exported. Format: properties/{property_id}/dataStreams/{stream_id} Example: [''properties/1000/dataStreams/2000'']' datasetLocation: type: string description: Required. Immutable. The geographic location where the created BigQuery dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations. freshDailyExportEnabled: type: boolean description: If set true, enables fresh daily export to the linked Google Cloud project. name: description: 'Output only. Resource name of this BigQuery link. Format: ''properties/{property_id}/bigQueryLinks/{bigquery_link_id}'' Format: ''properties/1234/bigQueryLinks/abc567''' type: string project: type: string description: 'Immutable. The linked Google Cloud project. When creating a BigQueryLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, the returned project will always have a project that contains a project number. Format: ''projects/{project number}'' Example: ''projects/1234''' includeAdvertisingId: type: boolean description: If set true, exported data will include advertising identifiers for mobile app streams. excludedEvents: type: array items: type: string description: The list of event names that will be excluded from exports. streamingExportEnabled: description: If set true, enables streaming export to the linked Google Cloud project. type: boolean createTime: type: string format: google-datetime description: Output only. Time when the link was created. type: object GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest: type: object description: Request message for ArchiveCustomMetric RPC. properties: {} 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 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 GoogleAnalyticsAdminV1alphaExpandedDataSet: type: object description: A resource message representing an `ExpandedDataSet`. properties: dataCollectionStartTime: type: string format: google-datetime description: Output only. Time when expanded data set began (or will begin) collecing data. displayName: description: Required. The display name of the ExpandedDataSet. Max 200 chars. type: string dimensionNames: type: array items: type: string description: Immutable. The list of dimensions included in the ExpandedDataSet. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names. description: description: Optional. The description of the ExpandedDataSet. Max 50 chars. type: string name: type: string description: 'Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}' metricNames: type: array items: type: string description: Immutable. The list of metrics included in the ExpandedDataSet. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of dimension names. dimensionFilterExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression' description: Immutable. A logical expression of ExpandedDataSet filters applied to dimension included in the ExpandedDataSet. This filter is used to reduce the number of rows and thus the chance of encountering `other` row. GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest: type: object description: Request message for UpdateAccessBinding RPC. properties: accessBinding: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: Required. The access binding to update. 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 GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest: description: Request message for DeleteAccessBinding RPC. properties: name: description: 'Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}' type: string type: object GoogleAnalyticsAdminV1alphaRunAccessReportRequest: description: The request for a Data Access Record Report. properties: orderBys: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessOrderBy' description: Specifies how rows are ordered in the response. metrics: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessMetric' description: The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. metricFilter: description: Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' dimensions: description: The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessDimension' dimensionFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' description: Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. returnEntityQuota: type: boolean description: Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false. includeAllUsers: description: Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included. type: boolean timeZone: description: This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". type: string offset: type: string description: The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). format: int64 limit: type: string description: The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). format: int64 expandGroups: description: Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned. type: boolean dateRanges: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessDateRange' description: Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges. type: object 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 GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest: description: Request message for ArchiveCustomDimension RPC. properties: {} type: object 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 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 GoogleAnalyticsAdminV1alphaBatchCreateAccessBindingsResponse: type: object description: Response message for BatchCreateAccessBindings RPC. properties: accessBindings: description: The access bindings created. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' 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 GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression: type: object description: A logical expression of EnhancedDataSet dimension filters. properties: filter: description: A filter on a single dimension. This cannot be set on the top level ExpandedDataSetFilterExpression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilter' andGroup: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpressionList' description: A list of expressions to be AND’ed together. It must contain a ExpandedDataSetFilterExpression with either not_expression or dimension_filter. This must be set for the top level ExpandedDataSetFilterExpression. notExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterExpression' description: A filter expression to be NOT'ed (that is, inverted, complemented). It must include a dimension_filter. This cannot be set on the top level ExpandedDataSetFilterExpression. GoogleAnalyticsAdminV1alphaExpandedDataSetFilter: description: A specific filter for a single dimension properties: fieldName: description: Required. The dimension name to filter. type: string stringFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter' description: A filter for a string-type dimension that matches a particular pattern. inListFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter' description: A filter for a string dimension that matches a particular list of options. type: object GoogleAnalyticsAdminV1alphaAudience: description: A resource message representing an Audience. properties: createTime: format: google-datetime description: Output only. Time when the Audience was created. type: string description: description: Required. The description of the Audience. type: string name: type: string description: 'Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}' eventTrigger: description: Optional. Specifies an event to log when a user joins the Audience. If not set, no event is logged when a user joins the Audience. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceEventTrigger' displayName: type: string description: Required. The display name of the Audience. membershipDurationDays: format: int32 description: Required. Immutable. The duration a user should stay in an Audience. It cannot be set to more than 540 days. type: integer filterClauses: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterClause' description: Required. Immutable. Unordered list. Filter clauses that define the Audience. All clauses will be AND’ed together. adsPersonalizationEnabled: type: boolean description: Output only. It is automatically set by GA to false if this is an NPA Audience and is excluded from ads personalization. exclusionDurationMode: description: Immutable. Specifies how long an exclusion lasts for users that meet the exclusion filter. It is applied to all EXCLUDE filter clauses and is ignored when there is no EXCLUDE filter clause in the Audience. enum: - AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED - EXCLUDE_TEMPORARILY - EXCLUDE_PERMANENTLY x-enumDescriptions: - Not specified. - Exclude users from the Audience during periods when they meet the filter clause. - Exclude users from the Audience if they've ever met the filter clause. type: string type: object 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. GoogleAnalyticsAdminV1alphaAccessNumericFilter: type: object description: Filters for numeric or date values. properties: operation: type: string x-enumDescriptions: - Unspecified. - Equal - Less than - Less than or equal - Greater than - Greater than or equal description: The operation type for this filter. enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL value: description: A numeric value or a date value. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaNumericValue' GoogleAnalyticsAdminV1alphaAttributionSettings: type: object description: The attribution settings used for a given property. This is a singleton resource. properties: reportingAttributionModel: x-enumDescriptions: - Reporting attribution model unspecified. - Data-driven attribution distributes credit for the conversion based on data for each conversion event. Each Data-driven model is specific to each advertiser and each conversion event. Previously CROSS_CHANNEL_DATA_DRIVEN - Ignores direct traffic and attributes 100% of the conversion value to the last channel that the customer clicked through (or engaged view through for YouTube) before converting. Previously CROSS_CHANNEL_LAST_CLICK - Attributes 100% of the conversion value to the last Google Paid channel that the customer clicked through before converting. Previously ADS_PREFERRED_LAST_CLICK description: Required. The reporting attribution model used to calculate conversion credit in this property's reports. Changing the attribution model will apply to both historical and future data. These changes will be reflected in reports with conversion and revenue data. User and session data will be unaffected. enum: - REPORTING_ATTRIBUTION_MODEL_UNSPECIFIED - PAID_AND_ORGANIC_CHANNELS_DATA_DRIVEN - PAID_AND_ORGANIC_CHANNELS_LAST_CLICK - GOOGLE_PAID_CHANNELS_LAST_CLICK type: string acquisitionConversionEventLookbackWindow: type: string description: Required. The lookback window configuration for acquisition conversion events. The default window size is 30 days. enum: - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_7_DAYS - ACQUISITION_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS x-enumDescriptions: - Lookback window size unspecified. - 7-day lookback window. - 30-day lookback window. name: type: string description: 'Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: "properties/1000/attributionSettings"' otherConversionEventLookbackWindow: x-enumDescriptions: - Lookback window size unspecified. - 30-day lookback window. - 60-day lookback window. - 90-day lookback window. description: Required. The lookback window for all other, non-acquisition conversion events. The default window size is 90 days. enum: - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_UNSPECIFIED - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_30_DAYS - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_60_DAYS - OTHER_CONVERSION_EVENT_LOOKBACK_WINDOW_90_DAYS type: string adsWebConversionDataExportScope: type: string x-enumDescriptions: - Default value. This value is unused. - No data export scope selected yet. Export scope can never be changed back to this value. - Paid and organic channels are eligible to receive conversion credit, but only credit assigned to Google Ads channels will appear in your Ads accounts. To learn more, see [Paid and Organic channels](https://support.google.com/analytics/answer/10632359). - Only Google Ads paid channels are eligible to receive conversion credit. To learn more, see [Google Paid channels](https://support.google.com/analytics/answer/10632359). description: Required. The Conversion Export Scope for data exported to linked Ads Accounts. enum: - ADS_WEB_CONVERSION_DATA_EXPORT_SCOPE_UNSPECIFIED - NOT_SELECTED_YET - PAID_AND_ORGANIC_CHANNELS - GOOGLE_PAID_CHANNELS GoogleAnalyticsAdminV1alphaSubpropertySyncConfig: description: Subproperty synchronization configuration controls how ordinary property configurations are synchronized to subproperties. This resource is provisioned automatically for each subproperty. properties: name: description: 'Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678' type: string applyToProperty: type: string description: Output only. Immutable. Resource name of the subproperty that these settings apply to. customDimensionAndMetricSyncMode: description: Required. Specifies the Custom Dimension / Metric synchronization mode for the subproperty. If set to ALL, Custom Dimension / Metric synchronization will be immediately enabled. Local configuration of Custom Dimensions / Metrics will not be allowed on the subproperty so long as the synchronization mode is set to ALL. If set to NONE, Custom Dimensions / Metric synchronization is disabled. Custom Dimensions / Metrics must be configured explicitly on the Subproperty. enum: - SYNCHRONIZATION_MODE_UNSPECIFIED - NONE - ALL x-enumDescriptions: - Synchronization mode unknown or not specified. - Entities are not synchronized. Local edits are allowed on the subproperty. - Entities are synchronized from parent property. Local mutations are not allowed on the subproperty (Create / Update / Delete) type: string type: object GoogleAnalyticsAdminV1alphaAccessBetweenFilter: description: To express that the result needs to be between two numbers (inclusive). properties: fromValue: description: Begins with this number. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaNumericValue' toValue: description: Ends with this number. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaNumericValue' type: object GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter: type: object description: A filter for numeric or date values on a dimension or metric. properties: operation: description: Required. The operation applied to a numeric filter. enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - GREATER_THAN x-enumDescriptions: - Unspecified. - Equal. - Less than. - Greater than. type: string value: description: Required. The numeric or date value to match against. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue' GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter: description: A filter for numeric or date values between certain values on a dimension or metric. properties: fromValue: description: Required. Begins with this number, inclusive. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue' toValue: description: Required. Ends with this number, inclusive. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue' type: object GoogleAnalyticsAdminV1alphaAccessFilter: type: object description: An expression to filter dimension or metric values. properties: stringFilter: description: Strings related filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessStringFilter' numericFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessNumericFilter' description: A filter for numeric or date values. betweenFilter: description: A filter for two values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBetweenFilter' fieldName: description: The dimension name or metric name. type: string inListFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessInListFilter' description: A filter for in list values. GoogleAnalyticsAdminV1alphaEventMapping: type: object description: Event setting conditions to match an event. properties: minEventValue: type: number description: The minimum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, minimum event value won't be checked. format: double minEventCount: description: At least one of the following four min/max values must be set. The values set will be ANDed together to qualify an event. The minimum number of times the event occurred. If not set, minimum event count won't be checked. format: int64 type: string maxEventCount: type: string format: int64 description: The maximum number of times the event occurred. If not set, maximum event count won't be checked. eventName: description: Required. Name of the Google Analytics event. It must always be set. The max allowed display name length is 40 UTF-16 code units. type: string maxEventValue: type: number format: double description: The maximum revenue generated due to the event. Revenue currency will be defined at the property level. If not set, maximum event value won't be checked. 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. 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 GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy: type: object description: Sorts by metric values. properties: metricName: description: A metric name in the request to order by. type: string 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 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 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 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. 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. 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' 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 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 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 GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest: type: object description: Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC. properties: {} GoogleAnalyticsAdminV1alphaAccessMetric: description: The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records. properties: metricName: description: The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`. type: string type: object GoogleAnalyticsAdminV1alphaExpandedDataSetFilterInListFilter: description: A filter for a string dimension that matches a particular list of options. properties: caseSensitive: type: boolean description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true. values: type: array items: type: string description: Required. The list of possible string values to match against. Must be non-empty. type: object GoogleAnalyticsAdminV1alphaGoogleAdsLink: type: object description: A link between a Google Analytics property and a Google Ads account. properties: name: description: 'Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.' type: string createTime: type: string description: Output only. Time when this link was originally created. format: google-datetime creatorEmailAddress: description: Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. type: string canManageClients: description: Output only. If true, this link is for a Google Ads manager account. type: boolean adsPersonalizationEnabled: type: boolean description: Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. updateTime: type: string description: Output only. Time when this link was last updated. format: google-datetime customerId: type: string description: Immutable. Google Ads customer ID. 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 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' 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' 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 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 GoogleAnalyticsAdminV1alphaCustomMetric: type: object description: A definition for a custom metric. properties: name: type: string description: 'Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}' parameterName: description: Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. type: string description: type: string description: Optional. Description for this custom dimension. Max length of 150 characters. displayName: description: Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. type: string measurementUnit: type: string description: Required. The type for the custom metric's value. enum: - MEASUREMENT_UNIT_UNSPECIFIED - STANDARD - CURRENCY - FEET - METERS - KILOMETERS - MILES - MILLISECONDS - SECONDS - MINUTES - HOURS x-enumDescriptions: - MeasurementUnit unspecified or missing. - This metric uses default units. - This metric measures a currency. - This metric measures feet. - This metric measures meters. - This metric measures kilometers. - This metric measures miles. - This metric measures milliseconds. - This metric measures seconds. - This metric measures minutes. - This metric measures hours. scope: description: Required. Immutable. The scope of this custom metric. enum: - METRIC_SCOPE_UNSPECIFIED - EVENT x-enumDescriptions: - Scope unknown or not specified. - Metric scoped to an event. type: string restrictedMetricType: type: array items: x-enumDescriptions: - Type unknown or unspecified. - Metric reports cost data. - Metric reports revenue data. enum: - RESTRICTED_METRIC_TYPE_UNSPECIFIED - COST_DATA - REVENUE_DATA type: string description: Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter: type: object description: A filter for a string dimension that matches a particular list of options. properties: values: description: Required. The list of possible string values to match against. Must be non-empty. type: array items: type: string caseSensitive: type: boolean description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. 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 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 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 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 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 GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink: description: A link between a Google Analytics property and a Display & Video 360 advertiser. properties: costDataSharingEnabled: description: Immutable. Enables the import of cost data from Display & Video 360 into the Google Analytics property. This can only be enabled if `campaign_data_sharing_enabled` is true. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. type: boolean adsPersonalizationEnabled: description: Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true. type: boolean advertiserDisplayName: type: string description: Output only. The display name of the Display & Video 360 Advertiser. campaignDataSharingEnabled: type: boolean description: Immutable. Enables the import of campaign data from Display & Video 360 into the Google Analytics property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true. advertiserId: type: string description: Immutable. The Display & Video 360 Advertiser's advertiser ID. name: type: string description: 'Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID' type: object GoogleAnalyticsAdminV1alphaAdSenseLink: type: object description: A link between a Google Analytics property and an AdSense for Content ad client. properties: name: type: string description: 'Output only. The resource name for this AdSense Link resource. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/6789' adClientCode: type: string description: 'Immutable. The AdSense ad client code that the Google Analytics property is linked to. Example format: "ca-pub-1234567890"' 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' GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData: description: Data specific to Android app streams. properties: firebaseAppId: description: Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated. type: string packageName: type: string description: 'Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"' type: object GoogleAnalyticsAdminV1alphaNumericValue: type: object description: To represent a number. properties: int64Value: type: string description: Integer value format: int64 doubleValue: type: number format: double description: Double value 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 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 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 GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsResponse: description: Response message for BatchUpdateAccessBindings RPC. properties: accessBindings: description: The access bindings updated. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' type: object GoogleAnalyticsAdminV1alphaAccessStringFilter: type: object description: The filter for strings. properties: value: description: The string value used for the matching. type: string matchType: type: string description: The match type for this filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full match for the regular expression with the string value. - Partial match for the regular expression with the string value. caseSensitive: type: boolean description: If true, the string value is case sensitive. 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. 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 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"' 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 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' 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 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 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' 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 GoogleAnalyticsAdminV1alphaParameterMutation: description: Defines an event parameter to mutate. properties: parameter: description: 'Required. The name of the parameter to mutate. This value must: * be less than 40 characters. * be unique across across all mutations within the rule * consist only of letters, digits or _ (underscores) For event edit rules, the name may also be set to ''event_name'' to modify the event_name in place.' type: string parameterValue: type: string description: Required. The value mutation to perform. * Must be less than 100 characters. * To specify a constant value for the param, use the value's string. * To copy value from another parameter, use syntax like "[[other_parameter]]" For more details, see this [help center article](https://support.google.com/analytics/answer/10085872#modify-an-event&zippy=%2Cin-this-article%2Cmodify-parameters). type: object GoogleAnalyticsAdminV1alphaAccessOrderBy: type: object description: Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering. properties: metric: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessOrderByMetricOrderBy' description: Sorts results by a metric's values. dimension: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy' description: Sorts results by a dimension's values. desc: description: If true, sorts by descending order. If false or unspecified, sorts in ascending order. type: boolean GoogleAnalyticsAdminV1alphaDataRetentionSettings: type: object description: Settings values for data retention. This is a singleton resource. properties: name: description: 'Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings' type: string userDataRetention: type: string x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that user-level data is retained. enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS eventDataRetention: x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that event-level data is retained. enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS type: string resetUserDataOnNewActivity: description: If true, reset the retention period for the user identifier with every event from that user. type: boolean 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 GoogleAnalyticsAdminV1alphaUserProvidedDataSettings: type: object description: Configuration for user-provided data collection. This is a singleton resource for a Google Analytics property. properties: automaticallyDetectedDataCollectionEnabled: type: boolean description: Optional. Whether this property allows a Google Tag to automatically collect user-provided data from your website. This setting only takes effect if `user_provided_data_collection_enabled` is also true. userProvidedDataCollectionEnabled: description: Optional. Whether this property accepts user-provided data sent to it. type: boolean name: description: 'Identifier. Resource name of this setting. Format: properties/{property}/userProvidedDataSettings Example: "properties/1000/userProvidedDataSettings"' type: string GoogleAnalyticsAdminV1alphaReportingDataAnnotationDateRange: description: Represents a Reporting Data Annotation's date range, both start and end dates are inclusive. Time zones are based on the parent property. properties: startDate: $ref: '#/components/schemas/GoogleTypeDate' description: Required. The start date for this range. Must be a valid date with year, month, and day set. The date may be in the past, present, or future. endDate: description: Required. The end date for this range. Must be a valid date with year, month, and day set. This date must be greater than or equal to the start date. $ref: '#/components/schemas/GoogleTypeDate' type: object GoogleAnalyticsAdminV1alphaChannelGroup: type: object description: A resource message representing a Channel Group. properties: groupingRule: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaGroupingRule' description: Required. The grouping rules of channels. Maximum number of rules is 50. description: type: string description: The description of the Channel Group. Max length of 256 characters. name: type: string description: 'Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}' systemDefined: type: boolean description: Output only. If true, then this channel group is the Default Channel Group predefined by Google Analytics. Display name and grouping rules cannot be updated for this channel group. displayName: description: Required. The display name of the Channel Group. Max length of 80 characters. type: string primary: description: Optional. If true, this channel group will be used as the default channel group for reports. Only one channel group can be set as `primary` at any time. If the `primary` field gets set on a channel group, it will get unset on the previous primary channel group. The Google Analytics predefined channel group is the primary by default. type: boolean GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal: type: object description: A proposal for a link between a Google Analytics property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals. properties: costDataSharingEnabled: type: boolean description: Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true. advertiserDisplayName: type: string description: Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360. linkProposalStatusDetails: description: Output only. The status information for this link proposal. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails' adsPersonalizationEnabled: description: Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true. type: boolean advertiserId: description: Immutable. The Display & Video 360 Advertiser's advertiser ID. type: string validationEmail: description: Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal. type: string campaignDataSharingEnabled: type: boolean description: Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true. name: type: string description: 'Identifier. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID' GoogleAnalyticsAdminV1alphaConversionValues: description: Conversion value settings for a postback window for SKAdNetwork conversion value schema. properties: displayName: description: Display name of the SKAdNetwork conversion value. The max allowed display name length is 50 UTF-16 code units. type: string fineValue: type: integer description: The fine-grained conversion value. This is applicable only to the first postback window. Its valid values are [0,63], both inclusive. It must be set for postback window 1, and must not be set for postback window 2 & 3. This value is not guaranteed to be unique. If the configuration for the first postback window is re-used for second or third postback windows this field has no effect. format: int32 eventMappings: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaEventMapping' description: Event conditions that must be met for this Conversion Value to be achieved. The conditions in this list are ANDed together. It must have minimum of 1 entry and maximum of 3 entries, if the postback window is enabled. coarseValue: description: Required. A coarse grained conversion value. This value is not guaranteed to be unique. enum: - COARSE_VALUE_UNSPECIFIED - COARSE_VALUE_LOW - COARSE_VALUE_MEDIUM - COARSE_VALUE_HIGH x-enumDescriptions: - Coarse value not specified. - Coarse value of low. - Coarse value of medium. - Coarse value of high. type: string lockEnabled: description: If true, the SDK should lock to this conversion value for the current postback window. type: boolean type: object 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 GoogleProtobufEmpty: type: object description: 'A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }' properties: {} GoogleAnalyticsAdminV1alphaAccessFilterExpressionList: description: A list of filter expressions. properties: expressions: description: A list of filter expressions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' type: object GoogleAnalyticsAdminV1alphaAccessOrderByDimensionOrderBy: description: Sorts by dimension values. properties: dimensionName: description: A dimension name in the request to order by. type: string orderType: type: string x-enumDescriptions: - Unspecified. - Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b" < "z". - Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z". - Dimension values are converted to numbers before sorting. For example in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" < "25". Non-numeric dimension values all have equal ordering value below all numeric values. description: Controls the rule for dimension value ordering. enum: - ORDER_TYPE_UNSPECIFIED - ALPHANUMERIC - CASE_INSENSITIVE_ALPHANUMERIC - NUMERIC type: object GoogleAnalyticsAdminV1alphaKeyEvent: type: object description: A key event in a Google Analytics property. properties: custom: description: Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property. type: boolean countingMethod: x-enumDescriptions: - Counting method not specified. - Each Event instance is considered a Key Event. - An Event instance is considered a Key Event at most once per session per user. description: Required. The method by which Key Events will be counted across multiple events within a session. enum: - COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION type: string name: description: 'Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}' type: string createTime: description: Output only. Time when this key event was created in the property. format: google-datetime type: string deletable: type: boolean description: Output only. If set to true, this event can be deleted. defaultValue: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaKeyEventDefaultValue' description: Optional. Defines a default value/currency for a key event. eventName: type: string description: 'Immutable. The event name for this key event. Examples: ''click'', ''purchase''' GoogleAnalyticsAdminV1alphaAccessInListFilter: description: The result needs to be in a list of string values. properties: values: description: The list of string values. Must be non-empty. type: array items: type: string caseSensitive: description: If true, the string value is case sensitive. type: boolean type: object 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 GoogleAnalyticsAdminV1alphaAccessQuota: type: object description: Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. properties: tokensPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. concurrentRequests: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties can use up to 50 concurrent requests. serverErrorsPerProjectPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties and cloud project pairs can have up to 50 server errors per hour. tokensPerDay: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' description: Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. tokensPerProjectPerHour: description: Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessQuotaStatus' GoogleAnalyticsAdminV1alphaConversionEvent: description: A conversion event in a Google Analytics property. properties: custom: description: Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property. type: boolean countingMethod: type: string x-enumDescriptions: - Counting method not specified. - Each Event instance is considered a Conversion. - An Event instance is considered a Conversion at most once per session per user. description: Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to `ONCE_PER_EVENT`. enum: - CONVERSION_COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION defaultConversionValue: description: Optional. Defines a default value/currency for a conversion event. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionEventDefaultConversionValue' eventName: description: 'Immutable. The event name for this conversion event. Examples: ''click'', ''purchase''' type: string name: type: string description: 'Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}' createTime: type: string format: google-datetime description: Output only. Time when this conversion event was created in the property. deletable: description: Output only. If set, this event can currently be deleted with DeleteConversionEvent. type: boolean type: object 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 GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema: type: object description: SKAdNetwork conversion value schema of an iOS stream. properties: name: description: 'Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema' type: string postbackWindowThree: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPostbackWindow' description: The conversion value settings for the third postback window. This field should only be set if the user chose to define different conversion values for this postback window. It is allowed to configure window 3 without setting window 2. In case window 1 & 2 settings are set and enable_postback_window_settings for this postback window is set to false, the schema will inherit settings from postback_window_two. postbackWindowOne: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPostbackWindow' description: Required. The conversion value settings for the first postback window. These differ from values for postback window two and three in that they contain a "Fine" grained conversion value (a numeric value). Conversion values for this postback window must be set. The other windows are optional and may inherit this window's settings if unset or disabled. applyConversionValues: description: If enabled, the GA SDK will set conversion values using this schema definition, and schema will be exported to any Google Ads accounts linked to this property. If disabled, the GA SDK will not automatically set conversion values, and also the schema will not be exported to Ads. type: boolean postbackWindowTwo: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaPostbackWindow' description: The conversion value settings for the second postback window. This field should only be configured if there is a need to define different conversion values for this postback window. If enable_postback_window_settings is set to false for this postback window, the values from postback_window_one will be used. GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse: description: Response message for BatchGetAccessBindings RPC. properties: accessBindings: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessBinding' description: The requested access bindings. type: object 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 GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericValue: type: object description: To represent a number. properties: int64Value: format: int64 description: Integer value. type: string doubleValue: format: double description: Double value. type: number GoogleAnalyticsAdminV1alphaPostbackWindow: description: Settings for a SKAdNetwork conversion postback window. properties: postbackWindowSettingsEnabled: description: If enable_postback_window_settings is true, conversion_values must be populated and will be used for determining when and how to set the Conversion Value on a client device and exporting schema to linked Ads accounts. If false, the settings are not used, but are retained in case they may be used in the future. This must always be true for postback_window_one. type: boolean conversionValues: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaConversionValues' description: Ordering of the repeated field will be used to prioritize the conversion value settings. Lower indexed entries are prioritized higher. The first conversion value setting that evaluates to true will be selected. It must have at least one entry if enable_postback_window_settings is set to true. It can have maximum of 128 entries. type: object 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. GoogleAnalyticsAdminV1alphaGoogleSignalsSettings: description: Settings values for Google Signals. This is a singleton resource. properties: name: type: string description: 'Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: "properties/1000/googleSignalsSettings"' consent: enum: - GOOGLE_SIGNALS_CONSENT_UNSPECIFIED - GOOGLE_SIGNALS_CONSENT_CONSENTED - GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED type: string x-enumDescriptions: - Google Signals consent value defaults to GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED. - Terms of service have been accepted - Terms of service have not been accepted description: Output only. Terms of Service acceptance. state: type: string description: Status of this setting. enum: - GOOGLE_SIGNALS_STATE_UNSPECIFIED - GOOGLE_SIGNALS_ENABLED - GOOGLE_SIGNALS_DISABLED x-enumDescriptions: - Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice. - Google Signals is enabled. - Google Signals is disabled. type: object GoogleAnalyticsAdminV1alphaChannelGroupFilterExpressionList: type: object description: A list of Channel Group filter expressions. properties: filterExpressions: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaChannelGroupFilterExpression' description: A list of Channel Group filter expressions. GoogleAnalyticsAdminV1alphaAccessDimensionValue: description: The value of a dimension. properties: value: type: string description: The dimension value. For example, this value may be 'France' for the 'country' dimension. type: object 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 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 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 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 GoogleAnalyticsAdminV1alphaAccessMetricValue: description: The value of a metric. properties: value: description: The measurement value. For example, this value may be '13'. type: string type: object GoogleAnalyticsAdminV1alphaKeyEventDefaultValue: type: object description: Defines a default value/currency for a key event. properties: numericValue: type: number format: double description: Required. This will be used to populate the "value" parameter for all occurrences of this Key Event (specified by event_name) where that parameter is unset. currencyCode: type: string description: Required. When an occurrence of this Key Event (specified by event_name) has no set currency this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information. GoogleAnalyticsAdminV1alphaProperty: description: A resource message representing a Google Analytics property. properties: currencyCode: type: string description: 'The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"' deleteTime: description: Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can. format: google-datetime type: string industryCategory: type: string x-enumDescriptions: - Industry category unspecified - Automotive - Business and industrial markets - Finance - Healthcare - Technology - Travel - Other - Arts and entertainment - Beauty and fitness - Books and literature - Food and drink - Games - Hobbies and leisure - Home and garden - Internet and telecom - Law and government - News - Online communities - People and society - Pets and animals - Real estate - Reference - Science - Sports - Jobs and education - Shopping description: 'Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK' enum: - INDUSTRY_CATEGORY_UNSPECIFIED - AUTOMOTIVE - BUSINESS_AND_INDUSTRIAL_MARKETS - FINANCE - HEALTHCARE - TECHNOLOGY - TRAVEL - OTHER - ARTS_AND_ENTERTAINMENT - BEAUTY_AND_FITNESS - BOOKS_AND_LITERATURE - FOOD_AND_DRINK - GAMES - HOBBIES_AND_LEISURE - HOME_AND_GARDEN - INTERNET_AND_TELECOM - LAW_AND_GOVERNMENT - NEWS - ONLINE_COMMUNITIES - PEOPLE_AND_SOCIETY - PETS_AND_ANIMALS - REAL_ESTATE - REFERENCE - SCIENCE - SPORTS - JOBS_AND_EDUCATION - SHOPPING name: type: string description: 'Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"' displayName: type: string description: Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. account: type: string description: 'Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"' expireTime: type: string description: Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. format: google-datetime createTime: description: Output only. Time when the entity was originally created. format: google-datetime type: string timeZone: description: 'Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"' type: string parent: description: 'Immutable. Resource name of this property''s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"' type: string updateTime: format: google-datetime description: Output only. Time when entity payload fields were last updated. type: string propertyType: description: Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP x-enumDescriptions: - Unknown or unspecified property type - Ordinary Google Analytics property - Google Analytics subproperty - Google Analytics rollup property type: string serviceLevel: description: Output only. The Google Analytics service level that applies to this property. x-enumDescriptions: - Service level not specified or invalid. - The standard version of Google Analytics. - The paid, premium version of Google Analytics. type: string enum: - SERVICE_LEVEL_UNSPECIFIED - GOOGLE_ANALYTICS_STANDARD - GOOGLE_ANALYTICS_360 type: object 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. 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 GoogleAnalyticsAdminV1alphaAudienceFilterExpression: type: object description: A logical expression of Audience dimension, metric, or event filters. properties: eventFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceEventFilter' description: Creates a filter that matches a specific event. This cannot be set on the top level AudienceFilterExpression. andGroup: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList' description: A list of expressions to be AND’ed together. It can only contain AudienceFilterExpressions with or_group. This must be set for the top level AudienceFilterExpression. orGroup: description: A list of expressions to OR’ed together. It cannot contain AudienceFilterExpressions with and_group or or_group. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpressionList' dimensionOrMetricFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter' description: A filter on a single dimension or metric. This cannot be set on the top level AudienceFilterExpression. notExpression: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceFilterExpression' description: A filter expression to be NOT'ed (For example, inverted, complemented). It can only include a dimension_or_metric_filter. This cannot be set on the top level AudienceFilterExpression. GoogleAnalyticsAdminV1alphaChannelGroupFilterInListFilter: description: A filter for a string dimension that matches a particular list of options. The match is case insensitive. properties: values: description: Required. The list of possible string values to match against. Must be non-empty. type: array items: type: string type: object GoogleAnalyticsAdminV1alphaAccessBinding: description: A binding of a user to a set of roles. properties: user: type: string description: 'If set, the email address of the user to set roles for. Format: "someuser@gmail.com"' name: description: 'Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: "accounts/100/accessBindings/200"' type: string roles: type: array items: type: string description: 'A list of roles for to grant to the parent resource. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data For users, if an empty list of roles is set, this AccessBinding will be deleted.' type: object 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. 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 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 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. 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 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 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 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 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. GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter: description: A specific filter for a single dimension or metric. properties: atAnyPointInTime: description: Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them. This can only be set when Audience scope is ACROSS_ALL_SESSIONS. type: boolean inListFilter: description: A filter for a string dimension that matches a particular list of options. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter' betweenFilter: description: A filter for numeric or date values between certain values on a dimension or metric. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter' fieldName: type: string description: Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the [Google Analytics Data API documentation] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions). stringFilter: description: A filter for a string-type dimension that matches a particular pattern. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter' numericFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter' description: A filter for numeric or date values on a dimension or metric. inAnyNDayPeriod: description: Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window). For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false. It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days. format: int32 type: integer type: object GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest: type: object description: Request message for BatchUpdateAccessBindings RPC. properties: requests: type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest' description: Required. The requests specifying the access bindings to update. A maximum of 1000 access bindings can be updated in a batch. GoogleAnalyticsAdminV1alphaAudienceEventTrigger: description: Specifies an event to log when a user joins the Audience. properties: eventName: description: Required. The event name that will be logged. type: string logCondition: type: string x-enumDescriptions: - Log condition is not specified. - The event should be logged only when a user is joined. - The event should be logged whenever the Audience condition is met, even if the user is already a member of the Audience. description: Required. When to log the event. enum: - LOG_CONDITION_UNSPECIFIED - AUDIENCE_JOINED - AUDIENCE_MEMBERSHIP_RENEWED type: object GoogleAnalyticsAdminV1alphaArchiveAudienceRequest: type: object description: Request message for ArchiveAudience RPC. properties: {} 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'. GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse: description: Response message for AcknowledgeUserDataCollection RPC. properties: {} type: object GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails: description: Status information for a link proposal. properties: linkProposalInitiatingProduct: enum: - LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED - GOOGLE_ANALYTICS - LINKED_PRODUCT x-enumDescriptions: - Unspecified product. - This proposal was created by a user from Google Analytics. - This proposal was created by a user from a linked product (not Google Analytics). description: Output only. The source of this proposal. type: string requestorEmail: type: string description: Output only. The email address of the user that proposed this linkage. linkProposalState: type: string x-enumDescriptions: - Unspecified state - This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time. - This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time. - This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time. - This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time. - This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time. - This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time. description: Output only. The state of this proposal. enum: - LINK_PROPOSAL_STATE_UNSPECIFIED - AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS - AWAITING_REVIEW_FROM_LINKED_PRODUCT - WITHDRAWN - DECLINED - EXPIRED - OBSOLETE type: object GoogleAnalyticsAdminV1alphaDataStream: description: A resource message representing a data stream. properties: name: description: 'Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"' type: string createTime: type: string format: google-datetime description: Output only. Time when this stream was originally created. type: type: string description: Required. Immutable. The type of this DataStream resource. enum: - DATA_STREAM_TYPE_UNSPECIFIED - WEB_DATA_STREAM - ANDROID_APP_DATA_STREAM - IOS_APP_DATA_STREAM x-enumDescriptions: - Type unknown or not specified. - Web data stream. - Android app data stream. - iOS app data stream. iosAppStreamData: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStreamIosAppStreamData' description: Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. displayName: type: string description: Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units. updateTime: description: Output only. Time when stream payload fields were last updated. format: google-datetime type: string androidAppStreamData: $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStreamAndroidAppStreamData' description: Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. webStreamData: description: Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaDataStreamWebStreamData' type: object GoogleAnalyticsAdminV1alphaMatchingCondition: description: Defines a condition for when an Event Edit or Event Creation rule applies to an event. properties: field: description: Required. The name of the field that is compared against for the condition. If 'event_name' is specified this condition will apply to the name of the event. Otherwise the condition will apply to a parameter with the specified name. This value cannot contain spaces. type: string comparisonType: x-enumDescriptions: - Unknown - Equals, case sensitive - Equals, case insensitive - Contains, case sensitive - Contains, case insensitive - Starts with, case sensitive - Starts with, case insensitive - Ends with, case sensitive - Ends with, case insensitive - Greater than - Greater than or equal - Less than - Less than or equal - regular expression. Only supported for web streams. - regular expression, case insensitive. Only supported for web streams. description: Required. The type of comparison to be applied to the value. enum: - COMPARISON_TYPE_UNSPECIFIED - EQUALS - EQUALS_CASE_INSENSITIVE - CONTAINS - CONTAINS_CASE_INSENSITIVE - STARTS_WITH - STARTS_WITH_CASE_INSENSITIVE - ENDS_WITH - ENDS_WITH_CASE_INSENSITIVE - GREATER_THAN - GREATER_THAN_OR_EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - REGULAR_EXPRESSION - REGULAR_EXPRESSION_CASE_INSENSITIVE type: string value: type: string description: Required. The value being compared against for this condition. The runtime implementation may perform type coercion of this value to evaluate this condition based on the type of the parameter value. negated: type: boolean description: Whether or not the result of the comparison should be negated. For example, if `negated` is true, then 'equals' comparisons would function as 'not equals'. type: object GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret: type: object description: A secret value used for sending hits to Measurement Protocol. properties: secretValue: type: string description: Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. name: description: 'Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}' type: string displayName: type: string description: Required. Human-readable display name for this secret. GoogleAnalyticsAdminV1alphaExpandedDataSetFilterStringFilter: description: A filter for a string-type dimension that matches a particular pattern. properties: value: type: string description: Required. The string value to be matched against. matchType: type: string description: Required. The match type for the string filter. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - CONTAINS x-enumDescriptions: - Unspecified - Exact match of the string value. - Contains the string value. caseSensitive: description: Optional. If true, the match is case-sensitive. If false, the match is case-insensitive. Must be true when match_type is EXACT. Must be false when match_type is CONTAINS. type: boolean type: object GoogleAnalyticsAdminV1alphaAccessDimension: description: Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings. properties: dimensionName: type: string description: The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`. type: object GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest: type: object description: Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC. properties: {} 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 GoogleAnalyticsAdminV1alphaAccessMetricHeader: description: Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers. properties: metricName: description: The metric's name; for example 'accessCount'. type: string type: object GoogleRpcStatus: type: object description: Canonical google.rpc.Status error payload returned by Google APIs. properties: code: type: integer format: int32 message: type: string details: type: array items: type: object GoogleAnalyticsAdminV1alphaReportingIdentitySettings: type: object description: A resource containing settings related to reporting identity. properties: name: description: 'Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: "properties/1234/reportingIdentitySettings"' type: string reportingIdentity: type: string description: The strategy used for identifying user identities in reports. enum: - IDENTITY_BLENDING_STRATEGY_UNSPECIFIED - BLENDED - OBSERVED - DEVICE_BASED x-enumDescriptions: - Unspecified blending strategy. - Blended reporting identity strategy. - Observed reporting identity strategy. - Device-based reporting identity strategy. GoogleAnalyticsAdminV1alphaAccessFilterExpression: type: object description: Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. properties: andGroup: description: Each of the FilterExpressions in the and_group has an AND relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpressionList' orGroup: description: Each of the FilterExpressions in the or_group has an OR relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpressionList' notExpression: description: The FilterExpression is NOT of not_expression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilterExpression' accessFilter: description: A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. $ref: '#/components/schemas/GoogleAnalyticsAdminV1alphaAccessFilter' GoogleAnalyticsAdminV1betaAccessDimensionValue: description: The value of a dimension. type: object properties: value: description: The dimension value. For example, this value may be 'France' for the 'country' dimension. type: string GoogleAnalyticsAdminV1betaDataRetentionSettings: description: Settings values for data retention. This is a singleton resource. type: object properties: userDataRetention: enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that user-level data is retained. type: string resetUserDataOnNewActivity: description: If true, reset the retention period for the user identifier with every event from that user. type: boolean name: description: 'Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings' type: string eventDataRetention: enum: - RETENTION_DURATION_UNSPECIFIED - TWO_MONTHS - FOURTEEN_MONTHS - TWENTY_SIX_MONTHS - THIRTY_EIGHT_MONTHS - FIFTY_MONTHS x-enumDescriptions: - Data retention time duration is not specified. - The data retention time duration is 2 months. - The data retention time duration is 14 months. - The data retention time duration is 26 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 38 months. Available to 360 properties only. Available for event data only. - The data retention time duration is 50 months. Available to 360 properties only. Available for event data only. description: Required. The length of time that event-level data is retained. type: string GoogleAnalyticsAdminV1betaKeyEvent: description: A key event in a Google Analytics property. type: object properties: countingMethod: enum: - COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION 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. type: string name: description: 'Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}' type: string 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 eventName: description: 'Immutable. The event name for this key event. Examples: ''click'', ''purchase''' type: string createTime: format: google-datetime description: Output only. Time when this key event was created in the property. type: string defaultValue: description: Optional. Defines a default value/currency for a key event. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaKeyEventDefaultValue' deletable: description: Output only. If set to true, this event can be deleted. type: boolean GoogleAnalyticsAdminV1betaNumericValue: description: To represent a number. type: object properties: int64Value: description: Integer value type: string format: int64 doubleValue: format: double description: Double value type: number GoogleAnalyticsAdminV1betaAccessMetricHeader: description: Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers. type: object properties: metricName: description: The metric's name; for example 'accessCount'. type: string GoogleAnalyticsAdminV1betaListDataStreamsResponse: properties: dataStreams: description: List of DataStreams. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStream' 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 description: Response message for ListDataStreams RPC. type: object GoogleAnalyticsAdminV1betaCustomDimension: description: A definition for a CustomDimension. type: object properties: 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 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 description: description: Optional. Description for this custom dimension. Max length of 150 characters. type: string name: description: 'Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}' type: string scope: enum: - DIMENSION_SCOPE_UNSPECIFIED - EVENT - USER - ITEM description: Required. Immutable. The scope of this dimension. type: string x-enumDescriptions: - Scope unknown or not specified. - Dimension scoped to an event. - Dimension scoped to a user. - Dimension scoped to eCommerce items disallowAdsPersonalization: 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. type: boolean GoogleAnalyticsAdminV1betaConversionEvent: properties: countingMethod: enum: - CONVERSION_COUNTING_METHOD_UNSPECIFIED - ONCE_PER_EVENT - ONCE_PER_SESSION description: Optional. The method by which conversions will be counted across multiple events within a session. If this value is not provided, it will be set to `ONCE_PER_EVENT`. type: string x-enumDescriptions: - Counting method not specified. - Each Event instance is considered a Conversion. - An Event instance is considered a Conversion at most once per session per user. defaultConversionValue: description: Optional. Defines a default value/currency for a conversion event. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue' eventName: description: 'Immutable. The event name for this conversion event. Examples: ''click'', ''purchase''' type: string createTime: format: google-datetime description: Output only. Time when this conversion event was created in the property. type: string name: description: 'Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}' type: string custom: description: Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property. type: boolean deletable: description: Output only. If set, this event can currently be deleted with DeleteConversionEvent. type: boolean description: A conversion event in a Google Analytics property. type: object GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue: description: Defines a default value/currency for a conversion event. Both value and currency must be provided. type: object properties: currencyCode: description: When a conversion event for this event_name has no set currency, this currency will be applied as the default. Must be in ISO 4217 currency code format. See https://en.wikipedia.org/wiki/ISO_4217 for more information. type: string value: description: This value will be used to populate the value for all conversions of the specified event_name where the event "value" parameter is unset. type: number format: double GoogleAnalyticsAdminV1betaAccessDateRange: description: 'A contiguous range of days: startDate, startDate + 1, ..., endDate.' type: object properties: startDate: description: The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone. type: string endDate: description: The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone. type: string GoogleAnalyticsAdminV1betaKeyEventDefaultValue: properties: numericValue: 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. type: number format: double currencyCode: 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. type: string description: Defines a default value/currency for a key event. type: object GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy: properties: metricName: description: A metric name in the request to order by. type: string description: Sorts by metric values. type: object GoogleAnalyticsAdminV1betaDataStreamWebStreamData: description: Data specific to web streams. type: object properties: measurementId: description: 'Output only. Analytics Measurement ID. Example: "G-1A2BCD345E"' type: string defaultUri: description: 'Domain name of the web app being measured, or empty. Example: "http://www.google.com", "https://www.google.com"' type: string firebaseAppId: description: Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated. type: string GoogleAnalyticsAdminV1betaRunAccessReportRequest: description: The request for a Data Access Record Report. type: object properties: offset: format: int64 description: The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string metrics: description: The metrics requested and displayed in the response. Requests are allowed up to 10 metrics. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetric' metricFilter: description: Metric filters allow you to restrict report response to specific metric values which match the filter. Metric filters are applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' includeAllUsers: description: Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included. type: boolean limit: description: The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 timeZone: description: This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example "America/New_York" or "Asia/Tokyo". type: string returnEntityQuota: description: Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false. type: boolean orderBys: description: Specifies how rows are ordered in the response. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderBy' expandGroups: description: Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned. type: boolean dimensionFilter: description: Dimension filters let you restrict report response to specific dimension values which match the filter. For example, filtering on access records of a single user. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' dimensions: description: The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimension' dateRanges: description: Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDateRange' GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest: properties: {} description: Request message for ArchiveCustomMetric RPC. type: object GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData: description: Data specific to iOS app streams. type: object properties: firebaseAppId: description: Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated. type: string bundleId: description: 'Required. Immutable. The Apple App Store Bundle ID for the app Example: "com.example.myiosapp"' type: string GoogleAnalyticsAdminV1betaAccessFilterExpression: properties: andGroup: description: Each of the FilterExpressions in the and_group has an AND relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpressionList' orGroup: description: Each of the FilterExpressions in the or_group has an OR relationship. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpressionList' notExpression: description: The FilterExpression is NOT of not_expression. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' accessFilter: description: A primitive filter. In the same FilterExpression, all of the filter's field names need to be either all dimensions or all metrics. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilter' description: Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics. type: object GoogleAnalyticsAdminV1betaAccessFilterExpressionList: properties: expressions: description: A list of filter expressions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression' description: A list of filter expressions. type: object GoogleAnalyticsAdminV1betaAccessMetricValue: properties: value: description: The measurement value. For example, this value may be '13'. type: string description: The value of a metric. type: object GoogleAnalyticsAdminV1betaFirebaseLink: properties: name: description: 'Identifier. Example format: properties/1234/firebaseLinks/5678' type: string project: description: 'Immutable. Firebase project resource name. When creating a FirebaseLink, you may provide this resource name using either a project number or project ID. Once this resource has been created, returned FirebaseLinks will always have a project_name that contains a project number. Format: ''projects/{project number}'' Example: ''projects/1234''' type: string createTime: description: Output only. Time when this FirebaseLink was originally created. type: string format: google-datetime description: A link between a Google Analytics property and a Firebase project. type: object GoogleAnalyticsAdminV1betaMeasurementProtocolSecret: description: A secret value used for sending hits to Measurement Protocol. type: object properties: displayName: description: Required. Human-readable display name for this secret. type: string secretValue: description: Output only. The measurement protocol secret value. Pass this value to the api_secret field of the Measurement Protocol API when sending hits to this secret's parent property. type: string name: description: 'Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}' type: string GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest: description: Request message for ArchiveCustomDimension RPC. type: object properties: {} GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy: properties: dimensionName: description: A dimension name in the request to order by. type: string orderType: enum: - ORDER_TYPE_UNSPECIFIED - ALPHANUMERIC - CASE_INSENSITIVE_ALPHANUMERIC - NUMERIC x-enumDescriptions: - Unspecified. - Alphanumeric sort by Unicode code point. For example, "2" < "A" < "X" < "b" < "z". - Case insensitive alphanumeric sort by lower case Unicode code point. For example, "2" < "A" < "b" < "X" < "z". - Dimension values are converted to numbers before sorting. For example in NUMERIC sort, "25" < "100", and in `ALPHANUMERIC` sort, "100" < "25". Non-numeric dimension values all have equal ordering value below all numeric values. description: Controls the rule for dimension value ordering. type: string description: Sorts by dimension values. type: object GoogleAnalyticsAdminV1betaAccessRow: description: Access report data for each row. type: object properties: dimensionValues: description: List of dimension values. These values are in the same order as specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimensionValue' metricValues: description: List of metric values. These values are in the same order as specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetricValue' GoogleAnalyticsAdminV1betaAccessBetweenFilter: description: To express that the result needs to be between two numbers (inclusive). type: object properties: fromValue: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue' description: Begins with this number. toValue: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue' description: Ends with this number. GoogleAnalyticsAdminV1betaListFirebaseLinksResponse: properties: firebaseLinks: description: List of FirebaseLinks. This will have at most one value. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaFirebaseLink' 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 FirebaseLink per property, so this will never be populated. type: string description: Response message for ListFirebaseLinks RPC type: object GoogleAnalyticsAdminV1betaAccessMetric: description: The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records. type: object properties: metricName: description: The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`. type: string GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse: description: Response message for ListGoogleAdsLinks RPC. type: object properties: nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string googleAdsLinks: description: List of GoogleAdsLinks. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaGoogleAdsLink' GoogleAnalyticsAdminV1betaAccessInListFilter: description: The result needs to be in a list of string values. type: object properties: values: description: The list of string values. Must be non-empty. type: array items: type: string caseSensitive: description: If true, the string value is case sensitive. type: boolean GoogleAnalyticsAdminV1betaListKeyEventsResponse: 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 keyEvents: description: The requested Key Events type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaKeyEvent' description: Response message for ListKeyEvents RPC. type: object GoogleAnalyticsAdminV1betaAccessFilter: properties: inListFilter: description: A filter for in list values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessInListFilter' stringFilter: description: Strings related filter. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessStringFilter' fieldName: description: The dimension name or metric name. type: string numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessNumericFilter' betweenFilter: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessBetweenFilter' description: A filter for two values. description: An expression to filter dimension or metric values. type: object GoogleAnalyticsAdminV1betaAccessQuota: description: Current state of all quotas for this Analytics property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. type: object properties: tokensPerHour: description: Properties can use 50,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' serverErrorsPerProjectPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' description: Properties and cloud project pairs can have up to 50 server errors per hour. concurrentRequests: description: Properties can use up to 50 concurrent requests. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' tokensPerProjectPerHour: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' description: Properties can use up to 25% of their tokens per project per hour. This amounts to Analytics 360 Properties can use 12,500 tokens per project per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. tokensPerDay: description: Properties can use 250,000 tokens per day. Most requests consume fewer than 10 tokens. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuotaStatus' GoogleAnalyticsAdminV1betaAccessDimensionHeader: description: Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers. type: object properties: dimensionName: description: The dimension's name; for example 'userEmail'. type: string GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest: 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 description: Request message for AcknowledgeUserDataCollection RPC. type: object GoogleAnalyticsAdminV1betaAccessDimension: properties: dimensionName: description: The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`. type: string description: Dimensions are attributes of your data. For example, the dimension `userEmail` indicates the email of the user that accessed reporting data. Dimension values in report responses are strings. type: object GoogleAnalyticsAdminV1betaAccessStringFilter: properties: value: description: The string value used for the matching. type: string matchType: x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full match for the regular expression with the string value. - Partial match for the regular expression with the string value. description: The match type for this filter. type: string enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP caseSensitive: description: If true, the string value is case sensitive. type: boolean description: The filter for strings. type: object GoogleAnalyticsAdminV1betaListCustomDimensionsResponse: description: Response message for ListCustomDimensions RPC. type: object properties: customDimensions: description: List of CustomDimensions. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaCustomDimension' 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 GoogleAnalyticsAdminV1betaAccessNumericFilter: description: Filters for numeric or date values. type: object properties: operation: x-enumDescriptions: - Unspecified. - Equal - Less than - Less than or equal - Greater than - Greater than or equal description: The operation type for this filter. type: string enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL value: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaNumericValue' description: A numeric value or a date value. GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData: properties: packageName: description: 'Immutable. The package name for the app being measured. Example: "com.example.myandroidapp"' type: string firebaseAppId: description: Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated. type: string description: Data specific to Android app streams. type: object GoogleAnalyticsAdminV1betaListConversionEventsResponse: description: Response message for ListConversionEvents RPC. type: object properties: conversionEvents: description: The requested conversion events type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaConversionEvent' 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 GoogleAnalyticsAdminV1betaDataStream: description: A resource message representing a data stream. type: object properties: type: enum: - DATA_STREAM_TYPE_UNSPECIFIED - WEB_DATA_STREAM - ANDROID_APP_DATA_STREAM - IOS_APP_DATA_STREAM description: Required. Immutable. The type of this DataStream resource. type: string x-enumDescriptions: - Type unknown or not specified. - Web data stream. - Android app data stream. - iOS app data stream. displayName: description: Human-readable display name for the Data Stream. Required for web data streams. The max allowed display name length is 255 UTF-16 code units. type: string webStreamData: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamWebStreamData' description: Data specific to web streams. Must be populated if type is WEB_DATA_STREAM. androidAppStreamData: description: Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData' iosAppStreamData: description: Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData' name: description: 'Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: "properties/1000/dataStreams/2000"' type: string createTime: description: Output only. Time when this stream was originally created. type: string format: google-datetime updateTime: format: google-datetime description: Output only. Time when stream payload fields were last updated. type: string GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse: description: Response message for AcknowledgeUserDataCollection RPC. type: object properties: {} GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse: properties: measurementProtocolSecrets: description: A list of secrets for the parent stream specified in the request. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaMeasurementProtocolSecret' 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 description: Response message for ListMeasurementProtocolSecret RPC type: object GoogleAnalyticsAdminV1betaListPropertiesResponse: description: Response message for ListProperties RPC. type: object properties: properties: description: Results that matched the filter criteria and were accessible to the caller. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaProperty' 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 GoogleAnalyticsAdminV1betaAccessOrderBy: properties: metric: description: Sorts results by a metric's values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy' desc: description: If true, sorts by descending order. If false or unspecified, sorts in ascending order. type: boolean dimension: description: Sorts results by a dimension's values. $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy' description: Order bys define how rows will be sorted in the response. For example, ordering rows by descending access count is one ordering, and ordering rows by the country string is a different ordering. type: object GoogleAnalyticsAdminV1betaGoogleAdsLink: description: A link between a Google Analytics property and a Google Ads account. type: object properties: adsPersonalizationEnabled: description: Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true. type: boolean creatorEmailAddress: description: Output only. Email address of the user that created the link. An empty string will be returned if the email address can't be retrieved. type: string createTime: description: Output only. Time when this link was originally created. type: string format: google-datetime updateTime: description: Output only. Time when this link was last updated. type: string format: google-datetime name: description: 'Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.' type: string customerId: description: Immutable. Google Ads customer ID. type: string canManageClients: description: Output only. If true, this link is for a Google Ads manager account. type: boolean GoogleAnalyticsAdminV1betaProperty: properties: expireTime: description: Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted. type: string format: google-datetime deleteTime: description: Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can. type: string format: google-datetime currencyCode: description: 'The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: "USD", "EUR", "JPY"' type: string updateTime: format: google-datetime description: Output only. Time when entity payload fields were last updated. type: string serviceLevel: x-enumDescriptions: - Service level not specified or invalid. - The standard version of Google Analytics. - The paid, premium version of Google Analytics. description: Output only. The Google Analytics service level that applies to this property. type: string enum: - SERVICE_LEVEL_UNSPECIFIED - GOOGLE_ANALYTICS_STANDARD - GOOGLE_ANALYTICS_360 industryCategory: enum: - INDUSTRY_CATEGORY_UNSPECIFIED - AUTOMOTIVE - BUSINESS_AND_INDUSTRIAL_MARKETS - FINANCE - HEALTHCARE - TECHNOLOGY - TRAVEL - OTHER - ARTS_AND_ENTERTAINMENT - BEAUTY_AND_FITNESS - BOOKS_AND_LITERATURE - FOOD_AND_DRINK - GAMES - HOBBIES_AND_LEISURE - HOME_AND_GARDEN - INTERNET_AND_TELECOM - LAW_AND_GOVERNMENT - NEWS - ONLINE_COMMUNITIES - PEOPLE_AND_SOCIETY - PETS_AND_ANIMALS - REAL_ESTATE - REFERENCE - SCIENCE - SPORTS - JOBS_AND_EDUCATION - SHOPPING description: 'Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK' type: string x-enumDescriptions: - Industry category unspecified - Automotive - Business and industrial markets - Finance - Healthcare - Technology - Travel - Other - Arts and entertainment - Beauty and fitness - Books and literature - Food and drink - Games - Hobbies and leisure - Home and garden - Internet and telecom - Law and government - News - Online communities - People and society - Pets and animals - Real estate - Reference - Science - Sports - Jobs and education - Shopping propertyType: x-enumDescriptions: - Unknown or unspecified property type - Ordinary Google Analytics property - Google Analytics subproperty - Google Analytics rollup property description: Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. type: string enum: - PROPERTY_TYPE_UNSPECIFIED - PROPERTY_TYPE_ORDINARY - PROPERTY_TYPE_SUBPROPERTY - PROPERTY_TYPE_ROLLUP name: description: 'Identifier. Resource name of this property. Format: properties/{property_id} Example: "properties/1000"' type: string timeZone: description: 'Required. Reporting Time Zone, used as the day boundary for reports, regardless of where the data originates. If the time zone honors DST, Analytics will automatically adjust for the changes. NOTE: Changing the time zone only affects data going forward, and is not applied retroactively. Format: https://www.iana.org/time-zones Example: "America/Los_Angeles"' type: string parent: description: 'Immutable. Resource name of this property''s logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: "accounts/100", "properties/101"' type: string createTime: format: google-datetime description: Output only. Time when the entity was originally created. type: string displayName: description: Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units. type: string account: description: 'Immutable. The resource name of the parent account Format: accounts/{account_id} Example: "accounts/123"' type: string description: A resource message representing a Google Analytics property. type: object GoogleAnalyticsAdminV1betaRunAccessReportResponse: properties: rows: description: Rows of dimension value combinations and metric values in the report. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessRow' quota: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessQuota' description: The quota state for this Analytics property including this request. This field doesn't work with account-level requests. metricHeaders: description: The header for a column in the report that corresponds to a specific metric. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessMetricHeader' dimensionHeaders: description: The header for a column in the report that corresponds to a specific dimension. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaAccessDimensionHeader' rowCount: format: int32 description: The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: integer description: The customized Data Access Record Report response. type: object GoogleAnalyticsAdminV1betaListCustomMetricsResponse: 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 customMetrics: description: List of CustomMetrics. type: array items: $ref: '#/components/schemas/GoogleAnalyticsAdminV1betaCustomMetric' description: Response message for ListCustomMetrics RPC. type: object GoogleAnalyticsAdminV1betaCustomMetric: properties: 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 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 description: description: Optional. Description for this custom dimension. Max length of 150 characters. type: string measurementUnit: 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. description: Required. The type for the custom metric's value. type: string enum: - MEASUREMENT_UNIT_UNSPECIFIED - STANDARD - CURRENCY - FEET - METERS - KILOMETERS - MILES - MILLISECONDS - SECONDS - MINUTES - HOURS scope: enum: - METRIC_SCOPE_UNSPECIFIED - EVENT description: Required. Immutable. The scope of this custom metric. type: string x-enumDescriptions: - Scope unknown or not specified. - Metric scoped to an event. name: description: 'Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}' type: string restrictedMetricType: 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. type: array items: enum: - RESTRICTED_METRIC_TYPE_UNSPECIFIED - COST_DATA - REVENUE_DATA x-enumDescriptions: - Type unknown or unspecified. - Metric reports cost data. - Metric reports revenue data. type: string description: A definition for a custom metric. type: object GoogleAnalyticsAdminV1betaAccessQuotaStatus: properties: remaining: format: int32 description: Quota remaining after this request. type: integer consumed: description: Quota consumed by this request. type: integer format: int32 description: Current state for a particular quota group. type: object InListFilter: description: The result needs to be in a list of string values. type: object properties: caseSensitive: description: If true, the string value is case sensitive. type: boolean values: description: The list of string values. Must be non-empty. type: array items: type: string QueryReportTaskResponse: description: The report content corresponding to a report task. type: object properties: minimums: items: $ref: '#/components/schemas/Row' description: If requested, the minimum values of metrics. type: array dimensionHeaders: description: Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. type: array items: $ref: '#/components/schemas/DimensionHeader' metricHeaders: items: $ref: '#/components/schemas/MetricHeader' description: Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. type: array rows: items: $ref: '#/components/schemas/Row' description: Rows of dimension value combinations and metric values in the report. type: array totals: items: $ref: '#/components/schemas/Row' description: If requested, the totaled values of metrics. type: array maximums: description: If requested, the maximum values of metrics. type: array items: $ref: '#/components/schemas/Row' metadata: description: Metadata for the report. $ref: '#/components/schemas/ResponseMetaData' rowCount: description: The total number of rows in the query result. type: integer format: int32 DimensionValue: description: The value of a dimension. type: object properties: value: description: Value as a string if the dimension type is a string. type: string FunnelStep: description: Steps define the user journey you want to measure. Steps contain one or more conditions that your users must meet to be included in that step of the funnel journey. type: object properties: isDirectlyFollowedBy: description: If true, this step must directly follow the previous step. If false, there can be events between the previous step and this step. If unspecified, `isDirectlyFollowedBy` is treated as false. type: boolean name: description: The distinctive name for this step. If unspecified, steps will be named by a 1 based indexed name (for example "0. ", "1. ", etc.). This name defines string value returned by the `funnelStepName` dimension. For example, specifying `name = Purchase` in the request's third funnel step will produce `3. Purchase` in the funnel report response. type: string filterExpression: description: The condition that your users must meet to be included in this step of the funnel journey. $ref: '#/components/schemas/FunnelFilterExpression' withinDurationFromPriorStep: description: If specified, this step must complete within this duration of the completion of the prior step. `withinDurationFromPriorStep` is inclusive of the endpoint at the microsecond granularity. For example a duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond. `withinDurationFromPriorStep` is optional, and if unspecified, steps may be separated by any time duration. type: string format: google-duration SchemaRestrictionResponse: description: The schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). type: object properties: activeMetricRestrictions: items: $ref: '#/components/schemas/ActiveMetricRestriction' description: All restrictions actively enforced in creating the report. For example, `purchaseRevenue` always has the restriction type `REVENUE_DATA`. However, this active response restriction is only populated if the user's custom role disallows access to `REVENUE_DATA`. type: array CohortsRange: description: Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over. type: object properties: granularity: x-enumDescriptions: - Should never be specified. - Daily granularity. Commonly used if the cohort's `dateRange` is a single day and the request contains `cohortNthDay`. - Weekly granularity. Commonly used if the cohort's `dateRange` is a week in duration (starting on Sunday and ending on Saturday) and the request contains `cohortNthWeek`. - Monthly granularity. Commonly used if the cohort's `dateRange` is a month in duration and the request contains `cohortNthMonth`. enum: - GRANULARITY_UNSPECIFIED - DAILY - WEEKLY - MONTHLY description: Required. The granularity used to interpret the `startOffset` and `endOffset` for the extended reporting date range for a cohort report. type: string startOffset: description: '`startOffset` specifies the start date of the extended reporting date range for a cohort report. `startOffset` is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If `granularity` is `DAILY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset` days. If `granularity` is `WEEKLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 7` days. If `granularity` is `MONTHLY`, the `startDate` of the extended reporting date range is `startDate` of the cohort plus `startOffset * 30` days.' type: integer format: int32 endOffset: description: Required. `endOffset` specifies the end date of the extended reporting date range for a cohort report. `endOffset` can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If `granularity` is `DAILY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset` days. If `granularity` is `WEEKLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 7` days. If `granularity` is `MONTHLY`, the `endDate` of the extended reporting date range is `endDate` of the cohort plus `endOffset * 30` days. type: integer format: int32 SamplingMetadata: description: If funnel report results are [sampled](https://support.google.com/analytics/answer/13331292), this metadata describes what percentage of events were used in this funnel report for a date range. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. type: object properties: samplesReadCount: description: The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this funnel report. type: string format: int64 samplingSpaceSize: description: The total number of events present in this property's data that could have been analyzed in this funnel report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set. To calculate the percentage of available data that was used in this funnel report, compute `samplesReadCount/samplingSpaceSize`. type: string format: int64 Metadata: description: The dimensions, metrics and comparisons currently accepted in reporting methods. type: object properties: conversions: items: $ref: '#/components/schemas/ConversionMetadata' description: The conversion descriptions. type: array metrics: description: The metric descriptions. type: array items: $ref: '#/components/schemas/MetricMetadata' dimensions: description: The dimension descriptions. type: array items: $ref: '#/components/schemas/DimensionMetadata' comparisons: description: The comparison descriptions. type: array items: $ref: '#/components/schemas/ComparisonMetadata' name: description: Resource name of this metadata. type: string Comparison: description: Defines an individual comparison. Most requests will include multiple comparisons so that the report compares between the comparisons. type: object properties: comparison: description: A saved comparison identified by the comparison's resource name. For example, 'comparisons/1234'. type: string name: description: Each comparison produces separate rows in the response. In the response, this comparison is identified by this name. If name is unspecified, we will use the saved comparisons display name. type: string dimensionFilter: description: A basic comparison. $ref: '#/components/schemas/FilterExpression' SessionSegmentCriteria: description: A session matches a criteria if the session's events meet the conditions in the criteria. type: object properties: andConditionGroups: description: A session matches this criteria if the session matches each of these `andConditionGroups`. type: array items: $ref: '#/components/schemas/SessionSegmentConditionGroup' Segment: description: A segment is a subset of your Analytics data. For example, of your entire set of users, one segment might be users from a particular country or city. Another segment might be users who purchase a particular line of products or who visit a specific part of your site or trigger certain events in your app. To learn more, see [Segment Builder](https://support.google.com/analytics/answer/9304353). type: object properties: name: description: The name for this segment. If unspecified, segments are named "Segment". This name defines string value returned by the `segment` dimension. The `segment` dimension prefixes segment names by the 1-based index number of the segment in the request (for example "1. Segment", "2. Segment", etc.). type: string userSegment: description: User segments are subsets of users who engaged with your site or app. $ref: '#/components/schemas/UserSegment' sessionSegment: description: Session segments are subsets of the sessions that occurred on your site or app. $ref: '#/components/schemas/SessionSegment' eventSegment: description: Event segments are subsets of events that were triggered on your site or app. $ref: '#/components/schemas/EventSegment' StringFilter: description: The filter for string type: object properties: caseSensitive: description: If true, the string value is case sensitive. type: boolean matchType: x-enumDescriptions: - Unspecified - Exact match of the string value. - Begins with the string value. - Ends with the string value. - Contains the string value. - Full match for the regular expression with the string value. - Partial match for the regular expression with the string value. enum: - MATCH_TYPE_UNSPECIFIED - EXACT - BEGINS_WITH - ENDS_WITH - CONTAINS - FULL_REGEXP - PARTIAL_REGEXP description: The match type for this filter. type: string value: description: The string value used for the matching. type: string SegmentParameterFilterExpressionList: description: A list of segment parameter filter expressions. type: object properties: expressions: description: The list of segment parameter filter expressions. type: array items: $ref: '#/components/schemas/SegmentParameterFilterExpression' FilterExpressionList: description: A list of filter expressions. type: object properties: expressions: description: A list of filter expressions. type: array items: $ref: '#/components/schemas/FilterExpression' ConversionSpec: description: 'Controls conversion reporting. This feature may not be available to your Google Analytics property. The Google Analytics team is actively working to expand this feature to more properties. Please reach out to your support team if you have questions about the eligibility of your property. ' type: object properties: conversionActions: items: type: string description: The conversion action IDs to include in the report. If empty, all conversions are included. Valid conversion action IDs can be retrieved from the `conversion_action` field within the `conversions` list in the response of the `GetMetadata` method. For example, 'conversionActions/1234'. type: array attributionModel: x-enumDescriptions: - Unspecified attribution model. - Attribution was based on the paid and organic data driven model - Attribution was based on the paid and organic last click model enum: - ATTRIBUTION_MODEL_UNSPECIFIED - DATA_DRIVEN - LAST_CLICK description: The attribution model to use in the Conversion Report. If unspecified, `DATA_DRIVEN` is used. type: string SegmentFilterScoping: description: Scopings specify how the dimensions & metrics of multiple events should be considered when evaluating a segment filter. type: object properties: atAnyPointInTime: description: If `atAnyPointInTime` is true, this filter evaluates to true for all events if it evaluates to true for any event in the date range of the request. This `atAnyPointInTime` parameter does not extend the date range of events in the report. If `atAnyPointInTime` is true, only events within the report's date range are considered when evaluating this filter. This `atAnyPointInTime` is only able to be specified if the criteria scoping is `ACROSS_ALL_SESSIONS` and is not able to be specified in sequences. If the criteria scoping is `ACROSS_ALL_SESSIONS`, `atAnyPointInTime` = false is used if unspecified. type: boolean AudienceRow: description: Dimension value attributes for the audience user row. type: object properties: dimensionValues: description: Each dimension value attribute for an audience user. One dimension value will be added for each dimension column requested. type: array items: $ref: '#/components/schemas/AudienceDimensionValue' Filter: description: An expression to filter dimension or metric values. type: object properties: betweenFilter: description: A filter for between two values. $ref: '#/components/schemas/BetweenFilter' stringFilter: description: Strings related filter. $ref: '#/components/schemas/StringFilter' emptyFilter: description: A filter for empty values such as "(not set)" and "" values. $ref: '#/components/schemas/EmptyFilter' fieldName: description: The dimension name or metric name. Must be a name defined in dimensions or metrics. type: string numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/NumericFilter' inListFilter: description: A filter for in list values. $ref: '#/components/schemas/InListFilter' NumericValue: description: To represent a number. type: object properties: int64Value: description: Integer value type: string format: int64 doubleValue: description: Double value type: number format: double UserSegment: description: User segments are subsets of users who engaged with your site or app. For example, users who have previously purchased; users who added items to their shopping carts, but didn’t complete a purchase. type: object properties: userInclusionCriteria: description: Defines which users are included in this segment. Optional. $ref: '#/components/schemas/UserSegmentCriteria' exclusion: description: Defines which users are excluded in this segment. Optional. $ref: '#/components/schemas/UserSegmentExclusion' FunnelNextAction: description: Next actions state the value for a dimension after the user has achieved a step but before the same user has achieved the next step. For example if the `nextActionDimension` is `eventName`, then `nextActionDimension` in the `i`th funnel step row will return first event after the event that qualified the user into the `i`th funnel step but before the user achieved the `i+1`th funnel step. type: object properties: nextActionDimension: description: The dimension column added to the funnel visualization sub report response. The next action dimension returns the next dimension value of this dimension after the user has attained the `i`th funnel step. `nextActionDimension` currently only supports `eventName` and most Page / Screen dimensions like `pageTitle` and `pagePath`. `nextActionDimension` cannot be a dimension expression. $ref: '#/components/schemas/Dimension' limit: description: The maximum number of distinct values of the breakdown dimension to return in the response. A `limit` of `5` is used if limit is not specified. Limit must exceed zero and cannot exceed 5. type: string format: int64 WebhookNotification: description: Configures a long-running operation resource to send a webhook notification from the Google Analytics Data API to your webhook server when the resource updates. Notification configurations contain private values & are only visible to your GCP project. Different GCP projects may attach different webhook notifications to the same long-running operation resource. type: object properties: uri: description: Optional. The web address that will receive the webhook notification. This address will receive POST requests as the state of the long running operation resource changes. The POST request will contain both a JSON version of the long running operation resource in the body and a `sentTimestamp` field. The sent timestamp will specify the unix microseconds since the epoch that the request was sent; this lets you identify replayed notifications. An example URI is `https://us-central1-example-project-id.cloudfunctions.net/example-function-1`. The URI must use HTTPS and point to a site with a valid SSL certificate on the web server. The URI must have a maximum string length of 128 characters & use only the allowlisted characters from [RFC 1738](https://www.rfc-editor.org/rfc/rfc1738). When your webhook server receives a notification, it is expected to reply with an HTTP response status code of 200 within 5 seconds. A URI is required to use webhook notifications. Requests to this webhook server will contain an ID token authenticating the service account `google-analytics-audience-export@system.gserviceaccount.com`. To learn more about ID tokens, see https://cloud.google.com/docs/authentication/token-types#id. For Google Cloud Functions, this lets you configure your function to require authentication. In Cloud IAM, you will need to grant the service account permissions to the Cloud Run Invoker (`roles/run.invoker`) & Cloud Functions Invoker (`roles/cloudfunctions.invoker`) roles for the webhook post request to pass Google Cloud Functions authentication. This API can send webhook notifications to arbitrary URIs; for webhook servers other than Google Cloud Functions, this ID token in the authorization bearer header should be ignored if it is not needed. type: string channelToken: description: Optional. The channel token is an arbitrary string value and must have a maximum string length of 64 characters. Channel tokens allow you to verify the source of a webhook notification. This guards against the message being spoofed. The channel token will be specified in the `X-Goog-Channel-Token` HTTP header of the webhook POST request. A channel token is not required to use webhook notifications. type: string FunnelFilterExpression: description: Expresses combinations of funnel filters. type: object properties: notExpression: description: The FunnelFilterExpression is NOT of `notExpression`. $ref: '#/components/schemas/FunnelFilterExpression' orGroup: description: The FunnelFilterExpression in `orGroup` have an OR relationship. $ref: '#/components/schemas/FunnelFilterExpressionList' andGroup: description: The FunnelFilterExpression in `andGroup` have an AND relationship. $ref: '#/components/schemas/FunnelFilterExpressionList' funnelFieldFilter: description: A funnel filter for a dimension or metric. $ref: '#/components/schemas/FunnelFieldFilter' funnelEventFilter: description: Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. $ref: '#/components/schemas/FunnelEventFilter' FunnelParameterFilter: description: An expression to filter parameter values in a funnel. type: object properties: itemParameterName: description: This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category". Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the [Measure ecommerce] (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce) guide. type: string stringFilter: description: Strings related filter. $ref: '#/components/schemas/StringFilter' betweenFilter: description: A filter for between two values. $ref: '#/components/schemas/BetweenFilter' numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/NumericFilter' eventParameterName: description: This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency". Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. type: string inListFilter: description: A filter for in list values. $ref: '#/components/schemas/InListFilter' SessionSegment: description: 'Session segments are subsets of the sessions that occurred on your site or app: for example, all the sessions that originated from a particular advertising campaign.' type: object properties: sessionInclusionCriteria: description: Defines which sessions are included in this segment. Optional. $ref: '#/components/schemas/SessionSegmentCriteria' exclusion: description: Defines which sessions are excluded in this segment. Optional. $ref: '#/components/schemas/SessionSegmentExclusion' FunnelBreakdown: description: Breakdowns add a dimension to the funnel table sub report response. type: object properties: breakdownDimension: description: The dimension column added to the funnel table sub report response. The breakdown dimension breaks down each funnel step. A valid `breakdownDimension` is required if `funnelBreakdown` is specified. $ref: '#/components/schemas/Dimension' limit: description: The maximum number of distinct values of the breakdown dimension to return in the response. A `limit` of `5` is used if limit is not specified. Limit must exceed zero and cannot exceed 15. type: string format: int64 ComparisonMetadata: description: The metadata for a single comparison. type: object properties: description: description: This comparison's description. type: string uiName: description: This comparison's name within the Google Analytics user interface. type: string apiName: description: This comparison's resource name. Usable in [Comparison](#Comparison)'s `comparison` field. For example, 'comparisons/1234'. type: string ConcatenateExpression: description: Used to combine dimension values to a single dimension. type: object properties: dimensionNames: description: Names of dimensions. The names must refer back to names in the dimensions field of the request. type: array items: type: string delimiter: description: The delimiter placed between dimension names. Delimiters are often single characters such as "|" or "," but can be longer strings. If a dimension value contains the delimiter, both will be present in response with no distinction. For example if dimension 1 value = "US,FR", dimension 2 value = "JP", and delimiter = ",", then the response will contain "US,FR,JP". type: string MetricOrderBy: description: Sorts by metric values. type: object properties: metricName: description: A metric name in the request to order by. type: string SegmentFilterExpressionList: description: A list of segment filter expressions. type: object properties: expressions: description: The list of segment filter expressions type: array items: $ref: '#/components/schemas/SegmentFilterExpression' MetricHeader: description: Describes a metric column in the report. Visible metrics requested in a report produce column entries within rows and MetricHeaders. However, metrics used exclusively within filters or expressions do not produce columns in a report; correspondingly, those metrics do not produce headers. type: object properties: name: description: The metric's name. type: string type: description: The metric's data type. type: string x-enumDescriptions: - Unspecified type. - Integer type. - Floating point type. - A duration of seconds; a special floating point type. - A duration in milliseconds; a special floating point type. - A duration in minutes; a special floating point type. - A duration in hours; a special floating point type. - A custom metric of standard type; a special floating point type. - An amount of money; a special floating point type. - A length in feet; a special floating point type. - A length in miles; a special floating point type. - A length in meters; a special floating point type. - A length in kilometers; a special floating point type. enum: - METRIC_TYPE_UNSPECIFIED - TYPE_INTEGER - TYPE_FLOAT - TYPE_SECONDS - TYPE_MILLISECONDS - TYPE_MINUTES - TYPE_HOURS - TYPE_STANDARD - TYPE_CURRENCY - TYPE_FEET - TYPE_MILES - TYPE_METERS - TYPE_KILOMETERS FunnelEventFilter: description: Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. type: object properties: funnelParameterFilterExpression: description: If specified, this filter matches events that match both the single event name and the parameter filter expressions. Inside the parameter filter expression, only parameter filters are available. $ref: '#/components/schemas/FunnelParameterFilterExpression' eventName: description: This filter matches events of this single event name. Event name is required. type: string ListAudienceListsResponse: description: A list of all audience lists for a property. type: object properties: nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string audienceLists: items: $ref: '#/components/schemas/AudienceList' description: Each audience list for a property. type: array RecurringAudienceList: description: A recurring audience list produces new audience lists each day. Audience lists are users in an audience at the time of the list's creation. A recurring audience list ensures that you have audience list based on the most recent data available for use each day. type: object properties: audienceDisplayName: description: Output only. The descriptive display name for this audience. For example, "Purchasers". type: string audienceLists: description: Output only. Audience list resource names for audience list instances created for this recurring audience list. One audience list is created for each day, and the audience list will be listed here. This list is ordered with the most recently created audience list first. type: array items: type: string name: description: 'Output only. Identifier. The recurring audience list resource name assigned during creation. This resource name identifies this `RecurringAudienceList`. Format: `properties/{property}/recurringAudienceLists/{recurring_audience_list}`' type: string audience: description: 'Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`' type: string dimensions: items: $ref: '#/components/schemas/AudienceDimension' description: Required. The dimensions requested and displayed in the audience list response. type: array activeDaysRemaining: description: Optional. The number of remaining days that a recurring audience export will produce an audience list instance. This counter decreases by one each day, and when it reaches zero, no new audience lists will be created. Recurring audience list request for Analytics 360 properties default to 180 days and have a maximum of 365 days. Requests for standard Analytics properties default to 14 days and have a maximum of 30 days. The minimum value allowed during creation is 1. Requests above their respective maximum will be coerced to their maximum. type: integer format: int32 webhookNotification: description: Optional. Configures webhook notifications to be sent from the Google Analytics Data API to your webhook server. Use of webhooks is optional. If unused, you'll need to poll this API to determine when a recurring audience list creates new audience lists. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Two POST requests will be sent each time a recurring audience list creates an audience list. This happens once per day until a recurring audience list reaches 0 active days remaining. The first request will be sent showing a newly created audience list in its CREATING state. The second request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). $ref: '#/components/schemas/WebhookNotification' UserSegmentCriteria: description: A user matches a criteria if the user's events meet the conditions in the criteria. type: object properties: andSequenceGroups: items: $ref: '#/components/schemas/UserSegmentSequenceGroup' description: A user matches this criteria if the user matches each of these `andSequenceGroups` and each of the `andConditionGroups`. `andSequenceGroups` may be empty if `andConditionGroups` are specified. type: array andConditionGroups: items: $ref: '#/components/schemas/UserSegmentConditionGroup' description: A user matches this criteria if the user matches each of these `andConditionGroups` and each of the `andSequenceGroups`. `andConditionGroups` may be empty if `andSequenceGroups` are specified. type: array FunnelFilterExpressionList: description: A list of funnel filter expressions. type: object properties: expressions: items: $ref: '#/components/schemas/FunnelFilterExpression' description: The list of funnel filter expressions. type: array ActiveMetricRestriction: description: A metric actively restricted in creating the report. type: object properties: metricName: description: The name of the restricted metric. type: string restrictedMetricTypes: items: type: string x-enumDescriptions: - Unspecified type. - Cost metrics such as `adCost`. - Revenue metrics such as `purchaseRevenue`. enum: - RESTRICTED_METRIC_TYPE_UNSPECIFIED - COST_DATA - REVENUE_DATA description: The reason for this metric's restriction. type: array PropertyQuotasSnapshot: description: Current state of all Property Quotas organized by quota category. type: object properties: corePropertyQuota: description: Property Quota for core property tokens $ref: '#/components/schemas/PropertyQuota' funnelPropertyQuota: description: Property Quota for funnel property tokens $ref: '#/components/schemas/PropertyQuota' realtimePropertyQuota: description: Property Quota for realtime property tokens $ref: '#/components/schemas/PropertyQuota' name: description: Identifier. The property quota snapshot resource name. type: string EventSegmentCriteria: description: An event matches a criteria if the event meet the conditions in the criteria. type: object properties: andConditionGroups: description: An event matches this criteria if the event matches each of these `andConditionGroups`. type: array items: $ref: '#/components/schemas/EventSegmentConditionGroup' CaseExpression: description: Used to convert a dimension value to a single case. type: object properties: dimensionName: description: Name of a dimension. The name must refer back to a name in dimensions field of the request. type: string ReportMetadata: description: The report metadata for a specific report task. type: object properties: taskRowCount: description: Output only. The total number of rows in the report result. This field will be populated when the state is active. You can utilize `task_row_count` for pagination within the confines of their existing report. type: integer format: int32 totalRowCount: description: Output only. The total number of rows in Google Analytics storage. If you want to query additional data rows beyond the current report, they can initiate a new report task based on the `total_row_count`. The `task_row_count` represents the number of rows specifically pertaining to the current report, whereas `total_row_count` encompasses the total count of rows across all data retrieved from Google Analytics storage. For example, suppose the current report's `task_row_count` is 20, displaying the data from the first 20 rows. Simultaneously, the `total_row_count` is 30, indicating the presence of data for all 30 rows. The `task_row_count` can be utilizated to paginate through the initial 20 rows. To expand the report and include data from all 30 rows, a new report task can be created using the total_row_count to access the full set of 30 rows' worth of data. type: integer format: int32 errorMessage: description: Output only. Error message is populated if a report task fails during creation. type: string creationQuotaTokensCharged: description: Output only. The total quota tokens charged during creation of the report. Because this token count is based on activity from the `CREATING` state, this tokens charge will be fixed once a report task enters the `ACTIVE` or `FAILED` state. type: integer format: int32 state: x-enumDescriptions: - Unspecified state will never be used. - The report is currently creating and will be available in the future. Creating occurs immediately after the CreateReport call. - The report is fully created and ready for querying. - The report failed to be created. enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - FAILED description: Output only. The current state for this report task. type: string beginCreatingTime: description: Output only. The time when `CreateReportTask` was called and the report began the `CREATING` state. type: string format: google-datetime DateRange: description: 'A contiguous set of days: `startDate`, `startDate + 1`, ..., `endDate`. Requests are allowed up to 4 date ranges.' type: object properties: startDate: description: The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `end_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone. type: string endDate: description: The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `start_date`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the property's reporting time zone. type: string name: description: 'Assigns a name to this date range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, date ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.' type: string Operation: description: This resource represents a long-running operation that is the result of a network API call. type: object properties: name: description: The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. type: string metadata: description: Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. done: description: If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. type: boolean response: additionalProperties: description: Properties of the object. Contains field @type with type URL. description: The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. type: object error: description: The error result of the operation in case of failure or cancellation. $ref: '#/components/schemas/Status' QueryReportTaskRequest: description: A request to fetch the report content for a report task. type: object properties: offset: description: Optional. The row count of the start row in the report. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 limit: description: Optional. The number of rows to return from the report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. The number of rows available to a QueryReportTaskRequest is further limited by the limit of the associated ReportTask. A query can retrieve at most ReportTask.limit rows. For example, if the ReportTask has a limit of 1,000, then a QueryReportTask request with offset=900 and limit=500 will return at most 100 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 MetricMetadata: description: Explains a metric. type: object properties: description: description: Description of how this metric is used and calculated. type: string type: x-enumDescriptions: - Unspecified type. - Integer type. - Floating point type. - A duration of seconds; a special floating point type. - A duration in milliseconds; a special floating point type. - A duration in minutes; a special floating point type. - A duration in hours; a special floating point type. - A custom metric of standard type; a special floating point type. - An amount of money; a special floating point type. - A length in feet; a special floating point type. - A length in miles; a special floating point type. - A length in meters; a special floating point type. - A length in kilometers; a special floating point type. enum: - METRIC_TYPE_UNSPECIFIED - TYPE_INTEGER - TYPE_FLOAT - TYPE_SECONDS - TYPE_MILLISECONDS - TYPE_MINUTES - TYPE_HOURS - TYPE_STANDARD - TYPE_CURRENCY - TYPE_FEET - TYPE_MILES - TYPE_METERS - TYPE_KILOMETERS description: The type of this metric. type: string category: description: The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together. type: string expression: description: The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty. type: string apiName: description: A metric name. Usable in [Metric](#Metric)'s `name`. For example, `eventCount`. type: string sections: description: Specifies the Google Analytics sections this metric applies to. type: array items: x-enumDescriptions: - Should never be specified. - The report data is from the standard report data. Google Analytics reports include acquisition, engagement, and user behavior reports. Reports use dimensions like session source & landing page; reports use metrics like sessions, views, and engagement time. - The report data is from the conversion data. The Google Analytics Advertising section reports on conversion performance. Advertising reports use dimensions like source & medium; advertising reports use metrics like all conversions and ads cost. enum: - SECTION_UNSPECIFIED - SECTION_REPORT - SECTION_ADVERTISING type: string deprecatedApiNames: items: type: string description: Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`. type: array uiName: description: This metric's name within the Google Analytics user interface. For example, `Event count`. type: string blockedReasons: description: If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). type: array items: x-enumDescriptions: - Will never be specified in API response. - If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related. - If present, your access is blocked to cost related metrics for this property, and this metric is cost related. enum: - BLOCKED_REASON_UNSPECIFIED - NO_REVENUE_METRICS - NO_COST_METRICS type: string customDefinition: description: True if the metric is a custom metric for this property. type: boolean MetricValue: description: The value of a metric. type: object properties: value: description: Measurement value. See MetricHeader for type. type: string EventSegmentExclusion: description: Specifies which events are excluded in this segment. type: object properties: eventExclusionDuration: x-enumDescriptions: - Unspecified exclusion duration. Do not specify. - Permanently exclude events from the segment if the event ever meets the `eventExclusionCriteria` condition. enum: - EVENT_EXCLUSION_DURATION_UNSPECIFIED - EVENT_EXCLUSION_PERMANENT description: '`eventExclusionDuration` should always be `PERMANENTLY_EXCLUDE`. Optional. If unspecified, an `eventExclusionDuration` of `EVENT_EXCLUSION_PERMANENT` is used.' type: string eventExclusionCriteria: description: If an event meets this condition, the event is excluded from membership in the segment for the `eventExclusionDuration`. $ref: '#/components/schemas/EventSegmentCriteria' SessionSegmentExclusion: description: Specifies which sessions are excluded in this segment. type: object properties: sessionExclusionDuration: x-enumDescriptions: - Unspecified exclusion duration. Do not specify. - Temporarily exclude sessions from the segment during periods when the session meets the `sessionExclusionCriteria` condition. - Permanently exclude sessions from the segment if the session ever meets the `sessionExclusionCriteria` condition. enum: - SESSION_EXCLUSION_DURATION_UNSPECIFIED - SESSION_EXCLUSION_TEMPORARY - SESSION_EXCLUSION_PERMANENT description: Specifies how long an exclusion will last if a session matches the `sessionExclusionCriteria`. Optional. If unspecified, a `sessionExclusionDuration` of `SESSION_EXCLUSION_TEMPORARY` is used. type: string sessionExclusionCriteria: description: If a session meets this condition, the session is excluded from membership in the segment for the `sessionExclusionDuration`. $ref: '#/components/schemas/SessionSegmentCriteria' CohortReportSettings: description: Optional settings of a cohort report. type: object properties: accumulate: description: If true, accumulates the result from first touch day to the end day. Not supported in `RunReportRequest`. type: boolean FunnelResponseMetadata: description: The funnel report's response metadata carries additional information about the funnel report. type: object properties: samplingMetadatas: description: If funnel report results are [sampled](https://support.google.com/analytics/answer/13331292), this describes what percentage of events were used in this funnel report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. type: array items: $ref: '#/components/schemas/SamplingMetadata' ConversionMetadata: description: 'The metadata for a single conversion. This feature may not be available to your Google Analytics property. The Google Analytics team is actively working to expand this feature to more properties. Please reach out to your support team if you have questions about the eligibility of your property. ' type: object properties: displayName: description: This conversion's name within the Google Analytics user interface. type: string conversionAction: description: The unique identifier of the conversion action. This ID is used to specify which conversions to include in a report by populating the `conversion_actions` field in the `ConversionsSpec` of a report request. For example, 'conversionActions/1234'. type: string Cohort: description: Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same `firstSessionDate` belong to the same cohort. type: object properties: name: description: Assigns a name to this cohort. The dimension `cohort` is valued to this name in a report response. If set, cannot begin with `cohort_` or `RESERVED_`. If not set, cohorts are named by their zero based index `cohort_0`, `cohort_1`, etc. type: string dimension: description: Dimension used by the cohort. Required and only supports `firstSessionDate`. type: string dateRange: description: The cohort selects users whose first touch date is between start date and end date defined in the `dateRange`. This `dateRange` does not specify the full date range of event data that is present in a cohort report. In a cohort report, this `dateRange` is extended by the granularity and offset present in the `cohortsRange`; event data for the extended reporting date range is present in a cohort report. In a cohort request, this `dateRange` is required and the `dateRanges` in the `RunReportRequest` or `RunPivotReportRequest` must be unspecified. This `dateRange` should generally be aligned with the cohort's granularity. If `CohortsRange` uses daily granularity, this `dateRange` can be a single day. If `CohortsRange` uses weekly granularity, this `dateRange` can be aligned to a week boundary, starting at Sunday and ending Saturday. If `CohortsRange` uses monthly granularity, this `dateRange` can be aligned to a month, starting at the first and ending on the last day of the month. $ref: '#/components/schemas/DateRange' QueryAudienceListRequest: description: A request to list users in an audience list. type: object properties: offset: description: Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 limit: description: Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 ReportTask: description: A specific report task configuration. type: object properties: reportDefinition: description: Optional. A report definition to fetch report data, which describes the structure of a report. It typically includes the fields that will be included in the report and the criteria that will be used to filter the data. $ref: '#/components/schemas/ReportDefinition' name: description: 'Output only. Identifier. The report task resource name assigned during creation. Format: "properties/{property}/reportTasks/{report_task}"' type: string reportMetadata: description: 'Output only. The report metadata for a specific report task, which provides information about a report. It typically includes the following information: the resource name of the report, the state of the report, the timestamp the report was created, etc,' $ref: '#/components/schemas/ReportMetadata' SessionSegmentConditionGroup: description: Conditions tell Analytics what data to include in or exclude from the segment. type: object properties: conditionScoping: description: Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the `segmentFilterExpression` is evaluated on before the condition group is determined to be matched or not. For example if `conditionScoping = SESSION_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this session. For example if `conditionScoping = SESSION_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this session. Optional. If unspecified, a `conditionScoping` of `WITHIN_SAME_SESSION` is used. type: string x-enumDescriptions: - Unspecified criteria scoping. Do not specify. - If the criteria is satisfied within one event, the session matches the criteria. - If the criteria is satisfied within one session, the session matches the criteria. enum: - SESSION_CRITERIA_SCOPING_UNSPECIFIED - SESSION_CRITERIA_WITHIN_SAME_EVENT - SESSION_CRITERIA_WITHIN_SAME_SESSION segmentFilterExpression: description: Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters. $ref: '#/components/schemas/SegmentFilterExpression' QuotaStatus: description: Current state for a particular quota group. type: object properties: consumed: description: Quota consumed by this request. type: integer format: int32 remaining: description: Quota remaining after this request. type: integer format: int32 ReportDefinition: description: The definition of how a report should be run. type: object properties: limit: description: Optional. The number of rows to return in the Report. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values 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. type: string format: int64 orderBys: items: $ref: '#/components/schemas/OrderBy' description: Optional. Specifies how rows are ordered in the response. type: array metricFilter: description: Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' metricAggregations: items: type: string x-enumDescriptions: - Unspecified operator. - SUM operator. - Minimum operator. - Maximum operator. - Count operator. enum: - METRIC_AGGREGATION_UNSPECIFIED - TOTAL - MINIMUM - MAXIMUM - COUNT description: Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". type: array metrics: description: Optional. The metrics requested and displayed. type: array items: $ref: '#/components/schemas/Metric' offset: description: Optional. The row count of the start row from Google Analytics Storage. The first row is counted as row 0. When creating a report task, the `offset` and `limit` parameters define the subset of data rows from Google Analytics storage to be included in the generated report. For example, if there are a total of 300,000 rows in Google Analytics storage, the initial report task may have the first 10,000 rows with a limit of 10,000 and an offset of 0. Subsequently, another report task could cover the next 10,000 rows with a limit of 10,000 and an offset of 10,000. type: string format: int64 cohortSpec: description: Optional. Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. $ref: '#/components/schemas/CohortSpec' dimensionFilter: description: Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' keepEmptyRows: description: 'Optional. If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row containing eventName: "purchase" and eventCount: 0.' type: boolean dimensions: description: Optional. The dimensions requested and displayed. type: array items: $ref: '#/components/schemas/Dimension' dateRanges: description: Optional. Date ranges of data 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 event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified. type: array items: $ref: '#/components/schemas/DateRange' currencyCode: description: Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. type: string samplingLevel: description: Optional. The report's sampling level. type: string x-enumDescriptions: - Unspecified type. - Applies a sampling level of 10 million to standard properties and 100 million to Google Analytics 360 properties. - Exclusive to Google Analytics 360 properties with a sampling level of 1 billion. - Exclusive to Google Analytics 360 properties. Unsampled explorations are more accurate and can reveal insights that aren't visible in standard explorations. To learn more, see https://support.google.com/analytics/answer/10896953. enum: - SAMPLING_LEVEL_UNSPECIFIED - LOW - MEDIUM - UNSAMPLED DimensionExpression: description: 'Used to express a dimension which is the result of a formula of multiple dimensions. Example usages: 1) lower_case(dimension) 2) concatenate(dimension1, symbol, dimension2).' type: object properties: concatenate: description: 'Used to combine dimension values to a single dimension. For example, dimension "country, city": concatenate(country, ", ", city).' $ref: '#/components/schemas/ConcatenateExpression' upperCase: description: Used to convert a dimension value to upper case. $ref: '#/components/schemas/CaseExpression' lowerCase: description: Used to convert a dimension value to lower case. $ref: '#/components/schemas/CaseExpression' SegmentParameterFilterExpression: description: Expresses combinations of segment filter on parameters. type: object properties: orGroup: description: The SegmentParameterFilterExpression in `orGroup` have an OR relationship. $ref: '#/components/schemas/SegmentParameterFilterExpressionList' segmentParameterFilter: description: A primitive segment parameter filter. $ref: '#/components/schemas/SegmentParameterFilter' andGroup: description: The SegmentParameterFilterExpression in `andGroup` have an AND relationship. $ref: '#/components/schemas/SegmentParameterFilterExpressionList' notExpression: description: The SegmentParameterFilterExpression is NOT of `notExpression`. $ref: '#/components/schemas/SegmentParameterFilterExpression' FunnelParameterFilterExpressionList: description: A list of funnel parameter filter expressions. type: object properties: expressions: items: $ref: '#/components/schemas/FunnelParameterFilterExpression' description: The list of funnel parameter filter expressions. type: array RunFunnelReportResponse: description: The funnel report response contains two sub reports. The two sub reports are different combinations of dimensions and metrics. type: object properties: funnelVisualization: description: The funnel visualization is a report with the funnel step, segment, date, next action dimension, and active users. The segment dimension is only present in this response if a segment was requested. The date dimension is only present in this response if it was requested through the `TRENDED_FUNNEL` funnel type. The next action dimension is only present in the response if it was requested. $ref: '#/components/schemas/FunnelSubReport' propertyQuota: description: This Analytics Property's quota state including this request. $ref: '#/components/schemas/PropertyQuota' funnelTable: description: The funnel table is a report with the funnel step, segment, breakdown dimension, active users, completion rate, abandonments, and abandonments rate. The segment dimension is only present in this response if a segment was requested. The breakdown dimension is only present in this response if it was requested. $ref: '#/components/schemas/FunnelSubReport' kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runFunnelReport". Useful to distinguish between response types in JSON. type: string FilterExpression: description: To express dimension or metric filters. The fields in the same FilterExpression need to be either all dimensions or all metrics. type: object properties: orGroup: description: The FilterExpressions in or_group have an OR relationship. $ref: '#/components/schemas/FilterExpressionList' andGroup: description: The FilterExpressions in and_group have an AND relationship. $ref: '#/components/schemas/FilterExpressionList' notExpression: description: The FilterExpression is NOT of not_expression. $ref: '#/components/schemas/FilterExpression' filter: 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/Filter' SegmentFilterExpression: description: Expresses combinations of segment filters. type: object properties: notExpression: description: The SegmentFilterExpression is NOT of `notExpression`. $ref: '#/components/schemas/SegmentFilterExpression' segmentEventFilter: description: Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. $ref: '#/components/schemas/SegmentEventFilter' segmentFilter: description: A primitive segment filter. $ref: '#/components/schemas/SegmentFilter' andGroup: description: The SegmentFilterExpression in `andGroup` have an AND relationship. $ref: '#/components/schemas/SegmentFilterExpressionList' orGroup: description: The SegmentFilterExpression in `orGroup` have an OR relationship. $ref: '#/components/schemas/SegmentFilterExpressionList' SegmentFilter: description: An expression to filter dimension or metric values. type: object properties: betweenFilter: description: A filter for between two values. $ref: '#/components/schemas/BetweenFilter' stringFilter: description: Strings related filter. $ref: '#/components/schemas/StringFilter' filterScoping: description: Specifies the scope for the filter. $ref: '#/components/schemas/SegmentFilterScoping' fieldName: description: The dimension name or metric name. type: string numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/NumericFilter' inListFilter: description: A filter for in list values. $ref: '#/components/schemas/InListFilter' ResponseMetaData: description: Response's metadata carrying additional information about the report content. type: object properties: dataLossFromOtherRow: description: If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). type: boolean subjectToThresholding: description: If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630) and [About Demographics and Interests](https://support.google.com/analytics/answer/2799357). type: boolean samplingMetadatas: items: $ref: '#/components/schemas/SamplingMetadata' description: If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. type: array schemaRestrictionResponse: description: Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). $ref: '#/components/schemas/SchemaRestrictionResponse' timeZone: description: The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. 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 currencyCode: description: The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. type: string emptyReason: description: If empty reason is specified, the report is empty for this reason. type: string section: x-enumDescriptions: - Should never be specified. - The report data is from the standard report data. Google Analytics reports include acquisition, engagement, and user behavior reports. Reports use dimensions like session source & landing page; reports use metrics like sessions, views, and engagement time. - The report data is from the conversion data. The Google Analytics Advertising section reports on conversion performance. Advertising reports use dimensions like source & medium; advertising reports use metrics like all conversions and ads cost. enum: - SECTION_UNSPECIFIED - SECTION_REPORT - SECTION_ADVERTISING description: Identifies the type of data in the report. type: string SegmentParameterFilterScoping: description: Scopings specify how multiple events should be considered when evaluating a segment parameter filter. type: object properties: inAnyNDayPeriod: description: 'Accumulates the parameter over the specified period of days before applying the filter. Only supported if criteria scoping is `ACROSS_ALL_SESSIONS` or `WITHIN_SAME_SESSION`. Only supported if the parameter is `event_count`. For example if `inAnyNDayPeriod` is 3, the event_name is "purchase", the event parameter is "event_count", and the Filter''s criteria is greater than 5, this filter will accumulate the event count of purchase events over every 3 consecutive day period in the report''s date range; a user will pass this Filter''s criteria to be included in this segment if their count of purchase events exceeds 5 in any 3 consecutive day period. For example, the periods 2021-11-01 to 2021-11-03, 2021-11-02 to 2021-11-04, 2021-11-03 to 2021-11-05, and etc. will be considered. The date range is not extended for the purpose of having a full N day window near the start of the date range. For example if a report is for 2021-11-01 to 2021-11-10 and `inAnyNDayPeriod` = 3, the first two day period will be effectively shortened because no event data outside the report''s date range will be read. For example, the first four periods will effectively be: 2021-11-01 to 2021-11-01, 2021-11-01 to 2021-11-02, 2021-11-01 to 2021-11-03, and 2021-11-02 to 2021-11-04. `inAnyNDayPeriod` is optional. If not specified, the `segmentParameterFilter` is applied to each event individually.' type: string format: int64 OrderBy: description: Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering. type: object properties: desc: description: If true, sorts by descending order. type: boolean dimension: description: Sorts results by a dimension's values. $ref: '#/components/schemas/DimensionOrderBy' metric: description: Sorts results by a metric's values. $ref: '#/components/schemas/MetricOrderBy' UserSegmentConditionGroup: description: Conditions tell Analytics what data to include in or exclude from the segment. type: object properties: conditionScoping: x-enumDescriptions: - Unspecified criteria scoping. Do not specify. - If the criteria is satisfied within one event, the user matches the criteria. - If the criteria is satisfied within one session, the user matches the criteria. - If the criteria is satisfied by any events for the user, the user matches the criteria. enum: - USER_CRITERIA_SCOPING_UNSPECIFIED - USER_CRITERIA_WITHIN_SAME_EVENT - USER_CRITERIA_WITHIN_SAME_SESSION - USER_CRITERIA_ACROSS_ALL_SESSIONS description: Data is included or excluded from the segment based on if it matches the condition group. This scoping defines how many events the `segmentFilterExpression` is evaluated on before the condition group is determined to be matched or not. For example if `conditionScoping = USER_CRITERIA_WITHIN_SAME_SESSION`, the expression is evaluated on all events in a session, and then, the condition group is determined to be matched or not for this user. For example if `conditionScoping = USER_CRITERIA_WITHIN_SAME_EVENT`, the expression is evaluated on a single event, and then, the condition group is determined to be matched or not for this user. Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is used. type: string segmentFilterExpression: description: Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters. $ref: '#/components/schemas/SegmentFilterExpression' ListRecurringAudienceListsResponse: description: A list of all recurring audience lists for a property. type: object properties: recurringAudienceLists: items: $ref: '#/components/schemas/RecurringAudienceList' description: Each recurring audience list for a property. type: array 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 AudienceDimension: description: An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceListResponse`. type: object properties: dimensionName: description: Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names. type: string EmptyFilter: description: Filter for empty values. type: object properties: {} SegmentEventFilter: description: Creates a filter that matches events of a single event name. If a parameter filter expression is specified, only the subset of events that match both the single event name and the parameter filter expressions match this event filter. type: object properties: segmentParameterFilterExpression: description: If specified, this filter matches events that match both the single event name and the parameter filter expressions. Inside the parameter filter expression, only parameter filters are available. $ref: '#/components/schemas/SegmentParameterFilterExpression' eventName: description: This filter matches events of this single event name. Event name is required. type: string RunReportResponse: description: The response report table corresponding to a request. type: object properties: minimums: items: $ref: '#/components/schemas/Row' description: If requested, the minimum values of metrics. type: array metadata: description: Metadata for the report. $ref: '#/components/schemas/ResponseMetaData' kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runReport". Useful to distinguish between response types in JSON. type: string 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 dimensionHeaders: description: Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. type: array items: $ref: '#/components/schemas/DimensionHeader' metricHeaders: items: $ref: '#/components/schemas/MetricHeader' description: Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. type: array propertyQuota: description: This Analytics Property's quota state including this request. $ref: '#/components/schemas/PropertyQuota' rowCount: description: The total number of rows in the query result, regardless of the number of rows returned in the response. For example if a query returns 175 rows and includes limit = 50 in the API request, the response will contain row_count = 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: integer format: int32 rows: description: Rows of dimension value combinations and metric values in the report. type: array items: $ref: '#/components/schemas/Row' totals: description: If requested, the totaled values of metrics. type: array items: $ref: '#/components/schemas/Row' maximums: items: $ref: '#/components/schemas/Row' description: If requested, the maximum values of metrics. type: array UserSegmentExclusion: description: Specifies which users are excluded in this segment. type: object properties: userExclusionDuration: description: Specifies how long an exclusion will last if a user matches the `userExclusionCriteria`. Optional. If unspecified, `userExclusionDuration` of `USER_EXCLUSION_TEMPORARY` is used. type: string x-enumDescriptions: - Unspecified exclusion duration. Do not specify. - Temporarily exclude users from the segment during periods when the user meets the `userExclusionCriteria` condition. - Permanently exclude users from the segment if the user ever meets the `userExclusionCriteria` condition. enum: - USER_EXCLUSION_DURATION_UNSPECIFIED - USER_EXCLUSION_TEMPORARY - USER_EXCLUSION_PERMANENT userExclusionCriteria: description: If a user meets this condition, the user is excluded from membership in the segment for the `userExclusionDuration`. $ref: '#/components/schemas/UserSegmentCriteria' DimensionMetadata: description: Explains a dimension. type: object properties: apiName: description: This dimension's name. Usable in [Dimension](#Dimension)'s `name`. For example, `eventName`. type: string category: description: The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. type: string sections: description: Specifies the Google Analytics sections this dimension applies to. type: array items: type: string x-enumDescriptions: - Should never be specified. - The report data is from the standard report data. Google Analytics reports include acquisition, engagement, and user behavior reports. Reports use dimensions like session source & landing page; reports use metrics like sessions, views, and engagement time. - The report data is from the conversion data. The Google Analytics Advertising section reports on conversion performance. Advertising reports use dimensions like source & medium; advertising reports use metrics like all conversions and ads cost. enum: - SECTION_UNSPECIFIED - SECTION_REPORT - SECTION_ADVERTISING deprecatedApiNames: description: Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`. type: array items: type: string description: description: Description of how this dimension is used and calculated. type: string customDefinition: description: True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316. type: boolean uiName: description: This dimension's name within the Google Analytics user interface. For example, `Event name`. type: string EventSegmentConditionGroup: description: Conditions tell Analytics what data to include in or exclude from the segment. type: object properties: conditionScoping: x-enumDescriptions: - Unspecified criteria scoping. Do not specify. - If the criteria is satisfied within one event, the event matches the criteria. enum: - EVENT_CRITERIA_SCOPING_UNSPECIFIED - EVENT_CRITERIA_WITHIN_SAME_EVENT description: '`conditionScoping` should always be `EVENT_CRITERIA_WITHIN_SAME_EVENT`. Optional. If unspecified, a `conditionScoping` of `EVENT_CRITERIA_WITHIN_SAME_EVENT` is used.' type: string segmentFilterExpression: description: Data is included or excluded from the segment based on if it matches this expression. Expressions express criteria on dimension, metrics, and/or parameters. $ref: '#/components/schemas/SegmentFilterExpression' UserSegmentSequenceGroup: description: Define conditions that must occur in a specific order for the user to be a member of the segment. type: object properties: sequenceMaximumDuration: description: Defines the time period in which the whole sequence must occur; for example, 30 Minutes. `sequenceMaximumDuration` is inclusive of the endpoint at the microsecond granularity. For example a sequence with a maximum duration of 5 seconds can be completed at 4.9 or 5.0 seconds, but not 5 seconds and 1 microsecond. `sequenceMaximumDuration` is optional, and if unspecified, sequences can be completed in any time duration. type: string format: google-duration sequenceScoping: x-enumDescriptions: - Unspecified criteria scoping. Do not specify. - If the criteria is satisfied within one event, the user matches the criteria. - If the criteria is satisfied within one session, the user matches the criteria. - If the criteria is satisfied by any events for the user, the user matches the criteria. enum: - USER_CRITERIA_SCOPING_UNSPECIFIED - USER_CRITERIA_WITHIN_SAME_EVENT - USER_CRITERIA_WITHIN_SAME_SESSION - USER_CRITERIA_ACROSS_ALL_SESSIONS description: All sequence steps must be satisfied in the scoping for the user to match the sequence. For example if `sequenceScoping = USER_CRITERIA_WITHIN_SAME_SESSION`, all sequence steps must complete within one session for the user to match the sequence. `sequenceScoping = USER_CRITERIA_WITHIN_SAME_EVENT` is not supported. Optional. If unspecified, `conditionScoping = ACROSS_ALL_SESSIONS` is used. type: string userSequenceSteps: description: An ordered sequence of condition steps. A user's events must complete each step in order for the user to match the `UserSegmentSequenceGroup`. type: array items: $ref: '#/components/schemas/UserSequenceStep' NumericFilter: description: Filters for numeric or date values. type: object properties: operation: x-enumDescriptions: - Unspecified. - Equal - Less than - Less than or equal - Greater than - Greater than or equal enum: - OPERATION_UNSPECIFIED - EQUAL - LESS_THAN - LESS_THAN_OR_EQUAL - GREATER_THAN - GREATER_THAN_OR_EQUAL description: The operation type for this filter. type: string value: description: A numeric value or a date value. $ref: '#/components/schemas/NumericValue' Metric: description: The quantitative measurements of a report. For example, the metric `eventCount` is the total number of events. Requests are allowed up to 10 metrics. type: object properties: invisible: description: Indicates if a metric is invisible in the report response. If a metric is invisible, the metric will not produce a column in the response, but can be used in `metricFilter`, `orderBys`, or a metric `expression`. type: boolean expression: description: A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`. type: string name: description: The name of the metric. See the [API Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics) for the list of metric names supported by the `runRealtimeReport` method. See [Funnel Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics) for the list of metric names supported by the `runFunnelReport` method. If `expression` is specified, `name` can be any string that you would like within the allowed character set. For example if `expression` is `screenPageViews/sessions`, you could call that metric's name = `viewsPerSession`. Metric names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric `expression`. type: string PropertyQuota: description: Current state of all quotas for this Analytics Property. If any quota for a property is exhausted, all requests to that property will return Resource Exhausted errors. type: object properties: tokensPerDay: description: Standard Analytics Properties can use up to 200,000 tokens per day; Analytics 360 Properties can use 2,000,000 tokens per day. Most requests consume fewer than 10 tokens. $ref: '#/components/schemas/QuotaStatus' tokensPerProjectPerHour: description: Analytics Properties can use up to 35% of their tokens per project per hour. This amounts to standard Analytics Properties can use up to 14,000 tokens per project per hour, and Analytics 360 Properties can use 140,000 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/QuotaStatus' serverErrorsPerProjectPerHour: description: Standard Analytics Properties and cloud project pairs can have up to 10 server errors per hour; Analytics 360 Properties and cloud project pairs can have up to 50 server errors per hour. $ref: '#/components/schemas/QuotaStatus' concurrentRequests: description: Standard Analytics Properties can send up to 10 concurrent requests; Analytics 360 Properties can use up to 50 concurrent requests. $ref: '#/components/schemas/QuotaStatus' tokensPerHour: description: Standard Analytics Properties can use up to 40,000 tokens per hour; Analytics 360 Properties can use 400,000 tokens per hour. An API request consumes a single number of tokens, and that number is deducted from all of the hourly, daily, and per project hourly quotas. $ref: '#/components/schemas/QuotaStatus' potentiallyThresholdedRequestsPerHour: description: Analytics Properties can send up to 120 requests with potentially thresholded dimensions per hour. In a batch request, each report request is individually counted for this quota if the request contains potentially thresholded dimensions. $ref: '#/components/schemas/QuotaStatus' ListReportTasksResponse: description: A list of all report tasks for a property. type: object properties: nextPageToken: description: A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. type: string reportTasks: description: Each report task for a property. type: array items: $ref: '#/components/schemas/ReportTask' FunnelSubReport: description: Funnel sub reports contain the dimension and metric data values. For example, 12 users reached the second step of the funnel. type: object properties: rows: description: Rows of dimension value combinations and metric values in the report. type: array items: $ref: '#/components/schemas/Row' metadata: description: Metadata for the funnel report. $ref: '#/components/schemas/FunnelResponseMetadata' dimensionHeaders: items: $ref: '#/components/schemas/DimensionHeader' description: Describes dimension columns. Funnel reports always include the funnel step dimension in sub report responses. Additional dimensions like breakdowns, dates, and next actions may be present in the response if requested. type: array metricHeaders: items: $ref: '#/components/schemas/MetricHeader' description: Describes metric columns. Funnel reports always include active users in sub report responses. The funnel table includes additional metrics like completion rate, abandonments, and abandonments rate. type: array CohortSpec: description: The specification of cohorts for a cohort report. Cohort reports create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the `cohort` object. Following that cohort for the next six weeks is specified in the `cohortsRange` object. For examples, see [Cohort Report Examples](https://developers.google.com/analytics/devguides/reporting/data/v1/advanced#cohort_report_examples). The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric `cohortActiveUsers/cohortTotalUsers` and will be separate rows in the report. type: object properties: cohorts: items: $ref: '#/components/schemas/Cohort' description: Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name. type: array cohortsRange: description: Cohort reports follow cohorts over an extended reporting date range. This range specifies an offset duration to follow the cohorts over. $ref: '#/components/schemas/CohortsRange' cohortReportSettings: description: Optional settings for a cohort report. $ref: '#/components/schemas/CohortReportSettings' Dimension: description: Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". type: object properties: name: description: The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) for the list of dimension names supported by the `runFunnelReport` method. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`. type: string dimensionExpression: description: 'One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).' $ref: '#/components/schemas/DimensionExpression' RunFunnelReportRequest: description: The request for a funnel report. type: object properties: limit: description: Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. type: string format: int64 dimensionFilter: description: 'Optional. Dimension filters allow you to ask for only specific dimension values in the report. To learn more, see [Creating a Report: Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter.' $ref: '#/components/schemas/FilterExpression' returnPropertyQuota: description: Optional. Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). type: boolean funnel: description: Optional. The configuration of this request's funnel. This funnel configuration is required. $ref: '#/components/schemas/Funnel' funnelBreakdown: description: Optional. If specified, this breakdown adds a dimension to the funnel table sub report response. This breakdown dimension expands each funnel step to the unique values of the breakdown dimension. For example, a breakdown by the `deviceCategory` dimension will create rows for `mobile`, `tablet`, `desktop`, and the total. $ref: '#/components/schemas/FunnelBreakdown' segments: items: $ref: '#/components/schemas/Segment' description: Optional. The configurations of segments. Segments are subsets of a property's data. In a funnel report with segments, the funnel is evaluated in each segment. Each segment specified in this request produces a separate row in the response; in the response, each segment identified by its name. The segments parameter is optional. Requests are limited to 4 segments. type: array funnelNextAction: description: Optional. If specified, next action adds a dimension to the funnel visualization sub report response. This next action dimension expands each funnel step to the unique values of the next action. For example a next action of the `eventName` dimension will create rows for several events (for example `session_start` & `click`) and the total. Next action only supports `eventName` and most Page / Screen dimensions like `pageTitle` and `pagePath`. $ref: '#/components/schemas/FunnelNextAction' funnelVisualizationType: description: Optional. The funnel visualization type controls the dimensions present in the funnel visualization sub report response. If not specified, `STANDARD_FUNNEL` is used. type: string x-enumDescriptions: - Unspecified type. - A standard (stepped) funnel. The funnel visualization sub report in the response will not contain date. - A trended (line chart) funnel. The funnel visualization sub report in the response will contain the date dimension. enum: - FUNNEL_VISUALIZATION_TYPE_UNSPECIFIED - STANDARD_FUNNEL - TRENDED_FUNNEL dateRanges: description: Optional. Date ranges of data 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 event data for the overlapping days is included in the response rows for both date ranges. type: array items: $ref: '#/components/schemas/DateRange' SegmentParameterFilter: description: An expression to filter parameter values in a segment. type: object properties: betweenFilter: description: A filter for between two values. $ref: '#/components/schemas/BetweenFilter' itemParameterName: description: This filter will be evaluated on the specified item parameter. Item parameters are logged as parameters in the item array. Item parameters include fields like "item_name" & "item_category". Item parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. Item parameters are only available in ecommerce events. To learn more about ecommerce events, see the [Measure ecommerce] (https://developers.google.com/analytics/devguides/collection/ga4/ecommerce) guide. type: string stringFilter: description: Strings related filter. $ref: '#/components/schemas/StringFilter' filterScoping: description: Specifies the scope for the filter. $ref: '#/components/schemas/SegmentParameterFilterScoping' numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/NumericFilter' eventParameterName: description: This filter will be evaluated on the specified event parameter. Event parameters are logged as parameters of the event. Event parameters include fields like "firebase_screen" & "currency". Event parameters can only be used in segments & funnels and can only be used in a descendent filter from an EventFilter. In a descendent filter from an EventFilter either event or item parameters should be used. type: string inListFilter: description: A filter for in list values. $ref: '#/components/schemas/InListFilter' EventSegment: description: Event segments are subsets of events that were triggered on your site or app. for example, all purchase events made in a particular location; app_exception events that occurred on a specific operating system. type: object properties: eventInclusionCriteria: description: Defines which events are included in this segment. Optional. $ref: '#/components/schemas/EventSegmentCriteria' exclusion: description: Defines which events are excluded in this segment. Optional. $ref: '#/components/schemas/EventSegmentExclusion' BetweenFilter: description: To express that the result needs to be between two numbers (inclusive). type: object properties: toValue: description: Ends with this number. $ref: '#/components/schemas/NumericValue' fromValue: description: Begins with this number. $ref: '#/components/schemas/NumericValue' FunnelParameterFilterExpression: description: Expresses combinations of funnel filters on parameters. type: object properties: funnelParameterFilter: description: A primitive funnel parameter filter. $ref: '#/components/schemas/FunnelParameterFilter' orGroup: description: The FunnelParameterFilterExpression in `orGroup` have an OR relationship. $ref: '#/components/schemas/FunnelParameterFilterExpressionList' andGroup: description: The FunnelParameterFilterExpression in `andGroup` have an AND relationship. $ref: '#/components/schemas/FunnelParameterFilterExpressionList' notExpression: description: The FunnelParameterFilterExpression is NOT of `notExpression`. $ref: '#/components/schemas/FunnelParameterFilterExpression' QueryAudienceListResponse: description: A list of users in an audience list. type: object properties: audienceRows: description: Rows for each user in an audience list. The number of rows in this response will be less than or equal to request's page size. type: array items: $ref: '#/components/schemas/AudienceRow' audienceList: description: Configuration data about AudienceList being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceList correspond to the columns in the AudienceRows. $ref: '#/components/schemas/AudienceList' rowCount: description: The total number of rows in the AudienceList result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: integer format: int32 UserSequenceStep: description: A condition that must occur in the specified step order for this user to match the sequence. type: object properties: stepScoping: description: This sequence step must be satisfied in the scoping for the user to match the sequence. For example if `sequenceScoping = WITHIN_SAME_SESSION`, this sequence steps must complete within one session for the user to match the sequence. `stepScoping = ACROSS_ALL_SESSIONS` is only allowed if the `sequenceScoping = ACROSS_ALL_SESSIONS`. Optional. If unspecified, `stepScoping` uses the same `UserCriteriaScoping` as the `sequenceScoping`. type: string x-enumDescriptions: - Unspecified criteria scoping. Do not specify. - If the criteria is satisfied within one event, the user matches the criteria. - If the criteria is satisfied within one session, the user matches the criteria. - If the criteria is satisfied by any events for the user, the user matches the criteria. enum: - USER_CRITERIA_SCOPING_UNSPECIFIED - USER_CRITERIA_WITHIN_SAME_EVENT - USER_CRITERIA_WITHIN_SAME_SESSION - USER_CRITERIA_ACROSS_ALL_SESSIONS segmentFilterExpression: description: A user matches this sequence step if their events match this expression. Expressions express criteria on dimension, metrics, and/or parameters. $ref: '#/components/schemas/SegmentFilterExpression' isDirectlyFollowedBy: description: If true, the event satisfying this step must be the very next event after the event satifying the last step. If false, this step indirectly follows the prior step; for example, there may be events between the prior step and this step. `isDirectlyFollowedBy` must be false for the first step. type: boolean Funnel: description: Configures the funnel in a funnel report request. A funnel reports on users as they pass through a sequence of steps. Funnel exploration lets you visualize the steps your users take to complete a task and quickly see how well they are succeeding or failing at each step. For example, how do prospects become shoppers and then become buyers? How do one time buyers become repeat buyers? With this information, you can improve inefficient or abandoned customer journeys. type: object properties: isOpenFunnel: description: In an open funnel, users can enter the funnel in any step, and in a closed funnel, users must enter the funnel in the first step. Optional. If unspecified, a closed funnel is used. type: boolean steps: items: $ref: '#/components/schemas/FunnelStep' description: The sequential steps of this funnel. type: array Status: description: 'The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).' type: object properties: code: description: The status code, which should be an enum value of google.rpc.Code. type: integer format: int32 message: description: A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. type: string details: items: type: object additionalProperties: description: Properties of the object. Contains field @type with type URL. description: A list of messages that carry the error details. There is a common set of message types for APIs to use. type: array DimensionOrderBy: description: Sorts by dimension values. type: object properties: orderType: description: Controls the rule for dimension value ordering. 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. enum: - ORDER_TYPE_UNSPECIFIED - ALPHANUMERIC - CASE_INSENSITIVE_ALPHANUMERIC - NUMERIC dimensionName: description: A dimension name in the request to order by. type: string AudienceList: description: An audience list is a list of users in an audience at the time of the list's creation. One audience may have multiple audience lists created for different days. type: object properties: state: description: Output only. The current state for this AudienceList. type: string enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - FAILED x-enumDescriptions: - Unspecified state will never be used. - The AudienceList is currently creating and will be available in the future. Creating occurs immediately after the CreateAudienceList call. - The AudienceList is fully created and ready for querying. An AudienceList is updated to active asynchronously from a request; this occurs some time (for example 15 minutes) after the initial create call. - The AudienceList failed to be created. It is possible that re-requesting this audience list will succeed. percentageCompleted: description: Output only. The percentage completed for this audience export ranging between 0 to 100. type: number format: double audienceDisplayName: description: Output only. The descriptive display name for this audience. For example, "Purchasers". type: string name: description: 'Output only. Identifier. The audience list resource name assigned during creation. This resource name identifies this `AudienceList`. Format: `properties/{property}/audienceLists/{audience_list}`' type: string audience: description: 'Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`' type: string rowCount: description: Output only. The total number of rows in the AudienceList result. type: integer format: int32 dimensions: items: $ref: '#/components/schemas/AudienceDimension' description: Required. The dimensions requested and displayed in the query response. type: array creationQuotaTokensCharged: description: Output only. The total quota tokens charged during creation of the AudienceList. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceList enters the `ACTIVE` or `FAILED` states. type: integer format: int32 recurringAudienceList: description: Output only. The recurring audience list that created this audience list. Recurring audience lists create audience lists daily. If audience lists are created directly, they will have no associated recurring audience list, and this field will be blank. type: string beginCreatingTime: description: Output only. The time when CreateAudienceList was called and the AudienceList began the `CREATING` state. type: string format: google-datetime errorMessage: description: Output only. Error message is populated when an audience list fails during creation. A common reason for such a failure is quota exhaustion. type: string webhookNotification: description: Optional. Configures webhook notifications to be sent from the Google Analytics Data API to your webhook server. Use of webhooks is optional. If unused, you'll need to poll this API to determine when an audience list is ready to be used. Webhooks allow a notification to be sent to your servers & avoid the need for polling. Either one or two POST requests will be sent to the webhook. The first POST request will be sent immediately showing the newly created audience list in its CREATING state. The second POST request will be sent after the audience list completes creation (either the ACTIVE or FAILED state). If identical audience lists are requested in quick succession, the second & subsequent audience lists can be served from cache. In that case, the audience list create method can return an audience list is already ACTIVE. In this scenario, only one POST request will be sent to the webhook. $ref: '#/components/schemas/WebhookNotification' AudienceDimensionValue: description: The value of a dimension. type: object properties: value: description: Value as a string if the dimension type is a string. type: string RunReportRequest: description: The request to generate a report. type: object properties: orderBys: items: $ref: '#/components/schemas/OrderBy' description: Optional. Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons. type: array comparisons: items: $ref: '#/components/schemas/Comparison' description: Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response. type: array conversionSpec: description: Optional. Controls conversion reporting. This field is optional. If this field is set or any conversion metrics are requested, the report will be a conversion report. $ref: '#/components/schemas/ConversionSpec' metrics: items: $ref: '#/components/schemas/Metric' description: Optional. The metrics requested and displayed. type: array metricFilter: description: Optional. The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' metricAggregations: items: type: string x-enumDescriptions: - Unspecified operator. - SUM operator. - Minimum operator. - Maximum operator. - Count operator. enum: - METRIC_AGGREGATION_UNSPECIFIED - TOTAL - MINIMUM - MAXIMUM - COUNT description: Optional. Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges. type: array returnPropertyQuota: description: Optional. Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). type: boolean limit: description: Optional. The maximum number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 currencyCode: description: Optional. A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. type: string keepEmptyRows: description: 'Optional. If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.' type: boolean dimensions: description: Optional. The dimensions requested and displayed. type: array items: $ref: '#/components/schemas/Dimension' dateRanges: description: Optional. Date ranges of data 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 event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified. type: array items: $ref: '#/components/schemas/DateRange' dimensionFilter: description: Optional. Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' offset: description: Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 cohortSpec: description: Optional. Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. $ref: '#/components/schemas/CohortSpec' DimensionHeader: description: Describes a dimension column in the report. Dimensions requested in a report produce column entries within rows and DimensionHeaders. However, dimensions used exclusively within filters or expressions do not produce columns in a report; correspondingly, those dimensions do not produce headers. type: object properties: name: description: The dimension's name. type: string FunnelFieldFilter: description: An expression to filter dimension or metric values. type: object properties: inListFilter: description: A filter for in list values. $ref: '#/components/schemas/InListFilter' fieldName: description: The dimension name or metric name. type: string numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/NumericFilter' betweenFilter: description: A filter for between two values. $ref: '#/components/schemas/BetweenFilter' stringFilter: description: Strings related filter. $ref: '#/components/schemas/StringFilter' Row: description: 'Report data for each row. For example if RunReportRequest contains: ```none "dimensions": [ { "name": "eventName" }, { "name": "countryId" } ], "metrics": [ { "name": "eventCount" } ] ``` One row with ''in_app_purchase'' as the eventName, ''JP'' as the countryId, and 15 as the eventCount, would be: ```none "dimensionValues": [ { "value": "in_app_purchase" }, { "value": "JP" } ], "metricValues": [ { "value": "15" } ] ```' type: object properties: metricValues: items: $ref: '#/components/schemas/MetricValue' description: List of requested visible metric values. type: array dimensionValues: items: $ref: '#/components/schemas/DimensionValue' description: List of requested dimension values. In a PivotReport, dimension_values are only listed for dimensions included in a pivot. type: array CheckCompatibilityResponse: description: The compatibility response with the compatibility of each dimension & metric. type: object properties: dimensionCompatibilities: items: $ref: '#/components/schemas/DimensionCompatibility' description: The compatibility of each dimension. type: array metricCompatibilities: items: $ref: '#/components/schemas/MetricCompatibility' description: The compatibility of each metric. type: array QueryAudienceExportRequest: properties: limit: description: Optional. The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 offset: description: Optional. The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 description: A request to list users in an audience export. type: object ResponseMetaData_2: properties: subjectToThresholding: description: If `subjectToThresholding` is true, this report is subject to thresholding and only returns data that meets the minimum aggregation thresholds. It is possible for a request to be subject to thresholding thresholding and no data is absent from the report, and this happens when all data is above the thresholds. To learn more, see [Data thresholds](https://support.google.com/analytics/answer/9383630). type: boolean samplingMetadatas: description: If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. One `samplingMetadatas` is populated for each date range. Each `samplingMetadatas` corresponds to a date range in order that date ranges were specified in the request. However if the results are not sampled, this field will not be defined. type: array items: $ref: '#/components/schemas/SamplingMetadata_2' schemaRestrictionResponse: description: Describes the schema restrictions actively enforced in creating this report. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). $ref: '#/components/schemas/SchemaRestrictionResponse' currencyCode: description: The currency code used in this report. Intended to be used in formatting currency metrics like `purchaseRevenue` for visualization. If currency_code was specified in the request, this response parameter will echo the request parameter; otherwise, this response parameter is the property's current currency_code. Currency codes are string encodings of currency types from the ISO 4217 standard (https://en.wikipedia.org/wiki/ISO_4217); for example "USD", "EUR", "JPY". To learn more, see https://support.google.com/analytics/answer/9796179. type: string timeZone: description: The property's current timezone. Intended to be used to interpret time-based dimensions like `hour` and `minute`. 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 dataLossFromOtherRow: description: If true, indicates some buckets of dimension combinations are rolled into "(other)" row. This can happen for high cardinality reports. The metadata parameter dataLossFromOtherRow is populated based on the aggregated data table used in the report. The parameter will be accurately populated regardless of the filters and limits in the report. For example, the (other) row could be dropped from the report because the request contains a filter on sessionSource = google. This parameter will still be populated if data loss from other row was present in the input aggregate data used to generate this report. To learn more, see [About the (other) row and data sampling](https://support.google.com/analytics/answer/13208658#reports). type: boolean emptyReason: description: If empty reason is specified, the report is empty for this reason. type: string description: Response's metadata carrying additional information about the report content. type: object Dimension_2: properties: name: description: The name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#dimensions) for the list of dimension names supported by core reporting methods such as `runReport` and `batchRunReports`. See [Realtime Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#dimensions) for the list of dimension names supported by the `runRealtimeReport` method. See [Funnel Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#dimensions) for the list of dimension names supported by the `runFunnelReport` method. If `dimensionExpression` is specified, `name` can be any string that you would like within the allowed character set. For example if a `dimensionExpression` concatenates `country` and `city`, you could call that dimension `countryAndCity`. Dimension names that you choose must match the regular expression `^[a-zA-Z0-9_]$`. Dimensions are referenced by `name` in `dimensionFilter`, `orderBys`, `dimensionExpression`, and `pivots`. type: string dimensionExpression: description: 'One dimension can be the result of an expression of multiple dimensions. For example, dimension "country, city": concatenate(country, ", ", city).' $ref: '#/components/schemas/DimensionExpression' description: Dimensions are attributes of your data. For example, the dimension city indicates the city from which an event originates. Dimension values in report responses are strings; for example, the city could be "Paris" or "New York". Requests are allowed up to 9 dimensions. type: object PivotDimensionHeader: description: Summarizes dimension values from a row for this pivot. type: object properties: dimensionValues: description: Values of multiple dimensions in a pivot. type: array items: $ref: '#/components/schemas/DimensionValue' RunPivotReportRequest: description: The request to generate a pivot report. type: object properties: returnPropertyQuota: description: Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). type: boolean dimensionFilter: description: The filter clause of dimensions. Dimensions must be requested to be used in this filter. Metrics cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' property: description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234' type: string metrics: description: 'The metrics requested, at least one metric needs to be specified. All defined metrics must be used by one of the following: metric_expression, metric_filter, order_bys.' type: array items: $ref: '#/components/schemas/Metric' comparisons: description: Optional. The configuration of comparisons requested and displayed. The request requires both a comparisons field and a comparisons dimension to receive a comparison column in the response. type: array items: $ref: '#/components/schemas/Comparison' pivots: items: $ref: '#/components/schemas/Pivot' description: Describes the visual format of the report's dimensions in columns or rows. The union of the fieldNames (dimension names) in all pivots must be a subset of dimension names defined in Dimensions. No two pivots can share a dimension. A dimension is only visible if it appears in a pivot. type: array metricFilter: description: The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Metrics must be requested to be used in this filter. Dimensions cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' cohortSpec: description: Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. $ref: '#/components/schemas/CohortSpec' dateRanges: description: The date range to retrieve event data for the report. If multiple date ranges are specified, event data from each date range is used in the report. A special dimension with field name "dateRange" can be included in a Pivot's field names; if included, the report compares between date ranges. In a cohort request, this `dateRanges` must be unspecified. type: array items: $ref: '#/components/schemas/DateRange' currencyCode: description: A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. type: string keepEmptyRows: description: 'If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.' type: boolean dimensions: description: 'The dimensions requested. All defined dimensions must be used by one of the following: dimension_expression, dimension_filter, pivots, order_bys.' type: array items: $ref: '#/components/schemas/Dimension_2' BatchRunReportsRequest: description: The batch request containing multiple report requests. type: object properties: requests: items: $ref: '#/components/schemas/RunReportRequest_2' description: Individual requests. Each request has a separate report response. Each batch request is allowed up to 5 requests. type: array MetricCompatibility: description: The compatibility for a single metric. type: object properties: metricMetadata: description: The metric metadata contains the API name for this compatibility information. The metric metadata also contains other helpful information like the UI name and description. $ref: '#/components/schemas/MetricMetadata_2' compatibility: description: The compatibility of this metric. If the compatibility is COMPATIBLE, this metric can be successfully added to the report. type: string enum: - COMPATIBILITY_UNSPECIFIED - COMPATIBLE - INCOMPATIBLE x-enumDescriptions: - Unspecified compatibility. - The dimension or metric is compatible. This dimension or metric can be successfully added to a report. - The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report. OrderBy_2: properties: dimension: description: Sorts results by a dimension's values. $ref: '#/components/schemas/DimensionOrderBy' metric: description: Sorts results by a metric's values. $ref: '#/components/schemas/MetricOrderBy' pivot: description: Sorts results by a metric's values within a pivot column group. $ref: '#/components/schemas/PivotOrderBy' desc: description: If true, sorts by descending order. type: boolean description: Order bys define how rows will be sorted in the response. For example, ordering rows by descending event count is one ordering, and ordering rows by the event name string is a different ordering. type: object V1betaAudienceDimensionValue: description: The value of a dimension. type: object properties: value: description: Value as a string if the dimension type is a string. type: string SamplingMetadata_2: description: If this report results is [sampled](https://support.google.com/analytics/answer/13331292), this describes the percentage of events used in this report. Sampling is the practice of analyzing a subset of all data in order to uncover the meaningful information in the larger data set. type: object properties: samplesReadCount: description: The total number of events read in this sampled report for a date range. This is the size of the subset this property's data that was analyzed in this report. type: string format: int64 samplingSpaceSize: description: The total number of events present in this property's data that could have been analyzed in this report for a date range. Sampling uncovers the meaningful information about the larger data set, and this is the size of the larger data set. To calculate the percentage of available data that was used in this report, compute `samplesReadCount/samplingSpaceSize`. type: string format: int64 V1betaAudienceRow: description: Dimension value attributes for the audience user row. type: object properties: dimensionValues: description: Each dimension value attribute for an audience user. One dimension value will be added for each dimension column requested. type: array items: $ref: '#/components/schemas/V1betaAudienceDimensionValue' ComparisonMetadata_2: description: The metadata for a single comparison. type: object properties: uiName: description: This comparison's name within the Google Analytics user interface. type: string apiName: description: This comparison's resource name. Useable in [Comparison](#Comparison)'s `comparison` field. For example, 'comparisons/1234'. type: string description: description: This comparison's description. type: string CheckCompatibilityRequest: properties: dimensionFilter: description: The filter clause of dimensions. `dimensionFilter` should be the same value as in your `runReport` request. $ref: '#/components/schemas/FilterExpression' metricFilter: description: The filter clause of metrics. `metricFilter` should be the same value as in your `runReport` request $ref: '#/components/schemas/FilterExpression' dimensions: description: The dimensions in this report. `dimensions` should be the same value as in your `runReport` request. type: array items: $ref: '#/components/schemas/Dimension_2' compatibilityFilter: enum: - COMPATIBILITY_UNSPECIFIED - COMPATIBLE - INCOMPATIBLE x-enumDescriptions: - Unspecified compatibility. - The dimension or metric is compatible. This dimension or metric can be successfully added to a report. - The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report. description: 'Filters the dimensions and metrics in the response to just this compatibility. Commonly used as `”compatibilityFilter”: “COMPATIBLE”` to only return compatible dimensions & metrics.' type: string metrics: description: The metrics in this report. `metrics` should be the same value as in your `runReport` request. type: array items: $ref: '#/components/schemas/Metric' description: The request for compatibility information for a report's dimensions and metrics. Check compatibility provides a preview of the compatibility of a report; fields shared with the `runReport` request should be the same values as in your `runReport` request. type: object BatchRunPivotReportsRequest: description: The batch request containing multiple pivot report requests. type: object properties: requests: description: Individual requests. Each request has a separate pivot report response. Each batch request is allowed up to 5 requests. type: array items: $ref: '#/components/schemas/RunPivotReportRequest' Metadata_2: description: The dimensions, metrics and comparisons currently accepted in reporting methods. type: object properties: name: description: Resource name of this metadata. type: string dimensions: description: The dimension descriptions. type: array items: $ref: '#/components/schemas/DimensionMetadata_2' comparisons: description: The comparison descriptions. type: array items: $ref: '#/components/schemas/ComparisonMetadata_2' metrics: description: The metric descriptions. type: array items: $ref: '#/components/schemas/MetricMetadata_2' Pivot: description: Describes the visible dimension columns and rows in the report response. type: object properties: orderBys: description: Specifies how dimensions are ordered in the pivot. In the first Pivot, the OrderBys determine Row and PivotDimensionHeader ordering; in subsequent Pivots, the OrderBys determine only PivotDimensionHeader ordering. Dimensions specified in these OrderBys must be a subset of Pivot.field_names. type: array items: $ref: '#/components/schemas/OrderBy_2' limit: description: 'The number of unique combinations of dimension values to return in this pivot. The `limit` parameter is required. A `limit` of 10,000 is common for single pivot requests. The product of the `limit` for each `pivot` in a `RunPivotReportRequest` must not exceed 250,000. For example, a two pivot request with `limit: 1000` in each pivot will fail because the product is `1,000,000`.' type: string format: int64 fieldNames: description: Dimension names for visible columns in the report response. Including "dateRange" produces a date range column; for each row in the response, dimension values in the date range column will indicate the corresponding date range from the request. type: array items: type: string metricAggregations: items: type: string x-enumDescriptions: - Unspecified operator. - SUM operator. - Minimum operator. - Maximum operator. - Count operator. enum: - METRIC_AGGREGATION_UNSPECIFIED - TOTAL - MINIMUM - MAXIMUM - COUNT description: Aggregate the metrics by dimensions in this pivot using the specified metric_aggregations. type: array offset: description: The row count of the start row. The first row is counted as row 0. type: string format: int64 RunReportResponse_2: description: The response report table corresponding to a request. type: object properties: metadata: description: Metadata for the report. $ref: '#/components/schemas/ResponseMetaData_2' rowCount: description: The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: integer format: int32 dimensionHeaders: description: Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. type: array items: $ref: '#/components/schemas/DimensionHeader' kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runReport". Useful to distinguish between response types in JSON. type: string maximums: items: $ref: '#/components/schemas/Row' description: If requested, the maximum values of metrics. type: array propertyQuota: description: This Google Analytics property's quota state including this request. $ref: '#/components/schemas/PropertyQuota' rows: items: $ref: '#/components/schemas/Row' description: Rows of dimension value combinations and metric values in the report. type: array totals: description: If requested, the totaled values of metrics. type: array items: $ref: '#/components/schemas/Row' metricHeaders: description: Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. type: array items: $ref: '#/components/schemas/MetricHeader' minimums: description: If requested, the minimum values of metrics. type: array items: $ref: '#/components/schemas/Row' DimensionMetadata_2: description: Explains a dimension. type: object properties: category: description: The display name of the category that this dimension belongs to. Similar dimensions and metrics are categorized together. type: string deprecatedApiNames: items: type: string description: Still usable but deprecated names for this dimension. If populated, this dimension is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the dimension will be available only by `apiName`. type: array description: description: Description of how this dimension is used and calculated. type: string customDefinition: description: True if the dimension is custom to this property. This includes user, event, & item scoped custom dimensions; to learn more about custom dimensions, see https://support.google.com/analytics/answer/14240153. This also include custom channel groups; to learn more about custom channel groups, see https://support.google.com/analytics/answer/13051316. type: boolean uiName: description: This dimension's name within the Google Analytics user interface. For example, `Event name`. type: string apiName: description: This dimension's name. Useable in [Dimension](#Dimension)'s `name`. For example, `eventName`. type: string BatchRunPivotReportsResponse: properties: pivotReports: description: Individual responses. Each response has a separate pivot report request. type: array items: $ref: '#/components/schemas/RunPivotReportResponse' kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#batchRunPivotReports". Useful to distinguish between response types in JSON. type: string description: The batch response containing multiple pivot reports. type: object PivotHeader: description: Dimensions' values in a single pivot. type: object properties: pivotDimensionHeaders: description: The size is the same as the cardinality of the corresponding dimension combinations. type: array items: $ref: '#/components/schemas/PivotDimensionHeader' rowCount: description: The cardinality of the pivot. The total number of rows for this pivot's fields regardless of how the parameters `offset` and `limit` are specified in the request. type: integer format: int32 RunRealtimeReportResponse: properties: metricHeaders: description: Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. type: array items: $ref: '#/components/schemas/MetricHeader' rows: description: Rows of dimension value combinations and metric values in the report. type: array items: $ref: '#/components/schemas/Row' totals: items: $ref: '#/components/schemas/Row' description: If requested, the totaled values of metrics. type: array minimums: description: If requested, the minimum values of metrics. type: array items: $ref: '#/components/schemas/Row' rowCount: description: The total number of rows in the query result. `rowCount` is independent of the number of rows returned in the response and the `limit` 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. type: integer format: int32 propertyQuota: description: This Google Analytics property's Realtime quota state including this request. $ref: '#/components/schemas/PropertyQuota' maximums: description: If requested, the maximum values of metrics. type: array items: $ref: '#/components/schemas/Row' dimensionHeaders: description: Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. type: array items: $ref: '#/components/schemas/DimensionHeader' kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runRealtimeReport". Useful to distinguish between response types in JSON. type: string description: The response realtime report table corresponding to a request. type: object V1betaAudienceDimension: description: An audience dimension is a user attribute. Specific user attributed are requested and then later returned in the `QueryAudienceExportResponse`. type: object properties: dimensionName: description: Optional. The API name of the dimension. See the [API Dimensions](https://developers.google.com/analytics/devguides/reporting/data/v1/audience-list-api-schema#dimensions) for the list of dimension names. type: string RunRealtimeReportRequest: description: The request to generate a realtime report. type: object properties: returnPropertyQuota: description: Toggles whether to return the current state of this Google Analytics property's Realtime quota. Quota is returned in [PropertyQuota](#PropertyQuota). type: boolean limit: description: The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values 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. type: string format: int64 dimensionFilter: description: The filter clause of dimensions. Metrics cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' metrics: items: $ref: '#/components/schemas/Metric' description: The metrics requested and displayed. type: array minuteRanges: description: The minute ranges of event data to read. If unspecified, one minute range for the last 30 minutes will be used. If multiple minute ranges are requested, each response row will contain a zero based minute range index. If two minute ranges overlap, the event data for the overlapping minutes is included in the response rows for both minute ranges. type: array items: $ref: '#/components/schemas/MinuteRange' metricAggregations: description: Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". type: array items: x-enumDescriptions: - Unspecified operator. - SUM operator. - Minimum operator. - Maximum operator. - Count operator. enum: - METRIC_AGGREGATION_UNSPECIFIED - TOTAL - MINIMUM - MAXIMUM - COUNT type: string metricFilter: description: The filter clause of metrics. Applied at post aggregation phase, similar to SQL having-clause. Dimensions cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' orderBys: description: Specifies how rows are ordered in the response. type: array items: $ref: '#/components/schemas/OrderBy_2' dimensions: description: The dimensions requested and displayed. type: array items: $ref: '#/components/schemas/Dimension_2' AudienceExport: properties: dimensions: description: Required. The dimensions requested and displayed in the query response. type: array items: $ref: '#/components/schemas/V1betaAudienceDimension' percentageCompleted: description: Output only. The percentage completed for this audience export ranging between 0 to 100. type: number format: double name: description: 'Output only. Identifier. The audience export resource name assigned during creation. This resource name identifies this `AudienceExport`. Format: `properties/{property}/audienceExports/{audience_export}`' type: string creationQuotaTokensCharged: description: Output only. The total quota tokens charged during creation of the AudienceExport. Because this token count is based on activity from the `CREATING` state, this tokens charged will be fixed once an AudienceExport enters the `ACTIVE` or `FAILED` states. type: integer format: int32 rowCount: description: Output only. The total number of rows in the AudienceExport result. type: integer format: int32 beginCreatingTime: description: Output only. The time when CreateAudienceExport was called and the AudienceExport began the `CREATING` state. type: string format: google-datetime audienceDisplayName: description: Output only. The descriptive display name for this audience. For example, "Purchasers". type: string audience: description: 'Required. The audience resource name. This resource name identifies the audience being listed and is shared between the Analytics Data & Admin APIs. Format: `properties/{property}/audiences/{audience}`' type: string state: description: Output only. The current state for this AudienceExport. type: string enum: - STATE_UNSPECIFIED - CREATING - ACTIVE - FAILED x-enumDescriptions: - Unspecified state will never be used. - The AudienceExport is currently creating and will be available in the future. Creating occurs immediately after the CreateAudienceExport call. - The AudienceExport is fully created and ready for querying. An AudienceExport is updated to active asynchronously from a request; this occurs some time (for example 15 minutes) after the initial create call. - The AudienceExport failed to be created. It is possible that re-requesting this audience export will succeed. errorMessage: description: Output only. Error message is populated when an audience export fails during creation. A common reason for such a failure is quota exhaustion. type: string description: An audience export is a list of users in an audience at the time of the list's creation. One audience may have multiple audience exports created for different days. type: object PivotOrderBy: description: Sorts by a pivot column group. type: object properties: metricName: description: In the response to order by, order rows by this column. Must be a metric name from the request. type: string pivotSelections: items: $ref: '#/components/schemas/PivotSelection' description: Used to select a dimension name and value pivot. If multiple pivot selections are given, the sort occurs on rows where all pivot selection dimension name and value pairs match the row's dimension name and value pair. type: array QueryAudienceExportResponse: properties: audienceRows: items: $ref: '#/components/schemas/V1betaAudienceRow' description: Rows for each user in an audience export. The number of rows in this response will be less than or equal to request's page size. type: array audienceExport: description: Configuration data about AudienceExport being queried. Returned to help interpret the audience rows in this response. For example, the dimensions in this AudienceExport correspond to the columns in the AudienceRows. $ref: '#/components/schemas/AudienceExport' rowCount: description: The total number of rows in the AudienceExport result. `rowCount` is independent of the number of rows returned in the response, the `limit` request parameter, and the `offset` request parameter. For example if a query returns 175 rows and includes `limit` of 50 in the API request, the response will contain `rowCount` of 175 but only 50 rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: integer format: int32 description: A list of users in an audience export. type: object DimensionCompatibility: properties: compatibility: enum: - COMPATIBILITY_UNSPECIFIED - COMPATIBLE - INCOMPATIBLE x-enumDescriptions: - Unspecified compatibility. - The dimension or metric is compatible. This dimension or metric can be successfully added to a report. - The dimension or metric is incompatible. This dimension or metric cannot be successfully added to a report. description: The compatibility of this dimension. If the compatibility is COMPATIBLE, this dimension can be successfully added to the report. type: string dimensionMetadata: description: The dimension metadata contains the API name for this compatibility information. The dimension metadata also contains other helpful information like the UI name and description. $ref: '#/components/schemas/DimensionMetadata_2' description: The compatibility for a single dimension. type: object PivotSelection: properties: dimensionName: description: Must be a dimension name from the request. type: string dimensionValue: description: Order by only when the named dimension is this value. type: string description: A pair of dimension names and values. Rows with this dimension pivot pair are ordered by the metric's value. For example if pivots = {{"browser", "Chrome"}} and metric_name = "Sessions", then the rows will be sorted based on Sessions in Chrome. ---------|----------|----------------|----------|---------------- | Chrome | Chrome | Safari | Safari ---------|----------|----------------|----------|---------------- Country | Sessions | Pages/Sessions | Sessions | Pages/Sessions ---------|----------|----------------|----------|---------------- US | 2 | 2 | 3 | 1 ---------|----------|----------------|----------|---------------- Canada | 3 | 1 | 4 | 1 ---------|----------|----------------|----------|---------------- type: object MetricMetadata_2: description: Explains a metric. type: object properties: apiName: description: A metric name. Useable in [Metric](#Metric)'s `name`. For example, `eventCount`. type: string type: x-enumDescriptions: - Unspecified type. - Integer type. - Floating point type. - A duration of seconds; a special floating point type. - A duration in milliseconds; a special floating point type. - A duration in minutes; a special floating point type. - A duration in hours; a special floating point type. - A custom metric of standard type; a special floating point type. - An amount of money; a special floating point type. - A length in feet; a special floating point type. - A length in miles; a special floating point type. - A length in meters; a special floating point type. - A length in kilometers; a special floating point type. enum: - METRIC_TYPE_UNSPECIFIED - TYPE_INTEGER - TYPE_FLOAT - TYPE_SECONDS - TYPE_MILLISECONDS - TYPE_MINUTES - TYPE_HOURS - TYPE_STANDARD - TYPE_CURRENCY - TYPE_FEET - TYPE_MILES - TYPE_METERS - TYPE_KILOMETERS description: The type of this metric. type: string uiName: description: This metric's name within the Google Analytics user interface. For example, `Event count`. type: string blockedReasons: description: If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see [Access and data-restriction management](https://support.google.com/analytics/answer/10851388). type: array items: type: string x-enumDescriptions: - Will never be specified in API response. - If present, your access is blocked to revenue related metrics for this property, and this metric is revenue related. - If present, your access is blocked to cost related metrics for this property, and this metric is cost related. enum: - BLOCKED_REASON_UNSPECIFIED - NO_REVENUE_METRICS - NO_COST_METRICS description: description: Description of how this metric is used and calculated. type: string customDefinition: description: True if the metric is a custom metric for this property. type: boolean deprecatedApiNames: items: type: string description: Still usable but deprecated names for this metric. If populated, this metric is available by either `apiName` or one of `deprecatedApiNames` for a period of time. After the deprecation period, the metric will be available only by `apiName`. type: array expression: description: The mathematical expression for this derived metric. Can be used in [Metric](#Metric)'s `expression` field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty. type: string category: description: The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together. type: string Filter_2: description: An expression to filter dimension or metric values. type: object properties: emptyFilter: description: A filter for empty values such as "(not set)" and "" values. $ref: '#/components/schemas/EmptyFilter' inListFilter: description: A filter for in list values. $ref: '#/components/schemas/InListFilter' stringFilter: description: Strings related filter. $ref: '#/components/schemas/StringFilter' betweenFilter: description: A filter for two values. $ref: '#/components/schemas/BetweenFilter' fieldName: description: The dimension name or metric name. In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics. type: string numericFilter: description: A filter for numeric or date values. $ref: '#/components/schemas/NumericFilter' RunReportRequest_2: properties: comparisons: items: $ref: '#/components/schemas/Comparison' description: Optional. The configuration of comparisons requested and displayed. The request only requires a comparisons field in order to receive a comparison column in the response. type: array offset: description: The row count of the start row. The first row is counted as row 0. When paging, the first request does not specify offset; or equivalently, sets offset to 0; the first request returns the first `limit` of rows. The second request sets offset to the `limit` of the first request; the second request returns the second `limit` of rows. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 limit: description: The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 250,000 rows per request, no matter how many you ask for. `limit` must be positive. The API can also return fewer rows than the requested `limit`, if there aren't as many dimension values as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). type: string format: int64 keepEmptyRows: description: 'If false or unspecified, each row with all metrics equal to 0 will not be returned. If true, these rows will be returned if they are not separately removed by a filter. Regardless of this `keep_empty_rows` setting, only data recorded by the Google Analytics property can be displayed in a report. For example if a property never logs a `purchase` event, then a query for the `eventName` dimension and `eventCount` metric will not have a row eventName: "purchase" and eventCount: 0.' type: boolean dimensions: items: $ref: '#/components/schemas/Dimension_2' description: The dimensions requested and displayed. type: array cohortSpec: description: Cohort group associated with this request. If there is a cohort group in the request the 'cohort' dimension must be present. $ref: '#/components/schemas/CohortSpec' metricFilter: description: The filter clause of metrics. Applied after aggregating the report's rows, similar to SQL having-clause. Dimensions cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' metricAggregations: description: Aggregation of metrics. Aggregated metric values will be shown in rows where the dimension_values are set to "RESERVED_(MetricAggregation)". Aggregates including both comparisons and multiple date ranges will be aggregated based on the date ranges. type: array items: type: string enum: - METRIC_AGGREGATION_UNSPECIFIED - TOTAL - MINIMUM - MAXIMUM - COUNT x-enumDescriptions: - Unspecified operator. - SUM operator. - Minimum operator. - Maximum operator. - Count operator. property: description: 'A Google Analytics property identifier whose events are tracked. Specified in the URL path and not the body. To learn more, see [where to find your Property ID](https://developers.google.com/analytics/devguides/reporting/data/v1/property-id). Within a batch request, this property should either be unspecified or consistent with the batch-level property. Example: properties/1234' type: string metrics: items: $ref: '#/components/schemas/Metric' description: The metrics requested and displayed. type: array dimensionFilter: description: Dimension filters let you ask for only specific dimension values in the report. To learn more, see [Fundamentals of Dimension Filters](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#dimension_filters) for examples. Metrics cannot be used in this filter. $ref: '#/components/schemas/FilterExpression' returnPropertyQuota: description: Toggles whether to return the current state of this Google Analytics property's quota. Quota is returned in [PropertyQuota](#PropertyQuota). type: boolean dateRanges: description: Date ranges of data 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 event data for the overlapping days is included in the response rows for both date ranges. In a cohort request, this `dateRanges` must be unspecified. type: array items: $ref: '#/components/schemas/DateRange' currencyCode: description: A currency code in ISO4217 format, such as "AED", "USD", "JPY". If the field is empty, the report uses the property's default currency. type: string orderBys: description: Specifies how rows are ordered in the response. Requests including both comparisons and multiple date ranges will have order bys applied on the comparisons. type: array items: $ref: '#/components/schemas/OrderBy_2' description: The request to generate a report. type: object RunPivotReportResponse: properties: pivotHeaders: description: 'Summarizes the columns and rows created by a pivot. Each pivot in the request produces one header in the response. If we have a request like this: "pivots": [{ "fieldNames": ["country", "city"] }, { "fieldNames": "eventName" }] We will have the following `pivotHeaders` in the response: "pivotHeaders" : [{ "dimensionHeaders": [{ "dimensionValues": [ { "value": "United Kingdom" }, { "value": "London" } ] }, { "dimensionValues": [ { "value": "Japan" }, { "value": "Osaka" } ] }] }, { "dimensionHeaders": [{ "dimensionValues": [{ "value": "session_start" }] }, { "dimensionValues": [{ "value": "scroll" }] }] }]' type: array items: $ref: '#/components/schemas/PivotHeader' metadata: description: Metadata for the report. $ref: '#/components/schemas/ResponseMetaData_2' metricHeaders: description: Describes metric columns. The number of MetricHeaders and ordering of MetricHeaders matches the metrics present in rows. type: array items: $ref: '#/components/schemas/MetricHeader' rows: description: Rows of dimension value combinations and metric values in the report. type: array items: $ref: '#/components/schemas/Row' dimensionHeaders: items: $ref: '#/components/schemas/DimensionHeader' description: Describes dimension columns. The number of DimensionHeaders and ordering of DimensionHeaders matches the dimensions present in rows. type: array kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#runPivotReport". Useful to distinguish between response types in JSON. type: string aggregates: description: Aggregation of metric values. Can be totals, minimums, or maximums. The returned aggregations are controlled by the metric_aggregations in the pivot. The type of aggregation returned in each row is shown by the dimension_values which are set to "RESERVED_". type: array items: $ref: '#/components/schemas/Row' propertyQuota: description: This Google Analytics property's quota state including this request. $ref: '#/components/schemas/PropertyQuota' description: The response pivot report table corresponding to a pivot request. type: object BatchRunReportsResponse: properties: reports: items: $ref: '#/components/schemas/RunReportResponse_2' description: Individual responses. Each response has a separate report request. type: array kind: description: Identifies what kind of resource this message is. This `kind` is always the fixed string "analyticsData#batchRunReports". Useful to distinguish between response types in JSON. type: string description: The batch response containing multiple reports. type: object ListAudienceExportsResponse: 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 audienceExports: items: $ref: '#/components/schemas/AudienceExport' description: Each audience export for a property. type: array description: A list of all audience exports for a property. type: object MinuteRange: properties: endMinutesAgo: description: 'The inclusive end minute for the query as a number of minutes before now. Cannot be before `startMinutesAgo`. For example, `"endMinutesAgo": 15` specifies the report should include event data from prior to 15 minutes ago. If unspecified, `endMinutesAgo` is defaulted to 0. Standard Analytics properties can request any minute in the last 30 minutes of event data (`endMinutesAgo <= 29`), and 360 Analytics properties can request any minute in the last 60 minutes of event data (`endMinutesAgo <= 59`).' type: integer format: int32 name: description: 'Assigns a name to this minute range. The dimension `dateRange` is valued to this name in a report response. If set, cannot begin with `date_range_` or `RESERVED_`. If not set, minute ranges are named by their zero based index in the request: `date_range_0`, `date_range_1`, etc.' type: string startMinutesAgo: description: 'The inclusive start minute for the query as a number of minutes before now. For example, `"startMinutesAgo": 29` specifies the report should include event data from 29 minutes ago and after. Cannot be after `endMinutesAgo`. If unspecified, `startMinutesAgo` is defaulted to 29. Standard Analytics properties can request up to the last 30 minutes of event data (`startMinutesAgo <= 29`), and 360 Analytics properties can request up to the last 60 minutes of event data (`startMinutesAgo <= 59`).' type: integer format: int32 description: 'A contiguous set of minutes: `startMinutesAgo`, `startMinutesAgo + 1`, ..., `endMinutesAgo`. Requests are allowed up to 2 minute ranges.' type: object securitySchemes: OAuth2: type: oauth2 description: Google OAuth 2.0. Scopes are the short form of the full https://www.googleapis.com/auth/ identifier. flows: authorizationCode: authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth tokenUrl: https://oauth2.googleapis.com/token scopes: analytics.edit: Edit Google Analytics management entities analytics.manage.users: Manage Google Analytics Account users by email address analytics.manage.users.readonly: View Google Analytics user permissions analytics.readonly: See and download your Google Analytics data BearerAuth: type: http scheme: bearer description: Google OAuth 2.0 access token presented as a bearer token. x-refined-from: - google-analytics-4-admin-v1alpha-openapi.yml - google-analytics-4-admin-v1beta-openapi.yml - google-analytics-4-data-v1alpha-openapi.yml - google-analytics-4-data-v1beta-openapi.yml