- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Permisos de autorización
- AudienceRow
- AudienceDimensionValue
- Pruébalo
Recupera una lista de público de usuarios. Después de crear un público, los usuarios no están disponibles de inmediato para mostrarse. En primer lugar, se necesita una solicitud a audienceLists.create
para crear una lista de público de usuarios y, en segundo lugar, se usa este método para recuperar los usuarios en la lista de público.
Consulte Cómo crear una lista de público para obtener una introducción a las listas de público con ejemplos.
Los públicos en 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.
Este método está disponible en versión beta en audienceExports.query. Para enviar tus comentarios sobre esta API, completa el formulario de comentarios de la API de Google Analytics Audience Export.
Solicitud HTTP
POST https://analyticsdata.googleapis.com/v1alpha/{name=properties/*/audienceLists/*}: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 lista de público de la 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 inicial. La primera fila se cuenta como fila 0. Durante la paginación, la primera solicitud no especifica el desplazamiento. o, de forma equivalente, establece el desplazamiento en 0; la primera solicitud muestra el primer Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
Opcional. Número 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, independientemente de cuántas solicites. El valor de 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 lista 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 para cada usuario en una lista 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. |
audienceList |
Datos de configuración de AudienceList que se consultan. Se muestra para ayudar a interpretar las filas de público en esta respuesta. Por ejemplo, las dimensiones de esta AudienceList corresponden a las columnas de AudienceRows. |
rowCount |
Es la cantidad total de filas en el resultado de AudienceList. Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
Alcances de autorización
Se necesita uno de los siguientes permisos de OAuth:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
AudienceRow
Atributos de valor de dimensión para la fila de usuarios del público.
Representación JSON |
---|
{
"dimensionValues": [
{
object ( |
Campos | |
---|---|
dimensionValues[] |
Es cada atributo de valor de dimensión para un usuario del público. Se agregará un valor de dimensión para cada columna de dimensión solicitada. |
AudienceDimensionValue
Es el valor de una dimensión.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión one_value . Es un tipo de valor de dimensión. Las direcciones (one_value ) solo pueden ser una de las siguientes opciones: |
|
value |
El valor como una cadena si el tipo de dimensión es una cadena. |