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 creación de listas. Primero, se necesita una solicitud a audienceLists.create para crear una lista de público de usuarios y, luego, se usa este método para recuperar los usuarios de la lista de público.

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 en Google Analytics 4 te permiten segmentar a tus usuarios de las maneras que son importantes 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 de comentarios sobre la API de Audience Export de Google Analytics.

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

Parámetros
name

string

Obligatorio. Es el nombre de la lista de público de la que se recuperarán 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. Es el recuento de filas de la fila inicial. La primera fila se cuenta como la fila 0.

Cuando se realiza la paginación, la primera solicitud no especifica un desplazamiento o, de manera equivalente, establece el desplazamiento en 0. La primera solicitud devuelve el primer limit de filas. La segunda solicitud establece el desplazamiento en el limit de la primera solicitud, y devuelve el segundo limit de filas.

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

string (int64 format)

Opcional. Es la cantidad de filas que se devolverán. Si no se especifica, se devuelven 10,000 filas. La API devuelve un máximo de 250,000 filas por solicitud, sin importar cuántas solicites. limit debe ser positivo.

La API también puede devolver menos filas que el limit solicitado si no hay tantos valores de dimensión como el 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)

Son las filas para cada usuario de 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)

Son los datos de configuración sobre el objeto AudienceList que se consulta. Se devuelve para ayudar a interpretar las filas de público de esta respuesta. Por ejemplo, las dimensiones de este 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, el parámetro de solicitud limit y el parámetro de solicitud offset. Por ejemplo, si una búsqueda devuelve 175 filas y la solicitud a la API incluye un valor de limit de 50, la respuesta contendrá un valor de 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 permisos de OAuth:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

AudienceRow

Son los atributos de valor de la dimensión para la fila del usuario del público.

Representación JSON 
{
  "dimensionValues": [
    {
      object (AudienceDimensionValue)
    }
  ]
}
Campos
dimensionValues[]

object (AudienceDimensionValue)

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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "value": string
  // End of mutually exclusive fields.
}
Campos
Es un tipo de valor de dimensión. A continuación, se incluye una lista de campos mutuamente excluyentes. En una respuesta, se establecerá, como máximo, uno de los siguientes campos:
value

string

Es el valor como una cadena si el tipo de dimensión es una cadena.
Fin de los campos mutuamente exclusivos.