Method: properties.audienceLists.exportSheet

Exporta una lista de público de usuarios a una hoja de cálculo de Google. 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 exportar a una hoja de cálculo de Google a esos usuarios.

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 se introduce durante el período de estabilidad de la versión alfa con la intención de reunir comentarios sobre la sintaxis y las funciones antes de proceder a la versión beta. 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/*}:exportSheet

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

La hoja de cálculo de Google creada con la 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 
{
  "spreadsheetUri": string,
  "spreadsheetId": string,
  "rowCount": integer,
  "audienceList": {
    object (AudienceList)
  }
}
Campos
spreadsheetUri

string

Un URI que debes visitar en tu navegador para ver la hoja de cálculo de Google.
spreadsheetId

string

Un ID que identifica el recurso creado en la hoja de cálculo de Google.
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.
audienceList

object (AudienceList)

Datos de configuración sobre la exportación de AudienceList. Regresa para ayudar a interpretar la lista de público de la hoja de cálculo de Google de esta respuesta.

Por ejemplo, AudienceList puede tener más filas que las presentes en la hoja de cálculo de Google y, en ese caso, es posible que quieras enviar una solicitud de exportación de hoja adicional con un valor offset diferente para recuperar la siguiente página de filas en una hoja de cálculo de Google adicional.

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
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets