Skip to main content

accounts

Overview

Nameaccounts
TypeResource
Idgoogleanalytics.analyticsadmin.accounts

Fields

NameDatatypeDescription
namestringOutput only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
createTimestringOutput only. Time when this account was originally created.
deletedbooleanOutput only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
displayNamestringRequired. Human-readable display name for this account.
regionCodestringCountry of business. Must be a Unicode CLDR region code.
updateTimestringOutput only. Time when account payload fields were last updated.

Methods

NameAccessible byRequired ParamsDescription
getSELECTaccountsIdLookup for a single Account.
listSELECTReturns all accounts accessible by the caller. Note that these accounts might not currently have GA4 properties. Soft-deleted (ie: "trashed") accounts are excluded by default. Returns an empty list if no relevant accounts are found.
deleteDELETEaccountsIdMarks 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, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.
patchEXECaccountsIdUpdates an account.
provisionAccountTicketEXECRequests a ticket for creating an account.
searchChangeHistoryEventsEXECaccountsIdSearches through all changes to an account or its children given the specified set of filters.