Skip to content

Users Drive Activity Settings

Ross Scroggs edited this page Apr 10, 2019 · 19 revisions

Users - Drive - Activity/Settings

API documentation

Definitions

<Date> ::=
        <Year>-<Month>-<Day> |
        (+|-)<Number>(d|w|y) |
        never|
        today
<Time> ::=
        <Year>-<Month>-<Day>(<Space>|T)<Hour>:<Minute>:<Second>[.<MilliSeconds>](Z|(+|-(<Hour>:<Minute>))) |
        (+|-)<Number>(m|h|d|w|y) |
        never|
        now|today

<DriveFileID> ::= <String>
<DriveFileName> ::= <String>
<DriveFolderID> ::= <String>
<DriveFolderName> ::= <String>

<DriveActivityAction> ::=
        comment|
        create|
        delete|trash|
        dlpchange|
        edit|
        emptytrash|
        move|
        permissionchange|
        reference|
        rename|
        restore|untrash|
        settingschange|
        upload
<DriveActivityActionList> ::= "<DriveActivityAction>(,<DriveActivityAction>)*"

<DriveSettingsFieldName> ::=
        appinstalled|
        exportformats|
        foldercolorpalette|
        importformats|
        largestchangeid|
        limit|
        maximportsizes|
        maxuploadsize|
        name|
        permissionid|
        rootfolderid|
        teamdrivethemes|
        usage|
        usageindrive|
        usageindrivetrash
<DriveSettingsFieldNameList> ::= "<DriveSettingsFieldName>(,<DriveSettingsFieldName>)*"

Display drive activity

Google has introduced Drive Activity API v2; it adds time and action filtering and has reorganized the format of the data. Drive Activity API v1 will be deprecated in December 2019.

GAMADV-XTD can do local filtering when Drive Activity API v1 is used.

gam <UserTypeEntity> print|show driveactivity [v2] [todrive <ToDriveAttributes>*]
        [(fileid <DriveFileID>) | (folderid <DriveFolderID>) |
         (drivefilename <DriveFileName>) | (drivefoldername <DriveFolderName>) | (query <QueryDriveFile>)]
        [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>] [action|actions [not] <DriveActivityActionList>]
        [formatjson] [quotechar <Character>]

By default, Drive Activity API v1 is used; the v2 option selects Drive Activity API v2.

By default, drive activity for all files in the top level of My Drive will be displayed.

  • fileid <DriveFileID> - Display drive activity for file <DriveFileID>
  • folderid <DriveFolderID> - Display drive activity for all files in folder <DriveFolderID>
  • drivefilename <DriveFileName> - Display drive activity for the file with name <DriveFolderID>
  • drivefoldername <DriveFolderName> - Display drive activity for all files in the folder with name <DriveFolderName>
  • query - Display drive activity for all files/folders selected by the query

Activities can be filtered by time; with Drive Activity API v1, GAM does the filtering locally; with Drive Activity API v2 Google does the filtering.

  • start|starttime <Date>|<Time> - Display activities that occur on or after the specifed <Date>|<Time>
  • end|endtime <Date>|<Time> - Display activities that occur on or before the specifed <Date>|<Time>

Activities can be filtered by action; ; with Drive Activity API v1, GAM does the filtering locally; with Drive Activity API v2 Google does the filtering.

  • action|actions <DriveActivityVxActionList> - Only display activities with the specified actions; by default, all actions are displayed
  • action|actions not <DriveActivityVxActionList> - Only display activities without the specified actions; by default, all actions are displayed

By default, Gam displays the information as columns of fields; the following option causes the ouput to be in JSON format,

  • formatjson - Display the fields in JSON format.

By default, when writing CSV files, Gam uses a quote character of double quote ". The quote character is used to enclose columns that contain the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled. When using the formatjson option, double quotes are used extensively in the data resulting in hard to read/process output. The quotechar <Character> option allows you to choose an alternate quote character, single quote for instance, that makes for readable/processable output. quotechar defaults to gam.cfg/csv_output_quote_char.

Display drive settings

gam <UserTypeEntity> print drivesettings [todrive <ToDriveAttribute>*] [allfields|<DriveSettingsFieldName>*|(fields <DriveSettingsFieldNameList>)] [delimiter <Character>]
gam <UserTypeEntity> show drivesettings [allfields|<DriveSettingsFieldName>*|(fields <DriveSettingsFieldNameList>)] [delimiter <Character>]

If no fields are selected, these fields will be displayed: name,appInstalled,largestChangeId,limit,maxUploadSize,permissionId,rootFolderId,usage,usageInDrive,usageInDriveTrash

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally