{"name":"analyticsadmin","version":"v1beta","revision":"20261007","title":"Google Analytics Admin API","rootUrl":"https://analyticsadmin.googleapis.com/","servicePath":"","basePath":"","batchPath":"batch","methods":[{"id":"accounts.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/accounts/{accountsId}","description":"Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Propertie","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the Account to soft-delete. Format: accounts/{account} Example: \"accounts/100\"","enum":null}]},{"id":"accounts.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/accounts/{accountsId}","description":"Lookup for a single Account.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the account to lookup. Format: accounts/{account} Example: \"accounts/100\"","enum":null}]},{"id":"accounts.getDataSharingSettings","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/accounts/{accountsId}/dataSharingSettings","description":"Get data sharing settings on an account. Data sharing settings are singletons.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`","enum":null}]},{"id":"accounts.list","httpMethod":"GET","path":"v1beta/accounts","flatPath":"v1beta/accounts","description":"Returns all accounts accessible by the caller. Note that these accounts might not currently have GA properties. Soft-deleted (ie: \"trashed\") accounts are excluded by default. Returns an empty list if no relevant accounts are found. Note: The easiest way to retrieve a list of all properties you have ","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":[],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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 5","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provid","enum":null},{"name":"showDeleted","type":"boolean","required":false,"repeated":false,"location":"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.","enum":null}]},{"id":"accounts.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/accounts/{accountsId}","description":"Updates an account.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name of this account. Format: accounts/{account} Example: \"accounts/100\"","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"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 t","enum":null}]},{"id":"accounts.provisionAccountTicket","httpMethod":"POST","path":"v1beta/accounts:provisionAccountTicket","flatPath":"v1beta/accounts:provisionAccountTicket","description":"Requests a ticket for creating an account.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":[],"parameters":[]},{"id":"accounts.runAccessReport","httpMethod":"POST","path":"v1beta/{+entity}:runAccessReport","flatPath":"v1beta/accounts/{accountsId}:runAccessReport","description":"Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions tha","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["entity"],"parameters":[{"name":"entity","type":"string","required":true,"repeated":false,"location":"path","description":"The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for","enum":null}]},{"id":"accounts.searchChangeHistoryEvents","httpMethod":"POST","path":"v1beta/{+account}:searchChangeHistoryEvents","flatPath":"v1beta/accounts/{accountsId}:searchChangeHistoryEvents","description":"Searches through all changes to an account or its children given the specified set of filters. Only returns the subset of changes supported by the API. The UI may return additional changes.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["account"],"parameters":[{"name":"account","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`","enum":null}]},{"id":"accountSummaries.list","httpMethod":"GET","path":"v1beta/accountSummaries","flatPath":"v1beta/accountSummaries","description":"Returns summaries of all accounts accessible by the caller.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":[],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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 unspeci","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameter","enum":null}]},{"id":"properties.acknowledgeUserDataCollection","httpMethod":"POST","path":"v1beta/{+property}:acknowledgeUserDataCollection","flatPath":"v1beta/properties/{propertiesId}:acknowledgeUserDataCollection","description":"Acknowledges the terms of user data collection for the specified property. This acknowledgement must be completed (either in the Google Analytics UI or through this API) before MeasurementProtocolSecret resources may be created.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["property"],"parameters":[{"name":"property","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The property for which to acknowledge user data collection.","enum":null}]},{"id":"properties.conversionEvents.create","httpMethod":"POST","path":"v1beta/{+parent}/conversionEvents","flatPath":"v1beta/properties/{propertiesId}/conversionEvents","description":"Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the parent property where this conversion event will be created. Format: properties/123","enum":null}]},{"id":"properties.conversionEvents.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}","description":"Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conver","enum":null}]},{"id":"properties.conversionEvents.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}","description":"Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: \"properties/123/conv","enum":null}]},{"id":"properties.conversionEvents.list","httpMethod":"GET","path":"v1beta/{+parent}/conversionEvents","flatPath":"v1beta/properties/{propertiesId}/conversionEvents","description":"Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"query","description":"Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coe","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListConversionEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameter","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the parent property. Example: 'properties/123'","enum":null}]},{"id":"properties.conversionEvents.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}","description":"Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event}","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"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 enti","enum":null}]},{"id":"properties.create","httpMethod":"POST","path":"v1beta/properties","flatPath":"v1beta/properties","description":"Creates a Google Analytics property with the specified location and attributes.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":[],"parameters":[]},{"id":"properties.customDimensions.archive","httpMethod":"POST","path":"v1beta/{+name}:archive","flatPath":"v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}:archive","description":"Archives a CustomDimension on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the CustomDimension to archive. Example format: properties/1234/customDimensions/5678","enum":null}]},{"id":"properties.customDimensions.create","httpMethod":"POST","path":"v1beta/{+parent}/customDimensions","flatPath":"v1beta/properties/{propertiesId}/customDimensions","description":"Creates a CustomDimension. Warning: It's not permissible to use this method to collect data on individual users. In particular, sending user IDs in custom dimensions violates the [Google Analytics Terms of Service](https://www.google.com/analytics/terms/).","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.customDimensions.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}","description":"Lookup for a single CustomDimension.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the CustomDimension to get. Example format: properties/1234/customDimensions/5678","enum":null}]},{"id":"properties.customDimensions.list","httpMethod":"GET","path":"v1beta/{+parent}/customDimensions","flatPath":"v1beta/properties/{propertiesId}/customDimensions","description":"Lists CustomDimensions on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"query","description":"Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coer","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListCustomDimensions` call. Provide this to retrieve the subsequent page. When paginating, all other parameter","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.customDimensions.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/customDimensions/{customDimensionsId}","description":"Updates a CustomDimension on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name for this CustomDimension resource. Format: properties/{property}/customDimensions/{customDimension}","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"query","description":"Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fiel","enum":null}]},{"id":"properties.customMetrics.archive","httpMethod":"POST","path":"v1beta/{+name}:archive","flatPath":"v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}:archive","description":"Archives a CustomMetric on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the CustomMetric to archive. Example format: properties/1234/customMetrics/5678","enum":null}]},{"id":"properties.customMetrics.create","httpMethod":"POST","path":"v1beta/{+parent}/customMetrics","flatPath":"v1beta/properties/{propertiesId}/customMetrics","description":"Creates a CustomMetric.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.customMetrics.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}","description":"Lookup for a single CustomMetric.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the CustomMetric to get. Example format: properties/1234/customMetrics/5678","enum":null}]},{"id":"properties.customMetrics.list","httpMethod":"GET","path":"v1beta/{+parent}/customMetrics","flatPath":"v1beta/properties/{propertiesId}/customMetrics","description":"Lists CustomMetrics on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"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","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.customMetrics.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/customMetrics/{customMetricsId}","description":"Updates a CustomMetric on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"query","description":"Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fiel","enum":null}]},{"id":"properties.dataStreams.create","httpMethod":"POST","path":"v1beta/{+parent}/dataStreams","flatPath":"v1beta/properties/{propertiesId}/dataStreams","description":"Creates a DataStream.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.dataStreams.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}","description":"Deletes a DataStream on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the DataStream to delete. Example format: properties/1234/dataStreams/5678","enum":null}]},{"id":"properties.dataStreams.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}","description":"Lookup for a single DataStream.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the DataStream to get. Example format: properties/1234/dataStreams/5678","enum":null}]},{"id":"properties.dataStreams.list","httpMethod":"GET","path":"v1beta/{+parent}/dataStreams","flatPath":"v1beta/properties/{propertiesId}/dataStreams","description":"Lists DataStreams on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"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 `","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.dataStreams.measurementProtocolSecrets.create","httpMethod":"POST","path":"v1beta/{+parent}/measurementProtocolSecrets","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets","description":"Creates a measurement protocol secret.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The parent resource where this secret will be created. Format: properties/{property}/dataStreams/{dataStream}","enum":null}]},{"id":"properties.dataStreams.measurementProtocolSecrets.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}","description":"Deletes target MeasurementProtocolSecret.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the MeasurementProtocolSecret to delete. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementPro","enum":null}]},{"id":"properties.dataStreams.measurementProtocolSecrets.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}","description":"Lookup for a single MeasurementProtocolSecret.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the measurement protocol secret to lookup. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets/{measurementP","enum":null}]},{"id":"properties.dataStreams.measurementProtocolSecrets.list","httpMethod":"GET","path":"v1beta/{+parent}/measurementProtocolSecrets","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets","description":"Returns child MeasurementProtocolSecrets under the specified parent Property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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 coerc","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListMeasurementProtocolSecrets` call. Provide this to retrieve the subsequent page. When paginating, all other","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the parent stream. Format: properties/{property}/dataStreams/{dataStream}/measurementProtocolSecrets","enum":null}]},{"id":"properties.dataStreams.measurementProtocolSecrets.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/measurementProtocolSecrets/{measurementProtocolSecretsId}","description":"Updates a measurement protocol secret.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name of this secret. This secret may be a child of any type of stream. Format: properties/{property}/dataStreams/{dataStream}/measurementPr","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"query","description":"Required. The list of fields to be updated. Omitted fields will not be updated.","enum":null}]},{"id":"properties.dataStreams.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}","description":"Updates a DataStream on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"query","description":"Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fiel","enum":null}]},{"id":"properties.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}","description":"Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: Goo","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the Property to soft-delete. Format: properties/{property_id} Example: \"properties/1000\"","enum":null}]},{"id":"properties.firebaseLinks.create","httpMethod":"POST","path":"v1beta/{+parent}/firebaseLinks","flatPath":"v1beta/properties/{propertiesId}/firebaseLinks","description":"Creates a FirebaseLink. Properties can have at most one FirebaseLink.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Format: properties/{property_id} Example: `properties/1234`","enum":null}]},{"id":"properties.firebaseLinks.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/firebaseLinks/{firebaseLinksId}","description":"Deletes a FirebaseLink on a property","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`","enum":null}]},{"id":"properties.firebaseLinks.list","httpMethod":"GET","path":"v1beta/{+parent}/firebaseLinks","flatPath":"v1beta/properties/{propertiesId}/firebaseLinks","description":"Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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 5","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters p","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Format: properties/{property_id} Example: `properties/1234`","enum":null}]},{"id":"properties.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}","description":"Lookup for a single GA Property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the property to lookup. Format: properties/{property_id} Example: \"properties/1000\"","enum":null}]},{"id":"properties.getDataRetentionSettings","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataRetentionSettings","description":"Returns the singleton data retention settings for this property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings Example: \"properties/1000/dataRetentionSettings\"","enum":null}]},{"id":"properties.googleAdsLinks.create","httpMethod":"POST","path":"v1beta/{+parent}/googleAdsLinks","flatPath":"v1beta/properties/{propertiesId}/googleAdsLinks","description":"Creates a GoogleAdsLink.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.googleAdsLinks.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}","description":"Deletes a GoogleAdsLink on a property","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234/googleAdsLinks/5678","enum":null}]},{"id":"properties.googleAdsLinks.list","httpMethod":"GET","path":"v1beta/{+parent}/googleAdsLinks","flatPath":"v1beta/properties/{propertiesId}/googleAdsLinks","description":"Lists GoogleAdsLinks on a property.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"query","description":"Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coer","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListGoogleAdsLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters ","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. Example format: properties/1234","enum":null}]},{"id":"properties.googleAdsLinks.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/googleAdsLinks/{googleAdsLinksId}","description":"Updates a GoogleAdsLink on a property","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Format: properties/{propertyId}/googleAdsLinks/{googleAdsLinkId} Note: googleAdsLinkId is not the Google Ads customer ID.","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"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 enti","enum":null}]},{"id":"properties.keyEvents.create","httpMethod":"POST","path":"v1beta/{+parent}/keyEvents","flatPath":"v1beta/properties/{propertiesId}/keyEvents","description":"Creates a Key Event.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["parent"],"parameters":[{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the parent property where this Key Event will be created. Format: properties/123","enum":null}]},{"id":"properties.keyEvents.delete","httpMethod":"DELETE","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}","description":"Deletes a Key Event.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the Key Event to delete. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"","enum":null}]},{"id":"properties.keyEvents.get","httpMethod":"GET","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}","description":"Retrieves a single Key Event.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the Key Event to retrieve. Format: properties/{property}/keyEvents/{key_event} Example: \"properties/123/keyEvents/456\"","enum":null}]},{"id":"properties.keyEvents.list","httpMethod":"GET","path":"v1beta/{+parent}/keyEvents","flatPath":"v1beta/properties/{propertiesId}/keyEvents","description":"Returns a list of Key Events in the specified parent property. Returns an empty list if no Key Events are found.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["parent"],"parameters":[{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"query","description":"Optional. The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coe","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListKeyEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provi","enum":null},{"name":"parent","type":"string","required":true,"repeated":false,"location":"path","description":"Required. The resource name of the parent property. Example: 'properties/123'","enum":null}]},{"id":"properties.keyEvents.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/keyEvents/{keyEventsId}","description":"Updates a Key Event.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"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 enti","enum":null}]},{"id":"properties.list","httpMethod":"GET","path":"v1beta/properties","flatPath":"v1beta/properties","description":"Returns child Properties under the specified parent Account. Properties will be excluded if the caller does not have access. Soft-deleted (ie: \"trashed\") properties are excluded by default. Returns an empty list if no relevant properties are found.","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":[],"parameters":[{"name":"filter","type":"string","required":false,"repeated":false,"location":"query","description":"Required. An expression for filtering the results of the request. Fields eligible for filtering are: `parent:`(The resource name of the parent account/property)","enum":null},{"name":"pageSize","type":"integer","required":false,"repeated":false,"location":"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 5","enum":null},{"name":"pageToken","type":"string","required":false,"repeated":false,"location":"query","description":"Optional. A page token, received from a previous `ListProperties` call. Provide this to retrieve the subsequent page. When paginating, all other parameters prov","enum":null},{"name":"showDeleted","type":"boolean","required":false,"repeated":false,"location":"query","description":"Whether to include soft-deleted (ie: \"trashed\") Properties in the results. Properties can be inspected to determine whether they are deleted or not.","enum":null}]},{"id":"properties.patch","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}","description":"Updates a property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name of this property. Format: properties/{property_id} Example: \"properties/1000\"","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"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 enti","enum":null}]},{"id":"properties.runAccessReport","httpMethod":"POST","path":"v1beta/{+entity}:runAccessReport","flatPath":"v1beta/properties/{propertiesId}:runAccessReport","description":"Returns a customized report of data access records. The report provides records of each time a user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data Access Reports can be requested for a property. Reports may be requested for any property, but dimensions tha","scopes":["https://www.googleapis.com/auth/analytics.edit","https://www.googleapis.com/auth/analytics.readonly"],"required":["entity"],"parameters":[{"name":"entity","type":"string","required":true,"repeated":false,"location":"path","description":"The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for","enum":null}]},{"id":"properties.updateDataRetentionSettings","httpMethod":"PATCH","path":"v1beta/{+name}","flatPath":"v1beta/properties/{propertiesId}/dataRetentionSettings","description":"Updates the singleton data retention settings for this property.","scopes":["https://www.googleapis.com/auth/analytics.edit"],"required":["name"],"parameters":[{"name":"name","type":"string","required":true,"repeated":false,"location":"path","description":"Identifier. Resource name for this DataRetentionSetting resource. Format: properties/{property}/dataRetentionSettings","enum":null},{"name":"updateMask","type":"string","required":false,"repeated":false,"location":"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 enti","enum":null}]}]}