Recurso: AudienceList
Uma lista de público-alvo inclui usuários de um público-alvo no momento em que ela foi criada. Um público-alvo pode ter várias listas criadas para dias diferentes.
Representação JSON |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
Campos | |
---|---|
name |
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 Formato: |
audience |
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: |
audienceDisplayName |
Apenas saída. Nome de exibição descritivo para esse público-alvo. Por exemplo, "Compradores". |
dimensions[] |
Obrigatório. As dimensões solicitadas e exibidas na resposta da consulta. |
creationQuotaTokensCharged |
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 |
state |
Apenas saída. O estado atual desta AudienceList. |
beginCreatingTime |
Apenas saída. A hora em que audienceLists.create foi chamado e a AudienceList iniciou o estado Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: |
rowCount |
Apenas saída. O número total de linhas no resultado da AudienceList. |
errorMessage |
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. |
percentageCompleted |
Apenas saída. A porcentagem concluída para essa exportação de público-alvo entre 0 e 100. |
recurringAudienceList |
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. |
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. |
Estado
Atualmente, a AudienceList existe nesse estado.
Enums | |
---|---|
STATE_UNSPECIFIED |
Um 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 está totalmente criada e pronta para consultas. 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 |
Falha ao criar a AudienceList. É possível que a nova solicitação dessa lista de público-alvo seja bem-sucedida. |
Métodos |
|
---|---|
|
Cria uma lista de público-alvo para recuperação posterior. |
|
Exporta uma lista de público-alvo de usuários para um arquivo das Planilhas Google. |
|
Recebe metadados de configuração sobre uma lista de público-alvo específica. |
|
Lista todas as listas de público-alvo de uma propriedade. |
|
Recupera uma lista de público-alvo de usuários. |