Method: accountTypes.accounts.userListGlobalLicenses.userListGlobalLicenseCustomerInfos.list

Lista todas as informações do cliente para uma licença global de lista de usuários.

Esse recurso está disponível apenas para parceiros de dados.

Solicitação HTTP

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

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. A licença global cujas informações do cliente estão sendo consultadas. Precisa estar no formato accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. Para listar todas as informações do cliente de licença global em uma conta, substitua o ID da licença global da lista de usuários por um "-" (por exemplo, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-).

Parâmetros de consulta

Parâmetros
filter

string

Opcional. Uma string de filtro a ser aplicada à solicitação de lista. Todos os campos precisam estar no lado esquerdo de cada condição (por exemplo, user_list_id = 123). Os campos precisam ser especificados usando todos os casos de camel ou snake. Não use uma combinação de camel case e snake case.

Operações aceitas :

  • AND
  • =
  • !=
  • >
  • >=
  • <
  • <=

Funções aceitas - IN(field, value1, value2, ...): retorna verdadeiro se o campo corresponder a qualquer um dos valores. Exemplo: IN(user_list_id, 123, 456)

Campos sem suporte :

  • name (use o método "get" em vez disso)
  • historical_pricings e todos os subcampos dele
  • pricing.start_time
  • pricing.end_time
pageSize

integer

Opcional. O número máximo de licenças a serem retornadas. O serviço pode retornar um valor inferior a este. Se não for especificado, no máximo 50 licenças 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 ListUserListDirectLicense anterior. Forneça isso para recuperar a página subsequente.

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

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Resposta da [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].

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

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

object (UserListGlobalLicenseCustomerInfo)

As informações do cliente para a licença especificada na solicitação.
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

UserListGlobalLicenseCustomerInfo

Informações sobre um cliente de uma licença global de lista de usuários. Isso será criado automaticamente pelo sistema quando um cliente comprar uma licença global.

Representação JSON 
{
  "name": string,
  "userListId": string,
  "userListDisplayName": string,
  "licenseType": enum (UserListGlobalLicenseType),
  "status": enum (UserListLicenseStatus),
  "pricing": {
    object (UserListLicensePricing)
  },
  "clientAccountType": enum (UserListLicenseClientAccountType),
  "clientAccountId": string,
  "clientAccountDisplayName": string,
  "historicalPricings": [
    {
      object (UserListLicensePricing)
    }
  ],
  "metrics": {
    object (UserListLicenseMetrics)
  }
}
Campos
name

string

Identificador. O nome do recurso do cliente de licença global da lista de usuários.
userListId

string (int64 format)

Apenas saída. ID da lista de usuários que está sendo licenciada.
userListDisplayName

string

Apenas saída. Nome da lista de usuários que está sendo licenciada.
licenseType

enum (UserListGlobalLicenseType)

Apenas saída. Tipo de produto do cliente para o qual a lista de usuários está sendo licenciada.
status

enum (UserListLicenseStatus)

Apenas saída. Status da UserListDirectLicense: ATIVADO ou DESATIVADO.
pricing

object (UserListLicensePricing)

Apenas saída. Preços da UserListDirectLicense.
clientAccountType

enum (UserListLicenseClientAccountType)

Apenas saída. Tipo de produto do cliente para o qual a lista de usuários está sendo licenciada.
clientAccountId

string (int64 format)

Apenas saída. ID do cliente para o qual a lista de usuários está sendo licenciada.
clientAccountDisplayName

string

Apenas saída. Nome do cliente para o qual a lista de usuários está sendo licenciada.
historicalPricings[]

object (UserListLicensePricing)

Apenas saída. Histórico de preços dessa licença de lista de usuários.
metrics

object (UserListLicenseMetrics)

Apenas saída. Métricas relacionadas a essa licença.

Esse campo só será preenchido se as datas de início e término forem definidas na chamada userListGlobalLicenseCustomerInfos.list.