REST Resource: accounts.icons

  • The Icon resource provides information about a partner's icon, including its name, image data, state, URI, reference, and any disapproval reasons.

  • Icons can be in different states, including NEW, APPROVED, and REJECTED.

  • The API provides methods to create, get, and list icons for a partner account.

Resource: Icon

Information about a partner's icon.

JSON representation 
{
  "name": string,
  "imageData": string,
  "state": enum (State),
  "iconUri": string,
  "reference": string,
  "disapprovalReasons": [
    enum (ImageDisapprovalReason)
  ]
}
Fields
name

string

Required. Output only. The resource name for the icon in the format accounts/{account_id}/icons/{icon_id}. Google generates the icon_id during the create operation. Use the icon_id to associate the icon with a brand using the accounts.brands API.
imageData

string (bytes format)

Required. Input only. The icon contents, which must be in PNG format, or convertible to PNG.

A base64-encoded string.
state

enum (State)

Output only. The icon's current state.
iconUri

string

Output only. The approved icon's Google-hosted URI. Only applies to icons with APPROVED state.
reference

string

Optional. Value for tracking the icon. It could be the primary key to your icon in your system, or the icon's filename. Google does not use this value.
disapprovalReasons[]

enum (ImageDisapprovalReason)

Output only. The icon's disapproval reason(s). Only applies to icons with REJECTED state.

State

Possible icon states.

Enums
STATE_UNSPECIFIED Default value.
NEW Google has received the icon and is reviewing its contents.
APPROVED The icon is approved and is ready for public display. You can link APPROVED icons to brands.
REJECTED The icon is rejected. Google won't display this icon.

Methods

create

 Uploads a new icon and starts its review process.

get

 Returns the Icon instance associated with an icon resource name specified in the request URI.

list

 Returns the Icons for a partner account.