REST Resource: properties.audienceLists

Recurso: AudienceList

Uma lista de público-alvo é uma lista de usuários em um público-alvo no momento da criação da lista. Um público-alvo pode ter várias listas de público-alvo criadas para dias diferentes.

Representação JSON 
{
  "name": string,
  "audience": string,
  "audienceDisplayName": string,
  "dimensions": [
    {
      object (AudienceDimension)
    }
  ],
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "rowCount": integer,
  "errorMessage": string,
  "percentageCompleted": number,
  "recurringAudienceList": string,
  "webhookNotification": {
    object (WebhookNotification)
  }
}
Campos
name

string

Apenas saída. Identificador. O nome do recurso da lista de público-alvo atribuído durante a criação. Esse nome de recurso identifica o AudienceList.

Formato: properties/{property}/audienceLists/{audienceList}
audience

string

Obrigatório. O nome do recurso de público-alvo. Esse nome de recurso identifica o público-alvo listado e é compartilhado entre as APIs Analytics Data e Admin.

Formato: properties/{property}/audiences/{audience}
audienceDisplayName

string

Apenas saída. O nome de exibição descritivo desse público-alvo. Por exemplo, "Compradores".
dimensions[]

object (AudienceDimension)

Obrigatório. As dimensões solicitadas e exibidas na resposta da consulta.
creationQuotaTokensCharged

integer

Apenas saída. O total de tokens de cota cobrados durante a criação da AudienceList. Como essa contagem de tokens é baseada na atividade do estado CREATING, esses tokens cobrados serão corrigidos quando uma AudienceList entrar nos estados ACTIVE ou FAILED.
state

enum (State)

Apenas saída. O estado atual da AudienceList.
beginCreatingTime

string (Timestamp format)

Apenas saída. O momento em que audienceLists.create foi chamado e a AudienceList começou o estado CREATING.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
rowCount

integer

Apenas saída. O número total de linhas no resultado da AudienceList.
errorMessage

string

Apenas saída. A mensagem de erro é preenchida quando uma lista de público-alvo falha durante a criação. Uma causa comum desse problema é o esgotamento de cota.
percentageCompleted

number

Apenas saída. A porcentagem concluída para essa exportação de público-alvo varia de 0 a 100.
recurringAudienceList

string

Apenas saída. A lista de público-alvo recorrente que criou essa lista. As listas de público-alvo recorrentes são criadas diariamente.

Se as listas de público-alvo forem criadas diretamente, elas não terão uma lista de público-alvo recorrente associada e esse campo vai ficar em branco.
webhookNotification

object (WebhookNotification)

Opcional. Configura as notificações de webhook para serem enviadas da API Data do Google Analytics para seu servidor de webhook. O uso de webhooks é opcional. Se não for usada, você vai precisar consultar essa API para determinar quando uma lista de público-alvo está pronta para uso. Os webhooks permitem que uma notificação seja enviada aos seus servidores e evitam a necessidade de pesquisa.

Uma ou duas solicitações POST serão enviadas ao webhook. A primeira solicitação POST será enviada imediatamente, mostrando a lista de público-alvo recém-criada no estado CREATING. A segunda solicitação POST será enviada depois que a criação da lista de público-alvo for concluída (no estado ACTIVE ou FAILED).

Se listas de público-alvo idênticas forem solicitadas em rápida sucessão, a segunda e as listas de público-alvo seguintes poderão ser veiculadas do cache. Nesse caso, o método de criação da lista de público-alvo pode retornar uma lista de público-alvo que já está ATIVA. Nesse cenário, apenas uma solicitação POST será enviada ao webhook.

Estado

A AudienceList está atualmente neste estado.

Enums
STATE_UNSPECIFIED O estado não especificado nunca será usado.
CREATING A AudienceList está sendo criada e será disponibilizada no futuro. A criação ocorre imediatamente após a chamada audienceLists.create.
ACTIVE A AudienceList foi totalmente criada e está pronta para consulta. Uma AudienceList é atualizada para ativa de forma assíncrona a partir de uma solicitação. Isso ocorre algum tempo (por exemplo, 15 minutos) após a chamada de criação inicial.
FAILED Não foi possível criar a lista de audiência. É possível que a solicitação da lista de público-alvo seja bem-sucedida.

Métodos

create

 Cria uma lista de público-alvo para recuperação posterior.

exportSheet

 Exporta uma lista de público-alvo de usuários para uma planilha Google.

get

 Recebe metadados de configuração sobre uma lista de público-alvo específica.

list

 Lista todas as listas de público-alvo de uma propriedade.

query

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