Class AccountsResource

The "accounts" collection of methods.

Inheritance
object
AccountsResource
Inherited Members
Namespace: Google.Apis.GoogleAnalyticsAdmin.v1alpha
Assembly: Google.Apis.GoogleAnalyticsAdmin.v1alpha.dll
Syntax
public class AccountsResource

Constructors

AccountsResource(IClientService)

Constructs a new resource.

Declaration
public AccountsResource(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

AccessBindings

Gets the AccessBindings resource.

Declaration
public virtual AccountsResource.AccessBindingsResource AccessBindings { get; }
Property Value
Type Description
AccountsResource.AccessBindingsResource

Methods

Delete(string)

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.

Declaration
public virtual AccountsResource.DeleteRequest Delete(string name)
Parameters
Type Name Description
string name

Required. The name of the Account to soft-delete. Format: accounts/{account} Example: "accounts/100"
Returns
Type Description
AccountsResource.DeleteRequest

Get(string)

Lookup for a single Account.

Declaration
public virtual AccountsResource.GetRequest Get(string name)
Parameters
Type Name Description
string name

Required. The name of the account to lookup. Format: accounts/{account} Example: "accounts/100"
Returns
Type Description
AccountsResource.GetRequest

GetDataSharingSettings(string)

Get data sharing settings on an account. Data sharing settings are singletons.

Declaration
public virtual AccountsResource.GetDataSharingSettingsRequest GetDataSharingSettings(string name)
Parameters
Type Name Description
string name

Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: accounts/1000/dataSharingSettings
Returns
Type Description
AccountsResource.GetDataSharingSettingsRequest

List()

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.

Declaration
public virtual AccountsResource.ListRequest List()
Returns
Type Description
AccountsResource.ListRequest

Patch(GoogleAnalyticsAdminV1alphaAccount, string)

Updates an account.

Declaration
public virtual AccountsResource.PatchRequest Patch(GoogleAnalyticsAdminV1alphaAccount body, string name)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaAccount body

The body of the request.
string name

Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
Returns
Type Description
AccountsResource.PatchRequest

ProvisionAccountTicket(GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest)

Requests a ticket for creating an account.

Declaration
public virtual AccountsResource.ProvisionAccountTicketRequest ProvisionAccountTicket(GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest body)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaProvisionAccountTicketRequest body

The body of the request.
Returns
Type Description
AccountsResource.ProvisionAccountTicketRequest

RunAccessReport(GoogleAnalyticsAdminV1alphaRunAccessReportRequest, string)

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. To give your feedback on this API, complete the Google Analytics Access Reports feedback form.

Declaration
public virtual AccountsResource.RunAccessReportRequest RunAccessReport(GoogleAnalyticsAdminV1alphaRunAccessReportRequest body, string entity)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaRunAccessReportRequest body

The body of the request.
string 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.
Returns
Type Description
AccountsResource.RunAccessReportRequest

SearchChangeHistoryEvents(GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest, string)

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.

Declaration
public virtual AccountsResource.SearchChangeHistoryEventsRequest SearchChangeHistoryEvents(GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest body, string account)
Parameters
Type Name Description
GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest body

The body of the request.
string account

Required. The account resource for which to return change history resources. Format: accounts/{account} Example: accounts/100
Returns
Type Description
AccountsResource.SearchChangeHistoryEventsRequest