- Solicitud HTTP
- Parámetros de ruta de acceso
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de autorización
- Pruébalo
Muestra un informe personalizado de los registros de acceso a los datos. El informe proporciona registros de cada vez que un usuario lee datos de los informes de Google Analytics. Los registros de acceso se retienen hasta por 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 GA, las exploraciones de la IU de GA, la API de datos de GA 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 una transmisión o cambiar la zona horaria. Para ver el historial de cambios de configuración, consulta searchChangeHistoryEvents.
Para enviar tus comentarios sobre esta API, completa el formulario de comentarios sobre los informes de acceso de Google Analytics.
Solicitud HTTP
POST https://analyticsadmin.googleapis.com/v1beta/{entity=properties/*}:runAccessReport
La URL usa la sintaxis de la transcodificación gRPC.
Parámetros de ruta de acceso
Parámetros | |
---|---|
entity |
El Informe de acceso a los datos admite solicitudes a nivel de la propiedad o de la cuenta. Si se solicita a nivel de la cuenta, los informes de acceso a los datos incluyen todo el acceso de todas las propiedades de esa cuenta. Para realizar la solicitud a nivel de la propiedad, la entidad debe ser, por ejemplo, "propiedades/123" si "123" es el ID de tu propiedad de Google Analytics. Para realizar la solicitud a nivel de la cuenta, la entidad debe ser, por ejemplo, "accounts/1234" si "1234" es el ID de tu cuenta de Google Analytics. |
Cuerpo de la solicitud
El cuerpo de la solicitud contiene datos con la siguiente estructura:
Representación JSON |
---|
{ "dimensions": [ { object ( |
Campos | |
---|---|
dimensions[] |
Las dimensiones solicitadas y que se muestran en la respuesta. Las solicitudes pueden tener hasta 9 dimensiones. |
metrics[] |
Las métricas solicitadas y mostradas en la respuesta. Las solicitudes pueden tener hasta 10 métricas. |
date |
Los períodos de los registros de acceso que se deben leer. Si se solicitan varios períodos, cada fila de la 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 pueden tener hasta 2 períodos. |
dimension |
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. Para obtener más información, consulta Conceptos básicos de los filtros de dimensiones y obtén ejemplos. No se pueden usar métricas en este filtro. |
metric |
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 having de SQL. No se pueden usar dimensiones en este filtro. |
offset |
Es el recuento de filas de la fila inicial. La primera fila se cuenta como fila 0. Si no se especifica el desplazamiento, se considera 0. Si el desplazamiento es cero, este método mostrará la primera página de resultados con entradas Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
limit |
Es la cantidad de filas que se mostrarán. Si no se especifica, se devuelven 10,000 filas. La API muestra un máximo de 100,000 filas por solicitud, independientemente de la cantidad que solicites. Es posible que la API devuelva menos filas que las Para obtener más información sobre este parámetro de paginación, consulta Paginación. |
time |
La 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 usa para interpretar las fechas de inicio y finalización del informe. Con formato de cadenas de la base de datos de zonas horarias de IANA (https://www.iana.org/time-zones); por ejemplo, "America/New_York" o "Asia/Tokyo". |
order |
Especifica cómo se ordenan las filas en la respuesta. |
return |
Activa o desactiva si se debe mostrar el estado actual de la cuota de esta propiedad de Analytics. La cuota se muestra en AccessQuota. Para las solicitudes a nivel de la cuenta, este campo debe ser falso. |
include |
Opcional. Determina si se deben incluir en la respuesta los usuarios que nunca realizaron 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 una llamada a la API o no. Si es falso, solo se incluirán los usuarios que hayan realizado una llamada a la API. |
expand |
Opcional. Decide si se deben mostrar los usuarios dentro de los grupos de usuarios. Este campo solo funciona cuando includeAllUsers se establece como verdadero. Si es verdadero, se mostrarán todos los usuarios con acceso a la propiedad o cuenta especificada. 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
.
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.edit