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 su creación. 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. 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 del público. Este nombre de recurso identifica el público que se incluye en la lista 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. Es el total de tokens de cuota cobrados durante la creación de AudienceExport. Debido a que este recuento de tokens se basa en la actividad del estado CREATING, estos tokens cobrados se corregirán una vez que un objeto 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. El momento en que se llamó a audienceExports.create y AudienceExport comenzó el estado CREATING.

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
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 una exportación de público falla durante la creación. Un motivo común de este tipo de error 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 del usuario. Se solicitan atributos de usuario específicos y, luego, se muestran en QueryAudienceExportResponse.

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

string

Opcional. Es el nombre de la API de la dimensión. Consulta Dimensiones de la API para ver la lista de nombres de las dimensiones.

Estado

Actualmente, AudienceExport se encuentra en este estado.

Enumeraciones
STATE_UNSPECIFIED Nunca se usará el estado sin especificar.
CREATING Actualmente, se está creando AudienceExport 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 consultarse. Un objeto AudienceExport se actualiza a activo de forma asíncrona desde una solicitud. Esto ocurre algún tiempo (por ejemplo, 15 minutos) después de la llamada de creación inicial.
FAILED No se pudo crear AudienceExport. Es posible que se pueda volver a solicitar esta exportación de público.

Métodos

create

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

get

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

list

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

query

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