Method: advertisers.adGroups.targetingTypes.assignedTargetingOptions.list

Lista as opções de segmentação atribuídas a um grupo de anúncios.

As opções de segmentação atribuídas herdadas não estão incluídas.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/adGroups/{adGroupId}/targetingTypes/{targetingType}/assignedTargetingOptions

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

Parâmetros de caminho

Parâmetros
advertiserId

string (int64 format)

Obrigatório. O ID do anunciante ao qual o grupo de anúncios pertence.

adGroupId

string (int64 format)

Obrigatório. O ID do grupo de anúncios para listar as opções de segmentação atribuídas.

targetingType

enum (TargetingType)

Obrigatório. Identifica o tipo de opções de segmentação atribuídas para listar.

Os tipos de segmentação compatíveis incluem:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_APP
  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_AUDIENCE_GROUP
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_KEYWORD
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SESSION_POSITION
  • TARGETING_TYPE_URL
  • TARGETING_TYPE_YOUTUBE_CHANNEL
  • TARGETING_TYPE_YOUTUBE_VIDEO

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitada. O valor precisa estar entre 1 e 5000. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT caso um valor inválido seja especificado.

pageToken

string

Opcional. Um token que identifica a página de resultados que o servidor retornará. Normalmente, esse é o valor de nextPageToken retornado pela chamada anterior para o método assignedTargetingOptions.list. Se não for especificado, a primeira página de resultados será retornada.

orderBy

string

Opcional. Campo que classificará a lista. Os valores aceitos são:

  • assignedTargetingOptionId (padrão)

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, adicione um sufixo "desc" ao nome dele. Exemplo: assignedTargetingOptionId desc.

filter

string

Opcional. Permite filtrar por campos de opção de segmentação atribuídos.

Sintaxe compatível:

  • As expressões de filtro são compostas por uma ou mais restrições.
  • As restrições podem ser combinadas pelo operador lógico OR.
  • Uma restrição tem o formato {field} {operator} {value}.
  • Todos os campos precisam usar o operador EQUALS (=).

Campos compatíveis:

  • assignedTargetingOptionId

Exemplos:

  • Recursos de AssignedTargetingOption com ID 1 ou 2: assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"

Esse campo não pode ter mais de 500 caracteres.

Consulte nosso guia de filtragem de solicitações LIST para mais informações.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para assignedTargetingOptions.list.

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

Representação JSON
{
  "assignedTargetingOptions": [
    {
      object (AssignedTargetingOption)
    }
  ],
  "nextPageToken": string
}
Campos
assignedTargetingOptions[]

object (AssignedTargetingOption)

Lista de opções de segmentação atribuídas.

Esta lista estará ausente se estiver vazia.

nextPageToken

string

Um token que identifica a próxima página de resultados. Esse valor precisa ser especificado como pageToken em uma ListAdGroupAssignedTargetingOptionsRequest subsequente para buscar a próxima página de resultados. Esse token estará ausente se não houver mais recursos AssignedTargetingOption para retornar.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/display-video

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