Method: advertisers.reachForecast.retrievePlannableUserLists

Recupera listas de usuários próprios e de terceiros disponíveis para estimativa.

Solicitação HTTP

GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/reachForecast:retrievePlannableUserLists

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 para recuperar listas de usuários planejáveis.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Tamanho da página solicitada. Precisa estar entre 1 e 5000. Se não for especificado, o padrão será 5000.
pageToken

string

Opcional. 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 reachForecast.retrievePlannableUserLists. Se não for especificado, a primeira página de resultados será retornada.
filter

string

Opcional. Permite filtrar por propriedades de lista de usuários planejáveis.

Sintaxe aceita:

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

Campos compatíveis:

  • plannableStatus
  • displayName
  • userListType
  • name

Exemplos:

  • Todas as listas de usuários planejáveis: plannableStatus="PLANNABLE"
  • Listas de usuários planejáveis com nome de exibição contendo "Shopping": plannableStatus="PLANNABLE" AND displayName:"Shopping"
  • Listas de usuários próprios: userListType="FIRST_PARTY"

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

Resposta para "reachForecast.retrievePlannableUserLists".

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

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

object (PlannableUserList)

Apenas saída. A lista de listas de usuários planejáveis.
nextPageToken

string

Apenas saída. Um token 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.

PlannableUserList

Uma lista de usuários planejável usada para previsão de alcance.

Representação JSON 
{
  "displayName": string,
  "userListType": enum (UserListType),
  "name": string,
  "plannableStatus": enum (PlannableStatus)
}
Campos
displayName

string

Apenas saída. O nome de exibição da lista de usuários.
userListType

enum (UserListType)

Apenas saída. O tipo da lista de usuários.
name

string

Apenas saída. O nome do recurso que identifica a lista de usuários.

Formato: advertisers/{advertiserId}/userLists/{user_list_id}
plannableStatus

enum (PlannableStatus)

Apenas saída. O status de capacidade de planejamento da lista de usuários.

UserListType

Tipos de listas de usuários.

Tipos enumerados
USER_LIST_TYPE_UNSPECIFIED Tipo de lista de usuários não especificado.
FIRST_PARTY Uma lista de usuários próprios.
THIRD_PARTY Uma lista de usuários de terceiros.

PlannableStatus

Status que indica se uma lista pode ser planejada ou não.

Tipos enumerados
PLANNABLE_STATUS_UNSPECIFIED Status de capacidade de planejamento não especificado.
PLANNABLE A lista de usuários pode ser planejada.
UNPLANNABLE A lista de usuários não pode ser planejada.