REST Resource: accounts

  • An Account is a resource message representing a Google Analytics account.

  • Accounts have fields such as name, creation and update times, display name, region code, and deleted status.

  • Available methods for accounts include deleting, getting, listing, patching, and retrieving data sharing settings, among others.

  • Accounts can be soft-deleted, and their change history can be searched.

Resource: Account

A resource message representing a Google Analytics account.

JSON representation 
{ "name": string, "createTime": string, "updateTime": string, "displayName": string, "regionCode": string, "deleted": boolean, "gmpOrganization": string }
Fields
name

string

Output only. Resource name of this account. Format: accounts/{account} Example: "accounts/100"
createTime

string (Timestamp format)

Output only. Time when this account was originally created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. Time when account payload fields were last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
displayName

string

Required. Human-readable display name for this account.
regionCode

string

Country of business. Must be a Unicode CLDR region code.
deleted

boolean

Output only. Indicates whether this Account is soft-deleted or not. Deleted accounts are excluded from List results unless specifically requested.
gmpOrganization

string

Output only. The URI for a Google Marketing Platform organization resource. Only set when this account is connected to a GMP organization. Format: marketingplatformadmin.googleapis.com/organizations/{org_id}

Methods

delete

 Marks target Account as soft-deleted (ie: "trashed") and returns it.

get

 Lookup for a single Account.

getDataSharingSettings

 Get data sharing settings on an account.

list

 Returns all accounts accessible by the caller.

patch

 Updates an account.

provisionAccountTicket

 Requests a ticket for creating an account.

runAccessReport

 Returns a customized report of data access records.

searchChangeHistoryEvents

 Searches through all changes to an account or its children given the specified set of filters.