{ "ownerDomain": "google.com", "title": "Google Analytics Admin API", "description": "Manage properties in Google Analytics. Warning: Creating multiple Customer Applications, Accounts, or Projects to simulate or act as a single Customer Application, Account, or Project (respectively) or to circumvent Service-specific usage limits or quotas is a direct violation of Google Cloud Platform Terms of Service as well as Google APIs Terms of Service. These actions can result in immediate termination of your GCP project(s) without any warning.", "parameters": { "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true", "type": "boolean" }, "callback": { "location": "query", "type": "string", "description": "JSONP" }, "upload_protocol": { "type": "string", "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "alt": { "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "description": "Data format for response.", "type": "string", "enum": [ "json", "media", "proto" ] }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "key": { "type": "string", "location": "query", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "location": "query", "type": "string", "enum": [ "1", "2" ], "description": "V1 error format." }, "quotaUser": { "type": "string", "location": "query", "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters." }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" } }, "kind": "discovery#restDescription", "baseUrl": "https://analyticsadmin.googleapis.com/", "id": "analyticsadmin:v1beta", "discoveryVersion": "v1", "canonicalName": "Google Analytics Admin", "basePath": "", "batchPath": "batch", "version": "v1beta", "fullyEncodeReservedExpansion": true, "ownerName": "Google", "name": "analyticsadmin", "resources": { "properties": { "methods": { "get": { "id": "analyticsadmin.properties.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "v1beta/{+name}", "flatPath": "v1beta/properties/{propertiesId}", "description": "Lookup for a single GA Property.", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "description": "Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"", "pattern": "^properties/[^/]+$", "type": "string", "required": true } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaProperty" } }, "delete": { "response": { "$ref": "GoogleAnalyticsAdminV1betaProperty" }, "id": "analyticsadmin.properties.delete", "flatPath": "v1beta/properties/{propertiesId}", "parameterOrder": [ "name" ], "httpMethod": "DELETE", "parameters": { "name": { "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string", "description": "Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"" } }, "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "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." }, "getDataRetentionSettings": { "description": "Returns the singleton data retention settings for this property.", "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "id": "analyticsadmin.properties.getDataRetentionSettings", "parameters": { "name": { "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"", "type": "string", "required": true, "pattern": "^properties/[^/]+/dataRetentionSettings$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" }, "httpMethod": "GET", "flatPath": "v1beta/properties/{propertiesId}/dataRetentionSettings" }, "updateDataRetentionSettings": { "response": { "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "v1beta/{+name}", "flatPath": "v1beta/properties/{propertiesId}/dataRetentionSettings", "httpMethod": "PATCH", "parameters": { "updateMask": { "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.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "required": true, "location": "path", "type": "string", "description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", "pattern": "^properties/[^/]+/dataRetentionSettings$" } }, "description": "Updates the singleton data retention settings for this property.", "id": "analyticsadmin.properties.updateDataRetentionSettings", "parameterOrder": [ "name" ], "request": { "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" } }, "list": { "response": { "$ref": "GoogleAnalyticsAdminV1betaListPropertiesResponse" }, "flatPath": "v1beta/properties", "httpMethod": "GET", "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": { "pageSize": { "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)", "location": "query" }, "showDeleted": { "type": "boolean", "location": "query", "description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not." }, "filter": { "type": "string", "location": "query", "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. | ```" }, "pageToken": { "type": "string", "location": "query", "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." } }, "parameterOrder": [], "id": "analyticsadmin.properties.list", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "v1beta/properties" }, "runAccessReport": { "flatPath": "v1beta/properties/{propertiesId}:runAccessReport", "id": "analyticsadmin.properties.runAccessReport", "parameters": { "entity": { "pattern": "^properties/[^/]+$", "location": "path", "type": "string", "required": true, "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." } }, "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.", "response": { "$ref": "GoogleAnalyticsAdminV1betaRunAccessReportResponse" }, "request": { "$ref": "GoogleAnalyticsAdminV1betaRunAccessReportRequest" }, "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameterOrder": [ "entity" ], "path": "v1beta/{+entity}:runAccessReport" }, "acknowledgeUserDataCollection": { "id": "analyticsadmin.properties.acknowledgeUserDataCollection", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "flatPath": "v1beta/properties/{propertiesId}:acknowledgeUserDataCollection", "request": { "$ref": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest" }, "response": { "$ref": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse" }, "parameters": { "property": { "pattern": "^properties/[^/]+$", "type": "string", "location": "path", "description": "Required. The property for which to acknowledge user data collection.", "required": true } }, "parameterOrder": [ "property" ], "httpMethod": "POST", "path": "v1beta/{+property}:acknowledgeUserDataCollection", "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." }, "create": { "httpMethod": "POST", "flatPath": "v1beta/properties", "parameterOrder": [], "response": { "$ref": "GoogleAnalyticsAdminV1betaProperty" }, "path": "v1beta/properties", "description": "Creates a Google Analytics property with the specified location and attributes.", "request": { "$ref": "GoogleAnalyticsAdminV1betaProperty" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": {}, "id": "analyticsadmin.properties.create" }, "patch": { "parameterOrder": [ "name" ], "flatPath": "v1beta/properties/{propertiesId}", "parameters": { "name": { "pattern": "^properties/[^/]+$", "type": "string", "location": "path", "required": true, "description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"" }, "updateMask": { "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.", "type": "string", "format": "google-fieldmask", "location": "query" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaProperty" }, "id": "analyticsadmin.properties.patch", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PATCH", "request": { "$ref": "GoogleAnalyticsAdminV1betaProperty" }, "description": "Updates a property.", "path": "v1beta/{+name}" } }, "resources": { "customDimensions": { "methods": { "create": { "path": "v1beta/{+parent}/customDimensions", "flatPath": "v1beta/properties/{propertiesId}/customDimensions", "request": { "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" }, "parameters": { "parent": { "location": "path", "pattern": "^properties/[^/]+$", "description": "Required. Example format: properties/1234", "type": "string", "required": true } }, "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/).", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "POST", "id": "analyticsadmin.properties.customDimensions.create" }, "get": { "parameters": { "name": { "required": true, "type": "string", "location": "path", "description": "Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678", "pattern": "^properties/[^/]+/customDimensions/[^/]+$" } }, "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Lookup for a single CustomDimension.", "id": "analyticsadmin.properties.customDimensions.get", "path": "v1beta/{+name}", "response": { "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" }, "httpMethod": "GET", "flatPath": "v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}" }, "list": { "path": "v1beta/{+parent}/customDimensions", "id": "analyticsadmin.properties.customDimensions.list", "response": { "$ref": "GoogleAnalyticsAdminV1betaListCustomDimensionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameters": { "parent": { "type": "string", "location": "path", "required": true, "pattern": "^properties/[^/]+$", "description": "Required. Example format: properties/1234" }, "pageSize": { "location": "query", "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).", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "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.", "type": "string" } }, "description": "Lists CustomDimensions on a property.", "flatPath": "v1beta/properties/{propertiesId}/customDimensions", "httpMethod": "GET", "parameterOrder": [ "parent" ] }, "archive": { "httpMethod": "POST", "description": "Archives a CustomDimension on a property.", "request": { "$ref": "GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest" }, "path": "v1beta/{+name}:archive", "response": { "$ref": "GoogleProtobufEmpty" }, "id": "analyticsadmin.properties.customDimensions.archive", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": { "name": { "type": "string", "description": "Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678", "required": true, "pattern": "^properties/[^/]+/customDimensions/[^/]+$", "location": "path" } }, "parameterOrder": [ "name" ], "flatPath": "v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive" }, "patch": { "response": { "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": { "name": { "required": true, "location": "path", "description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", "type": "string", "pattern": "^properties/[^/]+/customDimensions/[^/]+$" }, "updateMask": { "type": "string", "location": "query", "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.", "format": "google-fieldmask" } }, "description": "Updates a CustomDimension on a property.", "flatPath": "v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}", "id": "analyticsadmin.properties.customDimensions.patch", "httpMethod": "PATCH", "request": { "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" } } } }, "firebaseLinks": { "methods": { "create": { "request": { "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink" }, "id": "analyticsadmin.properties.firebaseLinks.create", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "v1beta/{+parent}/firebaseLinks", "description": "Creates a FirebaseLink. Properties can have at most one FirebaseLink.", "parameters": { "parent": { "location": "path", "description": "Required. Format: properties/{property_id} Example: `properties/1234`", "required": true, "pattern": "^properties/[^/]+$", "type": "string" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink" }, "flatPath": "v1beta/properties/{propertiesId}/firebaseLinks", "parameterOrder": [ "parent" ] }, "delete": { "id": "analyticsadmin.properties.firebaseLinks.delete", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`" } }, "flatPath": "v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}", "parameterOrder": [ "name" ], "description": "Deletes a FirebaseLink on a property", "httpMethod": "DELETE", "path": "v1beta/{+name}", "response": { "$ref": "GoogleProtobufEmpty" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ] }, "list": { "parameterOrder": [ "parent" ], "description": "Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.", "response": { "$ref": "GoogleAnalyticsAdminV1betaListFirebaseLinksResponse" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameters": { "parent": { "required": true, "type": "string", "location": "path", "pattern": "^properties/[^/]+$", "description": "Required. Format: properties/{property_id} Example: `properties/1234`" }, "pageToken": { "type": "string", "location": "query", "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." }, "pageSize": { "location": "query", "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)" } }, "flatPath": "v1beta/properties/{propertiesId}/firebaseLinks", "httpMethod": "GET", "id": "analyticsadmin.properties.firebaseLinks.list", "path": "v1beta/{+parent}/firebaseLinks" } } }, "googleAdsLinks": { "methods": { "list": { "parameters": { "pageSize": { "location": "query", "format": "int32", "type": "integer", "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)." }, "parent": { "type": "string", "description": "Required. Example format: properties/1234", "pattern": "^properties/[^/]+$", "required": true, "location": "path" }, "pageToken": { "location": "query", "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.", "type": "string" } }, "parameterOrder": [ "parent" ], "id": "analyticsadmin.properties.googleAdsLinks.list", "description": "Lists GoogleAdsLinks on a property.", "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks", "response": { "$ref": "GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "v1beta/{+parent}/googleAdsLinks" }, "patch": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PATCH", "description": "Updates a GoogleAdsLink on a property", "response": { "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" }, "request": { "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" }, "parameterOrder": [ "name" ], "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}", "path": "v1beta/{+name}", "id": "analyticsadmin.properties.googleAdsLinks.patch", "parameters": { "name": { "description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", "required": true, "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", "location": "path", "type": "string" }, "updateMask": { "location": "query", "type": "string", "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.", "format": "google-fieldmask" } } }, "create": { "id": "analyticsadmin.properties.googleAdsLinks.create", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" }, "parameters": { "parent": { "type": "string", "description": "Required. Example format: properties/1234", "required": true, "pattern": "^properties/[^/]+$", "location": "path" } }, "request": { "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" }, "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks", "path": "v1beta/{+parent}/googleAdsLinks", "parameterOrder": [ "parent" ], "httpMethod": "POST", "description": "Creates a GoogleAdsLink." }, "delete": { "description": "Deletes a GoogleAdsLink on a property", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "name" ], "httpMethod": "DELETE", "path": "v1beta/{+name}", "flatPath": "v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}", "id": "analyticsadmin.properties.googleAdsLinks.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", "required": true, "description": "Required. Example format: properties/1234/googleAdsLinks/5678", "type": "string" } } } } }, "keyEvents": { "methods": { "get": { "response": { "$ref": "GoogleAnalyticsAdminV1betaKeyEvent" }, "httpMethod": "GET", "flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "id": "analyticsadmin.properties.keyEvents.get", "description": "Retrieves a single Key Event.", "parameterOrder": [ "name" ], "parameters": { "name": { "description": "Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"", "pattern": "^properties/[^/]+/keyEvents/[^/]+$", "type": "string", "required": true, "location": "path" } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "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)", "location": "query" }, "parent": { "type": "string", "description": "Required. The resource name of the parent property. Example: 'properties/123'", "required": true, "pattern": "^properties/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "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.", "type": "string" } }, "id": "analyticsadmin.properties.keyEvents.list", "response": { "$ref": "GoogleAnalyticsAdminV1betaListKeyEventsResponse" }, "httpMethod": "GET", "path": "v1beta/{+parent}/keyEvents", "flatPath": "v1beta/properties/{propertiesId}/keyEvents" }, "patch": { "id": "analyticsadmin.properties.keyEvents.patch", "request": { "$ref": "GoogleAnalyticsAdminV1betaKeyEvent" }, "description": "Updates a Key Event.", "flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", "parameters": { "updateMask": { "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.", "location": "query" }, "name": { "description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}", "location": "path", "pattern": "^properties/[^/]+/keyEvents/[^/]+$", "required": true, "type": "string" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaKeyEvent" }, "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PATCH" }, "create": { "request": { "$ref": "GoogleAnalyticsAdminV1betaKeyEvent" }, "parameters": { "parent": { "description": "Required. The resource name of the parent property where this Key Event will be created. Format: properties/123", "location": "path", "type": "string", "pattern": "^properties/[^/]+$", "required": true } }, "path": "v1beta/{+parent}/keyEvents", "parameterOrder": [ "parent" ], "flatPath": "v1beta/properties/{propertiesId}/keyEvents", "description": "Creates a Key Event.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaKeyEvent" }, "httpMethod": "POST", "id": "analyticsadmin.properties.keyEvents.create" }, "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}", "parameters": { "name": { "location": "path", "pattern": "^properties/[^/]+/keyEvents/[^/]+$", "required": true, "description": "Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"", "type": "string" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "id": "analyticsadmin.properties.keyEvents.delete", "path": "v1beta/{+name}", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "description": "Deletes a Key Event.", "httpMethod": "DELETE" } } }, "customMetrics": { "methods": { "patch": { "request": { "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" }, "response": { "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" }, "path": "v1beta/{+name}", "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "type": "string", "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": { "location": "path", "type": "string", "required": true, "pattern": "^properties/[^/]+/customMetrics/[^/]+$", "description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}" } }, "description": "Updates a CustomMetric on a property.", "flatPath": "v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.customMetrics.patch", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "name" ] }, "get": { "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^properties/[^/]+/customMetrics/[^/]+$", "description": "Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" }, "id": "analyticsadmin.properties.customMetrics.get", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "flatPath": "v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}", "description": "Lookup for a single CustomMetric.", "path": "v1beta/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ] }, "list": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameters": { "parent": { "description": "Required. Example format: properties/1234", "required": true, "location": "path", "pattern": "^properties/[^/]+$", "type": "string" }, "pageSize": { "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).", "type": "integer", "location": "query", "format": "int32" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/customMetrics", "response": { "$ref": "GoogleAnalyticsAdminV1betaListCustomMetricsResponse" }, "httpMethod": "GET", "flatPath": "v1beta/properties/{propertiesId}/customMetrics", "id": "analyticsadmin.properties.customMetrics.list", "description": "Lists CustomMetrics on a property." }, "archive": { "request": { "$ref": "GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analyticsadmin.properties.customMetrics.archive", "parameterOrder": [ "name" ], "httpMethod": "POST", "description": "Archives a CustomMetric on a property.", "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "type": "string", "required": true, "description": "Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678", "location": "path", "pattern": "^properties/[^/]+/customMetrics/[^/]+$" } }, "path": "v1beta/{+name}:archive", "flatPath": "v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}:archive" }, "create": { "id": "analyticsadmin.properties.customMetrics.create", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "v1beta/{+parent}/customMetrics", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. Example format: properties/1234", "pattern": "^properties/[^/]+$", "location": "path" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" }, "description": "Creates a CustomMetric.", "request": { "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" }, "flatPath": "v1beta/properties/{propertiesId}/customMetrics" } } }, "dataStreams": { "methods": { "list": { "parameters": { "pageSize": { "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).", "location": "query", "type": "integer" }, "parent": { "description": "Required. Example format: properties/1234", "required": true, "location": "path", "type": "string", "pattern": "^properties/[^/]+$" }, "pageToken": { "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.", "location": "query", "type": "string" } }, "id": "analyticsadmin.properties.dataStreams.list", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaListDataStreamsResponse" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "v1beta/{+parent}/dataStreams", "httpMethod": "GET", "description": "Lists DataStreams on a property.", "flatPath": "v1beta/properties/{propertiesId}/dataStreams" }, "create": { "request": { "$ref": "GoogleAnalyticsAdminV1betaDataStream" }, "parameters": { "parent": { "pattern": "^properties/[^/]+$", "location": "path", "type": "string", "required": true, "description": "Required. Example format: properties/1234" } }, "parameterOrder": [ "parent" ], "id": "analyticsadmin.properties.dataStreams.create", "path": "v1beta/{+parent}/dataStreams", "flatPath": "v1beta/properties/{propertiesId}/dataStreams", "response": { "$ref": "GoogleAnalyticsAdminV1betaDataStream" }, "httpMethod": "POST", "description": "Creates a DataStream.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ] }, "delete": { "description": "Deletes a DataStream on a property.", "parameters": { "name": { "required": true, "location": "path", "type": "string", "description": "Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678", "pattern": "^properties/[^/]+/dataStreams/[^/]+$" } }, "response": { "$ref": "GoogleProtobufEmpty" }, "parameterOrder": [ "name" ], "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analyticsadmin.properties.dataStreams.delete", "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}", "path": "v1beta/{+name}" }, "get": { "description": "Lookup for a single DataStream.", "parameters": { "name": { "type": "string", "pattern": "^properties/[^/]+/dataStreams/[^/]+$", "location": "path", "description": "Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678", "required": true } }, "id": "analyticsadmin.properties.dataStreams.get", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaDataStream" }, "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}" }, "patch": { "request": { "$ref": "GoogleAnalyticsAdminV1betaDataStream" }, "description": "Updates a DataStream on a property.", "id": "analyticsadmin.properties.dataStreams.patch", "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}", "path": "v1beta/{+name}", "response": { "$ref": "GoogleAnalyticsAdminV1betaDataStream" }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "parameters": { "updateMask": { "format": "google-fieldmask", "type": "string", "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.", "location": "query" }, "name": { "required": true, "description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", "location": "path", "type": "string", "pattern": "^properties/[^/]+/dataStreams/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ] } }, "resources": { "measurementProtocolSecrets": { "methods": { "create": { "description": "Creates a measurement protocol secret.", "path": "v1beta/{+parent}/measurementProtocolSecrets", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" }, "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets", "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.create", "parameterOrder": [ "parent" ], "request": { "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" }, "parameters": { "parent": { "type": "string", "description": "Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}", "required": true, "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+$" } } }, "delete": { "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "description": "Deletes target MeasurementProtocolSecret.", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$" } }, "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.delete", "response": { "$ref": "GoogleProtobufEmpty" }, "httpMethod": "DELETE", "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}" }, "patch": { "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.patch", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "v1beta/{+name}", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "parameters": { "name": { "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", "required": true, "type": "string", "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}" }, "updateMask": { "format": "google-fieldmask", "type": "string", "description": "Required. The list of fields to be updated. Omitted fields will not be updated.", "location": "query" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" }, "description": "Updates a measurement protocol secret.", "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", "request": { "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" } }, "list": { "parameters": { "pageSize": { "location": "query", "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.", "type": "integer" }, "pageToken": { "location": "query", "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." }, "parent": { "type": "string", "description": "Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets", "pattern": "^properties/[^/]+/dataStreams/[^/]+$", "required": true, "location": "path" } }, "response": { "$ref": "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse" }, "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "v1beta/{+parent}/measurementProtocolSecrets", "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.list", "parameterOrder": [ "parent" ], "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", "httpMethod": "GET" }, "get": { "path": "v1beta/{+name}", "flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", "id": "analyticsadmin.properties.dataStreams.measurementProtocolSecrets.get", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" }, "description": "Lookup for a single MeasurementProtocolSecret.", "httpMethod": "GET", "parameters": { "name": { "pattern": "^properties/[^/]+/dataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", "description": "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", "type": "string", "required": true, "location": "path" } }, "parameterOrder": [ "name" ] } } } } }, "conversionEvents": { "methods": { "create": { "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "deprecated": true, "request": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" }, "id": "analyticsadmin.properties.conversionEvents.create", "response": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" }, "httpMethod": "POST", "parameters": { "parent": { "description": "Required. The resource name of the parent property where this conversion event will be created. Format: properties/123", "type": "string", "pattern": "^properties/[^/]+$", "required": true, "location": "path" } }, "path": "v1beta/{+parent}/conversionEvents", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameterOrder": [ "parent" ] }, "delete": { "parameterOrder": [ "name" ], "response": { "$ref": "GoogleProtobufEmpty" }, "parameters": { "name": { "location": "path", "type": "string", "required": true, "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\"" } }, "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "id": "analyticsadmin.properties.conversionEvents.delete", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "deprecated": true, "path": "v1beta/{+name}" }, "get": { "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameterOrder": [ "name" ], "httpMethod": "GET", "path": "v1beta/{+name}", "description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "parameters": { "name": { "required": true, "location": "path", "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\"", "type": "string" } }, "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "id": "analyticsadmin.properties.conversionEvents.get", "response": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" } }, "list": { "deprecated": true, "path": "v1beta/{+parent}/conversionEvents", "httpMethod": "GET", "parameterOrder": [ "parent" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaListConversionEventsResponse" }, "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.", "parameters": { "parent": { "type": "string", "required": true, "description": "Required. The resource name of the parent property. Example: 'properties/123'", "location": "path", "pattern": "^properties/[^/]+$" }, "pageSize": { "location": "query", "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)", "type": "integer", "format": "int32" }, "pageToken": { "location": "query", "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." } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "id": "analyticsadmin.properties.conversionEvents.list", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents" }, "patch": { "parameterOrder": [ "name" ], "description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "deprecated": true, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "httpMethod": "PATCH", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "parameters": { "updateMask": { "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.", "type": "string", "location": "query", "format": "google-fieldmask" }, "name": { "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", "type": "string", "required": true, "description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", "location": "path" } }, "path": "v1beta/{+name}", "response": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" }, "request": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" }, "id": "analyticsadmin.properties.conversionEvents.patch" } }, "deprecated": true } } }, "accounts": { "methods": { "delete": { "parameterOrder": [ "name" ], "flatPath": "v1beta/accounts/{accountsId}", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "response": { "$ref": "GoogleProtobufEmpty" }, "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^accounts/[^/]+$", "description": "Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"" } }, "id": "analyticsadmin.accounts.delete", "path": "v1beta/{+name}" }, "get": { "id": "analyticsadmin.accounts.get", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Lookup for a single Account.", "httpMethod": "GET", "flatPath": "v1beta/accounts/{accountsId}", "parameters": { "name": { "location": "path", "pattern": "^accounts/[^/]+$", "type": "string", "required": true, "description": "Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"" } }, "parameterOrder": [ "name" ], "path": "v1beta/{+name}", "response": { "$ref": "GoogleAnalyticsAdminV1betaAccount" } }, "patch": { "parameterOrder": [ "name" ], "httpMethod": "PATCH", "id": "analyticsadmin.accounts.patch", "path": "v1beta/{+name}", "request": { "$ref": "GoogleAnalyticsAdminV1betaAccount" }, "description": "Updates an account.", "response": { "$ref": "GoogleAnalyticsAdminV1betaAccount" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "parameters": { "updateMask": { "type": "string", "description": "Required. The list of fields to be updated. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", "format": "google-fieldmask", "location": "query" }, "name": { "required": true, "description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", "location": "path", "pattern": "^accounts/[^/]+$", "type": "string" } }, "flatPath": "v1beta/accounts/{accountsId}" }, "list": { "flatPath": "v1beta/accounts", "parameterOrder": [], "response": { "$ref": "GoogleAnalyticsAdminV1betaListAccountsResponse" }, "httpMethod": "GET", "id": "analyticsadmin.accounts.list", "parameters": { "pageSize": { "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)", "format": "int32", "type": "integer", "location": "query" }, "showDeleted": { "location": "query", "type": "boolean", "description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not." }, "pageToken": { "location": "query", "description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "description": "Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using `ListAccountSummaries`.", "path": "v1beta/accounts" }, "runAccessReport": { "parameters": { "entity": { "required": true, "location": "path", "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.", "type": "string", "pattern": "^accounts/[^/]+$" } }, "path": "v1beta/{+entity}:runAccessReport", "request": { "$ref": "GoogleAnalyticsAdminV1betaRunAccessReportRequest" }, "id": "analyticsadmin.accounts.runAccessReport", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "parameterOrder": [ "entity" ], "flatPath": "v1beta/accounts/{accountsId}:runAccessReport", "httpMethod": "POST", "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.", "response": { "$ref": "GoogleAnalyticsAdminV1betaRunAccessReportResponse" } }, "searchChangeHistoryEvents": { "id": "analyticsadmin.accounts.searchChangeHistoryEvents", "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "path": "v1beta/{+account}:searchChangeHistoryEvents", "request": { "$ref": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest" }, "description": "Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes.", "parameterOrder": [ "account" ], "flatPath": "v1beta/accounts/{accountsId}:searchChangeHistoryEvents", "response": { "$ref": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse" }, "parameters": { "account": { "location": "path", "pattern": "^accounts/[^/]+$", "required": true, "type": "string", "description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`" } } }, "provisionAccountTicket": { "request": { "$ref": "GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest" }, "flatPath": "v1beta/accounts:provisionAccountTicket", "httpMethod": "POST", "response": { "$ref": "GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse" }, "parameterOrder": [], "description": "Requests a ticket for creating an account.", "path": "v1beta/accounts:provisionAccountTicket", "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ], "id": "analyticsadmin.accounts.provisionAccountTicket", "parameters": {} }, "getDataSharingSettings": { "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "response": { "$ref": "GoogleAnalyticsAdminV1betaDataSharingSettings" }, "path": "v1beta/{+name}", "flatPath": "v1beta/accounts/{accountsId}/dataSharingSettings", "id": "analyticsadmin.accounts.getDataSharingSettings", "parameters": { "name": { "required": true, "location": "path", "type": "string", "pattern": "^accounts/[^/]+/dataSharingSettings$", "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`" } }, "httpMethod": "GET", "description": "Get data sharing settings on an account. Data sharing settings are singletons.", "parameterOrder": [ "name" ] } } }, "accountSummaries": { "methods": { "list": { "parameters": { "pageSize": { "format": "int32", "description": "Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "location": "query", "type": "integer" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token." } }, "parameterOrder": [], "description": "Returns summaries of all accounts accessible by the caller.", "id": "analyticsadmin.accountSummaries.list", "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ], "path": "v1beta/accountSummaries", "flatPath": "v1beta/accountSummaries", "httpMethod": "GET", "response": { "$ref": "GoogleAnalyticsAdminV1betaListAccountSummariesResponse" } } } } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/analytics.readonly": { "description": "See and download your Google Analytics data" }, "https://www.googleapis.com/auth/analytics.edit": { "description": "Edit Google Analytics management entities" } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "schemas": { "GoogleAnalyticsAdminV1betaKeyEvent": { "id": "GoogleAnalyticsAdminV1betaKeyEvent", "type": "object", "description": "A key event in a Google Analytics property.", "properties": { "deletable": { "description": "Output only. If set to true, this event can be deleted.", "readOnly": true, "type": "boolean" }, "createTime": { "readOnly": true, "type": "string", "description": "Output only. Time when this key event was created in the property.", "format": "google-datetime" }, "custom": { "readOnly": true, "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": { "type": "string", "description": "Immutable. The event name for this key event. Examples: 'click', 'purchase'" }, "countingMethod": { "description": "Required. The method by which Key Events will be counted across multiple events within a session.", "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." ], "type": "string", "enum": [ "COUNTING_METHOD_UNSPECIFIED", "ONCE_PER_EVENT", "ONCE_PER_SESSION" ] }, "name": { "readOnly": true, "type": "string", "description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}" }, "defaultValue": { "description": "Optional. Defines a default value/currency for a key event.", "$ref": "GoogleAnalyticsAdminV1betaKeyEventDefaultValue" } } }, "GoogleAnalyticsAdminV1betaListAccountSummariesResponse": { "id": "GoogleAnalyticsAdminV1betaListAccountSummariesResponse", "description": "Response message for ListAccountSummaries RPC.", "type": "object", "properties": { "accountSummaries": { "type": "array", "description": "Account summaries of all accounts the caller has access to.", "items": { "$ref": "GoogleAnalyticsAdminV1betaAccountSummary" } }, "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" } } }, "GoogleAnalyticsAdminV1betaListFirebaseLinksResponse": { "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. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.", "type": "string" }, "firebaseLinks": { "items": { "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink" }, "description": "List of FirebaseLinks. This will have at most one value.", "type": "array" } }, "description": "Response message for ListFirebaseLinks RPC", "type": "object", "id": "GoogleAnalyticsAdminV1betaListFirebaseLinksResponse" }, "GoogleAnalyticsAdminV1betaGoogleAdsLink": { "id": "GoogleAnalyticsAdminV1betaGoogleAdsLink", "type": "object", "description": "A link between a Google Analytics property and a Google Ads account.", "properties": { "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Time when this link was last updated.", "readOnly": true }, "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.", "readOnly": true, "type": "string" }, "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" }, "createTime": { "description": "Output only. Time when this link was originally created.", "format": "google-datetime", "readOnly": true, "type": "string" }, "name": { "description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", "type": "string" }, "canManageClients": { "readOnly": true, "type": "boolean", "description": "Output only. If true, this link is for a Google Ads manager account." }, "customerId": { "type": "string", "description": "Immutable. Google Ads customer ID." } } }, "GoogleAnalyticsAdminV1betaListPropertiesResponse": { "description": "Response message for ListProperties RPC.", "type": "object", "properties": { "properties": { "description": "Results that matched the filter criteria and were accessible to the caller.", "items": { "$ref": "GoogleAnalyticsAdminV1betaProperty" }, "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" } }, "id": "GoogleAnalyticsAdminV1betaListPropertiesResponse" }, "GoogleAnalyticsAdminV1betaDataStream": { "properties": { "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" }, "updateTime": { "format": "google-datetime", "description": "Output only. Time when stream payload fields were last updated.", "readOnly": true, "type": "string" }, "createTime": { "format": "google-datetime", "readOnly": true, "description": "Output only. Time when this stream was originally created.", "type": "string" }, "webStreamData": { "description": "Data specific to web streams. Must be populated if type is WEB_DATA_STREAM.", "$ref": "GoogleAnalyticsAdminV1betaDataStreamWebStreamData" }, "androidAppStreamData": { "description": "Data specific to Android app streams. Must be populated if type is ANDROID_APP_DATA_STREAM.", "$ref": "GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData" }, "name": { "type": "string", "description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"" }, "type": { "type": "string", "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.", "enumDescriptions": [ "Type unknown or not specified.", "Web data stream.", "Android app data stream.", "iOS app data stream." ] }, "iosAppStreamData": { "description": "Data specific to iOS app streams. Must be populated if type is IOS_APP_DATA_STREAM.", "$ref": "GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData" } }, "id": "GoogleAnalyticsAdminV1betaDataStream", "description": "A resource message representing a data stream.", "type": "object" }, "GoogleAnalyticsAdminV1betaListDataStreamsResponse": { "id": "GoogleAnalyticsAdminV1betaListDataStreamsResponse", "description": "Response message for ListDataStreams 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" }, "dataStreams": { "description": "List of DataStreams.", "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaDataStream" } } } }, "GoogleAnalyticsAdminV1betaAccount": { "properties": { "deleted": { "type": "boolean", "readOnly": true, "description": "Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested." }, "regionCode": { "description": "Country of business. Must be a Unicode CLDR region code.", "type": "string" }, "createTime": { "description": "Output only. Time when this account was originally created.", "type": "string", "format": "google-datetime", "readOnly": true }, "displayName": { "description": "Required. Human-readable display name for this account.", "type": "string" }, "updateTime": { "description": "Output only. Time when account payload fields were last updated.", "format": "google-datetime", "type": "string", "readOnly": true }, "name": { "description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", "type": "string" }, "gmpOrganization": { "readOnly": true, "description": "Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}", "type": "string" } }, "id": "GoogleAnalyticsAdminV1betaAccount", "type": "object", "description": "A resource message representing a Google Analytics account." }, "GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy": { "type": "object", "description": "Sorts by dimension values.", "properties": { "orderType": { "description": "Controls the rule for dimension value ordering.", "enumDescriptions": [ "Unspecified.", "Alphanumeric sort by Unicode code point. For example, \"2\" \u003c \"A\" \u003c \"X\" \u003c \"b\" \u003c \"z\".", "Case insensitive alphanumeric sort by lower case Unicode code point. For example, \"2\" \u003c \"A\" \u003c \"b\" \u003c \"X\" \u003c \"z\".", "Dimension values are converted to numbers before sorting. For example in NUMERIC sort, \"25\" \u003c \"100\", and in `ALPHANUMERIC` sort, \"100\" \u003c \"25\". Non-numeric dimension values all have equal ordering value below all numeric values." ], "type": "string", "enum": [ "ORDER_TYPE_UNSPECIFIED", "ALPHANUMERIC", "CASE_INSENSITIVE_ALPHANUMERIC", "NUMERIC" ] }, "dimensionName": { "description": "A dimension name in the request to order by.", "type": "string" } }, "id": "GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy" }, "GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse": { "description": "Response message for ListGoogleAdsLinks RPC.", "type": "object", "properties": { "googleAdsLinks": { "description": "List of GoogleAdsLinks.", "items": { "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" }, "type": "array" }, "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." } }, "id": "GoogleAnalyticsAdminV1betaListGoogleAdsLinksResponse" }, "GoogleProtobufEmpty": { "id": "GoogleProtobufEmpty", "properties": {}, "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); }" }, "GoogleAnalyticsAdminV1betaChangeHistoryEvent": { "id": "GoogleAnalyticsAdminV1betaChangeHistoryEvent", "type": "object", "properties": { "actorType": { "type": "string", "enum": [ "ACTOR_TYPE_UNSPECIFIED", "USER", "SYSTEM", "SUPPORT" ], "description": "The type of actor that made this change.", "enumDescriptions": [ "Unknown or unspecified actor type.", "Changes made by the user specified in actor_email.", "Changes made by the Google Analytics system.", "Changes made by Google Analytics support team staff." ] }, "userActorEmail": { "description": "Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.", "type": "string" }, "changesFiltered": { "type": "boolean", "description": "If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event." }, "id": { "description": "ID of this change history event. This ID is unique across Google Analytics.", "type": "string" }, "changes": { "description": "A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.", "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryChange" } }, "changeTime": { "description": "Time when change was made.", "format": "google-datetime", "type": "string" } }, "description": "A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes." }, "GoogleAnalyticsAdminV1betaAccessDimension": { "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": { "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" } }, "type": "object", "id": "GoogleAnalyticsAdminV1betaAccessDimension" }, "GoogleAnalyticsAdminV1betaCustomMetric": { "type": "object", "id": "GoogleAnalyticsAdminV1betaCustomMetric", "description": "A definition for a custom metric.", "properties": { "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.", "items": { "type": "string", "enum": [ "RESTRICTED_METRIC_TYPE_UNSPECIFIED", "COST_DATA", "REVENUE_DATA" ], "enumDescriptions": [ "Type unknown or unspecified.", "Metric reports cost data.", "Metric reports revenue data." ] }, "type": "array" }, "parameterName": { "type": "string", "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." }, "name": { "type": "string", "description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}" }, "description": { "type": "string", "description": "Optional. Description for this custom dimension. Max length of 150 characters." }, "displayName": { "type": "string", "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." }, "measurementUnit": { "type": "string", "enum": [ "MEASUREMENT_UNIT_UNSPECIFIED", "STANDARD", "CURRENCY", "FEET", "METERS", "KILOMETERS", "MILES", "MILLISECONDS", "SECONDS", "MINUTES", "HOURS" ], "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." }, "scope": { "enumDescriptions": [ "Scope unknown or not specified.", "Metric scoped to an event." ], "description": "Required. Immutable. The scope of this custom metric.", "type": "string", "enum": [ "METRIC_SCOPE_UNSPECIFIED", "EVENT" ] } } }, "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest": { "properties": { "acknowledgement": { "type": "string", "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": "object", "id": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest", "description": "Request message for AcknowledgeUserDataCollection RPC." }, "GoogleAnalyticsAdminV1betaAccessQuota": { "id": "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": "GoogleAnalyticsAdminV1betaAccessQuotaStatus" }, "concurrentRequests": { "$ref": "GoogleAnalyticsAdminV1betaAccessQuotaStatus", "description": "Properties can use up to 50 concurrent requests." }, "tokensPerDay": { "$ref": "GoogleAnalyticsAdminV1betaAccessQuotaStatus", "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": "GoogleAnalyticsAdminV1betaAccessQuotaStatus" }, "serverErrorsPerProjectPerHour": { "description": "Properties and cloud project pairs can have up to 50 server errors per hour.", "$ref": "GoogleAnalyticsAdminV1betaAccessQuotaStatus" } } }, "GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue": { "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.", "type": "number", "format": "double" }, "currencyCode": { "type": "string", "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." } }, "description": "Defines a default value/currency for a conversion event. Both value and currency must be provided.", "type": "object", "id": "GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue" }, "GoogleAnalyticsAdminV1betaCustomDimension": { "type": "object", "id": "GoogleAnalyticsAdminV1betaCustomDimension", "properties": { "description": { "description": "Optional. Description for this custom dimension. Max length of 150 characters.", "type": "string" }, "name": { "type": "string", "description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}" }, "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" }, "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" }, "scope": { "type": "string", "enum": [ "DIMENSION_SCOPE_UNSPECIFIED", "EVENT", "USER", "ITEM" ], "enumDescriptions": [ "Scope unknown or not specified.", "Dimension scoped to an event.", "Dimension scoped to a user.", "Dimension scoped to eCommerce items" ], "description": "Required. Immutable. The scope of this dimension." } }, "description": "A definition for a CustomDimension." }, "GoogleAnalyticsAdminV1betaAccessFilterExpressionList": { "description": "A list of filter expressions.", "type": "object", "id": "GoogleAnalyticsAdminV1betaAccessFilterExpressionList", "properties": { "expressions": { "description": "A list of filter expressions.", "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessFilterExpression" }, "type": "array" } } }, "GoogleAnalyticsAdminV1betaAccessFilter": { "properties": { "inListFilter": { "description": "A filter for in list values.", "$ref": "GoogleAnalyticsAdminV1betaAccessInListFilter" }, "stringFilter": { "$ref": "GoogleAnalyticsAdminV1betaAccessStringFilter", "description": "Strings related filter." }, "numericFilter": { "description": "A filter for numeric or date values.", "$ref": "GoogleAnalyticsAdminV1betaAccessNumericFilter" }, "betweenFilter": { "description": "A filter for two values.", "$ref": "GoogleAnalyticsAdminV1betaAccessBetweenFilter" }, "fieldName": { "description": "The dimension name or metric name.", "type": "string" } }, "description": "An expression to filter dimension or metric values.", "id": "GoogleAnalyticsAdminV1betaAccessFilter", "type": "object" }, "GoogleAnalyticsAdminV1betaFirebaseLink": { "description": "A link between a Google Analytics property and a Firebase project.", "type": "object", "properties": { "createTime": { "description": "Output only. Time when this FirebaseLink was originally created.", "type": "string", "readOnly": true, "format": "google-datetime" }, "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" } }, "id": "GoogleAnalyticsAdminV1betaFirebaseLink" }, "GoogleAnalyticsAdminV1betaRunAccessReportResponse": { "properties": { "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" }, "metricHeaders": { "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessMetricHeader" }, "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." }, "rows": { "description": "Rows of dimension value combinations and metric values in the report.", "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessRow" }, "type": "array" }, "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": "GoogleAnalyticsAdminV1betaAccessDimensionHeader" } }, "quota": { "description": "The quota state for this Analytics property including this request. This field doesn't work with account-level requests.", "$ref": "GoogleAnalyticsAdminV1betaAccessQuota" } }, "id": "GoogleAnalyticsAdminV1betaRunAccessReportResponse", "type": "object", "description": "The customized Data Access Record Report response." }, "GoogleAnalyticsAdminV1betaNumericValue": { "id": "GoogleAnalyticsAdminV1betaNumericValue", "description": "To represent a number.", "properties": { "int64Value": { "format": "int64", "description": "Integer value", "type": "string" }, "doubleValue": { "description": "Double value", "format": "double", "type": "number" } }, "type": "object" }, "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse": { "description": "Response message for SearchAccounts RPC.", "id": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsResponse", "type": "object", "properties": { "changeHistoryEvents": { "description": "Results that were accessible to the caller.", "items": { "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryEvent" }, "type": "array" }, "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." } } }, "GoogleAnalyticsAdminV1betaListConversionEventsResponse": { "properties": { "conversionEvents": { "description": "The requested conversion events", "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent" } }, "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." } }, "description": "Response message for ListConversionEvents RPC.", "type": "object", "id": "GoogleAnalyticsAdminV1betaListConversionEventsResponse" }, "GoogleAnalyticsAdminV1betaListAccountsResponse": { "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." }, "accounts": { "items": { "$ref": "GoogleAnalyticsAdminV1betaAccount" }, "type": "array", "description": "Results that were accessible to the caller." } }, "type": "object", "id": "GoogleAnalyticsAdminV1betaListAccountsResponse", "description": "Request message for ListAccounts RPC." }, "GoogleAnalyticsAdminV1betaProperty": { "id": "GoogleAnalyticsAdminV1betaProperty", "properties": { "parent": { "type": "string", "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\"" }, "industryCategory": { "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", "type": "string", "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" ] }, "propertyType": { "type": "string", "enum": [ "PROPERTY_TYPE_UNSPECIFIED", "PROPERTY_TYPE_ORDINARY", "PROPERTY_TYPE_SUBPROPERTY", "PROPERTY_TYPE_ROLLUP" ], "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.", "enumDescriptions": [ "Unknown or unspecified property type", "Ordinary Google Analytics property", "Google Analytics subproperty", "Google Analytics rollup property" ] }, "name": { "description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", "type": "string" }, "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": { "type": "string", "readOnly": true, "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" }, "expireTime": { "readOnly": true, "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" }, "serviceLevel": { "type": "string", "enum": [ "SERVICE_LEVEL_UNSPECIFIED", "GOOGLE_ANALYTICS_STANDARD", "GOOGLE_ANALYTICS_360" ], "readOnly": true, "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." }, "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": { "description": "Immutable. The resource name of the parent account Format: accounts/{account_id} Example: \"accounts/123\"", "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" }, "updateTime": { "type": "string", "format": "google-datetime", "readOnly": true, "description": "Output only. Time when entity payload fields were last updated." }, "createTime": { "type": "string", "readOnly": true, "description": "Output only. Time when the entity was originally created.", "format": "google-datetime" } }, "description": "A resource message representing a Google Analytics property.", "type": "object" }, "GoogleAnalyticsAdminV1betaPropertySummary": { "description": "A virtual resource representing metadata for a Google Analytics property.", "properties": { "property": { "description": "Resource name of property referred to by this property summary Format: properties/{property_id} Example: \"properties/1000\"", "type": "string" }, "displayName": { "type": "string", "description": "Display name for the property referred to in this property summary." }, "propertyType": { "description": "The property's property type.", "type": "string", "enum": [ "PROPERTY_TYPE_UNSPECIFIED", "PROPERTY_TYPE_ORDINARY", "PROPERTY_TYPE_SUBPROPERTY", "PROPERTY_TYPE_ROLLUP" ], "enumDescriptions": [ "Unknown or unspecified property type", "Ordinary Google Analytics property", "Google Analytics subproperty", "Google Analytics rollup property" ] }, "canEdit": { "type": "boolean", "description": "If true, then the user has a Google Analytics role that permits them to edit the property." }, "parent": { "description": "Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account}, properties/{property} Example: \"accounts/100\", \"properties/200\"", "type": "string" } }, "id": "GoogleAnalyticsAdminV1betaPropertySummary", "type": "object" }, "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse": { "properties": { "measurementProtocolSecrets": { "description": "A list of secrets for the parent stream specified in the request.", "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" } }, "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." } }, "description": "Response message for ListMeasurementProtocolSecret RPC", "type": "object", "id": "GoogleAnalyticsAdminV1betaListMeasurementProtocolSecretsResponse" }, "GoogleAnalyticsAdminV1betaListCustomDimensionsResponse": { "type": "object", "id": "GoogleAnalyticsAdminV1betaListCustomDimensionsResponse", "description": "Response message for ListCustomDimensions RPC.", "properties": { "customDimensions": { "items": { "$ref": "GoogleAnalyticsAdminV1betaCustomDimension" }, "type": "array", "description": "List of CustomDimensions." }, "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" } } }, "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse": { "description": "Response message for AcknowledgeUserDataCollection RPC.", "id": "GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionResponse", "properties": {}, "type": "object" }, "GoogleAnalyticsAdminV1betaAccessDimensionHeader": { "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'." } }, "id": "GoogleAnalyticsAdminV1betaAccessDimensionHeader" }, "GoogleAnalyticsAdminV1betaAccessMetric": { "id": "GoogleAnalyticsAdminV1betaAccessMetric", "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", "description": "The quantitative measurements of a report. For example, the metric `accessCount` is the total number of data access records." }, "GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy": { "id": "GoogleAnalyticsAdminV1betaAccessOrderByMetricOrderBy", "description": "Sorts by metric values.", "properties": { "metricName": { "type": "string", "description": "A metric name in the request to order by." } }, "type": "object" }, "GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData": { "properties": { "firebaseAppId": { "readOnly": true, "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": { "description": "Immutable. The package name for the app being measured. Example: \"com.example.myandroidapp\"", "type": "string" } }, "id": "GoogleAnalyticsAdminV1betaDataStreamAndroidAppStreamData", "description": "Data specific to Android app streams.", "type": "object" }, "GoogleAnalyticsAdminV1betaConversionEvent": { "description": "A conversion event in a Google Analytics property.", "id": "GoogleAnalyticsAdminV1betaConversionEvent", "properties": { "name": { "type": "string", "description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}" }, "defaultConversionValue": { "description": "Optional. Defines a default value/currency for a conversion event.", "$ref": "GoogleAnalyticsAdminV1betaConversionEventDefaultConversionValue" }, "countingMethod": { "type": "string", "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`.", "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." ] }, "deletable": { "type": "boolean", "description": "Output only. If set, this event can currently be deleted with DeleteConversionEvent.", "readOnly": true }, "eventName": { "description": "Immutable. The event name for this conversion event. Examples: 'click', 'purchase'", "type": "string" }, "custom": { "type": "boolean", "readOnly": true, "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." }, "createTime": { "description": "Output only. Time when this conversion event was created in the property.", "type": "string", "readOnly": true, "format": "google-datetime" } }, "type": "object" }, "GoogleAnalyticsAdminV1betaAccessStringFilter": { "properties": { "caseSensitive": { "description": "If true, the string value is case sensitive.", "type": "boolean" }, "matchType": { "type": "string", "enum": [ "MATCH_TYPE_UNSPECIFIED", "EXACT", "BEGINS_WITH", "ENDS_WITH", "CONTAINS", "FULL_REGEXP", "PARTIAL_REGEXP" ], "description": "The match type for this filter.", "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." ] }, "value": { "type": "string", "description": "The string value used for the matching." } }, "description": "The filter for strings.", "id": "GoogleAnalyticsAdminV1betaAccessStringFilter", "type": "object" }, "GoogleAnalyticsAdminV1betaListKeyEventsResponse": { "properties": { "keyEvents": { "description": "The requested Key Events", "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaKeyEvent" } }, "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." } }, "id": "GoogleAnalyticsAdminV1betaListKeyEventsResponse", "description": "Response message for ListKeyEvents RPC.", "type": "object" }, "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret": { "type": "object", "properties": { "displayName": { "type": "string", "description": "Required. Human-readable display name for this secret." }, "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" }, "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", "readOnly": true } }, "description": "A secret value used for sending hits to Measurement Protocol.", "id": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" }, "GoogleAnalyticsAdminV1betaAccessInListFilter": { "description": "The result needs to be in a list of string values.", "type": "object", "properties": { "values": { "items": { "type": "string" }, "type": "array", "description": "The list of string values. Must be non-empty." }, "caseSensitive": { "description": "If true, the string value is case sensitive.", "type": "boolean" } }, "id": "GoogleAnalyticsAdminV1betaAccessInListFilter" }, "GoogleAnalyticsAdminV1betaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1betaRunAccessReportRequest", "properties": { "metrics": { "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessMetric" }, "type": "array", "description": "The metrics requested and displayed in the response. Requests are allowed up to 10 metrics." }, "dimensionFilter": { "$ref": "GoogleAnalyticsAdminV1betaAccessFilterExpression", "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." }, "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" }, "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" }, "dateRanges": { "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessDateRange" }, "type": "array", "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." }, "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" }, "orderBys": { "description": "Specifies how rows are ordered in the response.", "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessOrderBy" } }, "dimensions": { "description": "The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions.", "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessDimension" }, "type": "array" }, "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" }, "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": "GoogleAnalyticsAdminV1betaAccessFilterExpression" }, "expandGroups": { "type": "boolean", "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." }, "includeAllUsers": { "type": "boolean", "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": "object" }, "GoogleAnalyticsAdminV1betaAccessDimensionValue": { "type": "object", "properties": { "value": { "type": "string", "description": "The dimension value. For example, this value may be 'France' for the 'country' dimension." } }, "id": "GoogleAnalyticsAdminV1betaAccessDimensionValue", "description": "The value of a dimension." }, "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest": { "description": "Request message for SearchChangeHistoryEvents RPC.", "id": "GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest", "properties": { "earliestChangeTime": { "format": "google-datetime", "type": "string", "description": "Optional. If set, only return changes made after this time (inclusive)." }, "actorEmail": { "description": "Optional. If set, only return changes if they are made by a user in this list.", "items": { "type": "string" }, "type": "array" }, "latestChangeTime": { "type": "string", "description": "Optional. If set, only return changes made before this time (inclusive).", "format": "google-datetime" }, "pageSize": { "description": "Optional. The maximum number of ChangeHistoryEvent items to return. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). Note that the service may return a page with fewer items than this value specifies (potentially even zero), and that there still may be additional pages. If you want a particular number of items, you'll need to continue requesting additional pages using `page_token` until you get the needed number.", "format": "int32", "type": "integer" }, "action": { "type": "array", "description": "Optional. If set, only return changes that match one or more of these types of actions.", "items": { "type": "string", "enum": [ "ACTION_TYPE_UNSPECIFIED", "CREATED", "UPDATED", "DELETED" ], "enumDescriptions": [ "Action type unknown or not specified.", "Resource was created in this change.", "Resource was updated in this change.", "Resource was deleted in this change." ] } }, "pageToken": { "type": "string", "description": "Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token." }, "property": { "type": "string", "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`" }, "resourceType": { "type": "array", "items": { "enumDescriptions": [ "Resource type unknown or not specified.", "Account resource", "Property resource", "FirebaseLink resource", "GoogleAdsLink resource", "GoogleSignalsSettings resource", "ConversionEvent resource", "MeasurementProtocolSecret resource", "CustomDimension resource", "CustomMetric resource", "DataRetentionSettings resource", "DisplayVideo360AdvertiserLink resource", "DisplayVideo360AdvertiserLinkProposal resource", "DataStream resource", "AttributionSettings resource" ], "type": "string", "enum": [ "CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED", "ACCOUNT", "PROPERTY", "FIREBASE_LINK", "GOOGLE_ADS_LINK", "GOOGLE_SIGNALS_SETTINGS", "CONVERSION_EVENT", "MEASUREMENT_PROTOCOL_SECRET", "CUSTOM_DIMENSION", "CUSTOM_METRIC", "DATA_RETENTION_SETTINGS", "DISPLAY_VIDEO_360_ADVERTISER_LINK", "DISPLAY_VIDEO_360_ADVERTISER_LINK_PROPOSAL", "DATA_STREAM", "ATTRIBUTION_SETTINGS" ] }, "description": "Optional. If set, only return changes if they are for a resource that matches at least one of these types." } }, "type": "object" }, "GoogleAnalyticsAdminV1betaAccessDateRange": { "description": "A contiguous range of days: startDate, startDate + 1, ..., endDate.", "id": "GoogleAnalyticsAdminV1betaAccessDateRange", "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" } } }, "GoogleAnalyticsAdminV1betaDataRetentionSettings": { "properties": { "userDataRetention": { "type": "string", "enum": [ "RETENTION_DURATION_UNSPECIFIED", "TWO_MONTHS", "FOURTEEN_MONTHS", "TWENTY_SIX_MONTHS", "THIRTY_EIGHT_MONTHS", "FIFTY_MONTHS" ], "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." }, "name": { "description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", "type": "string" }, "resetUserDataOnNewActivity": { "description": "If true, reset the retention period for the user identifier with every event from that user.", "type": "boolean" }, "eventDataRetention": { "type": "string", "enum": [ "RETENTION_DURATION_UNSPECIFIED", "TWO_MONTHS", "FOURTEEN_MONTHS", "TWENTY_SIX_MONTHS", "THIRTY_EIGHT_MONTHS", "FIFTY_MONTHS" ], "description": "Required. The length of time that event-level data is retained.", "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." ] } }, "type": "object", "id": "GoogleAnalyticsAdminV1betaDataRetentionSettings", "description": "Settings values for data retention. This is a singleton resource." }, "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { "properties": { "fromValue": { "$ref": "GoogleAnalyticsAdminV1betaNumericValue", "description": "Begins with this number." }, "toValue": { "description": "Ends with this number.", "$ref": "GoogleAnalyticsAdminV1betaNumericValue" } }, "description": "To express that the result needs to be between two numbers (inclusive).", "type": "object", "id": "GoogleAnalyticsAdminV1betaAccessBetweenFilter" }, "GoogleAnalyticsAdminV1betaAccessMetricValue": { "type": "object", "description": "The value of a metric.", "id": "GoogleAnalyticsAdminV1betaAccessMetricValue", "properties": { "value": { "type": "string", "description": "The measurement value. For example, this value may be '13'." } } }, "GoogleAnalyticsAdminV1betaAccountSummary": { "id": "GoogleAnalyticsAdminV1betaAccountSummary", "description": "A virtual resource representing an overview of an account and all its child Google Analytics properties.", "type": "object", "properties": { "account": { "description": "Resource name of account referred to by this account summary Format: accounts/{account_id} Example: \"accounts/1000\"", "type": "string" }, "name": { "type": "string", "description": "Identifier. Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"" }, "propertySummaries": { "type": "array", "items": { "$ref": "GoogleAnalyticsAdminV1betaPropertySummary" }, "description": "List of summaries for child accounts of this account." }, "displayName": { "description": "Display name for the account referred to in this account summary.", "type": "string" } } }, "GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse": { "properties": { "accountTicketId": { "type": "string", "description": "The param to be passed in the ToS link." } }, "type": "object", "description": "Response message for ProvisionAccountTicket RPC.", "id": "GoogleAnalyticsAdminV1betaProvisionAccountTicketResponse" }, "GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData": { "description": "Data specific to iOS app streams.", "type": "object", "id": "GoogleAnalyticsAdminV1betaDataStreamIosAppStreamData", "properties": { "bundleId": { "description": "Required. Immutable. The Apple App Store Bundle ID for the app Example: \"com.example.myiosapp\"", "type": "string" }, "firebaseAppId": { "type": "string", "readOnly": true, "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." } } }, "GoogleAnalyticsAdminV1betaAccessFilterExpression": { "description": "Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.", "properties": { "notExpression": { "description": "The FilterExpression is NOT of not_expression.", "$ref": "GoogleAnalyticsAdminV1betaAccessFilterExpression" }, "orGroup": { "description": "Each of the FilterExpressions in the or_group has an OR relationship.", "$ref": "GoogleAnalyticsAdminV1betaAccessFilterExpressionList" }, "andGroup": { "$ref": "GoogleAnalyticsAdminV1betaAccessFilterExpressionList", "description": "Each of the FilterExpressions in the and_group has an AND relationship." }, "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": "GoogleAnalyticsAdminV1betaAccessFilter" } }, "type": "object", "id": "GoogleAnalyticsAdminV1betaAccessFilterExpression" }, "GoogleAnalyticsAdminV1betaDataStreamWebStreamData": { "type": "object", "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", "readOnly": true }, "defaultUri": { "type": "string", "description": "Domain name of the web app being measured, or empty. Example: \"http://www.google.com\", \"https://www.google.com\"" }, "measurementId": { "readOnly": true, "type": "string", "description": "Output only. Analytics Measurement ID. Example: \"G-1A2BCD345E\"" } }, "description": "Data specific to web streams.", "id": "GoogleAnalyticsAdminV1betaDataStreamWebStreamData" }, "GoogleAnalyticsAdminV1betaKeyEventDefaultValue": { "id": "GoogleAnalyticsAdminV1betaKeyEventDefaultValue", "type": "object", "properties": { "numericValue": { "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.", "type": "number" }, "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." } }, "description": "Defines a default value/currency for a key event." }, "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource": { "id": "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource", "properties": { "firebaseLink": { "$ref": "GoogleAnalyticsAdminV1betaFirebaseLink", "description": "A snapshot of a FirebaseLink resource in change history." }, "dataStream": { "$ref": "GoogleAnalyticsAdminV1betaDataStream", "description": "A snapshot of a DataStream resource in change history." }, "measurementProtocolSecret": { "description": "A snapshot of a MeasurementProtocolSecret resource in change history.", "$ref": "GoogleAnalyticsAdminV1betaMeasurementProtocolSecret" }, "property": { "$ref": "GoogleAnalyticsAdminV1betaProperty", "description": "A snapshot of a Property resource in change history." }, "dataRetentionSettings": { "description": "A snapshot of a data retention settings resource in change history.", "$ref": "GoogleAnalyticsAdminV1betaDataRetentionSettings" }, "conversionEvent": { "$ref": "GoogleAnalyticsAdminV1betaConversionEvent", "description": "A snapshot of a ConversionEvent resource in change history." }, "googleAdsLink": { "description": "A snapshot of a GoogleAdsLink resource in change history.", "$ref": "GoogleAnalyticsAdminV1betaGoogleAdsLink" }, "account": { "$ref": "GoogleAnalyticsAdminV1betaAccount", "description": "A snapshot of an Account resource in change history." } }, "type": "object", "description": "A snapshot of a resource as before or after the result of a change in change history." }, "GoogleAnalyticsAdminV1betaChangeHistoryChange": { "id": "GoogleAnalyticsAdminV1betaChangeHistoryChange", "description": "A description of a change to a single Google Analytics resource.", "type": "object", "properties": { "resourceBeforeChange": { "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource", "description": "Resource contents from before the change was made. If this resource was created in this change, this field will be missing." }, "resourceAfterChange": { "$ref": "GoogleAnalyticsAdminV1betaChangeHistoryChangeChangeHistoryResource", "description": "Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing." }, "action": { "type": "string", "enum": [ "ACTION_TYPE_UNSPECIFIED", "CREATED", "UPDATED", "DELETED" ], "enumDescriptions": [ "Action type unknown or not specified.", "Resource was created in this change.", "Resource was updated in this change.", "Resource was deleted in this change." ], "description": "The type of action that changed this resource." }, "resource": { "description": "Resource name of the resource whose changes are described by this entry.", "type": "string" } } }, "GoogleAnalyticsAdminV1betaAccessMetricHeader": { "id": "GoogleAnalyticsAdminV1betaAccessMetricHeader", "properties": { "metricName": { "type": "string", "description": "The metric's name; for example 'accessCount'." } }, "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" }, "GoogleAnalyticsAdminV1betaAccessRow": { "id": "GoogleAnalyticsAdminV1betaAccessRow", "type": "object", "description": "Access report data for each row.", "properties": { "metricValues": { "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessMetricValue" }, "description": "List of metric values. These values are in the same order as specified in the request.", "type": "array" }, "dimensionValues": { "items": { "$ref": "GoogleAnalyticsAdminV1betaAccessDimensionValue" }, "type": "array", "description": "List of dimension values. These values are in the same order as specified in the request." } } }, "GoogleAnalyticsAdminV1betaAccessQuotaStatus": { "properties": { "consumed": { "type": "integer", "description": "Quota consumed by this request.", "format": "int32" }, "remaining": { "description": "Quota remaining after this request.", "format": "int32", "type": "integer" } }, "type": "object", "id": "GoogleAnalyticsAdminV1betaAccessQuotaStatus", "description": "Current state for a particular quota group." }, "GoogleAnalyticsAdminV1betaDataSharingSettings": { "description": "A resource message representing data sharing settings of a Google Analytics account.", "type": "object", "properties": { "sharingWithGoogleSupportEnabled": { "description": "Allows Google technical support representatives access to your Google Analytics data and account when necessary to provide service and find solutions to technical issues. This field maps to the \"Technical support\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithOthersEnabled": { "description": "Enable features like predictions, modeled data, and benchmarking that can provide you with richer business insights when you contribute aggregated measurement data. The data you share (including information about the property from which it is shared) is aggregated and de-identified before being used to generate business insights. This field maps to the \"Modeling contributions & business insights\" field in the Google Analytics Admin UI.", "type": "boolean" }, "name": { "type": "string", "description": "Identifier. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"" }, "sharingWithGoogleAnySalesEnabled": { "description": "Deprecated. This field is no longer used and always returns false.", "type": "boolean", "deprecated": true }, "sharingWithGoogleProductsEnabled": { "description": "Allows Google to use the data to improve other Google products or services. This fields maps to the \"Google products & services\" field in the Google Analytics Admin UI.", "type": "boolean" }, "sharingWithGoogleAssignedSalesEnabled": { "type": "boolean", "description": "Allows Google access to your Google Analytics account data, including account usage and configuration data, product spending, and users associated with your Google Analytics account, so that Google can help you make the most of Google products, providing you with insights, offers, recommendations, and optimization tips across Google Analytics and other Google products for business. This field maps to the \"Recommendations for your business\" field in the Google Analytics Admin UI." } }, "id": "GoogleAnalyticsAdminV1betaDataSharingSettings" }, "GoogleAnalyticsAdminV1betaAccessOrderBy": { "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", "id": "GoogleAnalyticsAdminV1betaAccessOrderBy", "properties": { "metric": { "description": "Sorts results by a metric's values.", "$ref": "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": "GoogleAnalyticsAdminV1betaAccessOrderByDimensionOrderBy" } } }, "GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest": { "properties": {}, "id": "GoogleAnalyticsAdminV1betaArchiveCustomDimensionRequest", "type": "object", "description": "Request message for ArchiveCustomDimension RPC." }, "GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest": { "properties": {}, "description": "Request message for ArchiveCustomMetric RPC.", "id": "GoogleAnalyticsAdminV1betaArchiveCustomMetricRequest", "type": "object" }, "GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest": { "id": "GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest", "type": "object", "properties": { "redirectUri": { "type": "string", "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Cloud Console as a Redirect URI." }, "account": { "$ref": "GoogleAnalyticsAdminV1betaAccount", "description": "The account to create." } }, "description": "Request message for ProvisionAccountTicket RPC." }, "GoogleAnalyticsAdminV1betaListCustomMetricsResponse": { "id": "GoogleAnalyticsAdminV1betaListCustomMetricsResponse", "properties": { "customMetrics": { "items": { "$ref": "GoogleAnalyticsAdminV1betaCustomMetric" }, "description": "List of CustomMetrics.", "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" } }, "description": "Response message for ListCustomMetrics RPC.", "type": "object" }, "GoogleAnalyticsAdminV1betaAccessNumericFilter": { "description": "Filters for numeric or date values.", "properties": { "operation": { "type": "string", "enum": [ "OPERATION_UNSPECIFIED", "EQUAL", "LESS_THAN", "LESS_THAN_OR_EQUAL", "GREATER_THAN", "GREATER_THAN_OR_EQUAL" ], "enumDescriptions": [ "Unspecified.", "Equal", "Less than", "Less than or equal", "Greater than", "Greater than or equal" ], "description": "The operation type for this filter." }, "value": { "$ref": "GoogleAnalyticsAdminV1betaNumericValue", "description": "A numeric value or a date value." } }, "type": "object", "id": "GoogleAnalyticsAdminV1betaAccessNumericFilter" } }, "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", "protocol": "rest", "rootUrl": "https://analyticsadmin.googleapis.com/", "revision": "20261014", "version_module": true, "mtlsRootUrl": "https://analyticsadmin.mtls.googleapis.com/", "servicePath": "" }