Method: properties.audienceExports.query

Recupera una exportación de usuarios de públicos. Después de crear un público, los usuarios no están disponibles de inmediato para exportarlos. En primer lugar, se necesita una solicitud a audienceExports.create para crear una exportación de usuarios de públicos y, en segundo lugar, se usa este método para recuperar los usuarios en la exportación de públicos.

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

Las APIs de Audience Export tienen algunos métodos en alfa y otros en estabilidad beta. El objetivo es avanzar con los métodos hacia la estabilidad de las versiones beta después de algunos comentarios y adopción. 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/v1beta/{name=properties/*/audienceExports/*}: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 exportación de públicos del que se recuperarán los usuarios. Formato: properties/{property}/audienceExports/{audienceExport}

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

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

string (int64 format)

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 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 limit.

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

Cuerpo de la respuesta

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

object (AudienceRow)

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

object (AudienceExport)

Datos de configuración de AudienceExport que se consultan. Se muestra para ayudar a interpretar las filas de público en esta respuesta. Por ejemplo, las dimensiones de esta AudienceExport corresponden a las columnas de AudienceRows.
rowCount

integer

Es la cantidad total de filas en el resultado de AudienceExport. 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.

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 (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 
{

  // 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. Es un tipo de valor de dimensión. Las direcciones (one_value) solo pueden ser una de las siguientes opciones:
value

string

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