Method: properties.audienceLists.query

Recupera una lista de público de usuarios. Después de crear un público, los usuarios no están disponibles de inmediato para la ficha. En primer lugar, se necesita una solicitud a audienceLists.create para crear una lista de público de usuarios. Luego, se usa este método para recuperar los usuarios de esa lista.

Consulta Cómo crear una lista de público para obtener una introducción a las listas de público 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.

Este método está disponible con estabilidad beta en audienceExports.query. 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/v1alpha/{name=properties/*/audienceLists/*}:query

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
name

string

Obligatorio. Es el nombre de la lista de público de la que se deben recuperar los usuarios. Formato: properties/{property}/audienceLists/{audienceList}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "offset": string,
  "limit": string
}
Campos
offset

string (int64 format)

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 limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud; la segunda solicitud muestra la segunda solicitud limit de filas.

Para obtener más información sobre este parámetro de paginación, consulta Paginación.
limit

string (int64 format)

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. limit debe ser positivo.

La API también puede mostrar menos filas que la limit solicitada si no hay tantos valores de dimensión como la limit.

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 (AudienceRow)
    }
  ],
  "audienceList": {
    object (AudienceList)
  },
  "rowCount": integer
}
Campos
audienceRows[]

object (AudienceRow)

Filas de 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

object (AudienceList)

Datos de configuración sobre AudienceList que se consulta. 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

integer

Es la cantidad total de filas en el resultado de AudienceList. rowCount es independiente de la cantidad de filas que se muestran en la respuesta, los parámetros de solicitud limit y offset. Por ejemplo, si una consulta muestra 175 filas e incluye limit de 50 en la solicitud a la API, la respuesta contendrá rowCount de 175, pero solo 50 filas.

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 (AudienceDimensionValue)
    }
  ]
}
Campos
dimensionValues[]

object (AudienceDimensionValue)

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 one_value can be only one of the following:
  "value": string
  // End of list of possible types for union field one_value.
}
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

string

Valor como cadena si el tipo de dimensión es una cadena.