Recurso: AudienceList
Una lista de público es una lista de los usuarios de un público en el momento de la creación de la lista. Es posible que un público tenga varias listas de público creadas para diferentes días.
Representación JSON |
---|
{ "name": string, "audience": string, "audienceDisplayName": string, "dimensions": [ { object ( |
Campos | |
---|---|
name |
Solo salida. Identificador. Es el nombre del recurso de la lista de público que se asignó durante la creación. El nombre del recurso identifica a este Formato: |
audience |
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: |
audienceDisplayName |
Solo salida. El nombre visible descriptivo para este público. Por ejemplo, "Compradores". |
dimensions[] |
Obligatorio. Las dimensiones solicitadas y que se muestran en la respuesta de la consulta. |
creationQuotaTokensCharged |
Solo salida. El total de tokens de cuota que se cobraron durante la creación de AudienceList. Debido a que este recuento de tokens se basa en la actividad del estado |
state |
Solo salida. Es el estado actual de esta AudienceList. |
beginCreatingTime |
Solo salida. El momento en el que se llamó a audienceLists.create y la AudienceList comenzó con el estado Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
rowCount |
Solo salida. Es la cantidad total de filas en el resultado de AudienceList. |
errorMessage |
Solo salida. Un mensaje de error se propaga cuando una lista de público falla durante su creación. Una causa común de este tipo de error es el agotamiento de la cuota. |
percentageCompleted |
Solo salida. El porcentaje completado de esta exportación de público, que oscila entre 0 y 100. |
recurringAudienceList |
Solo salida. Es la lista de público recurrente que creó esta lista de público. Las listas de público recurrentes crean listas de público diariamente. Si se crean listas de público directamente, no tendrán una lista de público recurrente asociada y este campo estará en blanco. |
webhookNotification |
Opcional. Configura las notificaciones de webhook para que se envíen desde la API de datos de Google Analytics a tu servidor de webhook. El uso de webhooks es opcional. Si no se usa, deberás consultar esta API para determinar cuándo se puede usar una lista de público. Los webhooks permiten que se envíe una notificación a tus servidores y evitar la necesidad de sondeos. Se enviarán una o dos solicitudes POST al webhook. La primera solicitud POST se enviará de inmediato y mostrará la lista de público recién creada en su estado CREATING. La segunda solicitud POST se enviará después de que se complete la creación de la lista de público (ya sea en el estado ACTIVE o FAILED). Si se solicitan listas de público idénticas en sucesión rápida, la segunda y las listas de público posteriores se pueden publicar desde la caché. En ese caso, el método de creación de listas de público puede mostrar que una lista de público ya está ACTIVA. En este caso, solo se enviará una solicitud POST al webhook. |
Estado
Actualmente, AudienceList existe en este estado.
Enumeraciones | |
---|---|
STATE_UNSPECIFIED |
Nunca se usará el estado no especificado. |
CREATING |
Actualmente, AudienceList se está creando y estará disponible en el futuro. La creación se produce inmediatamente después de la llamada audienceLists.create. |
ACTIVE |
AudienceList está completamente creada y lista para realizar consultas. Una AudienceList se actualiza a activa 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 la AudienceList. Es posible volver a solicitar esta lista de público con éxito. |
Métodos |
|
---|---|
|
Crea una lista de público para recuperarla más adelante. |
|
Exporta una lista de público de usuarios a una hoja de cálculo de Google. |
|
Obtiene los metadatos de configuración sobre una lista de público específica. |
|
Muestra todas las listas de público de una propiedad. |
|
Recupera una lista de público de usuarios. |