Method: targetingTypes.targetingOptions.list

Lista as opções de segmentação de um determinado tipo.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v3/targetingTypes/{targetingType}/targetingOptions

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

Parâmetros de caminho

Parâmetros
targetingType

enum (TargetingType)

Obrigatório. O tipo de opção de segmentação a ser listada.

Os valores aceitos são:

  • TARGETING_TYPE_APP_CATEGORY
  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_USER_REWARDED_CONTENT
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_BROWSER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_ON_SCREEN_POSITION
  • TARGETING_TYPE_CARRIER_AND_ISP
  • TARGETING_TYPE_OPERATING_SYSTEM
  • TARGETING_TYPE_DEVICE_MAKE_MODEL
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_CATEGORY
  • TARGETING_TYPE_VIEWABILITY
  • TARGETING_TYPE_AUTHORIZED_SELLER_STATUS
  • TARGETING_TYPE_LANGUAGE
  • TARGETING_TYPE_GEO_REGION
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_SUB_EXCHANGE
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID

Parâmetros de consulta

Parâmetros
advertiserId

string (int64 format)

Obrigatório. O anunciante no contexto em que esta solicitação está sendo feita.
pageSize

integer

Tamanho da página solicitada. Precisa estar entre 1 e 200. Se não for especificado, o padrão será 100. Retorna o código de erro INVALID_ARGUMENT se um valor inválido for especificado.
pageToken

string

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

string

Campo que classifica a lista. Os valores aceitáveis são:

  • targetingOptionId (padrão)

A ordem de classificação padrão é crescente. Para especificar a ordem decrescente em um campo, um sufixo "desc" precisa ser adicionado ao nome dele. Exemplo: targetingOptionId desc.
filter

string

Permite filtrar por campos de opção de segmentação.

Sintaxe aceita:

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

Campos compatíveis:

  • carrierAndIspDetails.type
  • geoRegionDetails.geoRegionType
  • targetingOptionId

Exemplos:

  • Todas as opções de segmentação GEO REGION que pertencem ao subtipo GEO_REGION_TYPE_COUNTRY ou GEO_REGION_TYPE_STATE: geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"
  • Todas as opções de segmentação CARRIER AND ISP que pertencem ao subtipo CARRIER_AND_ISP_TYPE_CARRIER: carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"

O comprimento deste campo não pode exceder 500 caracteres.

Consulte nosso guia Filtrar 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 targetingOptions.list.

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

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

object (TargetingOption)

A lista de opções de segmentação.

Essa lista não vai aparecer se estiver vazia.
nextPageToken

string

Um token para recuperar a próxima página de resultados. Transmita esse valor no campo pageToken na chamada subsequente ao método targetingOptions.list para recuperar a próxima página de resultados.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.