| { |
| "auth": { |
| "oauth2": { |
| "scopes": { |
| "https://www.googleapis.com/auth/analytics.edit": { |
| "description": "Edit Google Analytics management entities" |
| }, |
| "https://www.googleapis.com/auth/analytics.manage.users": { |
| "description": "Manage Google Analytics Account users by email address" |
| }, |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly": { |
| "description": "View Google Analytics user permissions" |
| }, |
| "https://www.googleapis.com/auth/analytics.readonly": { |
| "description": "See and download your Google Analytics data" |
| } |
| } |
| } |
| }, |
| "basePath": "", |
| "baseUrl": "https://analyticsadmin.googleapis.com/", |
| "batchPath": "batch", |
| "canonicalName": "Google Analytics Admin", |
| "description": "", |
| "discoveryVersion": "v1", |
| "documentationLink": "http://code.google.com/apis/analytics/docs/mgmt/home.html", |
| "fullyEncodeReservedExpansion": true, |
| "icons": { |
| "x16": "http://www.google.com/images/icons/product/search-16.gif", |
| "x32": "http://www.google.com/images/icons/product/search-32.gif" |
| }, |
| "id": "analyticsadmin:v1alpha", |
| "kind": "discovery#restDescription", |
| "mtlsRootUrl": "https://analyticsadmin.mtls.googleapis.com/", |
| "name": "analyticsadmin", |
| "ownerDomain": "google.com", |
| "ownerName": "Google", |
| "parameters": { |
| "$.xgafv": { |
| "description": "V1 error format.", |
| "enum": [ |
| "1", |
| "2" |
| ], |
| "enumDescriptions": [ |
| "v1 error format", |
| "v2 error format" |
| ], |
| "location": "query", |
| "type": "string" |
| }, |
| "access_token": { |
| "description": "OAuth access token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "alt": { |
| "default": "json", |
| "description": "Data format for response.", |
| "enum": [ |
| "json", |
| "media", |
| "proto" |
| ], |
| "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", |
| "type": "string" |
| }, |
| "callback": { |
| "description": "JSONP", |
| "location": "query", |
| "type": "string" |
| }, |
| "fields": { |
| "description": "Selector specifying which fields to include in a partial response.", |
| "location": "query", |
| "type": "string" |
| }, |
| "key": { |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "oauth_token": { |
| "description": "OAuth 2.0 token for the current user.", |
| "location": "query", |
| "type": "string" |
| }, |
| "prettyPrint": { |
| "default": "true", |
| "description": "Returns response with indentations and line breaks.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "quotaUser": { |
| "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "uploadType": { |
| "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| }, |
| "upload_protocol": { |
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "protocol": "rest", |
| "resources": { |
| "accountSummaries": { |
| "methods": { |
| "list": { |
| "description": "Returns summaries of all accounts accessible by the caller.", |
| "flatPath": "v1alpha/accountSummaries", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accountSummaries.list", |
| "parameterOrder": [], |
| "parameters": { |
| "pageSize": { |
| "description": "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)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/accountSummaries", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| } |
| } |
| }, |
| "accounts": { |
| "methods": { |
| "delete": { |
| "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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", |
| "flatPath": "v1alpha/accounts/{accountsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.accounts.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single Account.", |
| "flatPath": "v1alpha/accounts/{accountsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accounts.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccount" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "getDataSharingSettings": { |
| "description": "Get data sharing settings on an account. Data sharing settings are singletons.", |
| "flatPath": "v1alpha/accounts/{accountsId}/dataSharingSettings", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accounts.getDataSharingSettings", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", |
| "location": "path", |
| "pattern": "^accounts/[^/]+/dataSharingSettings$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDataSharingSettings" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found.", |
| "flatPath": "v1alpha/accounts", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accounts.list", |
| "parameterOrder": [], |
| "parameters": { |
| "pageSize": { |
| "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "showDeleted": { |
| "description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1alpha/accounts", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListAccountsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates an account.", |
| "flatPath": "v1alpha/accounts/{accountsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.accounts.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccount" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccount" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "provisionAccountTicket": { |
| "description": "Requests a ticket for creating an account.", |
| "flatPath": "v1alpha/accounts:provisionAccountTicket", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.provisionAccountTicket", |
| "parameterOrder": [], |
| "parameters": {}, |
| "path": "v1alpha/accounts:provisionAccountTicket", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "searchChangeHistoryEvents": { |
| "description": "Searches through all changes to an account or its children given the specified set of filters.", |
| "flatPath": "v1alpha/accounts/{accountsId}:searchChangeHistoryEvents", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.searchChangeHistoryEvents", |
| "parameterOrder": [ |
| "account" |
| ], |
| "parameters": { |
| "account": { |
| "description": "Required. The account resource for which to return change history resources.", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+account}:searchChangeHistoryEvents", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| }, |
| "resources": { |
| "userLinks": { |
| "methods": { |
| "audit": { |
| "description": "Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks:audit", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.userLinks.audit", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:audit", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "batchCreate": { |
| "description": "Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchCreate", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.userLinks.batchCreate", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchCreate", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "batchDelete": { |
| "description": "Deletes information about multiple users' links to an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchDelete", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.userLinks.batchDelete", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchDelete", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "batchGet": { |
| "description": "Gets information about multiple users' links to an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchGet", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accounts.userLinks.batchGet", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "names": { |
| "description": "Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}", |
| "location": "query", |
| "repeated": true, |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchGet", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "batchUpdate": { |
| "description": "Updates information about multiple users' links to an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchUpdate", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.userLinks.batchUpdate", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchUpdate", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "create": { |
| "description": "Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.accounts.userLinks.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "notifyNewUser": { |
| "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a user link on an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.accounts.userLinks.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Example format: accounts/1234/userLinks/5678", |
| "location": "path", |
| "pattern": "^accounts/[^/]+/userLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "get": { |
| "description": "Gets information about a user's link to an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accounts.userLinks.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Example format: accounts/1234/userLinks/5678", |
| "location": "path", |
| "pattern": "^accounts/[^/]+/userLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Lists all user links on an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.accounts.userLinks.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^accounts/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a user link on an account or property.", |
| "flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.accounts.userLinks.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Example format: properties/1234/userLinks/5678", |
| "location": "path", |
| "pattern": "^accounts/[^/]+/userLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "properties": { |
| "methods": { |
| "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 via this API) before MeasurementProtocolSecret resources may be created.", |
| "flatPath": "v1alpha/properties/{propertiesId}:acknowledgeUserDataCollection", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.acknowledgeUserDataCollection", |
| "parameterOrder": [ |
| "property" |
| ], |
| "parameters": { |
| "property": { |
| "description": "Required. The property for which to acknowledge user data collection.", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+property}:acknowledgeUserDataCollection", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "create": { |
| "description": "Creates an \"GA4\" property with the specified location and attributes.", |
| "flatPath": "v1alpha/properties", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.create", |
| "parameterOrder": [], |
| "parameters": {}, |
| "path": "v1alpha/properties", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not an GA4 Property.", |
| "flatPath": "v1alpha/properties/{propertiesId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single \"GA4\" Property.", |
| "flatPath": "v1alpha/properties/{propertiesId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "getDataRetentionSettings": { |
| "description": "Returns the singleton data retention settings for this property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/dataRetentionSettings", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.getDataRetentionSettings", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/dataRetentionSettings$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "getGoogleSignalsSettings": { |
| "description": "Lookup for Google Signals settings for a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.getGoogleSignalsSettings", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings", |
| "location": "path", |
| "pattern": "^properties/[^/]+/googleSignalsSettings$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child Properties under the specified parent Account. Only \"GA4\" properties will be returned. 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.", |
| "flatPath": "v1alpha/properties", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.list", |
| "parameterOrder": [], |
| "parameters": { |
| "filter": { |
| "description": "Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(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. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```", |
| "location": "query", |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "showDeleted": { |
| "description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not.", |
| "location": "query", |
| "type": "boolean" |
| } |
| }, |
| "path": "v1alpha/properties", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListPropertiesResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "updateDataRetentionSettings": { |
| "description": "Updates the singleton data retention settings for this property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/dataRetentionSettings", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.updateDataRetentionSettings", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", |
| "location": "path", |
| "pattern": "^properties/[^/]+/dataRetentionSettings$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "updateGoogleSignalsSettings": { |
| "description": "Updates Google Signals settings for a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/googleSignalsSettings", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.updateGoogleSignalsSettings", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: \"properties/1000/googleSignalsSettings\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/googleSignalsSettings$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| }, |
| "resources": { |
| "androidAppDataStreams": { |
| "methods": { |
| "delete": { |
| "description": "Deletes an android app stream on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.androidAppDataStreams.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the android app data stream to delete. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/123/androidAppDataStreams/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single AndroidAppDataStream", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.androidAppDataStreams.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the android app data stream to lookup. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/123/androidAppDataStreams/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child android app streams under the specified parent property. Android app streams will be excluded if the caller does not have access. Returns an empty list if no relevant android app streams are found.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.androidAppDataStreams.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAndroidAppDataStreams` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The name of the parent property. For example, to limit results to app streams under the property with Id 123: \"properties/123\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/androidAppDataStreams", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates an android app stream on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.androidAppDataStreams.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/1000/androidAppDataStreams/2000\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| }, |
| "resources": { |
| "measurementProtocolSecrets": { |
| "methods": { |
| "create": { |
| "description": "Creates a measurement protocol secret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/measurementProtocolSecrets", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes target MeasurementProtocolSecret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "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.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/measurementProtocolSecrets", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a measurement protocol secret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/androidAppDataStreams/{androidAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.androidAppDataStreams.measurementProtocolSecrets.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/androidAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "description": "The list of fields to be updated. Omitted fields will not be updated.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "conversionEvents": { |
| "methods": { |
| "create": { |
| "description": "Creates a conversion event with the specified attributes.", |
| "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.conversionEvents.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The resource name of the parent property where this conversion event will be created. Format: properties/123", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/conversionEvents", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaConversionEvent" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaConversionEvent" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a conversion event in a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.conversionEvents.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conversionEvents/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Retrieve a single conversion event.", |
| "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.conversionEvents.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conversionEvents/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/conversionEvents/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaConversionEvent" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", |
| "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.conversionEvents.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The resource name of the parent property. Example: 'properties/123'", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/conversionEvents", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListConversionEventsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| } |
| } |
| }, |
| "customDimensions": { |
| "methods": { |
| "archive": { |
| "description": "Archives a CustomDimension on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.customDimensions.archive", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/customDimensions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}:archive", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest" |
| }, |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "create": { |
| "description": "Creates a CustomDimension.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customDimensions", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.customDimensions.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/customDimensions", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single CustomDimension.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.customDimensions.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/customDimensions/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Lists CustomDimensions on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customDimensions", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.customDimensions.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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).", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/customDimensions", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a CustomDimension on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customDimensions/{customDimensionsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.customDimensions.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/customDimensions/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "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", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| }, |
| "customMetrics": { |
| "methods": { |
| "archive": { |
| "description": "Archives a CustomMetric on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}:archive", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.customMetrics.archive", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/customMetrics/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}:archive", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest" |
| }, |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "create": { |
| "description": "Creates a CustomMetric.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customMetrics", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.customMetrics.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/customMetrics", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single CustomMetric.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.customMetrics.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/customMetrics/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Lists CustomMetrics on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customMetrics", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.customMetrics.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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).", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "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" |
| }, |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/customMetrics", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListCustomMetricsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a CustomMetric on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/customMetrics/{customMetricsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.customMetrics.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/customMetrics/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "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", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| }, |
| "displayVideo360AdvertiserLinkProposals": { |
| "methods": { |
| "approve": { |
| "description": "Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}:approve", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinkProposals.approve", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}:approve", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "cancel": { |
| "description": "Cancels a DisplayVideo360AdvertiserLinkProposal. Cancelling can mean either: - Declining a proposal initiated from Display & Video 360 - Withdrawing a proposal initiated from Google Analytics After being cancelled, a proposal will eventually be deleted automatically.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}:cancel", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinkProposals.cancel", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}:cancel", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "create": { |
| "description": "Creates a DisplayVideo360AdvertiserLinkProposal.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinkProposals.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/displayVideo360AdvertiserLinkProposals", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinkProposals.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single DisplayVideo360AdvertiserLinkProposal.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals/{displayVideo360AdvertiserLinkProposalsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinkProposals.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinkProposals/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Lists DisplayVideo360AdvertiserLinkProposals on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinkProposals", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinkProposals.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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).", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinkProposals` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/displayVideo360AdvertiserLinkProposals", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| } |
| } |
| }, |
| "displayVideo360AdvertiserLinks": { |
| "methods": { |
| "create": { |
| "description": "Creates a DisplayVideo360AdvertiserLink. This can only be utilized by users who have proper authorization both on the Google Analytics property and on the Display & Video 360 advertiser. Users who do not have access to the Display & Video 360 advertiser should instead seek to create a DisplayVideo360LinkProposal.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinks.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/displayVideo360AdvertiserLinks", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a DisplayVideo360AdvertiserLink on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinks.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Look up a single DisplayVideo360AdvertiserLink", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinks.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Lists all DisplayVideo360AdvertiserLinks on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinks.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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).", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListDisplayVideo360AdvertiserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinks` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/displayVideo360AdvertiserLinks", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a DisplayVideo360AdvertiserLink on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/displayVideo360AdvertiserLinks/{displayVideo360AdvertiserLinksId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.displayVideo360AdvertiserLinks.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID", |
| "location": "path", |
| "pattern": "^properties/[^/]+/displayVideo360AdvertiserLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "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", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| }, |
| "firebaseLinks": { |
| "methods": { |
| "create": { |
| "description": "Creates a FirebaseLink. Properties can have at most one FirebaseLink.", |
| "flatPath": "v1alpha/properties/{propertiesId}/firebaseLinks", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.firebaseLinks.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Format: properties/{property_id} Example: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/firebaseLinks", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a FirebaseLink on a property", |
| "flatPath": "v1alpha/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.firebaseLinks.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "list": { |
| "description": "Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.", |
| "flatPath": "v1alpha/properties/{propertiesId}/firebaseLinks", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.firebaseLinks.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListFirebaseLinks` 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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Format: properties/{property_id} Example: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/firebaseLinks", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| } |
| } |
| }, |
| "googleAdsLinks": { |
| "methods": { |
| "create": { |
| "description": "Creates a GoogleAdsLink.", |
| "flatPath": "v1alpha/properties/{propertiesId}/googleAdsLinks", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.googleAdsLinks.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/googleAdsLinks", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a GoogleAdsLink on a property", |
| "flatPath": "v1alpha/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.googleAdsLinks.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Example format: properties/1234/googleAdsLinks/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "list": { |
| "description": "Lists GoogleAdsLinks on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/googleAdsLinks", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.googleAdsLinks.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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).", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Example format: properties/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/googleAdsLinks", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a GoogleAdsLink on a property", |
| "flatPath": "v1alpha/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.googleAdsLinks.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/googleAdsLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| }, |
| "iosAppDataStreams": { |
| "methods": { |
| "delete": { |
| "description": "Deletes an iOS app stream on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.iosAppDataStreams.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the iOS app data stream to delete. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/123/iosAppDataStreams/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single IosAppDataStream", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.iosAppDataStreams.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the iOS app data stream to lookup. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/123/iosAppDataStreams/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child iOS app data streams under the specified parent property. iOS app data streams will be excluded if the caller does not have access. Returns an empty list if no relevant iOS app data streams are found.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.iosAppDataStreams.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListIosAppDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIosAppDataStreams` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The name of the parent property. For example, to list results of app streams under the property with Id 123: \"properties/123\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/iosAppDataStreams", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates an iOS app stream on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.iosAppDataStreams.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/1000/iosAppDataStreams/2000\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| }, |
| "resources": { |
| "measurementProtocolSecrets": { |
| "methods": { |
| "create": { |
| "description": "Creates a measurement protocol secret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/measurementProtocolSecrets", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes target MeasurementProtocolSecret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "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.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/measurementProtocolSecrets", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a measurement protocol secret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/iosAppDataStreams/{iosAppDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.iosAppDataStreams.measurementProtocolSecrets.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/iosAppDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "description": "The list of fields to be updated. Omitted fields will not be updated.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| } |
| } |
| }, |
| "userLinks": { |
| "methods": { |
| "audit": { |
| "description": "Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks:audit", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.userLinks.audit", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:audit", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "batchCreate": { |
| "description": "Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchCreate", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.userLinks.batchCreate", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchCreate", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "batchDelete": { |
| "description": "Deletes information about multiple users' links to an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchDelete", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.userLinks.batchDelete", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchDelete", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "batchGet": { |
| "description": "Gets information about multiple users' links to an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchGet", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.userLinks.batchGet", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "names": { |
| "description": "Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}", |
| "location": "query", |
| "repeated": true, |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchGet", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "batchUpdate": { |
| "description": "Updates information about multiple users' links to an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchUpdate", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.userLinks.batchUpdate", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks:batchUpdate", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "create": { |
| "description": "Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.userLinks.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "notifyNewUser": { |
| "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", |
| "location": "query", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a user link on an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks/{userLinksId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.userLinks.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Example format: accounts/1234/userLinks/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/userLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| }, |
| "get": { |
| "description": "Gets information about a user's link to an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks/{userLinksId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.userLinks.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. Example format: accounts/1234/userLinks/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/userLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Lists all user links on an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.userLinks.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/userLinks", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users", |
| "https://www.googleapis.com/auth/analytics.manage.users.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a user link on an account or property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/userLinks/{userLinksId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.userLinks.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Example format: properties/1234/userLinks/5678", |
| "location": "path", |
| "pattern": "^properties/[^/]+/userLinks/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.manage.users" |
| ] |
| } |
| } |
| }, |
| "webDataStreams": { |
| "methods": { |
| "create": { |
| "description": "Creates a web stream with the specified location and attributes.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.webDataStreams.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent resource where this web data stream will be created. Format: properties/123", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/webDataStreams", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes a web stream on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.webDataStreams.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the web data stream to delete. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/123/webDataStreams/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single WebDataStream", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.webDataStreams.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the web data stream to lookup. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/123/webDataStreams/456\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "getGlobalSiteTag": { |
| "description": "Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/globalSiteTag", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.webDataStreams.getGlobalSiteTag", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/webDataStreams/{stream_id}/globalSiteTag Example: \"properties/123/webDataStreams/456/globalSiteTag\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+/globalSiteTag$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGlobalSiteTag" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child web data streams under the specified parent property. Web data streams will be excluded if the caller does not have access. Returns an empty list if no relevant web data streams are found.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.webDataStreams.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "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)", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `ListWebDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListWebDataStreams` must match the call that provided the page token.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The name of the parent property. For example, to list results of web streams under the property with Id 123: \"properties/123\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/webDataStreams", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a web stream on a property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.webDataStreams.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/1000/webDataStreams/2000\"", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "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.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| }, |
| "resources": { |
| "measurementProtocolSecrets": { |
| "methods": { |
| "create": { |
| "description": "Creates a measurement protocol secret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets", |
| "httpMethod": "POST", |
| "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.create", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "parent": { |
| "description": "Required. The parent resource where this secret will be created. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/measurementProtocolSecrets", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "delete": { |
| "description": "Deletes target MeasurementProtocolSecret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "DELETE", |
| "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.delete", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleProtobufEmpty" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| }, |
| "get": { |
| "description": "Lookup for a single \"GA4\" MeasurementProtocolSecret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.get", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret} Note: Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent.", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "list": { |
| "description": "Returns child MeasurementProtocolSecrets under the specified parent Property.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets", |
| "httpMethod": "GET", |
| "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.list", |
| "parameterOrder": [ |
| "parent" |
| ], |
| "parameters": { |
| "pageSize": { |
| "description": "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.", |
| "format": "int32", |
| "location": "query", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "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.", |
| "location": "query", |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Required. The resource name of the parent stream. Any type of stream (WebDataStream, IosAppDataStream, AndroidAppDataStream) may be a parent. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+$", |
| "required": true, |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+parent}/measurementProtocolSecrets", |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit", |
| "https://www.googleapis.com/auth/analytics.readonly" |
| ] |
| }, |
| "patch": { |
| "description": "Updates a measurement protocol secret.", |
| "flatPath": "v1alpha/properties/{propertiesId}/webDataStreams/{webDataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}", |
| "httpMethod": "PATCH", |
| "id": "analyticsadmin.properties.webDataStreams.measurementProtocolSecrets.patch", |
| "parameterOrder": [ |
| "name" |
| ], |
| "parameters": { |
| "name": { |
| "description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", |
| "location": "path", |
| "pattern": "^properties/[^/]+/webDataStreams/[^/]+/measurementProtocolSecrets/[^/]+$", |
| "required": true, |
| "type": "string" |
| }, |
| "updateMask": { |
| "description": "The list of fields to be updated. Omitted fields will not be updated.", |
| "format": "google-fieldmask", |
| "location": "query", |
| "type": "string" |
| } |
| }, |
| "path": "v1alpha/{+name}", |
| "request": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "response": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "scopes": [ |
| "https://www.googleapis.com/auth/analytics.edit" |
| ] |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "revision": "20211022", |
| "rootUrl": "https://analyticsadmin.googleapis.com/", |
| "schemas": { |
| "GoogleAnalyticsAdminV1alphaAccount": { |
| "description": "A resource message representing a Google Analytics account.", |
| "id": "GoogleAnalyticsAdminV1alphaAccount", |
| "properties": { |
| "createTime": { |
| "description": "Output only. Time when this account was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "deleted": { |
| "description": "Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.", |
| "readOnly": true, |
| "type": "boolean" |
| }, |
| "displayName": { |
| "description": "Required. Human-readable display name for this account.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "regionCode": { |
| "description": "Country of business. Must be a Unicode CLDR region code.", |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. Time when account payload fields were last updated.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAccountSummary": { |
| "description": "A virtual resource representing an overview of an account and all its child GA4 properties.", |
| "id": "GoogleAnalyticsAdminV1alphaAccountSummary", |
| "properties": { |
| "account": { |
| "description": "Resource name of account referred to by this account summary Format: accounts/{account_id} Example: \"accounts/1000\"", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Display name for the account referred to in this account summary.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Resource name for this account summary. Format: accountSummaries/{account_id} Example: \"accountSummaries/1000\"", |
| "type": "string" |
| }, |
| "propertySummaries": { |
| "description": "List of summaries for child accounts of this account.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaPropertySummary" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest": { |
| "description": "Request message for AcknowledgeUserDataCollection RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionRequest", |
| "properties": { |
| "acknowledgement": { |
| "description": "Required. An acknowledgement that the caller of this method understands the terms of user data collection. This field must contain the exact value: \"I acknowledge that I have the necessary privacy disclosures and rights from my end users for the collection and processing of their data, including the association of such data with the visitation information Google Analytics collects from my site and/or app property.\"", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse": { |
| "description": "Response message for AcknowledgeUserDataCollection RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaAcknowledgeUserDataCollectionResponse", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAndroidAppDataStream": { |
| "description": "A resource message representing a Google Analytics Android app stream.", |
| "id": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream", |
| "properties": { |
| "createTime": { |
| "description": "Output only. Time when this stream was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.", |
| "type": "string" |
| }, |
| "firebaseAppId": { |
| "description": "Output only. ID of the corresponding Android app in Firebase, if any. This ID can change if the Android app is deleted and recreated.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/androidAppDataStreams/{stream_id} Example: \"properties/1000/androidAppDataStreams/2000\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "packageName": { |
| "description": "Immutable. The package name for the app being measured. Example: \"com.example.myandroidapp\"", |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. Time when stream payload fields were last updated.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest": { |
| "description": "Request message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse": { |
| "description": "Response message for ApproveDisplayVideo360AdvertiserLinkProposal RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaApproveDisplayVideo360AdvertiserLinkProposalResponse", |
| "properties": { |
| "displayVideo360AdvertiserLink": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink", |
| "description": "The DisplayVideo360AdvertiserLink created as a result of approving the proposal." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest": { |
| "description": "Request message for ArchiveCustomDimension RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaArchiveCustomDimensionRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest": { |
| "description": "Request message for ArchiveCustomMetric RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaArchiveCustomMetricRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAuditUserLink": { |
| "description": "Read-only resource used to summarize a principal's effective roles.", |
| "id": "GoogleAnalyticsAdminV1alphaAuditUserLink", |
| "properties": { |
| "directRoles": { |
| "description": "Roles directly assigned to this user for this entity. Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "effectiveRoles": { |
| "description": "Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/viewer", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "emailAddress": { |
| "description": "Email address of the linked user", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Example format: properties/1234/userLinks/5678", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest": { |
| "description": "Request message for AuditUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest", |
| "properties": { |
| "pageSize": { |
| "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse": { |
| "description": "Response message for AuditUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse", |
| "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" |
| }, |
| "userLinks": { |
| "description": "List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLink" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest": { |
| "description": "Request message for BatchCreateUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest", |
| "properties": { |
| "notifyNewUsers": { |
| "description": "Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.", |
| "type": "boolean" |
| }, |
| "requests": { |
| "description": "Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse": { |
| "description": "Response message for BatchCreateUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse", |
| "properties": { |
| "userLinks": { |
| "description": "The user links created.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest": { |
| "description": "Request message for BatchDeleteUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest", |
| "properties": { |
| "requests": { |
| "description": "Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse": { |
| "description": "Response message for BatchGetUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse", |
| "properties": { |
| "userLinks": { |
| "description": "The requested user links.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest": { |
| "description": "Request message for BatchUpdateUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest", |
| "properties": { |
| "requests": { |
| "description": "Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse": { |
| "description": "Response message for BatchUpdateUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse", |
| "properties": { |
| "userLinks": { |
| "description": "The user links updated.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest": { |
| "description": "Request message for CancelDisplayVideo360AdvertiserLinkProposal RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaCancelDisplayVideo360AdvertiserLinkProposalRequest", |
| "properties": {}, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaChangeHistoryChange": { |
| "description": "A description of a change to a single Google Analytics resource.", |
| "id": "GoogleAnalyticsAdminV1alphaChangeHistoryChange", |
| "properties": { |
| "action": { |
| "description": "The type of action that changed this resource.", |
| "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." |
| ], |
| "type": "string" |
| }, |
| "resource": { |
| "description": "Resource name of the resource whose changes are described by this entry.", |
| "type": "string" |
| }, |
| "resourceAfterChange": { |
| "$ref": "GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource", |
| "description": "Resource contents from after the change was made. If this resource was deleted in this change, this field will be missing." |
| }, |
| "resourceBeforeChange": { |
| "$ref": "GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource", |
| "description": "Resource contents from before the change was made. If this resource was created in this change, this field will be missing." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource": { |
| "description": "A snapshot of a resource as before or after the result of a change in change history.", |
| "id": "GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource", |
| "properties": { |
| "account": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccount", |
| "description": "A snapshot of an Account resource in change history." |
| }, |
| "androidAppDataStream": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream", |
| "description": "A snapshot of an AndroidAppDataStream resource in change history." |
| }, |
| "conversionEvent": { |
| "$ref": "GoogleAnalyticsAdminV1alphaConversionEvent", |
| "description": "A snapshot of a ConversionEvent resource in change history." |
| }, |
| "customDimension": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension", |
| "description": "A snapshot of a CustomDimension resource in change history." |
| }, |
| "customMetric": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric", |
| "description": "A snapshot of a CustomMetric resource in change history." |
| }, |
| "dataRetentionSettings": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings", |
| "description": "A snapshot of a data retention settings resource in change history." |
| }, |
| "displayVideo360AdvertiserLink": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink", |
| "description": "A snapshot of a DisplayVideo360AdvertiserLink resource in change history." |
| }, |
| "displayVideo360AdvertiserLinkProposal": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal", |
| "description": "A snapshot of a DisplayVideo360AdvertiserLinkProposal resource in change history." |
| }, |
| "firebaseLink": { |
| "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink", |
| "description": "A snapshot of a FirebaseLink resource in change history." |
| }, |
| "googleAdsLink": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink", |
| "description": "A snapshot of a GoogleAdsLink resource in change history." |
| }, |
| "googleSignalsSettings": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings", |
| "description": "A snapshot of a GoogleSignalsSettings resource in change history." |
| }, |
| "iosAppDataStream": { |
| "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream", |
| "description": "A snapshot of an IosAppDataStream resource in change history." |
| }, |
| "measurementProtocolSecret": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret", |
| "description": "A snapshot of a MeasurementProtocolSecret resource in change history." |
| }, |
| "property": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty", |
| "description": "A snapshot of a Property resource in change history." |
| }, |
| "webDataStream": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream", |
| "description": "A snapshot of a WebDataStream resource in change history." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaChangeHistoryEvent": { |
| "description": "A set of changes within a Google Analytics account or its child properties that resulted from the same cause. Common causes would be updates made in the Google Analytics UI, changes from customer support, or automatic Google Analytics system changes.", |
| "id": "GoogleAnalyticsAdminV1alphaChangeHistoryEvent", |
| "properties": { |
| "actorType": { |
| "description": "The type of actor that made this change.", |
| "enum": [ |
| "ACTOR_TYPE_UNSPECIFIED", |
| "USER", |
| "SYSTEM", |
| "SUPPORT" |
| ], |
| "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." |
| ], |
| "type": "string" |
| }, |
| "changeTime": { |
| "description": "Time when change was made.", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "changes": { |
| "description": "A list of changes made in this change history event that fit the filters specified in SearchChangeHistoryEventsRequest.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaChangeHistoryChange" |
| }, |
| "type": "array" |
| }, |
| "changesFiltered": { |
| "description": "If true, then the list of changes returned was filtered, and does not represent all changes that occurred in this event.", |
| "type": "boolean" |
| }, |
| "id": { |
| "description": "ID of this change history event. This ID is unique across Google Analytics.", |
| "type": "string" |
| }, |
| "userActorEmail": { |
| "description": "Email address of the Google account that made the change. This will be a valid email address if the actor field is set to USER, and empty otherwise. Google accounts that have been deleted will cause an error.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaConversionEvent": { |
| "description": "A conversion event in a Google Analytics property.", |
| "id": "GoogleAnalyticsAdminV1alphaConversionEvent", |
| "properties": { |
| "createTime": { |
| "description": "Output only. Time when this conversion event was created in the property.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "custom": { |
| "description": "Output only. If set to true, this conversion event refers to a custom event. If set to false, this conversion event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom conversion events that may be created per property.", |
| "readOnly": true, |
| "type": "boolean" |
| }, |
| "deletable": { |
| "description": "Output only. If set, this event can currently be deleted via DeleteConversionEvent.", |
| "readOnly": true, |
| "type": "boolean" |
| }, |
| "eventName": { |
| "description": "Immutable. The event name for this conversion event. Examples: 'click', 'purchase'", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest": { |
| "description": "Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the \"primary\" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the \"primary\" email address. As a result, the input and output email address for this request may differ.", |
| "id": "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest", |
| "properties": { |
| "notifyNewUser": { |
| "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", |
| "type": "boolean" |
| }, |
| "parent": { |
| "description": "Required. Example format: accounts/1234", |
| "type": "string" |
| }, |
| "userLink": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink", |
| "description": "Required. The user link to create." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaCustomDimension": { |
| "description": "A definition for a CustomDimension.", |
| "id": "GoogleAnalyticsAdminV1alphaCustomDimension", |
| "properties": { |
| "description": { |
| "description": "Optional. Description for this custom dimension. Max length of 150 characters.", |
| "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" |
| }, |
| "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" |
| }, |
| "name": { |
| "description": "Output only. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "parameterName": { |
| "description": "Required. Immutable. Tagging parameter name for this custom dimension. If this is a user-scoped dimension, then this is the user property name. If this is an event-scoped dimension, then this is the event parameter name. 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" |
| }, |
| "scope": { |
| "description": "Required. Immutable. The scope of this dimension.", |
| "enum": [ |
| "DIMENSION_SCOPE_UNSPECIFIED", |
| "EVENT", |
| "USER" |
| ], |
| "enumDescriptions": [ |
| "Scope unknown or not specified.", |
| "Dimension scoped to an event.", |
| "Dimension scoped to a user." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaCustomMetric": { |
| "description": "A definition for a custom metric.", |
| "id": "GoogleAnalyticsAdminV1alphaCustomMetric", |
| "properties": { |
| "description": { |
| "description": "Optional. Description for this custom dimension. Max length of 150 characters.", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.", |
| "type": "string" |
| }, |
| "measurementUnit": { |
| "description": "Required. The type for the custom metric's value.", |
| "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." |
| ], |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "parameterName": { |
| "description": "Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.", |
| "type": "string" |
| }, |
| "scope": { |
| "description": "Required. Immutable. The scope of this custom metric.", |
| "enum": [ |
| "METRIC_SCOPE_UNSPECIFIED", |
| "EVENT" |
| ], |
| "enumDescriptions": [ |
| "Scope unknown or not specified.", |
| "Metric scoped to an event." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaDataRetentionSettings": { |
| "description": "Settings values for data retention. This is a singleton resource.", |
| "id": "GoogleAnalyticsAdminV1alphaDataRetentionSettings", |
| "properties": { |
| "eventDataRetention": { |
| "description": "The length of time that event-level data is retained.", |
| "enum": [ |
| "RETENTION_DURATION_UNSPECIFIED", |
| "TWO_MONTHS", |
| "FOURTEEN_MONTHS", |
| "TWENTY_SIX_MONTHS", |
| "THIRTY_EIGHT_MONTHS", |
| "FIFTY_MONTHS" |
| ], |
| "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.", |
| "The data retention time duration is 38 months. Available to 360 properties only.", |
| "The data retention time duration is 50 months. Available to 360 properties only." |
| ], |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "resetUserDataOnNewActivity": { |
| "description": "If true, reset the retention period for the user identifier with every event from that user.", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaDataSharingSettings": { |
| "description": "A resource message representing data sharing settings of a Google Analytics account.", |
| "id": "GoogleAnalyticsAdminV1alphaDataSharingSettings", |
| "properties": { |
| "name": { |
| "description": "Output only. Resource name. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "sharingWithGoogleAnySalesEnabled": { |
| "description": "Allows any of Google sales to access the data in order to suggest configuration changes to improve results.", |
| "type": "boolean" |
| }, |
| "sharingWithGoogleAssignedSalesEnabled": { |
| "description": "Allows Google sales teams that are assigned to the customer to access the data in order to suggest configuration changes to improve results. Sales team restrictions still apply when enabled.", |
| "type": "boolean" |
| }, |
| "sharingWithGoogleProductsEnabled": { |
| "description": "Allows Google to use the data to improve other Google products or services.", |
| "type": "boolean" |
| }, |
| "sharingWithGoogleSupportEnabled": { |
| "description": "Allows Google support to access the data in order to help troubleshoot issues.", |
| "type": "boolean" |
| }, |
| "sharingWithOthersEnabled": { |
| "description": "Allows Google to share the data anonymously in aggregate form with others.", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest": { |
| "description": "Request message for DeleteUserLink RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest", |
| "properties": { |
| "name": { |
| "description": "Required. Example format: accounts/1234/userLinks/5678", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink": { |
| "description": "A link between a GA4 property and a Display & Video 360 advertiser.", |
| "id": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink", |
| "properties": { |
| "adsPersonalizationEnabled": { |
| "description": "Enables personalized advertising features with this integration. If this field is not set on create/update, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "advertiserDisplayName": { |
| "description": "Output only. The display name of the Display & Video 360 Advertiser.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "advertiserId": { |
| "description": "Immutable. The Display & Video 360 Advertiser's advertiser ID.", |
| "type": "string" |
| }, |
| "campaignDataSharingEnabled": { |
| "description": "Immutable. Enables the import of campaign data from Display & Video 360 into the GA4 property. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "costDataSharingEnabled": { |
| "description": "Immutable. Enables the import of cost data from Display & Video 360 into the GA4 property. This can only be enabled if campaign_data_sharing_enabled is enabled. After link creation, this can only be updated from the Display & Video 360 product. If this field is not set on create, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "name": { |
| "description": "Output only. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal": { |
| "description": "A proposal for a link between a GA4 property and a Display & Video 360 advertiser. A proposal is converted to a DisplayVideo360AdvertiserLink once approved. Google Analytics admins approve inbound proposals while Display & Video 360 admins approve outbound proposals.", |
| "id": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal", |
| "properties": { |
| "adsPersonalizationEnabled": { |
| "description": "Immutable. Enables personalized advertising features with this integration. If this field is not set on create, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "advertiserDisplayName": { |
| "description": "Output only. The display name of the Display & Video Advertiser. Only populated for proposals that originated from Display & Video 360.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "advertiserId": { |
| "description": "Immutable. The Display & Video 360 Advertiser's advertiser ID.", |
| "type": "string" |
| }, |
| "campaignDataSharingEnabled": { |
| "description": "Immutable. Enables the import of campaign data from Display & Video 360. If this field is not set on create, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "costDataSharingEnabled": { |
| "description": "Immutable. Enables the import of cost data from Display & Video 360. This can only be enabled if campaign_data_sharing_enabled is enabled. If this field is not set on create, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "linkProposalStatusDetails": { |
| "$ref": "GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails", |
| "description": "Output only. The status information for this link proposal.", |
| "readOnly": true |
| }, |
| "name": { |
| "description": "Output only. The resource name for this DisplayVideo360AdvertiserLinkProposal resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinkProposals/{proposalId} Note: proposalId is not the Display & Video 360 Advertiser ID", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "validationEmail": { |
| "description": "Input only. On a proposal being sent to Display & Video 360, this field must be set to the email address of an admin on the target advertiser. This is used to verify that the Google Analytics admin is aware of at least one admin on the Display & Video 360 Advertiser. This does not restrict approval of the proposal to a single user. Any admin on the Display & Video 360 Advertiser may approve the proposal.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaFirebaseLink": { |
| "description": "A link between a GA4 property and a Firebase project.", |
| "id": "GoogleAnalyticsAdminV1alphaFirebaseLink", |
| "properties": { |
| "createTime": { |
| "description": "Output only. Time when this FirebaseLink was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Example format: properties/1234/firebaseLinks/5678", |
| "readOnly": true, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaGlobalSiteTag": { |
| "description": "Read-only resource with the tag for sending data from a website to a WebDataStream.", |
| "id": "GoogleAnalyticsAdminV1alphaGlobalSiteTag", |
| "properties": { |
| "name": { |
| "description": "Output only. Resource name for this GlobalSiteTag resource. Format: properties/{propertyId}/globalSiteTag", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "snippet": { |
| "description": "Immutable. JavaScript code snippet to be pasted as the first item into the head tag of every webpage to measure.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaGoogleAdsLink": { |
| "description": "A link between a GA4 property and a Google Ads account.", |
| "id": "GoogleAnalyticsAdminV1alphaGoogleAdsLink", |
| "properties": { |
| "adsPersonalizationEnabled": { |
| "description": "Enable personalized advertising features with this integration. Automatically publish my Google Analytics audience lists and Google Analytics remarketing events/parameters to the linked Google Ads account. If this field is not set on create/update, it will be defaulted to true.", |
| "type": "boolean" |
| }, |
| "canManageClients": { |
| "description": "Output only. If true, this link is for a Google Ads manager account.", |
| "readOnly": true, |
| "type": "boolean" |
| }, |
| "createTime": { |
| "description": "Output only. Time when this link was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "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" |
| }, |
| "customerId": { |
| "description": "Immutable. Google Ads customer ID.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. Time when this link was last updated.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings": { |
| "description": "Settings values for Google Signals. This is a singleton resource.", |
| "id": "GoogleAnalyticsAdminV1alphaGoogleSignalsSettings", |
| "properties": { |
| "consent": { |
| "description": "Output only. Terms of Service acceptance.", |
| "enum": [ |
| "GOOGLE_SIGNALS_CONSENT_UNSPECIFIED", |
| "GOOGLE_SIGNALS_CONSENT_CONSENTED", |
| "GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED" |
| ], |
| "enumDescriptions": [ |
| "Google Signals consent value defaults to GOOGLE_SIGNALS_CONSENT_UNSPECIFIED. This will be treated as GOOGLE_SIGNALS_CONSENT_NOT_CONSENTED.", |
| "Terms of service have been accepted", |
| "Terms of service have not been accepted" |
| ], |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: \"properties/1000/googleSignalsSettings\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "state": { |
| "description": "Status of this setting.", |
| "enum": [ |
| "GOOGLE_SIGNALS_STATE_UNSPECIFIED", |
| "GOOGLE_SIGNALS_ENABLED", |
| "GOOGLE_SIGNALS_DISABLED" |
| ], |
| "enumDescriptions": [ |
| "Google Signals status defaults to GOOGLE_SIGNALS_STATE_UNSPECIFIED to represent that the user has not made an explicit choice.", |
| "Google Signals is enabled.", |
| "Google Signals is disabled." |
| ], |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaIosAppDataStream": { |
| "description": "A resource message representing a Google Analytics IOS app stream.", |
| "id": "GoogleAnalyticsAdminV1alphaIosAppDataStream", |
| "properties": { |
| "bundleId": { |
| "description": "Required. Immutable. The Apple App Store Bundle ID for the app Example: \"com.example.myiosapp\"", |
| "type": "string" |
| }, |
| "createTime": { |
| "description": "Output only. Time when this stream was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Human-readable display name for the Data Stream. The max allowed display name length is 255 UTF-16 code units.", |
| "type": "string" |
| }, |
| "firebaseAppId": { |
| "description": "Output only. ID of the corresponding iOS app in Firebase, if any. This ID can change if the iOS app is deleted and recreated.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/iosAppDataStreams/{stream_id} Example: \"properties/1000/iosAppDataStreams/2000\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. Time when stream payload fields were last updated.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails": { |
| "description": "Status information for a link proposal.", |
| "id": "GoogleAnalyticsAdminV1alphaLinkProposalStatusDetails", |
| "properties": { |
| "linkProposalInitiatingProduct": { |
| "description": "Output only. The source of this proposal.", |
| "enum": [ |
| "LINK_PROPOSAL_INITIATING_PRODUCT_UNSPECIFIED", |
| "GOOGLE_ANALYTICS", |
| "LINKED_PRODUCT" |
| ], |
| "enumDescriptions": [ |
| "Unspecified product.", |
| "This proposal was created by a user from Google Analytics.", |
| "This proposal was created by a user from a linked product (not Google Analytics)." |
| ], |
| "readOnly": true, |
| "type": "string" |
| }, |
| "linkProposalState": { |
| "description": "Output only. The state of this proposal.", |
| "enum": [ |
| "LINK_PROPOSAL_STATE_UNSPECIFIED", |
| "AWAITING_REVIEW_FROM_GOOGLE_ANALYTICS", |
| "AWAITING_REVIEW_FROM_LINKED_PRODUCT", |
| "WITHDRAWN", |
| "DECLINED", |
| "EXPIRED", |
| "OBSOLETE" |
| ], |
| "enumDescriptions": [ |
| "Unspecified state", |
| "This proposal is awaiting review from a Google Analytics user. This proposal will automatically expire after some time.", |
| "This proposal is awaiting review from a user of a linked product. This proposal will automatically expire after some time.", |
| "This proposal has been withdrawn by an admin on the initiating product. This proposal will be automatically deleted after some time.", |
| "This proposal has been declined by an admin on the receiving product. This proposal will be automatically deleted after some time.", |
| "This proposal expired due to lack of response from an admin on the receiving product. This proposal will be automatically deleted after some time.", |
| "This proposal has become obsolete because a link was directly created to the same external product resource that this proposal specifies. This proposal will be automatically deleted after some time." |
| ], |
| "readOnly": true, |
| "type": "string" |
| }, |
| "requestorEmail": { |
| "description": "Output only. The email address of the user that proposed this linkage.", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse": { |
| "description": "Response message for ListAccountSummaries RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListAccountSummariesResponse", |
| "properties": { |
| "accountSummaries": { |
| "description": "Account summaries of all accounts the caller has access to.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccountSummary" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListAccountsResponse": { |
| "description": "Request message for ListAccounts RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListAccountsResponse", |
| "properties": { |
| "accounts": { |
| "description": "Results that were accessible to the caller.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccount" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse": { |
| "description": "Request message for ListAndroidDataStreams RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListAndroidAppDataStreamsResponse", |
| "properties": { |
| "androidAppDataStreams": { |
| "description": "Results that matched the filter criteria and were accessible to the caller.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAndroidAppDataStream" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListConversionEventsResponse": { |
| "description": "Response message for ListConversionEvents RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListConversionEventsResponse", |
| "properties": { |
| "conversionEvents": { |
| "description": "The requested conversion events", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaConversionEvent" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse": { |
| "description": "Response message for ListCustomDimensions RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListCustomDimensionsResponse", |
| "properties": { |
| "customDimensions": { |
| "description": "List of CustomDimensions.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomDimension" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListCustomMetricsResponse": { |
| "description": "Response message for ListCustomMetrics RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListCustomMetricsResponse", |
| "properties": { |
| "customMetrics": { |
| "description": "List of CustomMetrics.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse": { |
| "description": "Response message for ListDisplayVideo360AdvertiserLinkProposals RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinkProposalsResponse", |
| "properties": { |
| "displayVideo360AdvertiserLinkProposals": { |
| "description": "List of DisplayVideo360AdvertiserLinkProposals.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLinkProposal" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse": { |
| "description": "Response message for ListDisplayVideo360AdvertiserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListDisplayVideo360AdvertiserLinksResponse", |
| "properties": { |
| "displayVideo360AdvertiserLinks": { |
| "description": "List of DisplayVideo360AdvertiserLinks.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse": { |
| "description": "Response message for ListFirebaseLinks RPC", |
| "id": "GoogleAnalyticsAdminV1alphaListFirebaseLinksResponse", |
| "properties": { |
| "firebaseLinks": { |
| "description": "List of FirebaseLinks. This will have at most one value.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaFirebaseLink" |
| }, |
| "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. Currently, Google Analytics supports only one FirebaseLink per property, so this will never be populated.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse": { |
| "description": "Response message for ListGoogleAdsLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListGoogleAdsLinksResponse", |
| "properties": { |
| "googleAdsLinks": { |
| "description": "List of GoogleAdsLinks.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaGoogleAdsLink" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse": { |
| "description": "Request message for ListIosAppDataStreams RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListIosAppDataStreamsResponse", |
| "properties": { |
| "iosAppDataStreams": { |
| "description": "Results that matched the filter criteria and were accessible to the caller.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaIosAppDataStream" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse": { |
| "description": "Response message for ListMeasurementProtocolSecret RPC", |
| "id": "GoogleAnalyticsAdminV1alphaListMeasurementProtocolSecretsResponse", |
| "properties": { |
| "measurementProtocolSecrets": { |
| "description": "A list of secrets for the parent stream specified in the request.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListPropertiesResponse": { |
| "description": "Response message for ListProperties RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListPropertiesResponse", |
| "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" |
| }, |
| "properties": { |
| "description": "Results that matched the filter criteria and were accessible to the caller.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaProperty" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListUserLinksResponse": { |
| "description": "Response message for ListUserLinks RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListUserLinksResponse", |
| "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" |
| }, |
| "userLinks": { |
| "description": "List of UserLinks. These will be ordered stably, but in an arbitrary order.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse": { |
| "description": "Request message for ListWebDataStreams RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaListWebDataStreamsResponse", |
| "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" |
| }, |
| "webDataStreams": { |
| "description": "Results that matched the filter criteria and were accessible to the caller.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaWebDataStream" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret": { |
| "description": "A secret value used for sending hits to Measurement Protocol.", |
| "id": "GoogleAnalyticsAdminV1alphaMeasurementProtocolSecret", |
| "properties": { |
| "displayName": { |
| "description": "Required. Human-readable display name for this secret.", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/webDataStreams/{webDataStream}/measurementProtocolSecrets/{measurementProtocolSecret}", |
| "readOnly": true, |
| "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.", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaProperty": { |
| "description": "A resource message representing a Google Analytics GA4 property.", |
| "id": "GoogleAnalyticsAdminV1alphaProperty", |
| "properties": { |
| "account": { |
| "description": "Immutable. The resource name of the parent account Format: accounts/{account_id} Example: \"accounts/123\"", |
| "type": "string" |
| }, |
| "createTime": { |
| "description": "Output only. Time when the entity was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "currencyCode": { |
| "description": "The currency type used in reports involving monetary values. Format: https://en.wikipedia.org/wiki/ISO_4217 Examples: \"USD\", \"EUR\", \"JPY\"", |
| "type": "string" |
| }, |
| "deleteTime": { |
| "description": "Output only. If set, the time at which this property was trashed. If not set, then this property is not currently in the trash can.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Required. Human-readable display name for this property. The max allowed display name length is 100 UTF-16 code units.", |
| "type": "string" |
| }, |
| "expireTime": { |
| "description": "Output only. If set, the time at which this trashed property will be permanently deleted. If not set, then this property is not currently in the trash can and is not slated to be deleted.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "industryCategory": { |
| "description": "Industry associated with this property Example: AUTOMOTIVE, FOOD_AND_DRINK", |
| "enum": [ |
| "INDUSTRY_CATEGORY_UNSPECIFIED", |
| "AUTOMOTIVE", |
| "BUSINESS_AND_INDUSTRIAL_MARKETS", |
| "FINANCE", |
| "HEALTHCARE", |
| "TECHNOLOGY", |
| "TRAVEL", |
| "OTHER", |
| "ARTS_AND_ENTERTAINMENT", |
| "BEAUTY_AND_FITNESS", |
| "BOOKS_AND_LITERATURE", |
| "FOOD_AND_DRINK", |
| "GAMES", |
| "HOBBIES_AND_LEISURE", |
| "HOME_AND_GARDEN", |
| "INTERNET_AND_TELECOM", |
| "LAW_AND_GOVERNMENT", |
| "NEWS", |
| "ONLINE_COMMUNITIES", |
| "PEOPLE_AND_SOCIETY", |
| "PETS_AND_ANIMALS", |
| "REAL_ESTATE", |
| "REFERENCE", |
| "SCIENCE", |
| "SPORTS", |
| "JOBS_AND_EDUCATION", |
| "SHOPPING" |
| ], |
| "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" |
| ], |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "parent": { |
| "description": "Immutable. Resource name of this property's logical parent. Note: The Property-Moving UI can be used to change the parent. Format: accounts/{account} Example: \"accounts/100\"", |
| "type": "string" |
| }, |
| "serviceLevel": { |
| "description": "Output only. The Google Analytics service level that applies to this property.", |
| "enum": [ |
| "SERVICE_LEVEL_UNSPECIFIED", |
| "GOOGLE_ANALYTICS_STANDARD", |
| "GOOGLE_ANALYTICS_360" |
| ], |
| "enumDescriptions": [ |
| "Service level not specified or invalid.", |
| "The standard version of Google Analytics.", |
| "The paid, premium version of Google Analytics." |
| ], |
| "readOnly": true, |
| "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": { |
| "description": "Output only. Time when entity payload fields were last updated.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaPropertySummary": { |
| "description": "A virtual resource representing metadata for a GA4 property.", |
| "id": "GoogleAnalyticsAdminV1alphaPropertySummary", |
| "properties": { |
| "displayName": { |
| "description": "Display name for the property referred to in this account summary.", |
| "type": "string" |
| }, |
| "property": { |
| "description": "Resource name of property referred to by this property summary Format: properties/{property_id} Example: \"properties/1000\"", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest": { |
| "description": "Request message for ProvisionAccountTicket RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest", |
| "properties": { |
| "account": { |
| "$ref": "GoogleAnalyticsAdminV1alphaAccount", |
| "description": "The account to create." |
| }, |
| "redirectUri": { |
| "description": "Redirect URI where the user will be sent after accepting Terms of Service. Must be configured in Developers Console as a Redirect URI", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse": { |
| "description": "Response message for ProvisionAccountTicket RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaProvisionAccountTicketResponse", |
| "properties": { |
| "accountTicketId": { |
| "description": "The param to be passed in the ToS link.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest": { |
| "description": "Request message for SearchChangeHistoryEvents RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest", |
| "properties": { |
| "action": { |
| "description": "Optional. If set, only return changes that match one or more of these types of actions.", |
| "items": { |
| "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." |
| ], |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "actorEmail": { |
| "description": "Optional. If set, only return changes if they are made by a user in this list.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "earliestChangeTime": { |
| "description": "Optional. If set, only return changes made after this time (inclusive).", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "latestChangeTime": { |
| "description": "Optional. If set, only return changes made before this time (inclusive).", |
| "format": "google-datetime", |
| "type": "string" |
| }, |
| "pageSize": { |
| "description": "Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", |
| "format": "int32", |
| "type": "integer" |
| }, |
| "pageToken": { |
| "description": "Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token.", |
| "type": "string" |
| }, |
| "property": { |
| "description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources.", |
| "type": "string" |
| }, |
| "resourceType": { |
| "description": "Optional. If set, only return changes if they are for a resource that matches at least one of these types.", |
| "items": { |
| "enum": [ |
| "CHANGE_HISTORY_RESOURCE_TYPE_UNSPECIFIED", |
| "ACCOUNT", |
| "PROPERTY", |
| "WEB_DATA_STREAM", |
| "ANDROID_APP_DATA_STREAM", |
| "IOS_APP_DATA_STREAM", |
| "FIREBASE_LINK", |
| "GOOGLE_ADS_LINK", |
| "GOOGLE_SIGNALS_SETTINGS", |
| "CONVERSION_EVENT", |
| "MEASUREMENT_PROTOCOL_SECRET", |
| "CUSTOM_DIMENSION", |
| "CUSTOM_METRIC", |
| "DATA_RETENTION_SETTINGS" |
| ], |
| "enumDescriptions": [ |
| "Resource type unknown or not specified.", |
| "Account resource", |
| "Property resource", |
| "WebDataStream resource", |
| "AndroidAppDataStream resource", |
| "IosAppDataStream resource", |
| "FirebaseLink resource", |
| "GoogleAdsLink resource", |
| "GoogleSignalsSettings resource", |
| "ConversionEvent resource", |
| "MeasurementProtocolSecret resource", |
| "CustomDimension resource", |
| "CustomMetric resource", |
| "DataRetentionSettings resource" |
| ], |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse": { |
| "description": "Response message for SearchAccounts RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsResponse", |
| "properties": { |
| "changeHistoryEvents": { |
| "description": "Results that were accessible to the caller.", |
| "items": { |
| "$ref": "GoogleAnalyticsAdminV1alphaChangeHistoryEvent" |
| }, |
| "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" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest": { |
| "description": "Request message for UpdateUserLink RPC.", |
| "id": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest", |
| "properties": { |
| "userLink": { |
| "$ref": "GoogleAnalyticsAdminV1alphaUserLink", |
| "description": "Required. The user link to update." |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaUserLink": { |
| "description": "A resource message representing a user's permissions on an Account or Property resource.", |
| "id": "GoogleAnalyticsAdminV1alphaUserLink", |
| "properties": { |
| "directRoles": { |
| "description": "Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "emailAddress": { |
| "description": "Immutable. Email address of the user to link", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Example format: properties/1234/userLinks/5678", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleAnalyticsAdminV1alphaWebDataStream": { |
| "description": "A resource message representing a Google Analytics web stream.", |
| "id": "GoogleAnalyticsAdminV1alphaWebDataStream", |
| "properties": { |
| "createTime": { |
| "description": "Output only. Time when this stream was originally created.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "defaultUri": { |
| "description": "Immutable. Domain name of the web app being measured, or empty. Example: \"http://www.google.com\", \"https://www.google.com\"", |
| "type": "string" |
| }, |
| "displayName": { |
| "description": "Required. Human-readable display name for the Data Stream. The max allowed display name length is 100 UTF-16 code units.", |
| "type": "string" |
| }, |
| "firebaseAppId": { |
| "description": "Output only. ID of the corresponding web app in Firebase, if any. This ID can change if the web app is deleted and recreated.", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "measurementId": { |
| "description": "Output only. Analytics \"Measurement ID\", without the \"G-\" prefix. Example: \"G-1A2BCD345E\" would just be \"1A2BCD345E\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "name": { |
| "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/webDataStreams/{stream_id} Example: \"properties/1000/webDataStreams/2000\"", |
| "readOnly": true, |
| "type": "string" |
| }, |
| "updateTime": { |
| "description": "Output only. Time when stream payload fields were last updated.", |
| "format": "google-datetime", |
| "readOnly": true, |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "GoogleProtobufEmpty": { |
| "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); } The JSON representation for `Empty` is empty JSON object `{}`.", |
| "id": "GoogleProtobufEmpty", |
| "properties": {}, |
| "type": "object" |
| } |
| }, |
| "servicePath": "", |
| "title": "Google Analytics Admin API", |
| "version": "v1alpha", |
| "version_module": true |
| } |
