En esta guía, se explican los componentes principales de una respuesta en la API de Google Drive Activity, con ejemplos y cómo interpretarlas.
Objetos
DriveActivity
: Este es el recurso principal que muestran las consultas en la API de Drive Activity. Se describe uno o más actores que realizan una o más acciones que afectan a uno o más objetivos.Timestamp
yTimeRange
: Estas describen, respectivamente, un solo momento en el que ocurrió la actividad o el inicio y el final de cuándo ocurrió la actividad durante un período.Actor
: Por lo general, unActor
es un usuario final. Sin embargo, a veces, un evento del sistema puede activar unAction
cuando un administrador actúa como usuario o como sí mismo, o cuando lo realiza una persona no identificable. El mensajeActor
encapsula cada uno de estos casos.Target
: UnTarget
es el objeto de una actividad, como un archivo, una carpeta, una unidad compartida o un comentario de un archivo. Ten en cuenta que muchos tipos de acciones admiten más de un tipo de objetivo. Por ejemplo, aunque, en general,Edit
se aplica a los archivos de Drive, otras acciones comoRename
yCreate
también se pueden aplicar a carpetas de Drive y a unidades compartidas. Los destinos que no son elementos de Drive aún pueden hacer referencia a uno, como la carpeta raíz de una unidad o el documento superior que contiene un comentario de archivo.Action
: Cada recursoDriveActivity
tiene una o más acciones relacionadas. UnAction
es independiente, como un evento, ya que comprende no solo el tipo detallado y la información sobre la acción, sino también unActor
, unTarget
y unTimestamp
oTimeRange
. Para evitar la redundancia, unAction
no propaga sus propios camposTarget
,Actor
o de hora cuando son iguales que elDriveActivity
general.ActionDetail
: Este es el tipo específico y la información detallada sobre unAction
. Por ejemplo, un detalle de acciónMove
tiene una ubicación de origen y de destino, y unaPermissionChange
especifica quién ahora puede acceder a un documento y con qué privilegios.
Respuestas de ejemplo
Un usuario editó un archivo en Drive:
Un recurso DriveActivity
simple puede incluir solo una acción, como un usuario que edita un archivo.
"activities":[{
"primary_action_detail":{ "edit":{} },
"actors":[ { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID" } } } ],
"targets":[ { "drive_item":{ "name":"items/ITEM_ID", "title":"TITLE", "file":{} } } ],
"timestamp":{ "seconds":"1536794657", "nanos":791000000 },
"actions":[ { "detail":{ "edit":{} } } ]
}]
En esta salida, se incluyen los siguientes valores:
- ACCOUNT_ID: Es el ID del usuario. Se puede usar con la API de personas para obtener más información.
- ITEM_ID: Es el ID del elemento de Drive.
- TITLE: Es el título del elemento de Drive.
Ten en cuenta que el Action
de esta respuesta no incluye Actor
, Target
ni TimeStamp
porque coinciden con el DriveActivity
general.
Dos usuarios editaron el mismo archivo en momentos similares:
Cuando la consolidación está activada, las acciones relacionadas se agrupan en una DriveActivity
. En este ejemplo, se agrupan 2 acciones similares: un tipo de acción Edit
de 2 usuarios diferentes.
"activities":[{
"primary_action_detail":{ "edit":{} },
"actors":[
{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_1" } } },
{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_2" } } }
],
"targets":[
{ "drive_item":{ "name":"items/ITEM_ID", "title":"TITLE", "file":{} } }
],
"time_range":{
"start_time":{ "seconds":"1541089823", "nanos":712000000 },
"end_time":{ "seconds":"1541089830", "nanos":830000000 }
},
"actions":[
{
"detail":{ "edit":{} },
"actor":{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_1" } } },
"timestamp":{ "seconds":"1541089830", "nanos":830000000 }
},
{
"detail":{ "edit":{} },
"actor":{ "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID_2" } } },
"timestamp":{ "seconds":"1541089823", "nanos":712000000 }
}
]
}]
En esta salida, se incluyen los siguientes valores:
- ACCOUNT_ID_1: Es el ID del primer usuario. Se puede usar con la API de personas para obtener más información.
- ACCOUNT_ID_2: Es el ID del segundo usuario.
- ITEM_ID: Es el ID del elemento de Drive.
- TITLE: Es el título del elemento de Drive.
Ten en cuenta que las acciones de esta respuesta no incluyen la Target
porque es
la misma que la DriveActivity
general.
En el ejemplo, también se ilustra cómo las apps pueden usar solo la información de resumen en DriveActivity
, sin observar las acciones individuales. La respuesta indica que 2 usuarios editaron un archivo determinado durante un período.
Un usuario movió 2 archivos a un nuevo directorio:
En este ejemplo, la estrategia de consolidación agrupó 2 acciones Move
relacionadas porque los archivos se movieron de la misma fuente al mismo destino al mismo tiempo.
"activities":[{
"primary_action_detail":{
"move":{
"added_parents":[ { ... } ]
"removed_parents":[ { ... } ]
}
},
"actors":[ { "user":{ "known_user":{ "person_name":"people/ACCOUNT_ID" } } } ],
"targets":[
{ "drive_item":{ "name":"items/ITEM_ID_1", "title":"TITLE_1", "file":{} } },
{ "drive_item":{ "name":"items/ITEM_ID_2", "title":"* TITLE_2", "file":{} } }
],
"timestamp":{ "seconds":"1541090960", "nanos":985000000 },
"actions":[
{
"detail":{ "move":{ "added_parents":[ { ... } ] "removed_parents":[ { ... } ] } },
"target":{ "drive_item":{ "name":"items/ITEM_ID_1", "title":"TITLE_1", "file":{} } }
},
{
"detail":{ "move":{ "added_parents":[ { ... } ] "removed_parents":[ { ... } ] } },
"target":{ "drive_item":{ "name":"items/ITEM_ID_2", "title":"* TITLE_2", "file":{} } }
}
]
}]
En esta salida, se incluyen los siguientes valores:
- ACCOUNT_ID: Es el ID del usuario. Se puede usar con la API de personas para obtener más información.
- ITEM_ID_1: Es el ID del primer elemento de Drive.
- ITEM_ID_2: Es el ID del segundo elemento de Drive.
- TITLE_1: Es el título del primer elemento de Drive.
- TITLE_2: Es el título del segundo elemento de Drive.
Ten en cuenta que las acciones de esta respuesta no incluyen Actor
ni TimeStamp
, ya que son las mismas que las DriveActivity
generales.