REST Resource: platforms.accounts

Resource: Account

Representation of an Account.

JSON representation 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "timeZone": {
    object (TimeZone)
  },
  "createTime": string,
  "regionCode": string,
  "creationRequestId": string
}
Fields
name

string

Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
displayName

string

Display name of this account.
state

enum (State)

Output only. Approval state of the account.
timeZone

object (TimeZone)

Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
createTime

string (Timestamp format)

Output only. Creation time of the account.

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".
regionCode

string

Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
creationRequestId

string

Required. An opaque token that uniquely identifies the account among all the platform's accounts.

This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user.

This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name.

Once an account has been created, a second attempt to create an account using the same creationRequestId will result in an ALREADY_EXISTS error.

State

Approval state of the account.

Enums
STATE_UNSPECIFIED Unspecified.
UNCHECKED Unchecked.
APPROVED The account is ready to serve ads.
DISAPPROVED The account has been blocked from serving ads.

Methods

close

 Closes a sub-account.

create

 Creates a sub-account.

get

 Gets information about the selected sub-account.

list

 Lists a partial view of sub-accounts for a specific parent account.

lookup

 Looks up information about a sub-account for a specified creation_request_id.