Method: accountTypes.accounts.userLists.list

Lista UserLists.

Cabeçalhos de autorização:

Esse método aceita os seguintes cabeçalhos opcionais para definir como a API autoriza o acesso à solicitação:

  • login-account: (opcional) o nome do recurso da conta em que a Conta do Google das credenciais é um usuário. Se não for definido, o padrão será a conta da solicitação. Formato: accountTypes/{loginAccountType}/accounts/{loginAccountId}
  • linked-account: (opcional) o nome do recurso da conta com um link de produto estabelecido para o login-account. Formato: accountTypes/{linkedAccountType}/accounts/{linkedAccountId}

Solicitação HTTP

GET https://datamanager.googleapis.com/v1/{parent=accountTypes/*/accounts/*}/userLists

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. A conta principal proprietária dessa coleção de listas de usuários. Formato: accountTypes/{accountType}/accounts/{account}

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de listas de usuários a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 listas de usuários serão retornadas. O valor máximo é 1.000. Valores maiores serão convertidos para 1.000.
pageToken

string

Opcional. Um token de página recebido de uma chamada userLists.list anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para userLists.list precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. Uma string de filtro. Todos os campos precisam estar à esquerda de cada condição (por exemplo, display_name = "list 1"). Eles precisam ser especificados usando camel case ou snake case. Não use uma combinação de camel case e snake case.

Operações compatíveis:

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • : (tem)

Campos compatíveis:

  • id
  • display_name
  • description
  • membership_status
  • integration_code
  • access_reason
  • ingested_user_list_info.upload_key_types

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para userLists.list.

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

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

object (UserList)

As listas de usuários da conta especificada.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

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