REST Resource: properties.audienceExports

Recurso: AudienceExport

Uma exportação 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 exportações 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
}
Campos
name

string

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 AudienceExport.

Formato: properties/{property}/audienceExports/{audienceExport}
audience

string

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

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 mostradas na resposta da consulta.
creationQuotaTokensCharged

integer

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 CREATING, os tokens cobrados serão fixos quando um AudienceExport entrar nos estados ACTIVE ou FAILED.
state

enum (State)

Apenas saída. O estado atual desse AudienceExport.
beginCreatingTime

string (Timestamp format)

Apenas saída. O horário em que audienceExports.create foi chamado e o AudienceExport começou o estado CREATING.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
rowCount

integer

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

string

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

number

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

AudienceDimension

Uma dimensão de público-alvo é um atributo do usuário. Atributos específicos do usuário são solicitados e retornados posteriormente na QueryAudienceExportResponse.

Representação JSON 
{
  "dimensionName": string
}
Campos
dimensionName

string

Opcional. O nome da dimensão da API. Consulte as dimensões da API para conferir a lista de nomes de dimensões.

Estado

O AudienceExport existe atualmente nesse estado.

Tipos enumerados
STATE_UNSPECIFIED O estado não especificado nunca será usado.
CREATING O AudienceExport está sendo criado e estará disponível no futuro. A criação ocorre imediatamente após a chamada audienceExports.create.
ACTIVE O AudienceExport foi totalmente criado e está pronto para consulta. Um AudienceExport é atualizado para 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 Não foi possível criar o AudienceExport. É possível que a nova solicitação dessa exportação de público-alvo seja bem-sucedida.

Métodos

create

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

get

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

list

 Lista todas as exportações de público-alvo de uma propriedade.

query

 Recupera uma exportação de público-alvo de usuários.