REST Resource: properties.audienceExports

Recurso: AudienceExport

Una exportación de público es una lista de usuarios de un público al momento de la creación de la lista. Un público puede tener varias exportaciones de públicos 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. El nombre del recurso de exportación de públicos 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 aparece en la lista y se comparte entre las APIs de Analytics y de 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 a la consulta.

creationQuotaTokensCharged

integer

Solo salida. Son los tokens de cuota totales que se cobran durante la creación de AudienceExport. Dado que este recuento de tokens se basa en la actividad del estado CREATING, estos tokens que se cobrarán se corregirá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 el momento en el que se llamó a audienceExports.create y este comenzó el estado CREATING.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con 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 la exportación de un público falla durante la creación. Un motivo común para una falla de este tipo es el agotamiento de la cuota.

percentageCompleted

number

Solo salida. El porcentaje completado de esta exportación de público que se encuentra entre 0 y 100.

AudienceDimension

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

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

string

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

Estado

Actualmente, AudienceExport existe en este estado.

Enumeradores
STATE_UNSPECIFIED Nunca se usará un estado no especificado.
CREATING Actualmente, se está creando la exportación de públicos y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada audienceExports.create.
ACTIVE La exportación de público está completamente creada y lista para realizar consultas. Un AudienceExport se actualiza para que se active de forma asíncrona a partir de una solicitud. Esto ocurre durante un tiempo (por ejemplo, 15 minutos) después de la llamada de creación inicial.
FAILED No se pudo crear AudienceExport. Es posible que se realice correctamente volver a solicitar esta exportación de público.

Métodos

create

Crea una exportación de público para su posterior recuperación.

get

Obtiene los metadatos de configuración de una exportación de público específico.

list

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

query

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