Recurso: AudienceExport
Uma exportação de público-alvo inclui uma lista de usuários em um público-alvo no momento em que ela foi criada. Um público-alvo pode ter várias exportações de público-alvo 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 de exportação 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 do AudienceExport. Como essa contagem de tokens é baseada na atividade do estado |
state |
Apenas saída. O estado atual desse AudienceExport. |
beginCreatingTime |
Apenas saída. A hora em que o audienceExports.create foi chamado e o AudienceExport 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 do AudienceExport. |
errorMessage |
Apenas saída. A mensagem de erro é preenchida quando a exportação de um 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. |
AudienceDimension
Uma dimensão de público-alvo é um atributo do usuário. O usuário específico atribuído é solicitado e, em seguida, retornado na QueryAudienceExportResponse
.
Representação JSON |
---|
{ "dimensionName": string } |
Campos | |
---|---|
dimensionName |
Opcional. O nome da API da dimensão. Consulte as Dimensões da API para ver a lista de nomes de dimensões. |
Estado
O AudienceExport existe nesse estado atualmente.
Enums | |
---|---|
STATE_UNSPECIFIED |
Um estado não especificado nunca será usado. |
CREATING |
O AudienceExport está sendo criado e será disponibilizado no futuro. A criação ocorre imediatamente após a chamada audienceExports.create. |
ACTIVE |
O AudienceExport está totalmente criado e pronto para consultas. Um AudienceExport é atualizado para ficar ativo 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 o AudienceExport. É possível que uma nova solicitação dessa exportação de público-alvo seja bem-sucedida. |
Métodos |
|
---|---|
|
Cria uma exportação de público-alvo para recuperação posterior. |
|
Recebe metadados de configuração sobre uma exportação de público-alvo específico. |
|
Lista todas as exportações de público-alvo de uma propriedade. |
|
Recupera uma exportação de público-alvo de usuários. |