REST Resource: properties.audienceExports

Recurso: AudienceExport

Una exportación de público es una lista de usuarios incluidos en un público al momento de crearse la lista. Es posible que un público tenga 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 El nombre de este recurso identifica este AudienceExport.

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

string

Obligatorio. Es el nombre del recurso del público. El nombre de este recurso identifica el público que se muestra en la lista y se comparte entre las APIs de Analytics Data & Admin.

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

string

Solo salida. Es el nombre visible descriptivo para 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 total que se cobran 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 AudienceExport ingrese a los estados ACTIVE o FAILED.
state

enum (State)

Solo salida. Es el estado actual de esta exportación de público.
beginCreatingTime

string (Timestamp format)

Solo salida. Es el momento en que se llamó a audienceExports.create y este comenzó a mostrar 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 falla la exportación de un público 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 para esta exportación de público oscila entre 0 y 100.

AudienceDimension

Una dimensión de público es un atributo de usuario. Se solicita un usuario específico atribuido y, luego, se muestra en QueryAudienceExportResponse.

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

string

Opcional. El nombre de la API de la dimensión. Para ver la lista de nombres de dimensiones, consulta Dimensiones de la API.

Estado

Actualmente, la exportación de públicos existe en este estado.

Enumeradores
STATE_UNSPECIFIED Nunca se usará el estado no especificado.
CREATING Actualmente, se está creando la exportación de público y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada audienceExports.create.
ACTIVE AudienceExport está completamente creada y lista para realizar consultas. Una exportación de público se actualiza a activa de forma asíncrona a partir de 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 la exportación de público. Es posible que la nueva solicitud de esta exportación de público tenga éxito.

Métodos

create

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

get

 Obtiene los metadatos de configuración sobre la exportación de un público específico.

list

 Muestra una lista de todas las exportaciones de públicos de una propiedad.

query

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