- 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, uma solicitação para audienceLists.create
é necessária para criar uma lista de público-alvo de usuários e, em seguida, 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 a listas de público-alvo com exemplos.
Com os públicos-alvo do Google Analytics 4, você pode segmentar os usuários das maneiras 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 feedback sobre essa 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 recuperar usuários. 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 linha inicial. A primeira linha é contada como 0. Durante a paginação, a primeira solicitação não especifica o deslocamento. ou equivalente, define o deslocamento para 0; a primeira solicitação retorna o primeiro Para saber mais sobre esse parâmetro de paginação, consulte Paginação. |
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ê pedir. A API também poderá retornar menos linhas do que o 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 ( |
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 sobre a AudienceList sendo consultada. Retornado para ajudar a interpretar as linhas de público-alvo nesta resposta. Por exemplo, as dimensões nessa AudienceList correspondem às colunas em AudienceRows. |
rowCount |
O número total de linhas no resultado da lista de públicos-alvo. 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 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 de 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. |