{ "opencollection": "1.0.0", "info": { "name": "Google Analytics Admin API", "version": "v1alpha" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "accountSummaries", "type": "folder" }, "items": [ { "info": { "name": "Returns summaries of all accounts accessible by the caller", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accountSummaries", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns summaries of all accounts accessible by the caller." } ] }, { "info": { "name": "accounts", "type": "folder" }, "items": [ { "info": { "name": "Lookup for a single Account", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"" }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single Account." }, { "info": { "name": "Updates an account", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an account." }, { "info": { "name": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"" }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found." }, { "info": { "name": "Get data sharing settings on an account", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/dataSharingSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`" }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get data sharing settings on an account. Data sharing settings are singletons." }, { "info": { "name": "Returns all accounts accessible by the caller", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "showDeleted", "value": "", "type": "query", "description": "Whether to include soft-deleted (ie: \"trashed\") Accounts in the results. Accounts can be inspected to determine whether they are deleted or not." }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have access to is by using `ListAccountSummaries`." }, { "info": { "name": "Requests a ticket for creating an account", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts:provisionAccountTicket", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Requests a ticket for creating an account." }, { "info": { "name": "Returns a customized report of data access records", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId:runAccessReport", "params": [ { "name": "entity", "value": "", "type": "query", "description": "The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if \"123\" is your Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if \"1234\" is your Google Analytics Account ID." }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Exploratio" }, { "info": { "name": "Searches through all changes to an account or its children given the specified set of filters", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId:searchChangeHistoryEvents", "params": [ { "name": "account", "value": "", "type": "query", "description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes." }, { "info": { "name": "Creates information about multiple access bindings to an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings:batchCreate", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created." }, { "info": { "name": "Deletes information about multiple users' links to an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings:batchDelete", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes information about multiple users' links to an account or property." }, { "info": { "name": "Gets information about multiple access bindings to an account or property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings:batchGet", "params": [ { "name": "names", "value": "", "type": "query", "description": "Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}" }, { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets information about multiple access bindings to an account or property." }, { "info": { "name": "Updates information about multiple access bindings to an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings:batchUpdate", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates information about multiple access bindings to an account or property." }, { "info": { "name": "Lists all access bindings on an account or property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Formats: - accounts/{account} - properties/{property}" }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListAccessBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccessBindings` must match the call that provided the page token." }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all access bindings on an account or property." }, { "info": { "name": "Creates an access binding on an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Formats: - accounts/{account} - properties/{property}" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an access binding on an account or property." }, { "info": { "name": "Gets information about an access binding", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings/:accessBindingsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}" }, { "name": "accessBindingsId", "value": "", "type": "path" }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets information about an access binding." }, { "info": { "name": "Updates an access binding on an account or property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings/:accessBindingsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: \"accounts/100/accessBindings/200\"" }, { "name": "accessBindingsId", "value": "", "type": "path" }, { "name": "accountsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an access binding on an account or property." }, { "info": { "name": "Deletes an access binding on an account or property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/accounts/:accountsId/accessBindings/:accessBindingsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}" }, { "name": "accessBindingsId", "value": "", "type": "path" }, { "name": "accountsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an access binding on an account or property." } ] }, { "info": { "name": "properties", "type": "folder" }, "items": [ { "info": { "name": "Acknowledges the terms of user data collection for the specified property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId:acknowledgeUserDataCollection", "params": [ { "name": "property", "value": "", "type": "query", "description": "Required. The property for which to acknowledge user data collection." }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created." }, { "info": { "name": "Returns child Properties under the specified parent Account", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProperties` must match the call that provided the page token." }, { "name": "showDeleted", "value": "", "type": "query", "description": "Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not." }, { "name": "filter", "value": "", "type": "query", "description": "Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property) or `ancestor:`(The resource name of the parent account) or `firebase_project:`(The id or number of the linked firebase project). Some examples of filters: ``` | Filter | Description | |-----------------------------|-------------------------------------------| | parent:accounts/123 | The account with account id: 123. | | parent:properties/123 | The property with property id: 123. | | ancestor:accounts/123 | The account with account id: 123. | | firebase_project:project-id | The firebase project with id: project-id. | | firebase_project:123 | The firebase project with number: 123. | ```" }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found." }, { "info": { "name": "Creates a Google Analytics property with the specified location and attributes", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Google Analytics property with the specified location and attributes." }, { "info": { "name": "Create a roll-up property and all roll-up property source links", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties:createRollupProperty", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a roll-up property and all roll-up property source links." }, { "info": { "name": "Lookup for a single GA Property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single GA Property." }, { "info": { "name": "Updates a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a property." }, { "info": { "name": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found." }, { "info": { "name": "Lookup for a AttributionSettings singleton", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/attributionSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the attribution settings to retrieve. Format: properties/{property}/attributionSettings" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a AttributionSettings singleton." }, { "info": { "name": "Updates attribution settings on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/attributionSettings", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of this attribution settings resource. Format: properties/{property_id}/attributionSettings Example: \"properties/1000/attributionSettings\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates attribution settings on a property." }, { "info": { "name": "Returns the singleton data retention settings for this property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataRetentionSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the singleton data retention settings for this property." }, { "info": { "name": "Updates the singleton data retention settings for this property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataRetentionSettings", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the singleton data retention settings for this property." }, { "info": { "name": "Lookup for Google Signals settings for a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/googleSignalsSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the google signals settings to retrieve. Format: properties/{property}/googleSignalsSettings" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for Google Signals settings for a property." }, { "info": { "name": "Updates Google Signals settings for a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/googleSignalsSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of this setting. Format: properties/{property_id}/googleSignalsSettings Example: \"properties/1000/googleSignalsSettings\"" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates Google Signals settings for a property." }, { "info": { "name": "Returns the reporting identity settings for this property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingIdentitySettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the settings to lookup. Format: properties/{property}/reportingIdentitySettings Example: \"properties/1000/reportingIdentitySettings\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the reporting identity settings for this property." }, { "info": { "name": "Updates the reporting identity settings for this property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingIdentitySettings", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Optional. The list of fields to be updated. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields. If omitted, the service will treat it as an implied field mask equivalent to all fields that are populated." }, { "name": "name", "value": "", "type": "query", "description": "Output only. Identifier. Resource name for this reporting identity settings singleton resource. Format: properties/{property_id}/reportingIdentitySettings Example: \"properties/1234/reportingIdentitySettings\"" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the reporting identity settings for this property." }, { "info": { "name": "Looks up settings related to user-provided data for a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/userProvidedDataSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the user provided data settings to retrieve. Format: properties/{property}/userProvidedDataSettings" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Looks up settings related to user-provided data for a property." }, { "info": { "name": "Create a subproperty and a subproperty event filter that applies to the created subproperty", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties:provisionSubproperty", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Create a subproperty and a subproperty event filter that applies to the created subproperty." }, { "info": { "name": "Returns a customized report of data access records", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId:runAccessReport", "params": [ { "name": "entity", "value": "", "type": "query", "description": "The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if \"123\" is your Google Analytics property ID. To request at the account level, entity should be for example 'accounts/1234' if \"1234\" is your Google Analytics Account ID." }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions that aren't related to quota can only be requested on Google Analytics 360 properties. This method is only available to Administrators. These data access records include GA UI Reporting, GA UI Exploratio" }, { "info": { "name": "Submits a request for user deletion for a property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId:submitUserDeletion", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the property to submit user deletion for." }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Submits a request for user deletion for a property." }, { "info": { "name": "Creates information about multiple access bindings to an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings:batchCreate", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent field in the CreateAccessBindingRequest messages must either be empty or match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates information about multiple access bindings to an account or property. This method is transactional. If any AccessBinding cannot be created, none of the AccessBindings will be created." }, { "info": { "name": "Deletes information about multiple users' links to an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings:batchDelete", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field in DeleteAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes information about multiple users' links to an account or property." }, { "info": { "name": "Gets information about multiple access bindings to an account or property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings:batchGet", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent of all provided values for the 'names' field must match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "names", "value": "", "type": "query", "description": "Required. The names of the access bindings to retrieve. A maximum of 1000 access bindings can be retrieved in a batch. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets information about multiple access bindings to an account or property." }, { "info": { "name": "Updates information about multiple access bindings to an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings:batchUpdate", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The account or property that owns the access bindings. The parent of all provided AccessBinding in UpdateAccessBindingRequest messages must match this field. Formats: - accounts/{account} - properties/{property}" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates information about multiple access bindings to an account or property." }, { "info": { "name": "Lists all access bindings on an account or property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListAccessBindings` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccessBindings` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Formats: - accounts/{account} - properties/{property}" }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of access bindings to return. The service may return fewer than this value. If unspecified, at most 200 access bindings will be returned. The maximum value is 500; values above 500 will be coerced to 500." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all access bindings on an account or property." }, { "info": { "name": "Creates an access binding on an account or property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Formats: - accounts/{account} - properties/{property}" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an access binding on an account or property." }, { "info": { "name": "Gets information about an access binding", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings/:accessBindingsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the access binding to retrieve. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}" }, { "name": "accessBindingsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets information about an access binding." }, { "info": { "name": "Updates an access binding on an account or property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings/:accessBindingsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of this binding. Format: accounts/{account}/accessBindings/{access_binding} or properties/{property}/accessBindings/{access_binding} Example: \"accounts/100/accessBindings/200\"" }, { "name": "accessBindingsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an access binding on an account or property." }, { "info": { "name": "Deletes an access binding on an account or property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/accessBindings/:accessBindingsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Formats: - accounts/{account}/accessBindings/{accessBinding} - properties/{property}/accessBindings/{accessBinding}" }, { "name": "accessBindingsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an access binding on an account or property." }, { "info": { "name": "Lists AdSenseLinks on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/adSenseLinks", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A page token received from a previous `ListAdSenseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAdSenseLinks` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Resource name of the parent property. Format: properties/{propertyId} Example: properties/1234" }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists AdSenseLinks on a property." }, { "info": { "name": "Creates an AdSenseLink", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/adSenseLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The property for which to create an AdSense Link. Format: properties/{propertyId} Example: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an AdSenseLink." }, { "info": { "name": "Looks up a single AdSenseLink", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/adSenseLinks/:adSenseLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Unique identifier for the AdSense Link requested. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678" }, { "name": "adSenseLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Looks up a single AdSenseLink." }, { "info": { "name": "Deletes an AdSenseLink", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/adSenseLinks/:adSenseLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Unique identifier for the AdSense Link to be deleted. Format: properties/{propertyId}/adSenseLinks/{linkId} Example: properties/1234/adSenseLinks/5678" }, { "name": "adSenseLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an AdSenseLink." }, { "info": { "name": "Archives an Audience on a property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/audiences/:audiencesId:archive", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Example format: properties/1234/audiences/5678" }, { "name": "audiencesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Archives an Audience on a property." }, { "info": { "name": "Lists Audiences on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/audiences", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListAudiences` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAudiences` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists Audiences on a property. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions." }, { "info": { "name": "Creates an Audience", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/audiences", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an Audience." }, { "info": { "name": "Lookup for a single Audience", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/audiences/:audiencesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the Audience to get. Example format: properties/1234/audiences/5678" }, { "name": "audiencesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single Audience. Audiences created before 2020 may not be supported. Default audiences will not show filter definitions." }, { "info": { "name": "Updates an Audience on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/audiences/:audiencesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. The resource name for this Audience resource. Format: properties/{propertyId}/audiences/{audienceId}" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "audiencesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an Audience on a property." }, { "info": { "name": "Lists BigQuery Links on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/bigQueryLinks", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListBigQueryLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBigQueryLinks` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. The name of the property to list BigQuery links under. Format: properties/{property_id} Example: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists BigQuery Links on a property." }, { "info": { "name": "Creates a BigQueryLink", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/bigQueryLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a BigQueryLink." }, { "info": { "name": "Lookup for a single BigQuery Link", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/bigQueryLinks/:bigQueryLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the BigQuery link to lookup. Format: properties/{property_id}/bigQueryLinks/{bigquery_link_id} Example: properties/123/bigQueryLinks/456" }, { "name": "bigQueryLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single BigQuery Link." }, { "info": { "name": "Updates a BigQueryLink", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/bigQueryLinks/:bigQueryLinksId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of this BigQuery link. Format: 'properties/{property_id}/bigQueryLinks/{bigquery_link_id}' Format: 'properties/1234/bigQueryLinks/abc567'" }, { "name": "bigQueryLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a BigQueryLink." }, { "info": { "name": "Deletes a BigQueryLink on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/bigQueryLinks/:bigQueryLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The BigQueryLink to delete. Example format: properties/1234/bigQueryLinks/5678" }, { "name": "bigQueryLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a BigQueryLink on a property." }, { "info": { "name": "Lists CalculatedMetrics on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/calculatedMetrics", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListCalculatedMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCalculatedMetrics` must match the call that provided the page token." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists CalculatedMetrics on a property." }, { "info": { "name": "Creates a CalculatedMetric", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/calculatedMetrics", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Format: properties/{property_id} Example: properties/1234" }, { "name": "calculatedMetricId", "value": "", "type": "query", "description": "Required. The ID to use for the calculated metric which will become the final component of the calculated metric's resource name. This value should be 1-80 characters and valid characters are /[a-zA-Z0-9_]/, no spaces allowed. calculated_metric_id must be unique between all calculated metrics under a property. The calculated_metric_id is used when referencing this calculated metric from external APIs, for example, \"calcMetric:{calculated_metric_id}\"." }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a CalculatedMetric." }, { "info": { "name": "Lookup for a single CalculatedMetric", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/calculatedMetrics/:calculatedMetricsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the CalculatedMetric to get. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01" }, { "name": "calculatedMetricsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single CalculatedMetric." }, { "info": { "name": "Updates a CalculatedMetric on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/calculatedMetrics/:calculatedMetricsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name for this CalculatedMetric. Format: 'properties/{property_id}/calculatedMetrics/{calculated_metric_id}'" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "calculatedMetricsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a CalculatedMetric on a property." }, { "info": { "name": "Deletes a CalculatedMetric on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/calculatedMetrics/:calculatedMetricsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the CalculatedMetric to delete. Format: properties/{property_id}/calculatedMetrics/{calculated_metric_id} Example: properties/1234/calculatedMetrics/Metric01" }, { "name": "calculatedMetricsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a CalculatedMetric on a property." }, { "info": { "name": "Lists ChannelGroups on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/channelGroups", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListChannelGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChannelGroups` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. The property for which to list ChannelGroups. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists ChannelGroups on a property." }, { "info": { "name": "Creates a ChannelGroup", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/channelGroups", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The property for which to create a ChannelGroup. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a ChannelGroup." }, { "info": { "name": "Lookup for a single ChannelGroup", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/channelGroups/:channelGroupsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The ChannelGroup to get. Example format: properties/1234/channelGroups/5678" }, { "name": "channelGroupsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single ChannelGroup." }, { "info": { "name": "Updates a ChannelGroup", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/channelGroups/:channelGroupsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. The resource name for this Channel Group resource. Format: properties/{property}/channelGroups/{channel_group}" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "channelGroupsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a ChannelGroup." }, { "info": { "name": "Deletes a ChannelGroup on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/channelGroups/:channelGroupsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The ChannelGroup to delete. Example format: properties/1234/channelGroups/5678" }, { "name": "channelGroupsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a ChannelGroup on a property." }, { "info": { "name": "Deprecated: Use `ListKeyEvents` instead", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/conversionEvents", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConversionEvents` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. The resource name of the parent property. Example: 'properties/123'" }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found." }, { "info": { "name": "Deprecated: Use `CreateKeyEvent` instead", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/conversionEvents", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The resource name of the parent property where this conversion event will be created. Format: properties/123" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes." }, { "info": { "name": "Deprecated: Use `GetKeyEvent` instead", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/conversionEvents/:conversionEventsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conversionEvents/456\"" }, { "name": "conversionEventsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event." }, { "info": { "name": "Deprecated: Use `UpdateKeyEvent` instead", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/conversionEvents/:conversionEventsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "conversionEventsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes." }, { "info": { "name": "Deprecated: Use `DeleteKeyEvent` instead", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/conversionEvents/:conversionEventsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conversionEvents/456\"" }, { "name": "conversionEventsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property." }, { "info": { "name": "Archives a CustomDimension on a property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customDimensions/:customDimensionsId:archive", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678" }, { "name": "customDimensionsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Archives a CustomDimension on a property." }, { "info": { "name": "Lists CustomDimensions on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customDimensions", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomDimensions` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists CustomDimensions on a property." }, { "info": { "name": "Creates a CustomDimension", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customDimensions", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a CustomDimension. Warning: It's not permissible to use this method to collect data on individual users. In particular, sending user IDs in custom dimensions violates the [Google Analytics Terms of Service](https://www.google.com/analytics/terms/)." }, { "info": { "name": "Lookup for a single CustomDimension", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customDimensions/:customDimensionsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678" }, { "name": "customDimensionsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single CustomDimension." }, { "info": { "name": "Updates a CustomDimension on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customDimensions/:customDimensionsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "customDimensionsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a CustomDimension on a property." }, { "info": { "name": "Archives a CustomMetric on a property", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customMetrics/:customMetricsId:archive", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678" }, { "name": "customMetricsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Archives a CustomMetric on a property." }, { "info": { "name": "Lists CustomMetrics on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customMetrics", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListCustomMetrics` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCustomMetrics` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists CustomMetrics on a property." }, { "info": { "name": "Creates a CustomMetric", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customMetrics", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a CustomMetric." }, { "info": { "name": "Lookup for a single CustomMetric", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customMetrics/:customMetricsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678" }, { "name": "customMetricsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single CustomMetric." }, { "info": { "name": "Updates a CustomMetric on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/customMetrics/:customMetricsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "customMetricsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a CustomMetric on a property." }, { "info": { "name": "Lists DataStreams on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListDataStreams` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDataStreams` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists DataStreams on a property." }, { "info": { "name": "Creates a DataStream", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a DataStream." }, { "info": { "name": "Lookup for a single DataStream", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single DataStream." }, { "info": { "name": "Updates a DataStream on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a DataStream on a property." }, { "info": { "name": "Deletes a DataStream on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a DataStream on a property." }, { "info": { "name": "Lookup for a single DataRedactionSettings", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/dataRedactionSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: \"properties/1000/dataStreams/2000/dataRedactionSettings\"" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single DataRedactionSettings." }, { "info": { "name": "Updates a DataRedactionSettings on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/dataRedactionSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: \"properties/1000/dataStreams/2000/dataRedactionSettings\"" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a DataRedactionSettings on a property." }, { "info": { "name": "Returns the enhanced measurement settings for this data stream", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/enhancedMeasurementSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: \"properties/1000/dataStreams/2000/enhancedMeasurementSettings\"" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect." }, { "info": { "name": "Updates the enhanced measurement settings for this data stream", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/enhancedMeasurementSettings", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of the Enhanced Measurement Settings. Format: properties/{property_id}/dataStreams/{data_stream}/enhancedMeasurementSettings Example: \"properties/1000/dataStreams/2000/enhancedMeasurementSettings\"" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect." }, { "info": { "name": "Returns the Site Tag for the specified web stream", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/globalSiteTag", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag`" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns the Site Tag for the specified web stream. Site Tags are immutable singletons." }, { "info": { "name": "Lists EventCreateRules on a web data stream", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventCreateRules", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListEventCreateRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventCreateRules` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists EventCreateRules on a web data stream." }, { "info": { "name": "Creates an EventCreateRule", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventCreateRules", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an EventCreateRule." }, { "info": { "name": "Lookup for a single EventCreateRule", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventCreateRules/:eventCreateRulesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the EventCreateRule to get. Example format: properties/123/dataStreams/456/eventCreateRules/789" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "eventCreateRulesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single EventCreateRule." }, { "info": { "name": "Updates an EventCreateRule", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventCreateRules/:eventCreateRulesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name for this EventCreateRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventCreateRules/{event_create_rule}" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "eventCreateRulesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an EventCreateRule." }, { "info": { "name": "Deletes an EventCreateRule", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventCreateRules/:eventCreateRulesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456/eventCreateRules/789" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "eventCreateRulesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an EventCreateRule." }, { "info": { "name": "Lists EventEditRules on a web data stream", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventEditRules", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListEventEditRules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventEditRules` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456" }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists EventEditRules on a web data stream." }, { "info": { "name": "Creates an EventEditRule", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventEditRules", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates an EventEditRule." }, { "info": { "name": "Lookup for a single EventEditRule", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventEditRules/:eventEditRulesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the EventEditRule to get. Example format: properties/123/dataStreams/456/eventEditRules/789" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "eventEditRulesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single EventEditRule." }, { "info": { "name": "Updates an EventEditRule", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventEditRules/:eventEditRulesId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name for this EventEditRule resource. Format: properties/{property}/dataStreams/{data_stream}/eventEditRules/{event_edit_rule}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "eventEditRulesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an EventEditRule." }, { "info": { "name": "Deletes an EventEditRule", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventEditRules/:eventEditRulesId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456/eventEditRules/789" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "eventEditRulesId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes an EventEditRule." }, { "info": { "name": "Changes the processing order of event edit rules on the specified stream", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/eventEditRules:reorder", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/123/dataStreams/456" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Changes the processing order of event edit rules on the specified stream." }, { "info": { "name": "Returns child MeasurementProtocolSecrets under the specified parent Property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/measurementProtocolSecrets", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMeasurementProtocolSecrets` must match the call that provided the page token." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 10 resources will be returned. The maximum value is 10. Higher values will be coerced to the maximum." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns child MeasurementProtocolSecrets under the specified parent Property." }, { "info": { "name": "Creates a measurement protocol secret", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/measurementProtocolSecrets", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a measurement protocol secret." }, { "info": { "name": "Lookup for a single MeasurementProtocolSecret", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/measurementProtocolSecrets/:measurementProtocolSecretsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "measurementProtocolSecretsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single MeasurementProtocolSecret." }, { "info": { "name": "Updates a measurement protocol secret", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/measurementProtocolSecrets/:measurementProtocolSecretsId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "measurementProtocolSecretsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a measurement protocol secret." }, { "info": { "name": "Deletes target MeasurementProtocolSecret", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/measurementProtocolSecrets/:measurementProtocolSecretsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementProtocolSecret}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "measurementProtocolSecretsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes target MeasurementProtocolSecret." }, { "info": { "name": "Lists SKAdNetworkConversionValueSchema on a stream", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/sKAdNetworkConversionValueSchema", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "parent", "value": "", "type": "query", "description": "Required. The DataStream resource to list schemas for. Format: properties/{property_id}/dataStreams/{dataStream} Example: properties/1234/dataStreams/5678" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListSKAdNetworkConversionValueSchemas` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSKAdNetworkConversionValueSchema` must match the call that provided the page token." }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists SKAdNetworkConversionValueSchema on a stream. Properties can have at most one SKAdNetworkConversionValueSchema." }, { "info": { "name": "Creates a SKAdNetworkConversionValueSchema", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/sKAdNetworkConversionValueSchema", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The parent resource where this schema will be created. Format: properties/{property}/dataStreams/{dataStream}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a SKAdNetworkConversionValueSchema." }, { "info": { "name": "Looks up a single SKAdNetworkConversionValueSchema", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/sKAdNetworkConversionValueSchema/:sKAdNetworkConversionValueSchemaId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The resource name of SKAdNetwork conversion value schema to look up. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "sKAdNetworkConversionValueSchemaId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Looks up a single SKAdNetworkConversionValueSchema." }, { "info": { "name": "Updates a SKAdNetworkConversionValueSchema", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/sKAdNetworkConversionValueSchema/:sKAdNetworkConversionValueSchemaId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. Resource name of the schema. This will be child of ONLY an iOS stream, and there can be at most one such child under an iOS stream. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "sKAdNetworkConversionValueSchemaId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a SKAdNetworkConversionValueSchema." }, { "info": { "name": "Deletes target SKAdNetworkConversionValueSchema", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/dataStreams/:dataStreamsId/sKAdNetworkConversionValueSchema/:sKAdNetworkConversionValueSchemaId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the SKAdNetworkConversionValueSchema to delete. Format: properties/{property}/dataStreams/{dataStream}/sKAdNetworkConversionValueSchema/{skadnetwork_conversion_value_schema}" }, { "name": "dataStreamsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "sKAdNetworkConversionValueSchemaId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes target SKAdNetworkConversionValueSchema." }, { "info": { "name": "Approves a DisplayVideo360AdvertiserLinkProposal", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinkProposals/:displayVideo360AdvertiserLinkProposalsId:approve", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to approve. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678" }, { "name": "displayVideo360AdvertiserLinkProposalsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Approves a DisplayVideo360AdvertiserLinkProposal. The DisplayVideo360AdvertiserLinkProposal will be deleted and a new DisplayVideo360AdvertiserLink will be created." }, { "info": { "name": "Cancels a DisplayVideo360AdvertiserLinkProposal", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinkProposals/:displayVideo360AdvertiserLinkProposalsId:cancel", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to cancel. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678" }, { "name": "displayVideo360AdvertiserLinkProposalsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Lists DisplayVideo360AdvertiserLinkProposals on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinkProposals", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListDisplayVideo360AdvertiserLinkProposals` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinkProposals` must match the call that provided the page token." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists DisplayVideo360AdvertiserLinkProposals on a property." }, { "info": { "name": "Creates a DisplayVideo360AdvertiserLinkProposal", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinkProposals", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a DisplayVideo360AdvertiserLinkProposal." }, { "info": { "name": "Lookup for a single DisplayVideo360AdvertiserLinkProposal", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinkProposals/:displayVideo360AdvertiserLinkProposalsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to get. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678" }, { "name": "displayVideo360AdvertiserLinkProposalsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single DisplayVideo360AdvertiserLinkProposal." }, { "info": { "name": "Deletes a DisplayVideo360AdvertiserLinkProposal on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinkProposals/:displayVideo360AdvertiserLinkProposalsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DisplayVideo360AdvertiserLinkProposal to delete. Example format: properties/1234/displayVideo360AdvertiserLinkProposals/5678" }, { "name": "displayVideo360AdvertiserLinkProposalsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a DisplayVideo360AdvertiserLinkProposal on a property. This can only be used on cancelled proposals." }, { "info": { "name": "Lists all DisplayVideo360AdvertiserLinks on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinks", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListDisplayVideo360AdvertiserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDisplayVideo360AdvertiserLinks` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all DisplayVideo360AdvertiserLinks on a property." }, { "info": { "name": "Creates a DisplayVideo360AdvertiserLink", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Look up a single DisplayVideo360AdvertiserLink", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinks/:displayVideo360AdvertiserLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DisplayVideo360AdvertiserLink to get. Example format: properties/1234/displayVideo360AdvertiserLink/5678" }, { "name": "displayVideo360AdvertiserLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Look up a single DisplayVideo360AdvertiserLink" }, { "info": { "name": "Updates a DisplayVideo360AdvertiserLink on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinks/:displayVideo360AdvertiserLinksId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Identifier. The resource name for this DisplayVideo360AdvertiserLink resource. Format: properties/{propertyId}/displayVideo360AdvertiserLinks/{linkId} Note: linkId is not the Display & Video 360 Advertiser ID" }, { "name": "displayVideo360AdvertiserLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a DisplayVideo360AdvertiserLink on a property." }, { "info": { "name": "Deletes a DisplayVideo360AdvertiserLink on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/displayVideo360AdvertiserLinks/:displayVideo360AdvertiserLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the DisplayVideo360AdvertiserLink to delete. Example format: properties/1234/displayVideo360AdvertiserLinks/5678" }, { "name": "displayVideo360AdvertiserLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a DisplayVideo360AdvertiserLink on a property." }, { "info": { "name": "Lists ExpandedDataSets on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/expandedDataSets", "params": [ { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListExpandedDataSets` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListExpandedDataSet` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists ExpandedDataSets on a property." }, { "info": { "name": "Creates a ExpandedDataSet", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/expandedDataSets", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a ExpandedDataSet." }, { "info": { "name": "Lookup for a single ExpandedDataSet", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/expandedDataSets/:expandedDataSetsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the ExpandedDataSet to get. Example format: properties/1234/expandedDataSets/5678" }, { "name": "expandedDataSetsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single ExpandedDataSet." }, { "info": { "name": "Updates a ExpandedDataSet on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/expandedDataSets/:expandedDataSetsId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Output only. The resource name for this ExpandedDataSet resource. Format: properties/{property_id}/expandedDataSets/{expanded_data_set}" }, { "name": "expandedDataSetsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a ExpandedDataSet on a property." }, { "info": { "name": "Deletes a ExpandedDataSet on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/expandedDataSets/:expandedDataSetsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Example format: properties/1234/expandedDataSets/5678" }, { "name": "expandedDataSetsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a ExpandedDataSet on a property." }, { "info": { "name": "Lists FirebaseLinks on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/firebaseLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Format: properties/{property_id} Example: `properties/1234`" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink." }, { "info": { "name": "Creates a FirebaseLink", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/firebaseLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Format: properties/{property_id} Example: `properties/1234`" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a FirebaseLink. Properties can have at most one FirebaseLink." }, { "info": { "name": "Deletes a FirebaseLink on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/firebaseLinks/:firebaseLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`" }, { "name": "firebaseLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a FirebaseLink on a property" }, { "info": { "name": "Lists GoogleAdsLinks on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/googleAdsLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListGoogleAdsLinks` must match the call that provided the page token." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists GoogleAdsLinks on a property." }, { "info": { "name": "Creates a GoogleAdsLink", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/googleAdsLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a GoogleAdsLink." }, { "info": { "name": "Updates a GoogleAdsLink on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/googleAdsLinks/:googleAdsLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID." }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "googleAdsLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a GoogleAdsLink on a property" }, { "info": { "name": "Deletes a GoogleAdsLink on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/googleAdsLinks/:googleAdsLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Example format: properties/1234/googleAdsLinks/5678" }, { "name": "googleAdsLinksId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a GoogleAdsLink on a property" }, { "info": { "name": "Returns a list of Key Events in the specified parent property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/keyEvents", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "parent", "value": "", "type": "query", "description": "Required. The resource name of the parent property. Example: 'properties/123'" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListKeyEvents` must match the call that provided the page token." }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found." }, { "info": { "name": "Creates a Key Event", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/keyEvents", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The resource name of the parent property where this Key Event will be created. Format: properties/123" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Key Event." }, { "info": { "name": "Retrieve a single Key Event", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/keyEvents/:keyEventsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"" }, { "name": "keyEventsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve a single Key Event." }, { "info": { "name": "Updates a Key Event", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/keyEvents/:keyEventsId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}" }, { "name": "keyEventsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a Key Event." }, { "info": { "name": "Deletes a Key Event", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/keyEvents/:keyEventsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"" }, { "name": "keyEventsId", "value": "", "type": "path" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a Key Event." }, { "info": { "name": "List all Reporting Data Annotations on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingDataAnnotations", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Optional. Filter that restricts which reporting data annotations under the parent property are listed. Supported fields are: * 'name' * `title` * `description` * `annotation_date` * `annotation_date_range` * `color` Additionally, this API provides the following helper functions: * annotation_duration() : the duration that this annotation marks, [durations](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/duration.proto). expect a numeric representation of seconds followed by an `s` suffix. * is_annotation_in_range(start_date, end_date) : if the annotation is in the range specified by the `start_date` and `end_date`. The dates are in ISO-8601 format, for example `2031-06-28`. Supported operations: * `=` : equals * `!=` : not equals * `<` : less than * `>` : greater than * `<=` : less than or equals * `>=` : greater than or equals * `:` : has operator * `=~` : [regular expression](https://github.com/google/re2/wiki/Syntax) match * `!~` : [regular expression](https://github.com/google/re2/wiki/Syntax) does not match * `NOT` : Logical not * `AND` : Logical and * `OR` : Logical or Examples: 1. `title=\"Holiday Sale\"` 2. `description=~\"[Bb]ig [Gg]ame.*[Ss]ale\"` 3. `is_annotation_in_range(\"2025-12-25\", \"2026-01-16\") = true` 4. `annotation_duration() >= 172800s AND title:BOGO`" }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListReportingDataAnnotations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReportingDataAnnotations` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Resource name of the property. Format: properties/property_id Example: properties/123" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all Reporting Data Annotations on a property." }, { "info": { "name": "Creates a Reporting Data Annotation", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingDataAnnotations", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The property for which to create a Reporting Data Annotation. Format: properties/property_id Example: properties/123" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a Reporting Data Annotation." }, { "info": { "name": "Lookup a single Reporting Data Annotation", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingDataAnnotations/:reportingDataAnnotationsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Resource name of the Reporting Data Annotation to lookup. Format: properties/property_id/reportingDataAnnotations/reportingDataAnnotation Example: properties/123/reportingDataAnnotations/456" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "reportingDataAnnotationsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup a single Reporting Data Annotation." }, { "info": { "name": "Updates a Reporting Data Annotation", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingDataAnnotations/:reportingDataAnnotationsId", "params": [ { "name": "updateMask", "value": "", "type": "query", "description": "Optional. The list of fields to update. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "name", "value": "", "type": "query", "description": "Required. Identifier. Resource name of this Reporting Data Annotation. Format: 'properties/{property_id}/reportingDataAnnotations/{reporting_data_annotation}' Format: 'properties/123/reportingDataAnnotations/456'" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "reportingDataAnnotationsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a Reporting Data Annotation." }, { "info": { "name": "Deletes a Reporting Data Annotation", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/reportingDataAnnotations/:reportingDataAnnotationsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Resource name of the Reporting Data Annotation to delete. Format: properties/property_id/reportingDataAnnotations/reporting_data_annotation Example: properties/123/reportingDataAnnotations/456" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "reportingDataAnnotationsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a Reporting Data Annotation." }, { "info": { "name": "Lists roll-up property source Links on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/rollupPropertySourceLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListRollupPropertySourceLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollupPropertySourceLinks` must match the call that provided the page token." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties." }, { "info": { "name": "Creates a roll-up property source link", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/rollupPropertySourceLinks", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Format: properties/{property_id} Example: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties." }, { "info": { "name": "Lookup for a single roll-up property source Link", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/rollupPropertySourceLinks/:rollupPropertySourceLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "rollupPropertySourceLinksId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties." }, { "info": { "name": "Deletes a roll-up property source link", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/rollupPropertySourceLinks/:rollupPropertySourceLinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "rollupPropertySourceLinksId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties." }, { "info": { "name": "Lists all SearchAds360Links on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/searchAds360Links", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum)." }, { "name": "pageToken", "value": "", "type": "query", "description": "A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lists all SearchAds360Links on a property." }, { "info": { "name": "Creates a SearchAds360Link", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/searchAds360Links", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Example format: properties/1234" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a SearchAds360Link." }, { "info": { "name": "Look up a single SearchAds360Link", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/searchAds360Links/:searchAds360LinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "searchAds360LinksId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Look up a single SearchAds360Link" }, { "info": { "name": "Updates a SearchAds360Link on a property", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/searchAds360Links/:searchAds360LinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Identifier. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "searchAds360LinksId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a SearchAds360Link on a property." }, { "info": { "name": "Deletes a SearchAds360Link on a property", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/searchAds360Links/:searchAds360LinksId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "searchAds360LinksId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a SearchAds360Link on a property." }, { "info": { "name": "List all subproperty Event Filters on a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertyEventFilters", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token." }, { "name": "parent", "value": "", "type": "query", "description": "Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all subproperty Event Filters on a property." }, { "info": { "name": "Creates a subproperty Event Filter", "type": "http" }, "http": { "method": "POST", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertyEventFilters", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123" }, { "name": "propertiesId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Creates a subproperty Event Filter." }, { "info": { "name": "Lookup for a single subproperty Event Filter", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertyEventFilters/:subpropertyEventFiltersId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "subpropertyEventFiltersId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single subproperty Event Filter." }, { "info": { "name": "Updates a subproperty Event Filter", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertyEventFilters/:subpropertyEventFiltersId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678" }, { "name": "updateMask", "value": "", "type": "query", "description": "Required. The list of fields to update. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "subpropertyEventFiltersId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a subproperty Event Filter." }, { "info": { "name": "Deletes a subproperty event filter", "type": "http" }, "http": { "method": "DELETE", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertyEventFilters/:subpropertyEventFiltersId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "subpropertyEventFiltersId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a subproperty event filter." }, { "info": { "name": "Lookup for a single `SubpropertySyncConfig`", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertySyncConfigs/:subpropertySyncConfigsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Required. Resource name of the SubpropertySyncConfig to lookup. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678" }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "subpropertySyncConfigsId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Lookup for a single `SubpropertySyncConfig`." }, { "info": { "name": "Updates a `SubpropertySyncConfig`", "type": "http" }, "http": { "method": "PATCH", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertySyncConfigs/:subpropertySyncConfigsId", "params": [ { "name": "name", "value": "", "type": "query", "description": "Output only. Identifier. Format: properties/{ordinary_property_id}/subpropertySyncConfigs/{subproperty_id} Example: properties/1234/subpropertySyncConfigs/5678" }, { "name": "updateMask", "value": "", "type": "query", "description": "Optional. The list of fields to update. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields." }, { "name": "propertiesId", "value": "", "type": "path" }, { "name": "subpropertySyncConfigsId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates a `SubpropertySyncConfig`." }, { "info": { "name": "List all `SubpropertySyncConfig` resources for a property", "type": "http" }, "http": { "method": "GET", "url": "https://analyticsadmin.googleapis.com/v1alpha/properties/:propertiesId/subpropertySyncConfigs", "params": [ { "name": "parent", "value": "", "type": "query", "description": "Required. Resource name of the property. Format: properties/property_id Example: properties/123" }, { "name": "pageToken", "value": "", "type": "query", "description": "Optional. A page token, received from a previous `ListSubpropertySyncConfig` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertySyncConfig` must match the call that provided the page token." }, { "name": "pageSize", "value": "", "type": "query", "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)" }, { "name": "propertiesId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://accounts.google.com/o/oauth2/v2/auth", "accessTokenUrl": "https://oauth2.googleapis.com/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "List all `SubpropertySyncConfig` resources for a property." } ] } ], "bundled": true }