Reports API: Drive Activity – Event Names

This document details the Google Drive activity report's eventName parameters and properties. For more information, see the developer's guide and the Activities: list method.

access events

create
A user created a document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
upload
A user uploaded a document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
edit
A user edited the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
view
A user viewed the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
rename
A user renamed the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
old_value The original title of the document.
new_value The new title for the document.
move
A user moved the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
source_folder_title The title of the folder the file was removed from.
source_folder_id The ID of the folder the file was removed from.
destination_folder_title The title of the folder the file was added to.
destination_folder_id The ID of the folder the file was added to.
add_to_folder
A user added the document to a folder.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
destination_folder_title The title of the folder the file was added to.
destination_folder_id The ID of the folder the file was added to.
remove_from_folder
A user removed the document from a folder.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
source_folder_title The title of the folder the file was removed from.
source_folder_id The ID of the folder the file was removed from.
trash
A user trashed the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
delete
A user deleted the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
untrash
A user untrashed the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
download
A user downloaded the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
preview
A user accessed the document using preview.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.

acl_change events

change_acl_editors
A user changed which roles are allowed to edit permissions for the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
old_visibility The maximum visibility of the file before this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
visibility_change The change in maximum visibility of the file due to this event. Possible values include:
  • internal—Visibility changed from external (outside domain) to internal (within domain or private).
  • external—Visibility changed from internal (within domain or private) to external (outside domain).
  • none—Visibility change not detected. Also applicable if visibility or old_visibility is unknown.
old_value The old acl editors for the file. Possible values include:
  • owner
  • organizer
  • writers
new_value The new acl editors for the file. Possible values include:
  • owner
  • organizer
  • writers
change_document_access_scope
A user changed the default access scope for users that can access the document. For example, if a document has the visibility public_in_the_domain for the domain "example.com" with the access scope can_edit, any user in the domain "example.com" can edit the file.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
old_visibility The maximum visibility of the file before this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
visibility_change The change in maximum visibility of the file due to this event. Possible values include:
  • internal—Visibility changed from external (outside domain) to internal (within domain or private).
  • external—Visibility changed from internal (within domain or private) to external (outside domain).
  • none—Visibility change not detected. Also applicable if visibility or old_visibility is unknown.
target_domain Optional. The domain for which the acccess scope was changed. This can also be the alias all to indicate the access scope was changed for all domains that have visibility for this document.
old_value The old access scope of the file. Possible values include:
  • none
  • owner
  • can_view
  • can_edit
  • can_comment
new_value The new access scope of the file. Possible values include:
  • none
  • owner
  • can_view
  • can_edit
  • can_comment
change_document_visibility
A user changed the visibility of the document. The visibility indicates which users can access a document without having it explicitly shared with them.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
old_visibility The maximum visibility of the file before this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
visibility_change The change in maximum visibility of the file due to this event. Possible values include:
  • internal—Visibility changed from external (outside domain) to internal (within domain or private).
  • external—Visibility changed from internal (within domain or private) to external (outside domain).
  • none—Visibility change not detected. Also applicable if visibility or old_visibility is unknown.
target_domain Optional. The domain for which the visibility was changed. This can also be the alias all to indicate the access scope was changed for all domains that have visibility for this document.
old_value The old visibility of the file using its link. Possible values:
  • private—Only specific users and Google Groups (internal or external) granted access.
  • people_within_domain_with_link—Any user within the domain with a direct link to the file.
  • people_with_link—Anyone inside or outside the domain with a direct link to the file.
  • public_in_the_domain—Any user within the domain may access the document. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • public_on_the_web—The file can show up in search results and anyone who finds the web address of the file can access it.
new_value The new visibility of the file using its link. Possible values:
  • private—Only specific users and Google Groups (internal or external) granted access.
  • people_within_domain_with_link—Any user within the domain with a direct link to the file.
  • people_with_link—Anyone inside or outside the domain with a direct link to the file.
  • public_in_the_domain—Any user within the domain may access the document. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • public_on_the_web—The file can show up in search results and anyone who finds the web address of the file can access it.
change_user_access
A user changed a specific user or group's access scope for the document.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_title The document's title.
doc_type The file's type. Possible values include:
  • document
  • spreadsheet
  • presentation
  • folder
  • form
  • drawing
  • team_drive
  • unknown
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
owner Email address of the document's owner. For items contained in a Team Drive, the owner is the name of the Team Drive.
visibility The maximum visibility of the file at the time of this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
old_visibility The maximum visibility of the file before this event. Possible values include:
  • private—Visible only to owner.
  • shared_internally—Visible to specific users within the domain, who have been granted access.
  • people_within_domain_with_link—Visible to any user within the domain with a direct link.
  • public_in_the_domain—Visible to any user within the domain. Users in the domain can also find the file using the domain search option in the Advanced Search menu.
  • shared_externally—Visible to specific users outside the domain, who have been granted access. The file could also be visible within the domain.
  • people_with_link—Visible to anyone inside or outside the domain with a direct link.
  • public_on_the_web—Visible in search results, and to anyone who finds the web address of the file.
  • unknown—Unknown visibility.
visibility_change The change in maximum visibility of the file due to this event. Possible values include:
  • internal—Visibility changed from external (outside domain) to internal (within domain or private).
  • external—Visibility changed from internal (within domain or private) to external (outside domain).
  • none—Visibility change not detected. Also applicable if visibility or old_visibility is unknown.
target_user The email address of the user or group whose access permissions were changed, or the name of the domain for which access permissions were changed.
old_value The old access scope of the user for this file. Possible values include:
  • none
  • owner
  • can_view
  • can_edit
  • can_comment
new_value The new access scope of the file. Possible values include:
  • none
  • owner
  • can_view
  • can_edit
  • can_comment
team_drive_membership_change
A user changed a specific user or group's membership for a Team Drive.
Parameters Values and Notes
primary_event Boolean. Whether this is a primary event. A single user action in Drive may generate several events. Of these, one is the primary event (primary_event=true) and the rest are side effects of that event (primary_event=false). For example, when a user creates a document, several events are generated, with only the create event having primary_event=true. All other events from this action have primary_event=false.
doc_id The unique identifier for the file.
doc_id The unique identifier of the Team Drive. Only populated for for events relating to a Team Drive or item contained inside a Team Drive.
owner_is_team_drive Boolean. Whether the item referred to by doc_id is owned by a Team Drive.
doc_title The document's title.
doc_type The file's type. Always team_drive for this event.
owner The name of the Team Drive.
target The email address of the user or group whose membership was changed.
membership_change_type The type of membership change. Possible values include:
  • add_to_team_drive: added_role contains the new role(s) which the target is being added with.
  • remove_from_team_drive: removed_role contains the old role(s) the target was previously assigned.
  • change_roles: Change in roles represented by added_role and removed_role.
  • re_share: Occurs when a user is added indirectly, such as added to a group that is currently a member. added_role contains the new role(s) which the target is being added with.
removed_role The old access scope of the user for this file. Possible values include:
  • none
  • organizer
  • viewer
  • editor
  • commenter
added_role The new access scope of the file. Possible values include:
  • none
  • organizer
  • viewer
  • editor
  • commenter

Send feedback about...

Reports API
Reports API