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ú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 que se asignó durante la creación. El nombre del recurso identifica a este AudienceExport.

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

string

Obligatorio. El nombre del recurso de público. El nombre de este recurso identifica el público que se muestra y se comparte entre los datos de Analytics. Admin.

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

string

Solo salida. El nombre visible descriptivo para este público. Por ejemplo, "Compradores".
dimensions[]

object (AudienceDimension)

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

integer

Solo salida. El total de tokens de cuota que se cobraron durante la creación de AudienceExport. Debido a que este recuento de tokens se basa en la actividad del estado CREATING, los tokens cobrados se corregirán una vez que AudienceExport entre en los estados ACTIVE o FAILED.
state

enum (State)

Solo salida. Es el estado actual de 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. Este mensaje de error se propaga cuando la exportación de un público falla durante la creación. Una causa común de este tipo de error es el agotamiento de la cuota.
percentageCompleted

number

Solo salida. 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

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

Estado

Actualmente, AudienceExport existe en este estado.

Enumeraciones
STATE_UNSPECIFIED Nunca se usará el estado no especificado.
CREATING Actualmente, AudienceExport se está creando 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. AudienceExport se actualiza a activo de forma asíncrona a partir de una solicitud. Esto ocurre en algún momento (por ejemplo, 15 minutos) después de la llamada inicial de creación.
FAILED No se pudo crear AudienceExport. Es posible que se vuelva a solicitar esta exportación de públicos con éxito.

Métodos

create

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

get

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

list

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

query

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