- Solicitação HTTP
- Parâmetros de caminho
- Corpo da solicitação
- Corpo da resposta
- Escopos de autorização
- AudienceRow
- AudienceDimensionValue
- Faça um teste
Recupera uma lista de público-alvo de usuários. Depois de criar um público-alvo, os usuários não ficam imediatamente disponíveis para a página de detalhes. Primeiro, é necessário enviar uma solicitação para audienceLists.create
a fim de criar uma lista de público-alvo de usuários. Depois, esse método é usado para recuperar os usuários na lista.
Consulte Criar uma lista de público-alvo para uma introdução a listas de público-alvo com exemplos.
Com os públicos-alvo no Google Analytics 4, é possível segmentar os usuários mais relevantes para sua empresa. Para saber mais, consulte https://support.google.com/analytics/answer/9267572.
Esse método está disponível na versão Beta de estabilidade em audienceExports.query. Para enviar seu feedback sobre a API, preencha o formulário Feedback sobre a 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 |
Obrigatório. O nome da lista de público-alvo da qual os usuários serão recuperados. Formato: |
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 |
Opcional. A contagem de linhas da primeira linha. A primeira linha é contada como a linha 0. Na paginação, a primeira solicitação não especifica o deslocamento ou, de maneira equivalente, define o deslocamento como 0. A primeira solicitação retorna a primeira Consulte Paginação para saber mais sobre esse parâmetro. |
limit |
Opcional. O número de linhas a serem retornadas. Se não for especificado, 10.000 linhas serão retornadas. A API retorna no máximo 250.000 linhas por solicitação, independentemente de quantas linhas você solicitar. A API também pode retornar menos linhas do que o Consulte Paginação para saber mais sobre esse parâmetro. |
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 ( |
Campos | |
---|---|
audienceRows[] |
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 |
Dados de configuração da lista de público-alvo que está sendo consultada. Retornado para ajudar a interpretar as linhas do público-alvo nessa resposta. Por exemplo, as dimensões nessa AudienceList correspondem às colunas nas AudienceRows. |
rowCount |
O número total de linhas no resultado da AudienceList. Consulte Paginação para saber mais sobre esse parâmetro. |
Escopos de autorização
Requer um dos seguintes escopos de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
Atributos de valor de dimensão para a linha de usuário do público-alvo.
Representação JSON |
---|
{
"dimensionValues": [
{
object ( |
Campos | |
---|---|
dimensionValues[] |
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 |
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 |
Valor como uma string se o tipo de dimensão for uma string. |