target.apidocs.com.google.api.services.analyticsadmin.v1beta.GoogleAnalyticsAdmin.Properties.html Maven / Gradle / Ivy
GoogleAnalyticsAdmin.Properties (Google Analytics Admin API v1beta-rev20240916-2.0.0)
com.google.api.services.analyticsadmin.v1beta
Class GoogleAnalyticsAdmin.Properties
- java.lang.Object
-
- com.google.api.services.analyticsadmin.v1beta.GoogleAnalyticsAdmin.Properties
-
- Enclosing class:
- GoogleAnalyticsAdmin
public class GoogleAnalyticsAdmin.Properties
extends Object
The "properties" collection of methods.
-
-
Nested Class Summary
-
Constructor Summary
Constructors
Constructor and Description
Properties()
-
Method Summary
-
-
Method Detail
-
acknowledgeUserDataCollection
public GoogleAnalyticsAdmin.Properties.AcknowledgeUserDataCollection acknowledgeUserDataCollection(String property,
GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest content)
throws IOException
Acknowledges the terms of user data collection for the specified property. This acknowledgement
must be completed (either in the Google Analytics UI or through this API) before
MeasurementProtocolSecret resources may be created.
Create a request for the method "properties.acknowledgeUserDataCollection".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke
the remote operation.
- Parameters:
property - Required. The property for which to acknowledge user data collection.content - the GoogleAnalyticsAdminV1betaAcknowledgeUserDataCollectionRequest- Returns:
- the request
- Throws:
IOException
-
create
public GoogleAnalyticsAdmin.Properties.Create create(GoogleAnalyticsAdminV1betaProperty content)
throws IOException
Creates a Google Analytics property with the specified location and attributes.
Create a request for the method "properties.create".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
content - the GoogleAnalyticsAdminV1betaProperty- Returns:
- the request
- Throws:
IOException
-
delete
public GoogleAnalyticsAdmin.Properties.Delete delete(String name)
throws IOException
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.
Create a request for the method "properties.delete".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
name - Required. The name of the Property to soft-delete. Format: properties/{property_id} Example:
"properties/1000"- Returns:
- the request
- Throws:
IOException
-
get
public GoogleAnalyticsAdmin.Properties.Get get(String name)
throws IOException
Lookup for a single GA Property.
Create a request for the method "properties.get".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
name - Required. The name of the property to lookup. Format: properties/{property_id} Example:
"properties/1000"- Returns:
- the request
- Throws:
IOException
-
getDataRetentionSettings
public GoogleAnalyticsAdmin.Properties.GetDataRetentionSettings getDataRetentionSettings(String name)
throws IOException
Returns the singleton data retention settings for this property.
Create a request for the method "properties.getDataRetentionSettings".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
remote operation.
- Parameters:
name - Required. The name of the settings to lookup. Format: properties/{property}/dataRetentionSettings
Example: "properties/1000/dataRetentionSettings"- Returns:
- the request
- Throws:
IOException
-
list
public GoogleAnalyticsAdmin.Properties.List list()
throws IOException
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.
Create a request for the method "properties.list".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Returns:
- the request
- Throws:
IOException
-
patch
public GoogleAnalyticsAdmin.Properties.Patch patch(String name,
GoogleAnalyticsAdminV1betaProperty content)
throws IOException
Updates a property.
Create a request for the method "properties.patch".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
- Parameters:
name - Output only. Resource name of this property. Format: properties/{property_id} Example:
"properties/1000"content - the GoogleAnalyticsAdminV1betaProperty- Returns:
- the request
- Throws:
IOException
-
runAccessReport
public GoogleAnalyticsAdmin.Properties.RunAccessReport runAccessReport(String entity,
GoogleAnalyticsAdminV1betaRunAccessReportRequest content)
throws IOException
Returns a customized report of data access records. The report provides records of each time a
user reads Google Analytics reporting data. Access records are retained for up to 2 years. Data
Access Reports can be requested for a property. Reports may be requested for any property, but
dimensions that aren't related to quota can only be requested on Google Analytics 360 properties.
This method is only available to Administrators. These data access records include GA UI
Reporting, GA UI Explorations, GA Data API, and other products like Firebase & Admob that can
retrieve data from Google Analytics through a linkage. These records don't include property
configuration changes like adding a stream or changing a property's time zone. For configuration
change history, see [searchChangeHistoryEvents](https://developers.google.com/analytics/devguides
/config/admin/v1/rest/v1alpha/accounts/searchChangeHistoryEvents). To give your feedback on this
API, complete the [Google Analytics Access Reports feedback](https://docs.google.com/forms/d/e/1F
AIpQLSdmEBUrMzAEdiEKk5TV5dEHvDUZDRlgWYdQdAeSdtR4hVjEhw/viewform) form.
Create a request for the method "properties.runAccessReport".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
operation.
- Parameters:
entity - 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.content - the GoogleAnalyticsAdminV1betaRunAccessReportRequest- Returns:
- the request
- Throws:
IOException
-
updateDataRetentionSettings
public GoogleAnalyticsAdmin.Properties.UpdateDataRetentionSettings updateDataRetentionSettings(String name,
GoogleAnalyticsAdminV1betaDataRetentionSettings content)
throws IOException
Updates the singleton data retention settings for this property.
Create a request for the method "properties.updateDataRetentionSettings".
This request holds the parameters needed by the analyticsadmin server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the
remote operation.
- Parameters:
name - Output only. Resource name for this DataRetentionSetting resource. Format:
properties/{property}/dataRetentionSettingscontent - the GoogleAnalyticsAdminV1betaDataRetentionSettings- Returns:
- the request
- Throws:
IOException
-
conversionEvents
public GoogleAnalyticsAdmin.Properties.ConversionEvents conversionEvents()
An accessor for creating requests from the ConversionEvents collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.ConversionEvents.List request = analyticsadmin.conversionEvents().list(parameters ...)
- Returns:
- the resource collection
-
customDimensions
public GoogleAnalyticsAdmin.Properties.CustomDimensions customDimensions()
An accessor for creating requests from the CustomDimensions collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.CustomDimensions.List request = analyticsadmin.customDimensions().list(parameters ...)
- Returns:
- the resource collection
-
customMetrics
public GoogleAnalyticsAdmin.Properties.CustomMetrics customMetrics()
An accessor for creating requests from the CustomMetrics collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.CustomMetrics.List request = analyticsadmin.customMetrics().list(parameters ...)
- Returns:
- the resource collection
-
dataStreams
public GoogleAnalyticsAdmin.Properties.DataStreams dataStreams()
An accessor for creating requests from the DataStreams collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.DataStreams.List request = analyticsadmin.dataStreams().list(parameters ...)
- Returns:
- the resource collection
-
firebaseLinks
public GoogleAnalyticsAdmin.Properties.FirebaseLinks firebaseLinks()
An accessor for creating requests from the FirebaseLinks collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.FirebaseLinks.List request = analyticsadmin.firebaseLinks().list(parameters ...)
- Returns:
- the resource collection
-
googleAdsLinks
public GoogleAnalyticsAdmin.Properties.GoogleAdsLinks googleAdsLinks()
An accessor for creating requests from the GoogleAdsLinks collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.GoogleAdsLinks.List request = analyticsadmin.googleAdsLinks().list(parameters ...)
- Returns:
- the resource collection
-
keyEvents
public GoogleAnalyticsAdmin.Properties.KeyEvents keyEvents()
An accessor for creating requests from the KeyEvents collection.
The typical use is:
GoogleAnalyticsAdmin analyticsadmin = new GoogleAnalyticsAdmin(...);
GoogleAnalyticsAdmin.KeyEvents.List request = analyticsadmin.keyEvents().list(parameters ...)
- Returns:
- the resource collection
Copyright © 2011–2024 Google. All rights reserved.