Method: customers.userLists.list

Lista as listas de usuários gerenciadas pelo cliente especificado do Ads Data Hub.

Solicitação HTTP

GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Nome do recurso do cliente pai, por exemplo, 'customers/123'.

Parâmetros de consulta

Parâmetros
pageSize

integer

Número máximo de itens a serem retornados. Se for 0, o servidor determinará o número de listas de usuários que serão retornadas.
pageToken

string

Token da página, retornado por uma chamada anterior, usado para solicitar a próxima página de resultados.
filter

string

Exemplo de filtro: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND fillTime > "2012-04-21T10:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30:30
view

enum (UserListView)

Especifica quais campos serão incluídos em cada lista de usuários.
showDeleted

boolean

Se definido como verdadeiro, as listas de usuários excluídas serão incluídas na resposta.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

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

Resposta a uma solicitação de userLists.list. Contém as listas de usuários gerenciadas pelo cliente especificado do Ads Data Hub.

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

object (UserList)

Uma lista de listas de usuários.
nextPageToken

string

Um token que pode ser usado para solicitar a próxima página de resultados. Este campo ficará vazio se não houver resultados adicionais.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Visualização de lista de usuários

Enumeração para indicar quais campos incluir em cada lista de usuários retornada pela API [userLists.list].

Enums
USER_LIST_VIEW_UNSPECIFIED O valor padrão / não definido. Por padrão, a API usará a visualização FULL.
BASIC Incluir campos, exceto [recipientAdsDataLinks].
FULL Inclua tudo.