REST Resource: properties.audienceLists

{
  "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)
  }
}

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}

string

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

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

string

Apenas saída. Nome de exibição descritivo para esse público-alvo. Por exemplo, "Compradores".

object (AudienceDimension)

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

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, a cobrança dos tokens será feita quando uma AudienceList entrar nos estados ACTIVE ou FAILED.

enum (State)

Apenas saída. O estado atual desta AudienceList.

string (Timestamp format)

Apenas saída. A hora em que audienceLists.create foi chamado e a AudienceList iniciou o estado CREATING.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, 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".

integer

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

string

Apenas saída. A mensagem de erro é preenchida quando uma lista de público-alvo falha durante a criação. Um motivo comum para essa falha é o esgotamento da cota.

number

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

string

Apenas saída. A lista de público-alvo recorrente que criou esta lista de público-alvo. As listas de público-alvo recorrentes criam listas de público-alvo 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 o campo vai ficar em branco.

object (WebhookNotification)

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

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

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