com.google.api.services.analyticsadmin.v1beta

Class GoogleAnalyticsAdmin.Accounts

java.lang.Object

com.google.api.services.analyticsadmin.v1beta.GoogleAnalyticsAdmin.Accounts

Enclosing class:

GoogleAnalyticsAdmin

public class GoogleAnalyticsAdmin.Accounts
extends Object

The "accounts" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GoogleAnalyticsAdmin.Accounts.Delete
class	GoogleAnalyticsAdmin.Accounts.Get
class	GoogleAnalyticsAdmin.Accounts.GetDataSharingSettings
class	GoogleAnalyticsAdmin.Accounts.List
class	GoogleAnalyticsAdmin.Accounts.Patch
class	GoogleAnalyticsAdmin.Accounts.ProvisionAccountTicket
class	GoogleAnalyticsAdmin.Accounts.RunAccessReport
class	GoogleAnalyticsAdmin.Accounts.SearchChangeHistoryEvents

Constructor Summary

Constructors

Constructor and Description
Accounts()

Method Summary

Modifier and Type	Method and Description
GoogleAnalyticsAdmin.Accounts.Delete	delete(String name) Marks target Account as soft-deleted (ie: "trashed") and returns it.
GoogleAnalyticsAdmin.Accounts.Get	get(String name) Lookup for a single Account.
GoogleAnalyticsAdmin.Accounts.GetDataSharingSettings	getDataSharingSettings(String name) Get data sharing settings on an account.
GoogleAnalyticsAdmin.Accounts.List	list() Returns all accounts accessible by the caller.
GoogleAnalyticsAdmin.Accounts.Patch	patch(String name, GoogleAnalyticsAdminV1betaAccount content) Updates an account.
GoogleAnalyticsAdmin.Accounts.ProvisionAccountTicket	provisionAccountTicket(GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest content) Requests a ticket for creating an account.
GoogleAnalyticsAdmin.Accounts.RunAccessReport	runAccessReport(String entity, GoogleAnalyticsAdminV1betaRunAccessReportRequest content) Returns a customized report of data access records.
GoogleAnalyticsAdmin.Accounts.SearchChangeHistoryEvents	searchChangeHistoryEvents(String account, GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest content) Searches through all changes to an account or its children given the specified set of filters.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Accounts

public Accounts()

Method Detail

delete

public GoogleAnalyticsAdmin.Accounts.Delete delete(String name)
                                            throws IOException

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. Create a request for the method "accounts.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 Account to soft-delete. Format: accounts/{account} Example: "accounts/100"

Returns:

the request

Throws:

IOException

get

public GoogleAnalyticsAdmin.Accounts.Get get(String name)
                                      throws IOException

Lookup for a single Account. Create a request for the method "accounts.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 account to lookup. Format: accounts/{account} Example: "accounts/100"

Returns:

the request

Throws:

IOException

getDataSharingSettings

public GoogleAnalyticsAdmin.Accounts.GetDataSharingSettings getDataSharingSettings(String name)
                                                                            throws IOException

Get data sharing settings on an account. Data sharing settings are singletons. Create a request for the method "accounts.getDataSharingSettings". 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: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`

Returns:

the request

Throws:

IOException

list

public GoogleAnalyticsAdmin.Accounts.List list()
                                        throws IOException

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. Create a request for the method "accounts.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.Accounts.Patch patch(String name,
                                                 GoogleAnalyticsAdminV1betaAccount content)
                                          throws IOException

Updates an account. Create a request for the method "accounts.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 account. Format: accounts/{account} Example: "accounts/100"

content - the GoogleAnalyticsAdminV1betaAccount

Returns:

the request

Throws:

IOException

provisionAccountTicket

public GoogleAnalyticsAdmin.Accounts.ProvisionAccountTicket provisionAccountTicket(GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest content)
                                                                            throws IOException

Requests a ticket for creating an account. Create a request for the method "accounts.provisionAccountTicket". 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 GoogleAnalyticsAdminV1betaProvisionAccountTicketRequest

Returns:

the request

Throws:

IOException

runAccessReport

public GoogleAnalyticsAdmin.Accounts.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 "accounts.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

searchChangeHistoryEvents

public GoogleAnalyticsAdmin.Accounts.SearchChangeHistoryEvents searchChangeHistoryEvents(String account,
                                                                                         GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest content)
                                                                                  throws IOException

Searches through all changes to an account or its children given the specified set of filters. Create a request for the method "accounts.searchChangeHistoryEvents". 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:

account - Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`

content - the GoogleAnalyticsAdminV1betaSearchChangeHistoryEventsRequest

Returns:

the request

Throws:

IOException