REST Resource: properties.audienceExports

Recurso: AudienceExport

Una exportación de público es una lista de usuarios de un público en el momento de la creación de la lista. Un público puede tener varias exportaciones de público creadas para diferentes días.

Representación 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

Solo salida. Es el identificador. Es el nombre del recurso de exportación de público asignado durante la creación. Este nombre de recurso identifica este AudienceExport.

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

string

Obligatorio. Es el nombre del recurso de público. Este nombre de recurso identifica el público que se está enumerando y se comparte entre las APIs de Analytics Data y Admin.

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

string

Solo salida. Es el nombre visible descriptivo de este público. Por ejemplo, "Compradores".
dimensions[]

object (AudienceDimension)

Obligatorio. Son las dimensiones solicitadas y que se muestran en la respuesta de la consulta.
creationQuotaTokensCharged

integer

Solo salida. Son los tokens de cuota totales que se cobraron durante la creación de AudienceExport. Dado que este recuento de tokens se basa en la actividad del estado CREATING, los tokens cobrados se fijarán una vez que AudienceExport ingrese a los estados ACTIVE o FAILED.
state

enum (State)

Solo salida. Es el estado actual de este AudienceExport.
beginCreatingTime

string (Timestamp format)

Solo salida. Es la hora en la que se llamó a audienceExports.create y AudienceExport comenzó el estado CREATING.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
rowCount

integer

Solo salida. Es la cantidad total de filas en el resultado de AudienceExport.
errorMessage

string

Solo salida. El mensaje de error se propaga cuando falla una exportación de público durante la creación. Un motivo común de esta falla es el agotamiento de la cuota.
percentageCompleted

number

Solo salida. Es el porcentaje completado de esta exportación de público, que oscila entre 0 y 100.

AudienceDimension

Una dimensión de público es un atributo de usuario. Se solicitan atributos de usuario específicos y, luego, se muestran en QueryAudienceExportResponse.

Representación JSON 
{
  "dimensionName": string
}
Campos
dimensionName

string

Es opcional. Es el nombre de la API de la dimensión. Consulta las dimensiones de la API para obtener la lista de nombres de dimensiones.

Estado

AudienceExport existe actualmente en este estado.

Enums
STATE_UNSPECIFIED El estado sin especificar nunca se usará.
CREATING AudienceExport se está creando y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada a audienceExports.create.
ACTIVE AudienceExport se creó por completo y está listo para la consulta. Un AudienceExport se actualiza a activo de forma asíncrona desde una solicitud; esto ocurre un tiempo (por ejemplo, 15 minutos) después de la llamada de creación inicial.
FAILED No se pudo crear AudienceExport. Es posible que la solicitud de esta exportación de público se realice correctamente.

Métodos

create

 Crea una exportación de público para recuperarla más tarde.

get

 Obtiene metadatos de configuración sobre una exportación de público específica.

list

 Enumera todas las exportaciones de público de una propiedad.

query

 Recupera una exportación de público de usuarios.