REST Resource: accounts.brands

Resource: Brand

Brand-level icon and display name configuration. Once approved, the icon and display name appear in the search results for properties that the partner has assigned to this brand.

JSON representation 
{
  "name": string,
  "displayNames": [
    {
      object (LocalizedText)
    }
  ],
  "submittedDisplayNames": [
    {
      object (LocalizedText)
    }
  ],
  "activeDisplayNames": [
    {
      object (LocalizedText)
    }
  ],
  "displayNameState": enum (ReviewState),
  "displayNameDisapprovalReason": [
    {
      object (DisplayNameDisapprovalReason)
    }
  ],
  "icon": string,
  "submittedIcon": string,
  "activeIcon": string,
  "activeIconUri": string,
  "iconState": enum (ReviewState),
  "iconDisapprovalReasons": [
    enum (ImageDisapprovalReason)
  ],
  "propertyCount": string
}
Fields
name

string

Output only. The resource name for the brand in the format accounts/{account_id}/brands/{brandId}. The brandId corresponds to the partner's brand identifier used for landing page matching and the property-level brand identifier.

A default brand is applied to properties that do not have a brand. The brandId of the default brand is NO_BRAND_ID. It can be fetched and updated like any configured brand.
displayNames[]

object (LocalizedText)

Input only. The name Google displays for the brand's properties. Setting the display names is only necessary if you want to override the landing page display name or account-level display name for the brand. Google reviews the display names for appropriate content. When there are multiple languages, Google will only show the display names once Google approves all the languages.
submittedDisplayNames[]

object (LocalizedText)

Output only. The brand's submitted display names in all provided languages, only present if the display name is new or rejected for any language.
activeDisplayNames[]

object (LocalizedText)

Output only. The brand's active display names in all provided languages, only present if the display name is approved for all provided languages.
displayNameState

enum (ReviewState)

Output only. The brand's display names review state, which applies to all display name language entries. If there are both submitted and active display names, this refers to the submitted display names.
displayNameDisapprovalReason[]

object (DisplayNameDisapprovalReason)

Output only. Display name's disapproval reason. Only applies to display names with the review state 'REJECTED'.
icon

string

Input only. The brand's accounts.icon identifying the brand's icon. The value refers to the icons's resource name in the format accounts/{account_id}/icons/{icon_id}.
submittedIcon

string

Output only. The brand's submitted accounts.icon. The value refers to the icons's resource name in the format accounts/{account_id}/icons/{icon_id}. A submitted icon is one that is new or rejected.
activeIcon

string

Output only. The brand's active accounts.icon. The value refers to the icons's resource name in the format accounts/{account_id}/icons/{icon_id}. An active icon is one that has been approved.
activeIconUri

string

Output only. URL of the active icon, only present when the icon has been approved.
iconState

enum (ReviewState)

Output only. The brand's icon's review state. If there are both submitted and active icons, this refers to the submitted icon.
iconDisapprovalReasons[]

enum (ImageDisapprovalReason)

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

string (int64 format)

Output only. The number of properties with the corresponding brand ID.

ReviewState

Possible review states for the associated icon or display name.

Enums
REVIEW_STATE_UNSPECIFIED Default value.
REVIEW_STATE_NEW Google is reviewing the icon or display name.
APPROVED The icon or display name is approved and ready for public display.
REJECTED The icon or display name is rejected. Google won't display it.

DisplayNameDisapprovalReason

Disapproval reason of the display name in a specific language.

JSON representation 
{
  "languageCode": string,
  "disapprovalReason": enum (DisapprovalReason)
}
Fields
languageCode

string

Language of the disapproved display name.
disapprovalReason

enum (DisapprovalReason)

Disapproval reason.

DisapprovalReason

Possible reasons for a display name to be disapproved.

Enums
DISAPPROVAL_REASON_UNSPECIFIED Not specified.
PUNCTUATION The display name has bad formatting and/or contains punctuation.
MARKETING_LANGUAGE The display name contains marketing language.
LANDING_PAGE_NOT_MATCHED The display name does not match the landing page.
NOT_BRAND_NAME The display name does not appear to be a brand.

Methods

create

 Creates a new brand.

get

 Returns the Brand instance associated with the request URI's brand resource name.

list

 Returns the brands for a partner account.

patch

 Updates a brand.