- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- BrandSuggestion
- BrandState
- Try it!
Rpc to return a list of matching brands based on a prefix for this customer.
HTTP request
POST https://googleads.googleapis.com/v15/customers/{customerId}:suggestBrands
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
customerId |
Required. The ID of the customer onto which to apply the brand suggestion operation. |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "selectedBrands": [ string ], "brandPrefix": string } |
Fields | |
---|---|
selectedBrands[] |
Optional. Ids of the brands already selected by advertisers. They will be excluded in response. These are expected to be brand ids not brand names. |
brandPrefix |
Required. The prefix of a brand name. |
Response body
Response message for BrandSuggestionService.SuggestBrands
.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{
"brands": [
{
object ( |
Fields | |
---|---|
brands[] |
Generated brand suggestions of verified brands for the given prefix. |
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adwords
For more information, see the OAuth 2.0 Overview.
BrandSuggestion
Information of brand suggestion.
JSON representation |
---|
{
"id": string,
"name": string,
"urls": [
string
],
"state": enum ( |
Fields | |
---|---|
id |
Id for the brand. It would be CKG MID for verified/global scoped brands. |
name |
Name of the brand. |
urls[] |
Urls which uniquely identify the brand. |
state |
Current state of the brand. |
BrandState
Enumeration of different brand states.
Enums | |
---|---|
UNSPECIFIED |
No value has been specified. |
UNKNOWN |
Used for return value only. Represents value unknown in this version. |
ENABLED |
Brand is verified and globally available for selection |
DEPRECATED |
Brand was globally available in past but is no longer a valid brand (based on business criteria) |
UNVERIFIED |
Brand is unverified and customer scoped, but can be selected by customer (only who requested for same) for targeting |
APPROVED |
Was a customer-scoped (unverified) brand, which got approved by business and added to the global list. Its assigned CKG MID should be used instead of this |
CANCELLED |
Was a customer-scoped (unverified) brand, but the request was canceled by customer and this brand id is no longer valid |
REJECTED |
Was a customer-scoped (unverified) brand, but the request was rejected by internal business team and this brand id is no longer valid |