API de informes: Informe de actividad de Drive

El informe de actividad de Drive proporciona información sobre las actividades de tus usuarios cuando administran, modifican y comparten archivos en Google Drive en Google Workspace. Por ejemplo, puedes usar el informe de actividad de Drive para obtener una lista de todos los documentos de Drive nuevos creados por un usuario específico durante un período específico. Puedes usar esta información para obtener información sobre una mejor administración de contenido y posibles filtraciones de datos. Para obtener un informe, usa la solicitud básica del extremo del informe con parámetros específicos del informe, como la dirección de correo electrónico de un usuario o un tipo específico de cambio en Google Drive. Los informes pueden incluir datos de hasta los últimos 180 días.

Debes completar los pasos que se indican en Requisitos previos de la API de informes antes de usar la API para recuperar informes.

El informe de actividad de Google Drive solo se puede utilizar con fines legales en las cuentas que tienen una licencia asignada.

Para obtener información sobre las cadenas de consulta de la solicitud y las propiedades de la respuesta, consulta la Referencia de la API. Para obtener información sobre eventos específicos relacionados con Google Drive, consulta Nombres de eventos de Drive.

Recuperar los eventos de Google Drive de un dominio

Puedes usar el informe de actividad de Drive para incluir información sobre tus documentos de Drive. Por ejemplo, puedes solicitar un informe que enumere los 25 eventos de Drive más recientes de tu cuenta, que cubran hasta 180 días. Para obtener este informe, obtén un token de autorización como se describe en la guía de autorización y, luego, usa la siguiente solicitud HTTP GET:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?maxResults=25

Puedes ver una respuesta de ejemplo a esta llamada a la API.

En el siguiente ejemplo, se recupera un informe de todos los eventos de Drive de los últimos 180 días, que es el período máximo.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive

Recupera eventos de Google Drive por usuario

Para recuperar un informe de las actividades en Google Drive de un usuario en particular, usa una solicitud HTTP GET con el token de autorización descrito en la guía de la guía de autorización. El campo userKey es la dirección de correo electrónico principal del usuario en el informe o all para todos los usuarios.

En el siguiente ejemplo, se recupera un informe con todos los cambios realizados por el usuario especificado. Para ver un ejemplo de una respuesta de la API, consulta la respuesta JSON de muestra.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/kim@example.com
/applications/drive

Recuperar eventos de Google Drive de las unidades compartidas

Puedes recuperar un informe de las actividades de Google Drive para una unidad compartida específica mediante una solicitud HTTP GET con el token de autorización descrito en la guía de autorización. Especifica la dirección de correo electrónico del usuario sobre el que deseas ejecutar el informe en el campo userKey o especifica all para ejecutar el informe en todos los usuarios.

En el siguiente ejemplo, se recupera un informe de todos los cambios de una unidad compartida específica. Para ver un ejemplo de una respuesta de la API, consulta la respuesta JSON de muestra.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=shared_drive_id==<id of shared drive>

Si quieres recuperar eventos de una unidad compartida, aplica filtros con el doc_type. En el siguiente ejemplo, se recuperan los eventos que afectan a todas las unidades compartidas:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=doc_type=shared_drive

Si quieres recuperar eventos para cambios de membresía, especifica el evento shared_drive_membership_change. En el siguiente ejemplo, se recuperan todos los miembros agregados a las unidades compartidas:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?evetName=shared_drive_membership_change&
filters=membership_change_type==add_to_shared_drive

Recuperar eventos de Google Drive por tipo de evento

Para recuperar un informe de todas las instancias de un tipo de evento específico, como la creación o edición de un documento, usa una solicitud HTTP GET con el token de autorización descrito en la guía de autorización. El campo userKey es la dirección de correo electrónico principal del usuario en el informe o all para todos los usuarios.

En el siguiente ejemplo, se recupera un informe de todas las actividades de creación de documentación de la cuenta. Para ver un ejemplo de una respuesta de la API, consulta la respuesta JSON de muestra:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?eventName=create

Ejemplo de respuesta JSON

Cuando realizas una solicitud GET HTTP a la API, una respuesta correcta muestra un código de estado HTTP 200. Junto con el código de estado, la respuesta muestra un informe de la unidad. Estos informes también están disponibles en la Consola del administrador. Si quieres obtener más información, consulta el Centro de ayuda para administradores de Google Workspace. Para obtener información sobre eventName, consulta la referencia de nombres de eventos de Drive. Para obtener más información sobre las cadenas de consulta de la solicitud y las propiedades de la respuesta, consulta la Referencia de la API.

{
 "kind": "reports#auditActivities",
 "nextPageToken": "next page's token",
 "items": [
  {
   "kind": "audit#activity",
   "id": {
    "time": "2014-03-17T15:39:18.460Z",
    "uniqQualifier": "report's unique ID",
    "applicationName": "drive",
    "customerId": "ABC123xyz"
   },
   "actor": {
   "callerType": "USER",
   "email": "kim@example.com",
   "profileId": "user's unique Google Workspace profile ID",
   "key": "consumer key of requestor in an OAuth 2LO request"
   },
   "ownerDomain": "domain of the source owner",
   "ipAddress": "user's IP address",
   "events": [
    {
     "type": "access",
     "name": "edit",
     "parameters": [
      {
        "name": "primary_event",
        "boolValue": true
      },
      {
        "name": "owner_is_shared_drive",
        "boolValue": false
      },      {
        "name": "doc_id",
        "value": "1DWuYM3ot_sAyEQqOz0xWJ9bVMSYzOmRNeBqbgtSwuK8"
      },
      {
        "name": "doc_title",
        "value": "Meeting notes"
      },
      {
        "name": "doc_type",
        "value": "document"
      },
      {
        "name": "owner",
        "value": "mary@example.com"
      }
      ]
     }
    ]
   },
  ]
 }