Skip to main content
GET
Options

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
string<uuid>
required

Response

Successful Response

rulesetVersion
string
required
Required string length: 1 - 64
families
FamilyOption · object[]
required
Required array length: 1 - 6 elements
markets
NamedOption · object[]
required
Maximum array length: 300
languages
NamedOption · object[]
required
Maximum array length: 300
monthlyStrategyLimit
integer
required
Required range: x >= 0
remainingStrategyUnits
integer
required
Required range: x >= 0
renewsAt
string<date-time>
required
mediaBatchEligible
boolean
required
mediaPricingQualified
boolean
required
envelope
ScopeEnvelope · object
required
schemaVersion
string
default:google-create-v1
formats
GoogleFormatOption · object[]
Maximum array length: 10
defaultMarket
string | null
Required string length: 2 - 80
defaultLanguage
string | null
Required string length: 2 - 40
available
boolean
default:false
unavailableReason
string | null
Required string length: 1 - 500
textScopeQualified
boolean
default:false
usedStrategyUnits
integer
default:0
Required range: x >= 0
reservedStrategyUnits
integer
default:0
Required range: x >= 0
standaloneTextLimit
integer
default:0
Required range: x >= 0
usedStandaloneTextUnits
integer
default:0
Required range: x >= 0
reservedStandaloneTextUnits
integer
default:0
Required range: x >= 0
mediaGenerationAvailable
boolean
default:false