- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- AudienceRow
- AudienceDimensionValue
- Pruébala
Recupera una exportación de público de usuarios. Después de crear un público, los usuarios no están disponibles de inmediato para su exportación. En primer lugar, se necesita una solicitud a audienceExports.create
para crear una exportación de público de público. Luego, en segundo lugar, se usa este método para recuperar los usuarios de la exportación de público.
Consulta Cómo crear una exportación de público para obtener una introducción a las exportaciones de públicos con ejemplos.
Los públicos de Google Analytics 4 te permiten segmentar a tus usuarios de formas significativas para tu empresa. Para obtener más información, consulta https://support.google.com/analytics/answer/9267572.
Las APIs de exportación de públicos tienen algunos métodos en versión alfa y otros en estabilidad. El objetivo es que los métodos avancen hacia la estabilidad beta después de algunos comentarios y su adopción. Para enviar tus comentarios sobre esta API, completa el formulario Comentarios sobre la API de Google Analytics Audience Export.
Solicitud HTTP
POST https://analyticsdata.googleapis.com/v1beta/{name=properties/*/audienceExports/*}:query
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
name |
Obligatorio. El nombre de la exportación del público del que se recuperarán los usuarios. Formato: |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "offset": string, "limit": string } |
Campos | |
---|---|
offset |
Opcional. El recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0. Cuando se realiza la paginación, la primera solicitud no especifica el desplazamiento o, de manera equivalente, lo establece en 0. La primera solicitud muestra las primeras Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
Opcional. Cantidad de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas tengas. La API también puede mostrar menos filas que la Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
Cuerpo de la respuesta
Es una lista de usuarios en una exportación de público.
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Representación JSON |
---|
{ "audienceRows": [ { object ( |
Campos | |
---|---|
audienceRows[] |
Filas de cada usuario en una exportación de público. La cantidad de filas en esta respuesta será menor o igual que el tamaño de la página de la solicitud. |
audienceExport |
Datos de configuración sobre AudienceExport que se consulta. Se muestra para ayudar a interpretar las filas de público en esta respuesta. Por ejemplo, las dimensiones de este AudienceExport corresponden a las columnas de AudienceRows. |
rowCount |
Es la cantidad total de filas en el resultado de AudienceExport. Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
Permisos de autorización
Se necesita uno de los siguientes alcances de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
Atributos de valor de dimensión de la fila de usuario del público.
Representación JSON |
---|
{
"dimensionValues": [
{
object ( |
Campos | |
---|---|
dimensionValues[] |
Cada atributo de valor de dimensión de un usuario del público Se agregará un valor de dimensión para cada columna de dimensiones solicitada. |
AudienceDimensionValue
Indica el valor de una dimensión.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_value . Un tipo de valor de dimensión. Las direcciones (one_value ) solo pueden ser una de las siguientes opciones: |
|
value |
Valor como cadena si el tipo de dimensión es una cadena. |