Method: customers.suggestBrands

Rpc para retornar uma lista de marcas correspondentes com base em um prefixo para esse cliente.

Solicitação HTTP

POST https://googleads.googleapis.com/v15/customers/{customerId}:suggestBrands

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. O ID do cliente em que a operação de sugestão de marca será aplicada.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "selectedBrands": [
    string
  ],
  "brandPrefix": string
}
Campos
selectedBrands[]

string

Opcional. Os IDs das marcas já selecionadas pelos anunciantes. Eles serão excluídos em resposta. É esperado que sejam IDs de marca, e não nomes de marca.
brandPrefix

string

Obrigatório. O prefixo do nome de uma marca.

Corpo da resposta

Mensagem de resposta para BrandSuggestionService.SuggestBrands.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "brands": [
    {
      object (BrandSuggestion)
    }
  ]
}
Campos
brands[]

object (BrandSuggestion)

Foram geradas sugestões de marcas verificadas para o prefixo especificado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/adwords

Para mais informações, consulte a Visão geral do OAuth 2.0.

BrandSuggestion

Informações da sugestão de marca.

Representação JSON 
{
  "id": string,
  "name": string,
  "urls": [
    string
  ],
  "state": enum (BrandState)
}
Campos
id

string

ID da marca. Seria o CKG MID para marcas com escopo global/verificadas.
name

string

Nome da marca.
urls[]

string

URLs que identificam a marca de forma exclusiva.
state

enum (BrandState)

Estado atual da marca.

BrandState

Enumeração de diferentes estados de marca.

Enums
UNSPECIFIED Nenhum valor foi especificado.
UNKNOWN Usado apenas para valor de retorno. Representa o valor desconhecido nesta versão.
ENABLED A marca foi verificada e está disponível globalmente para seleção
DEPRECATED A marca estava disponível globalmente, mas não é mais uma marca válida (com base nos critérios de negócios)
UNVERIFIED A marca não é verificada e não tem escopo no cliente, mas pode ser selecionada pelo cliente (somente quem fez a solicitação) para segmentação.
APPROVED Era uma marca com escopo do cliente (não verificada) que foi aprovada pela empresa e adicionada à lista global. O MID do CKG atribuído a ele deve ser usado em vez deste
CANCELLED Era uma marca com escopo do cliente (não verificada), mas a solicitação foi cancelada pelo cliente, e o ID de marca não é mais válido
REJECTED Era uma marca com escopo do cliente (não verificada), mas a solicitação foi rejeitada pela equipe de negócios interna e este ID de marca não é mais válido