Se usó la API de Cloud Translation para traducir esta página.

Method: properties.runAccessReport

Solicitud HTTP
Parámetros de ruta de acceso
Cuerpo de la solicitud
- Representación JSON
Cuerpo de la respuesta
Alcances de la autorización
Pruébala

Devuelve un informe personalizado de los registros de acceso a los datos. El informe proporciona registros de cada vez que un usuario lee datos de informes de Google Analytics. Los registros de acceso se conservan por un máximo de 2 años.

Se pueden solicitar informes de acceso a los datos para una propiedad. Se pueden solicitar informes para cualquier propiedad, pero las dimensiones que no estén relacionadas con la cuota solo se pueden solicitar en las propiedades de Google Analytics 360. Este método solo está disponible para los administradores.

Estos registros de acceso a los datos incluyen los informes de la IU de GA4, las exploraciones de la IU de GA4, la API de datos de GA4 y otros productos, como Firebase y AdMob, que pueden recuperar datos de Google Analytics a través de una vinculación. Estos registros no incluyen cambios en la configuración de la propiedad, como agregar un flujo o cambiar la zona horaria de una propiedad. Para ver el historial de cambios de configuración, consulta searchChangeHistoryEvents.

Solicitud HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{entity=properties/*}:runAccessReport

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

Parámetros de ruta de acceso

Parámetros

Parámetros
`entity`	`string` El informe de acceso a los datos admite solicitudes a nivel de la propiedad o de la cuenta. Si se solicitan a nivel de la cuenta, estos informes incluirán todo el acceso a todas las propiedades de esa cuenta. Para realizar una solicitud a nivel de la propiedad, la entidad debería ser, por ejemplo, "propiedades/123" si "123" es el ID de tu propiedad GA4. Para enviar una solicitud a nivel de la cuenta, la entidad debería ser, por ejemplo, "accounts/1234" si "1234" es el ID de tu cuenta de GA4.

entity

string

El informe de acceso a los datos admite solicitudes a nivel de la propiedad o de la cuenta. Si se solicitan a nivel de la cuenta, estos informes incluirán todo el acceso a todas las propiedades de esa cuenta.

Para realizar una solicitud a nivel de la propiedad, la entidad debería ser, por ejemplo, "propiedades/123" si "123" es el ID de tu propiedad GA4. Para enviar una solicitud a nivel de la cuenta, la entidad debería ser, por ejemplo, "accounts/1234" si "1234" es el ID de tu cuenta de GA4.

Cuerpo de la solicitud

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

Representación JSON

Representación JSON
{ "dimensions": [ { object (`AccessDimension`) } ], "metrics": [ { object (`AccessMetric`) } ], "dateRanges": [ { object (`AccessDateRange`) } ], "dimensionFilter": { object (`AccessFilterExpression`) }, "metricFilter": { object (`AccessFilterExpression`) }, "offset": string, "limit": string, "timeZone": string, "orderBys": [ { object (`AccessOrderBy`) } ], "returnEntityQuota": boolean, "includeAllUsers": boolean, "expandGroups": boolean }

{
  "dimensions": [
    {
      object (AccessDimension)
    }
  ],
  "metrics": [
    {
      object (AccessMetric)
    }
  ],
  "dateRanges": [
    {
      object (AccessDateRange)
    }
  ],
  "dimensionFilter": {
    object (AccessFilterExpression)
  },
  "metricFilter": {
    object (AccessFilterExpression)
  },
  "offset": string,
  "limit": string,
  "timeZone": string,
  "orderBys": [
    {
      object (AccessOrderBy)
    }
  ],
  "returnEntityQuota": boolean,
  "includeAllUsers": boolean,
  "expandGroups": boolean
}

Campos
`dimensions[]`	`object (AccessDimension)` Son las dimensiones solicitadas y que se muestran en la respuesta. Se permiten solicitudes con hasta 9 dimensiones.
`metrics[]`	`object (AccessMetric)` Las métricas solicitadas y que se muestran en la respuesta. Se permiten hasta 10 métricas de solicitud.
`dateRanges[]`	`object (AccessDateRange)` Períodos de los registros de acceso que se deben leer. Si se solicitan varios períodos, cada fila de respuesta contendrá un índice de período basado en cero. Si dos períodos se superponen, los registros de acceso de los días superpuestos se incluyen en las filas de respuesta de ambos períodos. Las solicitudes se permiten en un máximo de 2 períodos.
`dimensionFilter`	`object (AccessFilterExpression)` Los filtros de dimensión te permiten restringir la respuesta del informe a valores de dimensión específicos que coincidan con el filtro. Por ejemplo, filtrar los registros de acceso de un solo usuario. Si deseas obtener más información, consulta ejemplos del artículo Aspectos básicos de los filtros de dimensión. No se pueden usar métricas en este filtro.
`metricFilter`	`object (AccessFilterExpression)` Los filtros de métricas te permiten restringir la respuesta del informe a valores de métricas específicos que coincidan con el filtro. Los filtros de métricas se aplican después de agregar las filas del informe, de manera similar a la cláusula de cláusula de SQL. No se pueden usar dimensiones en este filtro.
`offset`	`string (int64 format)` El recuento de filas de la fila de inicio. La primera fila se cuenta como la fila 0. Si no se especifica el desplazamiento, se trata como 0. Si el desplazamiento es cero, este método mostrará la primera página de resultados con entradas `limit`. Para obtener más información sobre este parámetro de paginación, consulta Paginación.
`limit`	`string (int64 format)` Cantidad de filas que se mostrarán. Si no se especifica, se muestran 10,000 filas. La API devuelve un máximo de 100,000 filas por solicitud, sin importar cuántas tengas. `limit` debe ser positivo. La API puede mostrar menos filas que la `limit` solicitada si no hay tantas filas restantes como la `limit`. Por ejemplo, hay menos de 300 valores posibles para la dimensión `country`. Por lo tanto, si genera informes solo de `country`, no podrá obtener más de 300 filas, incluso si establece `limit` en un valor más alto. Para obtener más información sobre este parámetro de paginación, consulta Paginación.
`timeZone`	`string` Zona horaria de esta solicitud, si se especifica. Si no se especifica, se usa la zona horaria de la propiedad. La zona horaria de la solicitud se utiliza para interpretar las fechas de inicio y finalización del informe. Tienen formato como cadenas de la base de datos de zonas horarias de la IANA (https://www.iana.org/time-zones). Por ejemplo, "America/New_York" o "Asia/Tokyo".
`orderBys[]`	`object (AccessOrderBy)` Especifica cómo se ordenan las filas en la respuesta.
`returnEntityQuota`	`boolean` Activa o desactiva si se muestra el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en AccessQuota. Para solicitudes a nivel de la cuenta, este campo debe ser falso.
`includeAllUsers`	`boolean` Opcional. Determina si se deben incluir en la respuesta usuarios que nunca hayan realizado una llamada a la API. Si es verdadero, todos los usuarios con acceso a la propiedad o cuenta especificada se incluyen en la respuesta, independientemente de si realizaron o no una llamada a la API. Si es falso, solo se incluirán los usuarios que hayan realizado una llamada a la API.
`expandGroups`	`boolean` Opcional. Decide si se muestran los usuarios dentro de los grupos de usuarios. Este campo funciona solo cuando includeAllUsers se establece en true. Si es verdadero, se mostrarán todos los usuarios con acceso a la propiedad o cuenta especificadas. Si es falso, solo se mostrarán los usuarios con acceso directo.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de RunAccessReportResponse.

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