Method: properties.audienceLists.query

Recupera uma lista de público-alvo de usuários. Depois de criar um público-alvo, os usuários não ficam disponíveis imediatamente para a listagem. Primeiro, uma solicitação para audienceLists.create é necessária para criar uma lista de público-alvo de usuários. Em segundo lugar, esse método é usado para recuperar os usuários na lista de público-alvo.

Consulte Como criar uma lista de público-alvo para uma introdução às listas de público-alvo com exemplos.

Com os públicos-alvo no Google Analytics 4, você pode segmentar os usuários de um jeito que seja relevante para sua empresa. Para saber mais, consulte https://support.google.com/analytics/answer/9267572.

Esse método está disponível na estabilidade Beta em audienceExports.query. Para enviar seu feedback sobre essa API, preencha o formulário de Feedback da API Audience Export do Google Analytics.

Solicitação HTTP

POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}:query

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

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome da lista de público-alvo para recuperar usuários. Formato: properties/{property}/audienceLists/{audienceList}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "offset": string,
  "limit": string
}
Campos
offset

string (int64 format)

Opcional. O número de linhas da linha inicial. A primeira linha é contada como linha 0.

Ao paginar, a primeira solicitação não especifica o deslocamento ou, de forma equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira limit de linhas. A segunda solicitação define o deslocamento para o limit da primeira solicitação. A segunda solicitação retorna o segundo limit das linhas.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.
limit

string (int64 format)

Opcional. O número de linhas que serão retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna um máximo de 250.000 linhas por solicitação, não importa quantas você solicitar. limit precisa ser positivo.

A API também pode retornar menos linhas do que o limit solicitado, se não houver tantos valores de dimensão quanto o limit.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

Corpo da resposta

Uma lista de usuários em uma lista de público-alvo.

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

Representação JSON 
{
  "audienceRows": [
    {
      object (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Campos
audienceRows[]

object (AudienceRow)

Linhas para cada usuário em uma lista de público-alvo. O número de linhas nessa resposta será menor ou igual ao tamanho da página da solicitação.
audienceList

object (AudienceList)

Dados de configuração sobre a lista de público-alvo consultada. Retornadas para ajudar a interpretar as linhas de público-alvo nesta resposta. Por exemplo, as dimensões nessa AudienceList correspondem às colunas na AudienceRows.
rowCount

integer

O número total de linhas no resultado da AudienceList. rowCount é independente do número de linhas retornadas na resposta, do parâmetro de solicitação limit e do parâmetro de solicitação offset. Por exemplo, se uma consulta retornar 175 linhas e incluir limit de 50 na solicitação da API, a resposta vai conter rowCount de 175, mas apenas 50 linhas.

Para saber mais sobre esse parâmetro de paginação, consulte Paginação.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

Atributos de valor da dimensão para a linha do usuário do público-alvo.

Representação JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Campos
dimensionValues[]

object (AudienceDimensionValue)

Cada atributo de valor de dimensão para um usuário do público-alvo. Um valor de dimensão será adicionado para cada coluna de dimensão solicitada.

AudienceDimensionValue

O valor de uma dimensão.

Representação JSON 
{

  // Union field one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
Campos
Campo de união one_value. Um tipo de valor de dimensão. one_value pode ser apenas de um dos tipos a seguir:
value

string

Valor como uma string se o tipo de dimensão for uma string.