Skip to content

GamUpdates

Jump to bottom
GitHub Action edited this page Aug 9, 2026 · 355 revisions

Update GAM7 to latest version

Automatic update to the latest version on Linux/Mac OS/Google Cloud Shell/Raspberry Pi/ChromeOS:

  • Do not create project or authorizations, default path $HOME/bin
    • bash <(curl -s -S -L https://git.io/gam-install) -l
  • Do not create project or authorizations, specify a path
    • bash <(curl -s -S -L https://git.io/gam-install) -l -d <Path>

By default, a folder, gam7, is created in the default or specified path and the files are downloaded into that folder. Add the -s option to the end of the above commands to suppress creating the gam7 folder; the files are downloaded directly into the default or specified path.

See Downloads-Installs-GAM7 for Windows or other options, including manual installation

7.47.04

Added clientencryptiondetails to <DriveFieldName>.

7.47.03

Added support for externalIds in Cloud Identity Groups.

Upgraded to Python 3.14.7.

7.47.02

Added option threadid <String> to gam <UserTypeEntity> draft|import|insert message.

7.47.01

Fixed bug in gam <UserTypeEntity> create shareddrive where GAM was unnecessarily waiting for the shared drive creation to complete when not required.

7.47.00

Added commands to update|display a user's chat availability.

You'll need to run gam user user@domain.com update serviceaccount and select 12) Chat API - User Availability (supports readonly).

7.46.11

Updated gam <UserTypeEntity> update user to handle the following error: ERROR: 404: resourceNotFound - Does not exist

7.46.10

Updated gam calendars <CalendarEntity> create event and gam <UserTypeEntity> create event to handle a trap ending in gamlib.glgapi.serviceNotAvailable: The service is currently unavailable

7.46.09

Added option showmembertypes to gam print cigroup|groups that expands Members fields to include type information.

Members -> MembersTypeCustomer, MembersTypeGroup, MembersTypeUser
MembersCount -> MembersTypeCustomerCount, MembersTypeGroupCount, MembersTypeUserCount
InternalMembers -> InternalMembersTypeCustomer, InternalMembersTypeGroup, InternalMembersTypeUser
InternalMembersCount -> InternalMembersTypeCustomerCount, InternalMembersTypeGroupCount, InternalMembersTypeUserCount
ExternalMembers -> ExternalMembersTypeGroup, ExternalMembersTypeUser
ExternalMembersCount -> ExternalMembersTypeGroupCount, ExternalMembersTypeUserCount

7.46.08

Added option (addcsvdata <FieldName> <String>)* to gam <UserTypeEntity> print calendars that adds additional columns of data to the CSV file output.

Added option ownedsecondary to gam <UserTypeEntity> print|show calendars that causes GAM to only display secondary calendars where <UserTypeEntity> is the dataOwner.

Added option showenabled to gam <UserTypeEntity> print|show forwardingaddresses that causes GAM to display the enabled status for each forwarding address.

Disabled unnecessary Regional Access Boundary (trust boundary) lookups to improve performance.

7.46.07

Added command gam show configlicenseskus that can be used to generate a command that sets the list of used license SKUs in gam.cfg; this improves performance of gam info user.

gam show configlicenseskus
Got 0 Licenses for 1010010001 (Cloud Identity Free)...
Got 0 Licenses for 1010050001 (Cloud Identity Premium)...
...
Got 2 Licenses for 1010340007 (Google Workspace for Education Fundamentals - Archived User)...
...
Got 100 Licenses for 1010070001 (Google Workspace for Education Fundamentals)...
Got 200 Licenses for 1010070001 (Google Workspace for Education Fundamentals)...
Got 300 Licenses for 1010070001 (Google Workspace for Education Fundamentals)...
Got 358 Licenses for 1010070001 (Google Workspace for Education Fundamentals)...
Got 2 Licenses for 1010070004 (Google Workspace for Education Gmail Only)...
...
Got 0 Licenses for Google-Vault (Google Vault)...
Got 0 Licenses for Google-Vault-Former-Employee (Google Vault - Former Employee)...
To set license_skus in gam.cfg, execute the following command:
gam config license_skus "1010340007,1010070001,1010070004" save verify variables license_skus

7.46.06

Updated GAM to suppress the following message:

Regional Access Boundary HTTP request failed after retries: response_data={'error': {'code': 403, 'message': 'Permission denied on the service account.', 'status': 'PERMISSION_DENIED'}}, retryable_error=False

7.46.05

Fixed bug in gam <UserTypeEntity> print sheet where an extra line of output was displayed before the CSV data.

7.46.04

Added the following command to transfer secondary calendar ownership.

gam <CalendarEntity> transfer ownership <UserItem>

7.46.03

Updated all Vault related commands to handle the following error: ERROR: 403: permissionDenied

7.46.02

Updated gam calendars <CalendarEntity> show settings to display dataOwner field; it is labelled Owner.

7.46.01

Fixed bug in gam <CrOSTypeEntity> issuecommand command <CrOSCommand> ... csv where command execution status lines were improperly indented.

Upgraded to Python 3.14.6.

7.46.00

Added commands to create, update and delete Cloud Identity policies for data loss prevention (DLP) rules and detectors.

7.45.00

Added options isdisabled [<Boolean>], disabledafter <DateTime> and disabledbefore <DateTime> to gam print users. These options along with issuspended [<Boolean>] and isarchived [<Boolean>] are useful when identifying users to deprovision.

Added option movefilepermissions [<Boolean>]] to gam <UserTypeEntity> move drivefile that, when False, causes GAM to remove ACLs from a file before moving it; this will be most useful when moving files to Shared Drives so that only the Shared Drive ACls apply. When not specified or set True, file permissions are not removed; this is the current GAM behavior.

Upgraded to OpenSSL 4.0.1.

7.44.03

Added writerwithoutprivateaccess to <CalendarACLRole>; this will become effective 2026-06-29.

7.44.02

Added fields bluetoothadapterinfo and osversioncompliance to <CrOSFieldName> for use in gam info|print cros.

7.44.01

Added option oneitemperrow to gam print crostelemetry to have each of a device's report field entries displayed on a separate row with all of the other device fields.

Added additional fields to <CrOSTelemetryFieldName>and <CrOSTelemetryListFieldName>:

appreport
heartbeatstatusreport
kioskappstatusreport
networkbandwidthreport
runtimecountersreport

7.44.00

Added support for User data archivalTime and suspensionTime that is available when fields archived and suspended are requested in gam info user and gam print users.

Added the following options to gam <UserTypeEntity> show chatmessages to simplify specifying a filter.

start|starttime <Date>|<Time>
end|endtime <Date>|<Time>
range <Date>|<Time> <Date>|<Time>
thread <ChatThread>

Added commands to search for and display chat messages.

These commands are in Developer Preview; to use them you must have these values set in gam.cfg.

developer_preview_apis = chat
developer_preview_api_key = <DeveloperPreviewKey>

Upgraded to Python 3.14.5.

7.43.10

Updated gam <UserTypeEntity> forward message|thread [recipient|to] <RecipientEntity> to not forward messages to the Bcc recipients of the original message.

Fixed bug in gam <UserTypeEntity> forward message|thread [recipient|to] <RecipientEntity> addorigfieldstosubject where the recipient of the forwarded message was added to the subject line instead of the recipient of the original message.

7.43.09

Fixed bug in gam <UserTypeEntity> print filelist that caused a trap.

7.43.08

Fixed bug and formatting issues in gam info device <DeviceEntity>.

7.43.07

Improved validation of <QueryCrOS>, <QueryDevice> and <QueryMobile>.

7.43.06

Updated commands that use <QueryCrOS>, <QueryDevice> or <QueryMobile> to validate that it is of the form field:value and that value does not contain a '?'. Without validation, Google can return many more devices than are expected.

7.43.05

Added option matchfield attendeesorganizer <Boolean> <EmailAddressEntity> to <EventMatchProperty> that is used in commands that process events. The match is true if all of the addresses in <EmailAddressEntity> are present as attendees in the event and are an organizer or not based on <Boolean>.

Added option max_to_deprov <Integer> to gam update cros <CrOSEntity> action <CrOSAction> that is used when <CrOSAction> is any of the following:

deprovision_different_model_replace|
deprovision_different_model_replacement|
deprovision_retiring_device|
deprovision_same_model_replace|
deprovision_same_model_replacement|
deprovision_upgrade_transfer

max_to_deprov <Integer> - No deprovisions are processed if the number of devices in <CrOSEntity> exceeds <Integer>; the default value is one; set <Integer> to 0 for no limit.

7.43.04

Added option include_suspended_zeros [<Boolean>] to gam print vaultcounts that causes GAM to generate zero count lines for suspended users with zero items as well as non-suspended users.

7.43.03

Added option parentpathonly [<Boolean>] to the following commands that causes GAM to display only the parent folder names when displaying the path to a file.

gam <UserTypeEntity> info drivefile ... filepath|fullpath
gam <UserTypeEntity> show fileinfo ... filepath|fullpath
gam <UserTypeEntity> print|show filepath
gam <UserTypeEntity> print filelist ... filepath|fullpath

7.43.02

Added option maxactivities <Integer> to gam <UserTypeEntity> print driveactivity to limit the number of activities displayed; the default is 0, no limit.

7.43.01

Updated gam info user and gam print users to display guest user attributes: isGuestUser, guestAccountInfo

Expanded <UserTypeEntity> to allow specification of guest users.

7.42.00

In versions prior to 7.42.00, when redirect csv <FileName> was used, GAM did not open and write <FileName> until all processing was complete; if <FileName> was not accessible, an error was generated and no results were saved. Now, <FileName> is opened initially to verify accessiblity and then written when processing is complete.

In the unlikely event that this causes issues, you can do redirect csv <FileName> delayopen to get the previous behavior.

7.41.03

Fixed bug in the following: Added the following to <RowValueFilter> used in CSV input/output row filtering; these are synonyms for count and countrange.

[(any|all):]number<Operator><Number>|
[(any|all):]numberrange!=<Number>/<Number>|
[(any|all):]numberrange=<Number>/<Number>|

7.41.02

Added option ownername to gam info|print courses to have GAM display the course owners full name; there is an extra API call per course to get the name.

Added option creatorname to gam print course-announcements|course-materials|course-works to have GAM display the item creators full name; there is an extra API call per course to get the name.

After creating a group, it may be sometime, e.g. 30-45 seconds, before members can successfully be added to the group even though the API reported that the group was created. The following options can be used with gam create group to verify that the group is actually ready to be updated. This will be most useful in scripts that are used to create and then populate groups.

verifycreationretries <Integer> - Verify group creation, defaults to 0, no verification performed, range 0-20
verifycreationinitialdelay <Integer> - Number of seconds to delay before first verification performed, defaults to 5, range 0-60
verifycreationretrydelay <Integer> - Number of seconds to delay between verificaton retries, defaults to 5, range 1-60

If you have a script that deletes a group and then immediately tries to create a new group with the same email address, you may run into issues. There seems to be a 30-45 second window after the deletion in which a couple of strange errors can occur on the creation: Resource not found and Duplicate. The following options can be used with gam create group to handle these errors. This will be most useful in scripts that are used to delete and then immediately recreate groups.

recentdeleteretries <Integer> - Handle group delete/create errors, defaults to 0, no errors handled, range 0-20
recentdeleteretrydelay <Integer> - Number of seconds to delay between retries, defaults to 5, range 1-60

Added the following to <RowValueFilter> used in CSV input/output row filtering; these are synonyms for count and countrange.

[(any|all):]number<Operator><Number>|
[(any|all):]numberrange!=<Number>/<Number>|
[(any|all):]numberrange=<Number>/<Number>|

7.41.01

Fixed bug in gam print cigroups members managers owners countsonly totalcount internal external that caused a trap.

7.41.00

Upgraded to Python 3.14.4 and OpenSSL 4.0.0.

7.40.03

Added option whocanaddexternalmembers only_owners_can_add_external_members|end_users_can_add_external_members to <GroupSettingsAttribute>. It appears that allowexternalmembers true must be set in the same command. Added option whocanaddexternalmembers to <GroupFieldName>. These options are not in general release as of 2026-04-13; experiment.

7.40.02

Updated gam info|print cigroups and gam print|show cigroup-members to handle trap caused by API returning invalid member data; preferredMemberKey with no id.

7.40.01

Updated gam <UserTypeEntity> print filelist|filecounts to handle the permissionDetails subfield of the permissions field for My Drives; this useful when trying to display permission inheritance. An additional API call per file is required to get the permissionDetails subfield.

gam user user@domain.com print filelist fields id,name,mimetype,basicpermissions,permissiondetails oneitemperrow
gam user user@domain.com print filelist fields id,name,mimetype,basicpermissions,permissiondetails pm inherited false em pmfilter oneitemperrow

7.40.00

Updated gam print|show businessprofileaccounts (client access) to gam <UserTypeEntity> print|show businessprofileaccounts (service account access). You'll need to run gam user user@domain.com update serviceaccount and select 2) Business Account Management API.

7.39.08

Fixed bug in gam oauth create that caused a trap when 0) Business Account Management API was selected.

Upgraded to Python 3.14.4 on macOS and Windows; Linux is still 3.14.3.

7.39.07

Upgraded to OpenSSL 3.6.2.

7.39.06

Fixed bug in gam version checkrc.

7.39.05

Added optional argument preview to updateprimaryemail <RegularExpression> <EmailReplacement> [preview] for the following commands that causes GAM to preview, but not perform, primary email address changes. This allows verification of the primary email address changes before commiting the changes.

gam update group <GroupEntity>
gam update cigroup <GroupEntity>
gam <UserTypeEntity> update user

7.39.04

Added updateprimaryemail <RegularExpression> <EmailReplacement> option to gam update group <GroupEntity> and gam update cigroup <GroupEntity> to allow modifying the group's current primary email address. For example, to change the domain of a set of groups from the current domain.com to newdomain.com:

gam update group csvfile Groups.csv:email updateprimaryemail "^(.+)@domain.com$" "\1@newdomain.com"

7.39.03

Added the following options to gam <UserTypeEntity> create chatspace that can be used to capture space details when creating chat spaces in bulk.

csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]] (addcsvdata <FieldName> <String>)*

See: https://github.com/GAM-team/GAM/wiki/Users-Chat#bulk-build-chat-spaces

7.39.02

Fixed progress messages for gam <UserTypeEntity> print filelist when permissions were being displayed/matched for Shared Drives.

7.39.01

Updated gam <UserTypeEntity> transfer drive <UserItem> to handle the following error:

ERROR: 403: cannotDeletePermission - The authenticated user cannot delete the permission.

7.39.00

Deleted variable enforce_expansive_access from gam.cfg and removed option enforceexpansiveaccess from the following commands as expansive access is now always enforced by Google on My Drives.

gam <UserTypeEntity> delete permissions
gam <UserTypeEntity> delete drivefileacl
gam <UserTypeEntity> update drivefileacl
gam <UserTypeEntity> copy drivefile
gam <UserTypeEntity> move drivefile
gam <UserTypeEntity> transfer ownership
gam <UserTypeEntity> claim ownership

7.38.02

Added license SKU 1010470009 for AI Expanded Access; abbreviation aiexpandedaccess.

Renamed license SKU 1010470001 from Gemini Enterprise to Gemini Enterprise - Legacy.

7.38.01

Added root as a synonym for '/' in command line arguments that specify an OU. This is to avoid issues where a stand-alone / on the command line may be mis-interpreted by the command line interpreter as a reference to the file system root.

7.38.00

Added variable gcp_org_id to gam.cfg that is used by the following commands; by setting the value, additional API calls are eliminated.

gam create project
gam create gcpfolder
gam create|update|delete caalevel
gam print|show caalevels
gam print|show tokens gcpdetails

You can get and set the gam.cfg/gcp_org_id value with these commands:

$ gam info gcporgid             
organizations/906207637890
$ gam config gcp_org_id organizations/906207637890 save

You can get and set the gam.cfg/customer_id value with these commands:

$ gam info customerid             
C78abc9de
$ gam config customer_id C78abc9de save

Added the following options to gam report <ActivityApplicationName>.

applicationinfofilter <String>
networkinfofilter <String>
statusfilter <String>
includesensitivedata

7.37.00

Added new client access scopes used by gam print tokens.

[*] 52)  Resource Manager API - Organizations readonly
[*] 53)  Resource Manager API - Projects readonly

Added option gcpdetails to gam print tokens that uses these scopes to get additional project information.

7.36.03

Added command to send email replies that causes Gmail to recognize the message in conversation mode for the user sending the reply and the user receiving the reply; GAM supplies the necessary headers and options.

gam <UserTypeEntity> sendreply
        (((query <QueryGmail> [querytime<String> <Date>]*) [or|and])+) | (ids <MessageIDEntity>)
        [replyto <EmailAddress>]
        [subject <String>] [<MessageContent>] [html [<Boolean>]]
        (attach <FileName> [charset <CharSet>])*
        (embedimage <FileName> <String>)*
        (<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*

gam user user@domain.com sendreply query "rfc822MsgId:<CAAMmEdqj43...1OsQ@mail.gmail.com>" textmessage "Thanks for the information"
gam user user@domain.com sendreply ids 19cfc3506c02c22b textmessage "Thanks for the information"

7.36.02

Added option threadid <String> to gam [<UserTypeEntity>] sendemail that causes Gmail to recognize the message in conversation mode in for the user sending the message.

7.36.01

Fixed bug in gam info|print|show policies where the policyQuery/query field was not displayed.

Added option noidmapping to gam info|print|show policies to suppress adding the policyQuery/groupEmail and policyQuery/orgUnitPath name fields that are mapped from the policyQuery/group and policyQuery/orgInit id fields.

7.36.00

Added options filtermultiattrtype and filtermultiattrcustomtogam info userandgam print usersthat support filteringdisplay based ontypeorcustomType`.

<UserMultiAttributeFilterName> ::=
        address|addresses|
        externalid|externalids|
        im|ims|
        keyword|keywords|
        location|locations|
        orgainzation|organizations|
        otheremail|otheremails|
        phone|phones|
        relation|relations|
        website|websites
  • filtermultiattrtype <UserMultiAttributeFilterName> <String> - Display <UserMultiAttributeFilterName> if its type is <String>
  • filtermultiattrcustom <UserMultiAttributeFilterName> <String> - Display <UserMultiAttributeFilterName> if its customType is <String> 
gam info user user@domain.com quick filtermultiattrtype organizations work filtermultiattrcustom phones private

7.35.03

Updated gam <UserTypeEntity> print filelist|filecounts to handle options showsize and showsizeunits as independent options.

  • showsize - Display a column Size with a byte count
  • showsizeunits - Display a column SizeUnits with a formatted size with units

If you select both options, you can sort multiple rows using the Size column.

7.35.02

Added option showsizeunits to gam gam <UserTypeEntity> print filelist|filecounts as an alternative to option showsize.

  • showsize - 31549200951 - This is a byte count
  • showsizeunits - 31.55 GB - This is as shown in the Admin console

7.35.01

The following commands have been updated to not verify the existence of gam.cfg credentials files as the WARNING messages about the missing files can be confusing to new users setting up GAM.

gam checkconn
gam oauth|oauth2
gam version

7.35.00

Windows gam-7.wx.yz-x86_64.msi has been replaced with gam-7.wx.yz-x86_64.exe.

Windows gam-7.wx.yz-arm64.msi has been replaced with gam-7.wx.yz-arm64.exe.

Updated cacerts.pem to avoid to following error in gam checkconn.

Checking raw.githubusercontent.com (185.199.110.133) (2)...                                         ERROR
    Certificate verification failed. If you are behind a firewall / proxy server that does TLS / SSL inspection you may need to point GAM at your certificate authority file by setting cacerts_pem = /path/to/your/certauth.pem in gam.cfg.

If you have customized cacerts.pem, update your version with the Operating CA: Let's Encrypt values from the GAM default version.

7.34.13

Fixed bug in gam info policies <CIPolicyNameEntity> ... formatjson where extraneous line Show Info 1 Policy was displayed.

7.34.12

Fixed build errors that prevented Windows zip files from being created.

Added option returnidonly to gam create|update printer that causes GAM to return just the ID of the printer.

7.34.11

Updated gam-install.sh script for macOS/Linux to properly config GAM when the answer to the following question is No.

Can you run a full browser on this machine? (usually Y for macOS, N for Linux if you SSH into this machine)

7.34.10

Fixed bug where formatjson quotechar <Character> on the command line did not override redirect csv <FileName> multiprocess quotechar <Character>.

7.34.09

Updated gam <UserTypeEntity> update photo to delete the user's existing photo before performing the update as the API update will succeed but not replace a user's existing self-set photo.

7.34.08

Rebuild to avoid the following error:

requests/__init__.py:113: RequestsDependencyWarning: urllib3 (2.6.3) or chardet (6.0.0.post1)/charset_normalizer (3.4.4) doesn't match a supported version!

7.34.07

Added the following command to create a guest user.

gam create guestuser <EmailAddress>

Added the following items to <UserFieldName>:

  • guestaccountinfo - Additional guest-related metadata fields
  • isguestuser - Indicates if the inserted user is a guest

7.34.06

Added option copyfolderpermissions [<Boolean>] to gam <UserTypeEntity> copy|move drivefile.

When copyfolderpermissions false is specified, no folder permissions are copied; this simplifies disabling all folder permission copying.

When not specified or copyfolderpermissions [true] is specified, folder permissions are copied based on the following options:

copymergewithparentfolderpermissions [<Boolean>]
copymergedtopfolderpermissions [<Boolean>]
copytopfolderpermissions [<Boolean>]
copytopfolderiheritedpermissions [<Boolean>]
copytopfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders
copymergedsubfolderpermissions [<Boolean>]
copysubfolderpermissions [<Boolean>]
copysubfolderinheritedpermissions [<Boolean>]
copysubfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders

7.34.05

Updated gam report <ActivityApplictionName> to perform a reverse chronological sort on all rows across multiple users and/or event names; this is consistent with the behavior in the Admin console. Use option notimesort to suppress this sort.

7.34.04

Updated gam <UserTypeEntity> create drivefileacl <DriveFileEntity> user <UserItem> role owner to better handle the case where the current owner of a file is suspended. Previously, the command was displayed as an error even though the ownership was changed.

gam user currentowner@domain.com add drivefileacl <DriveFileID> user newowner@domain.com role owner 
User: currentowner@domain.com, Add 1 Drive File/Folder ACL
  User: currentowner@domain.com, Drive File/Folder ID: <DriveFileID>, Permission ID: newowner@domain.com, Add Failed: Sorry, the items were successfully shared but emails could not be sent to newowner@domain.com.

Now the command is displayed as a success with a note indicating that the ownership change email was not sent.

gam user currentowner@domain.com add drivefileacl <DriveFileID> user newowner@domain.com role owner
User: currentowner@domain.com, Add 1 Drive File/Folder ACL
  User: currentowner@domain.com, Drive File/Folder ID: <DriveFileID>, Permission ID: newowner@domain.com, Added: Sorry, the items were successfully shared but emails could not be sent to newowner@domain.com.
  New Owner
    id: 10834698115409747890
    type: user
    emailAddress: newowner@domain.com
    domain: domain.com
    role: owner
    permissionDetails:
      role: writer
        type: file
        inherited: True
        inheritedFrom: Unknown
      role: owner
        type: file
        inherited: False
    deleted: False
    pendingOwner: False

7.34.03

Updated to Python 3.14.3

Updated Cryptography to 46.0.5

Updated gam course <CourseID> create student|teacher <EmailAddress> error message when <EmailAddress> is not in a trusted domain to remove suggestion about creating an invitation.

7.34.02

Updated GAM to prevent errors like the following:

ERROR: Unable to find the server at oauth2.googleapis.com
ERROR: Unable to find the server at gmail.googleapis.com

If you experience any unexpected errors, post a message to:

7.34.01

Updated gam create|update adminrole to handle the following errors:

ERROR: 400: invalid - Invalid Role privileges
ERROR: 400: required - Required parameter: [resource.privileges[n].service_id]

7.34.00

Added variable csv_output_header_required to gam.cfg that is a comma separated list of <Strings> that are required to be in the list of column headers in the CSV file written by a gam print command. This will typically be used to specify headers that are required in subsequent commands that process the CSV file even if the API didn't return any data for those columns.

Updated the following commands to not require the Directory API - Domains scope unless the internal or external options are used to request the member category.

gam info|print groups
gam print|show group-members
gam info|print cigroups
gam print|show cigroup-members
gam <UserTypeEntity> print|show filesharecounts

7.33.03

Fixed bug in gam [<UserTypeEntity>] sendemail ... from <EmailAddress> replyto <EmailAddress> where an <EmailAddress> of the form Text <user@domain.com> had the Text removed.

7.33.02

Added hideinvitationssetting to <UserCalendarSettingsField> used by gam <UserTypeEntity> print|show calsettings.

7.33.01

Added option shownopolicy to gam print chromepolicies that will display output like the following if no policies apply to the selected OU or group.

gam print chromepolicies ou /Test appid chrome:emidddocikgklceeeifefomdnbkldhng namespace chrome.users.apps shownopolicy 
Getting all Chrome Policies that match query (chrome.users.apps.*) for /Test
Got 0 Chrome Policies that matched query (chrome.users.apps.*) for /Test...
name,orgUnitPath,parentOrgUnitPath,direct,appId
noPolicy,/Test,/,False,chrome:emidddocikgklceeeifefomdnbkldhng

7.33.00

Added variable developer_preview_apis to gam.cfg that is a comma separated list of APIs requiring a Developer Preview key. Currently, chat is the only API that requires a Developer Preview key; it is required for the User Sections commands.

7.32.07

Added option includepermissionsforview published to gam <UserTypeEntity> print filelist and gam <UserTypeEntity> show fileinfo. From the Drive API documentation:

Specifies which additional view's permissions to include in the response. Only published is supported.

7.32.06

Added options to gam <UserTypeEntity> copy drivefile ... copysubfiles to limit copying to files whose modifiedTime meets specified requirements.

  • start|starttime <Date>|<Time> - If specified, modifiedTime must be >= the value
  • end|endtime <Date>|<Time> - If specified, modifiedTime must be <= the value
  • range <Date>|<Time> <Date>|<Time> - first value <= modifiedTime <= second value

7.32.05

Fixed bug in gam <UserTypeEntity> print messages|threads ... headers <SMTPHeaderList> where headers other than those specified in <SMTPHeaderList> were displayed.

Updated gam info users <UserTypeEntity> to display the following data when the Licensing API does not return data due to quota limits. Previously, no License data was displayed and there was no way to know if it was omitted due to API quota limits vs the user has no license?

  Licenses: (1)
    Not available/incomplete

If a user has no licenses, this will be displayed.

  Licenses: (0)

You should use license_skus = <SKUIDList> in gam.cfg to list all of the licensing SKUs used in your workspace. Without this list, GAM has to make 70+ API calls to get the licenses for a user; this can cause quota limit errors.

7.32.04

Support for student groups in Google Classroom no longer requires Developer Preview membership.

Upgraded to OpenSSL 3.6.1.

7.32.03

Added option template as an additional formating option for gam <UserTypeEntity> show signature that displays just the HTML data; this simplifies capturing the data for use as input to GAM.

$ gam redirect stdout ./SigTemplate.html user user@domain.com show signature template
$ more SigTemplate.html
<div dir="ltr"><div dir="ltr"><div dir="ltr">
<p style="margin:0px;font-size-adjust:none;font-stretch:normal;font-size:12px;line-height:normal;font-family:Monaco;color:rgb(0,0,0)">
<span style="background-color:rgb(82,208,206)">{RT}Email: {Email}{/RT}</span></p>
<p style="margin:0px;font-size-adjust:none;font-stretch:normal;font-size:12px;line-height:normal;font-family:Monaco;color:rgb(0,0,0)">
<span style="background-color:rgb(82,208,206)">{RT}Phone: {Phone}{/RT}</span></p>
<p style="margin:0px;font-size-adjust:none;font-stretch:normal;font-size:12px;line-height:normal;font-family:Monaco;color:rgb(0,0,0)">
<span style="background-color:rgb(82,208,206)">{RT}Mobile: {Mobile}{/RT}</span></p>
</div><br></div>\n</div>

7.32.02

Added variable oauth2_txt_lock_mode to gam.cfg, the default is 644 and valid values are: 644, 664, 666. This value is used to set the file permissions on the oauth2.txt.lock file. In very special cases where daemon processes, e.g. Apache/httpd, are running GAM, the value 666 may have to be used.

7.32.01

Added option (addcsvdata <FieldName> <String>)* to gam <CrOSTypeEntity> issuecommand command <CrOSCommand> csv and gam <CrOSTypeEntity> getcommand commandid <CommandID> csv that adds additional columns of data to the CSV file output.

7.32.00

Added option verifyallowexternal to gam print cigroup-members|group-members that causes GAM to only display external members in groups with `allowExternalMembers=False'. This option can be used to help verify that internal-only groups don't have external members.

Updated option internaldomains for the following commands:

gam info|print groups
gam print|show group-members
gam info|print cigroups
gam print|show cigroup-members
gam <UserTypeEntity> print|show filesharecounts

Which domains are considered internal domains:

  • internaldomains all - All of your workspace domains; this is the default
  • internaldomains primary - Your workspace primary domain
  • internaldomains <DomainNameList> - A list of domain names

Added option csv to gam <CrOSTypeEntity> issuecommand command <CrOSCommand> and gam <CrOSTypeEntity> getcommand commandid <CommandID> so that command details are displayed in CSV format. This can be used to log commands issued to devices and then monitor the results.

Added option filemimetype category <MimeTypeNameList> to gam <UserTypeEntity> copy drivefile to support copying of files based on their MimeType category.

Added option attendeeslist to gam calendars <CalendarEntity> print events and gam <UserTypeEntity> print events that causes GAM to display the attendee email addresses in a single column attendeesList; no attendee details are displayed. The email addresses are separated by csv_output_field_delimiter from gam.cfg.

Fixed bug in gam sendemail ... replyto <EmailAddress> that caused a message delivery error if <EmailAddress> did not include a domain name.

Added support for users's chat sections.

7.31.06

Added option batchsize <Integer> to gam calendar <CalendarEntity> delete|purge events and gam <UserTypeEntity> delete|purge events <UserCalendarEntity> that causes GAM to delete events with batch API calls rather than with individual API calls.

7.31.05

Added option variables <RESearchPattern> to gam select section <SectionName> verify and gam config verify that causes GAM to only display variables with names selected by <RESearchPattern>.

gam select School verify variables "^(customer|domain)"
Section: School
  customer_id = C03abc123
  domain = school.edu

gam config verify variables  'dir'
Section: DEFAULT
  cache_dir = ~/GamConfig/gamcache ; /Users/gamteam/GamConfig/gamcache
  config_dir = ~/GamConfig ; /Users/gamteam/GamConfig
  drive_dir = ~/GamWork ; /Users/gamteam/GamWork
  gmail_cse_incert_dir = ~/GmailCSE/Certs ; /Users/gamteam/GmailCSE/Certs
  gmail_cse_inkey_dir = ~/GmailCSE/Keys ; /Users/gamteam/GmailCSE/Keys
  input_dir = .

7.31.04

Fixed bug in gam report admin|chrome that caused to events to not be displayed.

Updated gam <UserTypeEntity> print|show messages|threads ... query <QueryGmail> to display the query.

7.31.03

Due to the following Calendar API update, the gam <UserTypeEntity> transfer calendars command has been removed.

7.31.02

Added the following options to gam <UserTypeEntity> copy drivefile to limit copying to those files owned by selected users.

  • copysubfilesownedby users <EmailAddressList> - Only files owned by users in <EmailAddressList> are copied.
  • copysubfilesownedby notusers <EmailAddressList> - Only files not owned by users in <EmailAddressList> are copied.
  • copysubfilesownedby regex <REMatchPattern> - Only files owned by users whose email addresses match <REMatchPattern> are copied.
  • copysubfilesownedby notregex <REMatchPattern> - Only files owned by users whose email addresses do not match <REMatchPattern> are copied.

7.31.01

Code cleanup for addcsvdata <FieldName> <String>.

7.31.00

Fixed bug in gam report chrome (user <UserItem>)|(select <UserTypeEntity>) where no activities were returned. report chrome does not use the parameter userKey=<EmailAddress> as do other applications but requires parameter filter DEVICE_USER==<EmailAddress>.

Updated gam report admin (user <UserItem>)|(select <UserTypeEntity>) to use parameter filter USER_EMAIL==<EmailAddress> to display activiities affecting the user <EmailAddress>. Use option userisactor to use the parameter userKey=<EmailAddress> that displays activities where user <EmailAddress> executed the command that generated the activity.

Fixed bug in gam print cros|filelist|users ... (addcsvdata <FieldName> <String>)+ formatjson where the addcsvdata columns were not displayed but the additional field values were included in the JSON data. Now, the addcsvdata columns are displayed but the additional field values are only included in the JSON data when option includdecsvdatainjson is specified.

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print cigroups|groups that adds additional columns of data to the CSV file output.

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print cigroupmembere|group-members that adds additional columns of data to the CSV file output.

7.30.05

Added option gmaileventtypes <NumberRangeList> to gam report gmail that can be used to limit the event types displayed.

<NumberRange> ::= <Number>|(<Number>/<Number>)
<NumberRangeList> ::= "<NumberRange>(,<NumberRange>)*"

gam report gmail user user@domain.com gmaileventtypes 1,10/11

Updated sorting of column headers in gam report <ActivityApplicationName>.

7.30.04

Updated gam report gmail to avoid the following error when incomplete start/end time information is provided.

ERROR: Invalid request: Start time and end time should both be provided, and the scan duration should not be greater than 30 days.
  • No time information provided - GAM sets range -30d today
  • Only start <Time> provided - GAM sets end <Time>+30d
  • Only end <Time> provided - GAM sets start <Time>-30d

7.30.03

Updated gam report <ActivityApplicationName> to reflect the changes described here:

Added option resourcedetailsfilter <String> to gam report <ActivityApplicationName> described here:

For gam <UserTypeEntity> print <Objects>, expanded the list of <Objects> covered by gam.cfg csv_output_users_audit = True.

7.30.02

Added option conferencedata meet <MeetID> to <EventAttribute> that allows specifying a reference to an existing Google Meet when creating/updating a calendar event.

Upgraded to Python 3.14.2.

7.30.01

Fixed bug introduced in 7.30.00 that caused errors when reading CSV files.

Added the following options to gam <UserTypeEntity> create focustime|outofoffice:

((date yyyy-mm-dd)|
 (range yyyy-mm-dd yyyy-mm-dd)|
 (daily yyyy-mm-dd N)|
 (weekly yyyy-mm-dd N))

Added the following options to gam <UserTypeEntity> create focustime|outofoffice|workinglocation:

noreminders|(reminder email|popup <Number>)+

7.30.00

Added input_dir directory variable to gam.cfg that is used to select a directory for reading files with non-absolute file names. The default is '.' that matches the current behavior where these files are read from the current working directory. This will be most useful in multiple domain situations where each domain will have distinct drive_dir and input_dir values.

Added support for the new resource calendar setting autoAcceptInvitations.

7.29.04

Updated gam delete chromepolicy chrome.users.apps.InstallType ou <OrgUnitItem> appid <AppID> to allow deleting an app, i.e., explicitly remove it from management. <OrgUnitItem> must specify where it was added for management.

7.29.03

Remove debugging message from gam <UserTypeEntity> move drivefile <DriveFileEntity>.

7.29.02

Fixed bug in gam <UserTypeEntity> move drivefile <DriveFileEntity> where the following options were only applied to top level files or folders re-created in the destination. Now, domain and email address mappings apply to all moved files/folders.

excludepermissionsfromdomains <DomainNameList>
includepermissionsfromdomains <DomainNameList>
mappermissionsdomain <DomainName> <DomainName>
mappermissionsemail <EmailAddress> <EmailAddress>
mappermissionsemailfile <CSVFileInput> endcsv

Upgraded to Python 3.14.1.

7.29.01

Added option oneitemperrow to gam <UserTypeEntity> print calendars ... permissions to have each of a calendar's permissions displayed on a separate row with all of the other calendar fields.

Updated gam yubikey reset_piv to handle YubiKey firmware updates that caused an error.

7.29.00

Added options mappermissionsemail <EmailAddress> <EmailAddress> and mappermissionsemailfile <CSVFileInput> endcsv to these commands:

gam [<UserTypeEntity>] copy shareddriveacls <SharedDriveEntity> to <SharedDriveEntity>
gam [<UserTypeEntity>] sync shareddriveacls <SharedDriveEntity> with <SharedDriveEntity>
gam <UserTypeEntity> copy drivefile <DriveFileEntity>
gam <UserTypeEntity> move drivefile <DriveFileEntity>

When mappermissionsemail <EmailAddress> <EmailAddress> is specifed, an ACL that references the first <EmailAddress> in the source will be modified to reference the second <EmailAddress> in the destination.

Bulk permission email address mapping can be specified with mappermissionsemailfile <CSVFileInput> endcsv. <CSVFileInput> must include these columns: sourceEmail and destinationEmail.

These options will be most useful with inter-workspace Shared Drive copies and moves.

7.28.13

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print messages that adds additional columns of data to the CSV file output.

7.28.12

Updated gam delete project to handle the following error:

ERROR: 400: failedPrecondition - Project not active

7.28.11

Removed all options/fields referencing inheritance from gam create|update|info|print org as this option/field is deprecated.

7.28.10

Added a command gam print course-counts that dsplays the count of the number of courses in which a teacher or student is a participant.

7.28.09

Fixed bug in gam print cigroups ... descriptionmatchpattern [not] <REMatchPattern> that caused a trap.

7.28.08

Updated gam <UserTypeEntity> print|show chatmessages to cache the sender UID to email address map so that each sender UID only has to be looked up once; this improves performance.

7.28.07

Fixed bug in gam report users ... aggregatebydate|aggregatebyuser where accounts:used_quota_in_percentage was incorrectly displayed.

7.28.06

Updated gam <UserTypeEntity> info|print|show calendars and gam calendars <CalendarEntity> print|show settings to display the new dataOwner field as described under Additional details below.

7.28.04

Updated commands that display Chrome device counts to display the date in the output.

7.28.03

Improved commands to display Chrome device counts.

7.28.02

Added commands to display Chrome device counts.

7.28.01

Updated gam <UserTypeEntity> show fileinfo <DriveFileEntity> to display displayName as the key field of a permission not deleted.

7.28.00

Added option addcsvdata <FieldName> <String> to gam report [usage] customers|users that adds additional columns of data to the CSV file output. This will be most useful when reading a CSV of user information and you want to include some of the user information, e.g., orgUnitPath, in the output.

gam redirect csv ./Users.csv print users fields ou
gam redirect csv ./UserStorageInfo.csv multiprocess csv Users.csv gam report users user "~primaryEmail" parameters accounts:drive_used_quota_in_mb,accounts:gmail_used_quota_in_mb,accounts:gplus_photos_used_quota_in_mb,accounts:total_quota_in_mb,accounts:used_quota_in_mb,accounts:used_quota_in_percentage addcsvdata orgUnitPath "~orgUnitPath"

7.27.05

Added option addcsvdata <FieldName> <String> to gam print courses that adds additional columns of data to the CSV file output.

The following scope is no longer necessary: Cloud Identity API - Groups Beta (Enables group locking/unlocking) as this scope Cloud Identity API - Groups now provides group locking/unlocking.

7.27.04

Added options to gam <UserTypeEntity> create delegate that support sending email notifications when a user adds a delegate.

7.27.03

Updated gam <UserTypeEntity> create|update|sync chatmember role specification to role member|manager|owner. This is the mapping between the Chat UI and Chat API; GAM uses the Chat UI role names.

UI: Member,  API: ROLE_MEMBER
UI: Manager, API: ROLE_ASSISTANT_MANAGER
UI: Owner,   API: ROLE_MANAGER

Updated gam <UserTypeEntity> update chatspace options for permission settings.

        [managemembersandgroups owners|managers|members]
        [modifyspacedetails owners|managers|members]
        [togglehistory owners|managers|members]
        [useatmentionall owners|managers|members]
        [manageapps owners|managers|members]
        [managewebhooks owners|managers|members]
        [replymessages owners|managers|members]

7.27.02

Added option clearattachments <String> to gam [<UserTypeMessage>] update chatmessage that clears all attachments from a Chat message. If <ChatContent> is not specified, the current message text is retained and <String> is appended; <String> must be specified but can be empty in which case the current message test is preserved as-is.

7.27.01

Fixed bug in gam <UserTypeEntity> claim ownership <DriveFileEntity> ... onlyUsers|skipusers <UserTypeEntity> where the email addresses in onlyUsers|skipusers <UserTypeEntity> were not normalized.

7.27.00

Added debug_redaction Boolean variable to gam.cfg. When True, the default, sensitive data like access/refresh tokens, client secret and authorization codes are redacted from debug output. This allows you to post debug output without compromising your account information. Even with debug redaction, anything shared publicly should be double-checked for sensitive content.

7.25.01

Fixed bug in gam config timezone <String> to handle timezone abbreviations correctly; they were incorrectly shifted to lowercase.

7.25.00

Removed a capabilty added in 7.24.00 that allowed reading command data from Google Docs and Sheets when a user's service account access to Drive and Sheets had been disabled. Jay was concerned that this change could be exploited to give access to all user's files.

This capability has been replaced by issuing the following commands. The admin specified in gam oauth create can read command data from Docs and Sheets to which it has access.

gam config commanddata_clientaccess true save
gam oauth create
Enable the following and proceed to authorization.

[*] 42)  Drive API - commanddata_clientaccess
[*] 54)  Sheets API - commanddata_clientaccess

Fixed in bug in gam report that caused a trap with either of the thismonth or previousmonths options were used.

Upgraded to Python 3.14.0.

7.24.01

Updated GAM to handle the following error that occurs when GAM tries to authenticate as a user that has been disabled by Google.

ERROR: Authentication Token Error - invalid_account: Forbidden

7.24.00

If you want to disable a user's service account access to Drive and Sheets but still allow reading command data from Google Docs and Sheets, issue the following command and make these settings:

gam user user@domain.com update serviceaccount

[ ] 20)  Drive API (supports readonly)
[*] 21)  Drive API - read command data
[ ] 42)  Sheets API (supports readonly)
[*] 43)  Sheets API - read command data

7.23.07

Fixed bug in gam print|show admins where all admin assignments were not displayed when types <AdminAssigneeTypeList> was not specified, i.e., all assignments should be displayed.

7.23.06

Added option types <AdminAssigneeTypeList> to gam print|show admins that allows filtering of admin assignments by the type of the assignee; by default, all assignee types are displayed.

<AdminAssigneeType> ::= group|user|serviceaccount|unknown
<AdminAssigneeTypeList> ::= "<AdminAssigneeType>(,<AdminAssigneeType>)*"

7.23.05

Added option recursive that will display assignments to the members of security groups assigned to roles; the security group membership is recursively expanded.

7.23.04

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print events and gam calendars <CalendarEntity> print events that adds additional columns of data to the CSV file output. An example would be to get the calendar name in addition to the calendar ID when printing events.

gam redirect csv ./Resources.csv print resources fields email,name
gam redirect csv ./ResourceEventCounts.csv multiprocess redirect stderr - multiprocess csv Resources.csv gam calendar "~resourceEmail" print events starttime -1y countsonly addcsvdata calendarName "~resourceName"

Upgraded to OpenSSL 3.6.0.

7.23.03

Upgraded to OpenSSL 3.5.4.

7.23.02

Added option oneitemperrow to 'gam print course-materials|course-work` to have each of a course's materials displayed on a separate row with all of the other course fields. This produces a CSV file that can be used in subsequent commands to process the materials without further script processing.

7.23.00

Added chat_max_results variable to gam.cfg.

chat_max_results
    When retrieving lists of Chat items from API,
    how many should be retrieved in each API call
    Default: 100
    Range: 1 - 1000

Previously, this vaule was always set to 1000 which could cause errors.

7.22.07

Added options showdetails and returnidonly to gam create|copy vaultquery.

Added option <JSONData> to gam create vaultexport|vaultquery and gam print vaultcounts.

7.22.06

Added commands to create, copy and delete Vault saved queries.

gam create vaultquery <MatterItem> [name <String>]
        corpus calendar|drive|gemini|groups|hangouts_chat|mail|voice
        [scope all_data|held_data|unprocessed_data]
        (accounts <EmailAddressEntity>) | (orgunit|org|ou <OrgUnitPath>) | everyone
        (documentids  (<DriveFileIDList>|(select <FileSelector>|<CSVFileSelector>))) |
        (shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>))) |
        [(includeshareddrives <Boolean>)|(shareddrivesoption included|included_if_account_is_not_a_member|not_included)]
        (sitesurl (<URLList>||(select <FileSelector>|<CSVFileSelector>)))
        [driveversiondate <Date>|<Time>]
        [includerooms <Boolean>]
        (rooms (<ChatSpaceList>|(select <FileSelector>|<CSVFileSelector>))) |
        [terms <String>] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>] [timezone <TimeZone>]
        [locationquery <StringList>] [peoplequery <StringList>] [minuswords <StringList>]
        [responsestatuses <AttendeeStatus>(,<AttendeeStatus>)*] [calendarversiondate <Date>|<Time>]
        (covereddata calllogs|textmessages|voicemails)*
        [shownames] [formatjson]

gam copy vaultquery <MatterItem> <QueryItem> [targetmatter <MatterItem>] [name <String>]
        [shownames] [formatjson]

gam delete vaultquery <QueryItem> matter <MatterItem>
gam delete vaultquery <MatterItem> <QueryItem>

Added a variant of gam print vaultcounts that gets its query parameters from a saved Vault query.

gam print vaultcounts [todrive <ToDriveAttributes>*]
        matter <MatterItem> <QueryItem>
        [wait <Integer>]

7.22.05

Added a variant of gam create vaultexport that gets its query parameters from a saved Vault query.

gam create vaultexport|export matter <MatterItem> [name <String>]
        vaultquery <QueryItem>
        [driveclientsideencryption any|encrypted|unencrypted]
        [includeaccessinfo <Boolean>]
        [excludedrafts <Boolean>] [mailclientsideencryption any|encrypted|unencrypted]
        [showconfidentialmodecontent <Boolean>] [usenewexport <Boolean>] [exportlinkeddrivefiles <Boolean>]
        [format ics|mbox|pst|xml]
        [region any|europe|us] [showdetails|returnidonly]

7.22.04

Added a variant of gam create vaulthold that gets its parameters from a saved Vault query.

gam create vaulthold matter <MatterItem> [name <String>]
        vaultquery <QueryItem>
        [showdetails|returnidonly]

7.22.03

Fix backwards compatability bug introduced in 7.22.00 for gam print users that changed suspended from a field name to a query option; it is now correctly interpreted as a field name.

7.22.02

An update to the httplib2 library caused GAM proxy connections to fail; this has been fixed by including the pysocks library needed by the latest httplib2 library.

7.22.00

Expanded <UserTypeEntity> to allow specification of non-archived/archived users.

These commands have been updated:

  • gam print aliases
  • gam update groups
  • gam info orgs
  • gam print orgs
  • gam print users

Added datetime <DateTimeFormat> command that can be embedded in Gam batch files. The current time is formatted with <DateTimeFormat> and subsequent lines in <BatchContent> will have %datetime% replaced with the formatted time value.

See: https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes

7.21.03

Added option notifyrecoveryemail to gam create user and gam <UserTypeEntity> update user password <String> that sends the passsword notification email to the user's recovery email address (if defined).

7.21.02

GAM now builds on macOS 26 Tahoe and properly identifies the OS.

A custom build of the cryptography library is no longer needed for Windows arm64 builds as the project now releases their own build for the OS.

Upgraded to OpenSSL 3.5.3.

7.21.01

Replaced datetime, dateutil, calendar and iso8601 Python libraries with arrow library. This should have no performance impact; report any problems.

You can now use timezone names when setting timezone in gam.cfg.

gam config timezone America/Los_Angeles save

7.20.04

Cleaned up Python library imports: googleapiclient, iso8601.

7.20.03

Rebranded license SKU 1010470004 from Gemini Education to Google AI Pro for Education.

Additional updates to student groups in Google Classroom.

7.20.02

Upgraded gam create course-studentgroups to allow specification of multiple student group titles; multiple student groups can be created in a single command.

  • ((title <String>)|(select <StringEntity))+

7.20.01

Added option showaccesssettings to gam [<UserTypeEntity>] print|show chatspaces. When listing Chat Spaces, the Chat API does not return the accessSettings field; if you need to see this field, add showaccesssettings to the command. This requires an additional Chat API call per chat space of type SPACE to get the accessSettings field.

7.20.00

Added initial support for student groups in Google Classroom. This is a work in progress and requires Developer Preview membership.

7.19.03

Fixed bug where specifying a <UserItem> as id:1234567890 could lead to errors like this:

ERROR: 400: invalidArgument - Resource name has invalid email.

7.19.02

Update gam info user <UserItem> to eliminate 5 second delay when getting license info.

Additional information:

7.19.01

Updated gam <UserTypeEntity> print|show signature to handle the following error that occurs when an alias is specified.

ERROR: 404: notFound - Requested entity was not found.

7.19.00

Eliminated drive_v3_beta and meet_v2_beta from gam.cfg as the API betas are no longer used.

Updated Meet API scopes so that GAM can read metadata about additional Meet spaces.

[*] 34)  Meet API - Manage/Display Meeting Spaces
[*] 35)  Meet API - Read Meeting Spaces metadata

7.18.07

Updated gam <UserTypeEntity> print drivelastmodification to put addcsvdata columns after User,id,name rather than after the last column.

7.18.06

Updated gam <UserTypeEntity> delete|modify messages to improve the handling of the following error.

quotaExceeded - User-rate limit exceeded

7.18.05

Added support for Inbound SSO OIDC profiles.

Currently, if you enter gam select <SectionName> and nothing else on the command line, GAM performs no action. Now, it will be treated as if you entered: gam select <SectionName> save

Updated to Python 3.13.7.

7.18.04

Added commands to display/manage Alert Center Pub/Sub notifications.

7.18.03

Updated gam oauth create to give a warning if the number of selected scopes will probably cause Google to generate a "Something went wrong" error.

7.18.02

Upgraded to OpenSSL 3.5.2.

7.18.01

Added option nosystemroles to gam print|show adminroles that causes GAM to only display non-system roles.

Added option formatjson to gam info|print|show adminroles; this will be most useful when the privileges option is used.

Updated gam create|update adminrole to allow specification of privileges with JSON data: privileges <JSONData>. These two updates make it easier to copy admin roles.

Updated gam create|update adminrole to allow output of the created/updated role data in CSV format; by default, GAM displays <RoleName>(<RoleID>) created|updated.

csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]] (addcsvdata <FieldName> <String>)*

7.18.00

Added commands to display Business Profile Accounts. These are special purpose commands and will not generally be used.

gam show businessprofileaccounts
gam print businessprofileaccounts [todrive <ToDriveAttribute>*]

7.17.03

Fixed bug in gam <UserItem> print|show chatspaces asadmin fields <ChatSpaceFieldNameList> that caused a trap when displayname was not in <ChatSpaceFieldNameList>.

7.17.02

Updated gam <UserTypeEntity> print|show webmastersites to handle the following error that occurs if you haven't updated your project to include the Google Search Console API.

ERROR: 403: permissionDenied - Google Search Console API has not been used in project 111055363999 before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/searchconsole.googleapis.com/overview?project=111055363999 then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.

7.17.01

Fixed bug in gam <UserTypeEntity> show webmastersites that caused a trap.

7.17.00

Added commands to discover Sites and WebResources that managed users (previously unmanaged) may have access to for better governance and visibility. These are special purpose commands and will not generally be used.

gam <UserTypeEntity> show webresources
gam <UserTypeEntity> print webresources [todrive <ToDriveAttribute>*]
gam <UserTypeEntity> show webmastersites
gam <UserTypeEntity> print webmastersites [todrive <ToDriveAttribute>*]

7.16.01

The Drive API now supports setting download restrictions on individual files.

Added downloadrestictions and <DriveDownloadRestrictionsSubfieldName> to <DriveFieldName>.

<DriveDownloadRestrictionsSubfieldName> ::=
  downloadrestrictions.itemdownloadrestriction|
  downloadrestrictions.effectivedownloadrestrictionwithcontext

Added itemdownloadrestriction restrictedforreaders|restrictedforwriters [<Boolean>] to <DriveFileAttribute>.

From the Drive API documentation:

itemDownloadRestriction - The download restriction of the file applied directly by the owner or organizer. This does not take into account shared drive settings or DLP rules.
effectiveDownloadRestrictionWithContext - Output only. The effective download restriction applied to this file. This considers all restriction settings and DLP rules.
restrictedForReaders - Whether download and copy is restricted for readers.
restrictedForWriters - Whether download and copy is restricted for writers. If true, download is also restricted for readers.

7.16.00

Removed drive_v3_native_names from gam.cfg; GAM now only uses Drive API v3 fields names on output. If you had drive_v3_native_names = False in gam.cfg or are updating from Legacy GAM:

7.15.01

Added downloadrestrictions.restrictedforreaders and downloadrestrictions.restrictedforwriters to <SharedDriveRestrictionsSubfieldName>; previously, only the abbreviations downloadrestrictedforreaders and downloadrestrictedforwriters were supported (they are still supported).

Updated gam <UserTypeEntity> copy drivefile to handle unexpected data returned by Google that caused a trap.

7.15.00

Updated gam print shareddriveorganizers to make shownoorganizerdrives default to True as documented; it was defaulting to False.

Cleaned up code for processing Python dictionary structures; this should have no noticable effect.

7.14.04

Fixed bug in gam print|show cigroups cimember <UserItem> that generated the following error:

ERROR: Cloud Identity Group: groups/-, Print Failed: Error(4013): Insufficient permissions to retrieve memberships.

Updated gam <UserTypeEntity> update user suspended off and gam <UserTypeEntity> unsuspend users to handle the following error that occurs when trying to unsuspend a user that has been suspended for abuse.

ERROR: 412: adminCannotUnsuspend - Cannot restore a user suspended for abuse.

7.14.03

Fixed bug in gam print cigroup-members includederivedmembership that caused a trap.

7.14.02

Fixed bug in gam print|show cigroups|cigroups-members cimember <UserItem> that generated the following error:

Cloud Identity Group Print Failed: Request contains an invalid argument.

7.14.01

Don't install yubikey library via pip by default. To install with yubikey support use pip install gam7[yubikey]

7.14.00

Added commands to display Google Tag Manager accounts, containers, workspaces, tags and user permissions.

7.13.03

Added option csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]] to gam create chromeprofilecommand so that command details are displayed in CSV format.

Added option commands <ChromeProfileCommandNameList>|<FileSelector>|<CSVFileSelector> to <ChromeProfileNameEntity> so that gam print|show chromeprofilecommands can directly display the commands generated by gam create chromeprofilecommand with the csv option.

7.13.02

Fixed bug in gam create chromeprofilecommand where select|filter were not recognized.

Updated gam create datatransfer <OldOwnerID> datastudio <NewOwnerID> that generated the following error due to an unhandled API change.

ERROR: Invalid choice (google data studio): Expected <calendar|looker studio|drive and docs>

7.13.01

Enhanced gam create|print|show chromeprofilecommand to allow specification of multiple Chrome browser profiles rather than just one.

<ChromeProfilePermanentID> ::= <String>
<ChromeProfileName> ::= customers/<CustomerID>/profiles/<ChromeProfilePermanentID> | <ChromeProfilePermanentID>
<ChromeProfileNameList> ::= "<ChromeProfileName>(,<ChromeProfileName>)*"
<ChromeProfileNameEntity> ::=
        <ChromeProfileNameList> |
        (select <FileSelector>|<CSVFileSelector>) |
        (filter <String> (filtertime<String> <Time>)* [orderby <ChromeProfileOrderByFieldName> [ascending|descending]])

gam create|print_show chromeprofilecommand <ChromeProfileNameEntity>

7.13.00

Added commands that send remote commands to Chrome browser profiles and display the results; at the moment, these commands can clear the browser cache and cookies.

7.12.02

Updated gam print users to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable

7.12.01

Added support for plan free in gam create resoldsubscription.

  • The free plan is exclusive to the Cloud Identity SKU and does not incur any billing.

7.12.00

Started updated handling of missing scopes messages in client access commands; this is a work in progress.

Updated gam info|show shareddrive to handle changes in the Drive API that caused traps.

Added downloadrestrictedforreaders and downloadrestrictedforwriters to <SharedDriveRestrictionsSubfieldName> to support new Shared Drive restrictions.

Updated gam course <CourseID> create|update announcement to accept input from a literal string, a file or a Google Doc.

<CourseAnnouncementContent> ::=
        ((text <String>)|
         (textfile <FileName> [charset <Charset>])|
         (gdoc <UserGoogleDoc>)|
         (gcsdoc <StorageBucketObjectName>))

Added command gam check suspended <UserItem> that checks the suspension status of a user and sets the return code to 0 if the user is not suspended or 26 if it is.

$ gam check suspended testok@domain.com
User: testok@domain.com, Account Suspended: False
$ echo $?
0

$ gam check suspended testsusp@domain.com
User: testsusp@domain.com, Account Suspended: True, Suspension Reason: ADMIN
$ echo $?
26

Updated gam <UserTypeEntity> sendemail to verify that one of recipient|to|from immediately follows sendemail.

7.11.00

Added commands to manage classroom/course announcements.

Upgraded to OpenSSL 3.5.1.

7.10.10

Added choices text and hyperlink to option showwebviewlink in gam [<UserTypeEntity>] print|show shareddrives.

  • showwebviewlink text - Displays https://drive.google.com/drive/folders/<SharedDriveID>
  • showwebviewlink hyperlink - Displays =HYPERLINK("https://drive.google.com/drive/folders/<SharedDriveID>", "<SharedDriveName>")

7.10.09

Added option showwebviewlink to gam [<UserTypeEntity>] print|show shareddrives that displays the web view link for the Shared Drive: https://drive.google.com/drive/folders/<SharedDriveID>.

7.10.08

Fixed bug in commands that modify messages where the labelids <LabelIdList> option could not be used unless one of these options was also specified: query, matchlabel, ids; it can be now be used by itself.

7.10.07

Updated gam <UserTypeEntity> copy|move drivefile to hanndle additional instances of the cannotModifyInheritedPermission error.

Added license SKU Google AI Ultra for Business

  • ProductID - 101047
  • SKUID - 1010470008 | geminiultra

7.10.06

Added option clientstates to gam print devices to include client states in device output.

7.10.05

Google renamed an error: cannotModifyInheritedTeamDrivePermission became cannotModifyInheritedPermission. GAM will now handle the new error.

7.10.04

Updated gam report <ActivityApplicationName> to accept accept application names as defined in the Reports API discovery document; this means that GAM does not have to be updated when Google defines a new application name.

gemini_in_workspace_apps is now available in gam report.

7.10.03

Fixed bug in commands that modify messages where the labelids <LabelIdList> option was not being applied.

7.10.02

Added option labelids <LabelIdList> to all commands that process messages; this option causes GAM to only return messages with labels that match all of the specified label IDs.

Updated gam <UserTypeEntity> print|show forms to always display isPublished and isAcceptingResponses in publishSettings/publishState regardless of their value; the API doesn't return these values when they are False.

7.10.01

Added options ispublished [<Boolean>] and isacceptingresponses [<Boolean>] to gam <UserTypeEntity> create|update form.

7.10.00

Added commands to manage/display Chat Custom Emojis.

Updated gam <UserItem> print|show chatspaces|chatmembers asadmin to display the spaces in ascending display name order.

7.09.07

Added webviewlink to <FileTreeFieldName> for use in gam <UserTypeEntity> print|show filetree.

7.09.06

Upddated gam print|show shareddrives, gam print|show shareddriveacls, gam print shareddriveorganizers to display the Shared Drives in ascending name order; the API returns them in an unidentifiable order.

7.09.05

Improved output of gam info|show chromeschemas [std] to more accurately display the schemas.

Fixed bugs in gam update chromepolicy that caused invalid error messaages.

7.09.04

Fixed bug in gam whatis <EmailItem> where the check for an invitable user always failed.

Fixed bug in gam print shareddriveorganizers where no organizers were displayed when domain in gam.cfg was blank.

Updated to Python 3.13.5

7.09.03

Updated gam <UserTypeEntity> create focustime|outofoffice ... timerange <Time> <Time> to check that the first <Time> is less than the second Time; previously the event was not created.

For new installs the enforce_expansive_access Boolean variable in gam.cfg now defaults to True. For existing installations, if enforce_expansive_access has not been added to gam.cfg, a default value of True will be used.

7.09.02

Added command gam info chromeschema std <SchemaName> to display a Chrome policy schema in the same format as Legacy GAM.

Improved output of gam show chromeschemas [std] and gam info chromeschema [std] to more accurately display the schemas.

7.09.01

Fixed bug in gam <UserTypeEntity> print diskusage where the ownedByMe column was blank for the top folder.

Fixed bug in gam update chromepolicy where the following error was generated when updating policies with simple numerical values.

ERROR: Missing argument: Expected <value>"

7.09.00

Removed the overly broad service account IAM and Access Management API scope https://www.googleapis.com/auth/cloud-platform from DWD. The gam <UserTypeEntity> check|Update serviceaccount commands issue an error message if this scope is enabled prompting you to update your service account authorization so that the scope can be removed.

GAM commands that need IAM access now use the more limited scope https://www.googleapis.com/auth/iam in a non-DWD manner.

Added enforce_expansive_access Boolean variable to gam.cfg that provides the default value for option enforceexpansiveaccess in all commands that delete or update drive file ACLs/permissions. It's default value is False.

gam <UserTypeEntity> delete permissions
gam <UserTypeEntity> delete drivefileacl
gam <UserTypeEntity> update drivefileacl
gam <UserTypeEntity> copy drivefile
gam <UserTypeEntity> move drivefile
gam <UserTypeEntity> transfer ownership
gam <UserTypeEntity> claim ownership
gam <UserTypeEntity> transfer drive

Fixed bug in gam print shareddriveorganizers that caused a trap when an organizer was a deleted user.

Updated to Python 3.13.4

7.08.02

Updated the defaults in gam print shareddriveorganizers to match the most common use case, not the script.

  • domainlist - The workspace primary domain
  • includetypes - user
  • oneorganizer - True
  • shownoorganizerdrives - True
  • includefileorganizers - False

To select organizers from any domain, use: domainlist ""

These commands produce the same result.

gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers domainlist mydomain.com includetypes user oneorganizer shownoorganizerdrives
gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers

7.08.01

Added option shareddrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)) to gam print shareddriveorganizers that displays organizers for a specific list of Shared Drive IDs.

7.08.00

Added the following command that can be used instead of the GetTeamDriveOrganizers.py script.

gam [<UserTypeEntity>] print shareddriveorganizers [todrive <ToDriveAttribute>*]
        [adminaccess|asadmin] [shareddriveadminquery|query <QuerySharedDrive>]
        [orgunit|org|ou <OrgUnitPath>]
        [matchname <REMatchPattern>]
        [domainlist <DomainList>]
        [includetypes <OrganizerTypeList>]
        [oneorganizer [<Boolean>]]
        [shownorganizerdrives [false|true|only]]
        [includefileorganizers [<Boolean>]]
        [delimiter <Character>]

The command defaults match the script defaults:

  • domainlist - All domains
  • includetypes - user,group
  • oneorganizer - False
  • shownoorganizerdrives - True
  • includefileorganizers - False

For example, to get a single organizer from your domain for all Shared Drives including no organizer drives:

gam redirect csv ./TeamDriveOrganizers.csv print shareddriveorganizers domainlist mydomain.com includetypes user oneorganizer shownoorganizerdrives

7.07.17

Added option oneuserperrow to gam print devices to have each of a device's users displayed on a separate row with all of the other device fields.

7.07.16

Added chromeostype, diskspaceusage and faninfo to <CrOSFieldName> for use in gam info|print cros.

Fixed bugs/cleaned output in gam info|print cros.

7.07.15

Added option shareddrivesoption included|included_if_account_is_not_a_member|not_included to gam create vaultexport.

The previous option includeshareddrives <Boolean> is mapped as follows:

  • includeshareddrives false - shareddrivesoption included_if_account_is_not_a_member
  • includeshareddrives true - shareddrivesoption included

7.07.14

Update gam setup chat output to include the following that shows the actual Cloud Pub/Sub Topic Name.

You'll use projects/<ProjectID>/topics/no-topic in Connection settings Cloud Pub/Sub Topic Name

7.07.13

Added option showitemcountonly to gam [<UserTypeEntity>] print|show shareddrives that causes GAM to display the number of Shared Drives on stdout; no CSV file is written.

7.07.12

Fixed bug in gam print|show oushareddrives that caused a trap.

Improved getting Shared Drive names from IDs when accessing Shared Drives in external workspaces.

7.07.11

Updated gam calendars <CalendarEntity> update events and gam <UserTypeEntity> update events <UserCalendarEntity> to handle the following error:

ERROR: 400: badRequest - Bad Request

Updated gam <UserTypeEntity> move drivefile to handle the following error:

ERROR: 400: shareOutNotPermitted

7.07.10

Updated gam calendars <CalendarEntity> update events and gam <UserTypeEntity> update events <UserCalendarEntity> to handle the following error:

ERROR: 400: eventTypeRestriction - Attendees cannot be added to 'fromGmail' event with this visibility setting.

7.07.09

Updated gam calendars <CalendarEntity> update events and gam <UserTypeEntity> update events <UserCalendarEntity> to handle the following error:

gamlib.glgapi.serviceNotAvailable: Authentication backend unavailable.

7.07.08

Fixed bug in gam <UserTypeEntity> print filelist ... countsonly that issued an incorrect warning message like the following when redirect csv <FileName> multiprocess was specified.

WARNING: csv_output_row_filter column "^name$" does not match any output columns

7.07.07

Fixed bug in gam report <ActivityApplictionName> ... countsonly eventrowfilter that issued an incorrect warning message like the following when redirect csv <FileName> multiprocess was specified.

WARNING: csv_output_row_filter column "^doc_title$" does not match any output columns

7.07.06

Added option eventrowfilter to gam calendars <CalendarEntity> print events ... countsonly and gam <UserTypeEntity> print events <UserCalendarEntity> ... countsonly that causes GAM to apply config csv_output_row_filter to the event details rather than the event counts. This will be useful when <EventSelectProperty> and <EventMatchProperty> do not have the capabilty to select the events of interest; e.g., you want to filter based on the event created property.

Dropped the extraneous id column for gam calendars <CalendarEntity> print events ... countsonly and gam <UserTypeEntity> print events <UserCalendarEntity> ... countsonly.

7.07.05

Updated gam <UserTypeEntity> move drivefile to recognize the API error: ERROR: 400: shareOutWarning.

7.07.04

Updated gam create vaultexport ... rooms <ChatSpaceList> to strip spaces/ from the Chat Space IDs.

Updated gam <UserTypeEntity> copy drivefile to recognize the API error: ERROR: 400: shareOutWarning.

7.07.03

Updated gam create vaultexport to allow allow specifying a list of items in a search method with shareddrives|rooms|sitesurl select <FileSelector>|<CSVFileSelector>.

7.07.02

Fixed bug in redirect csv ... transpose where a CSV file with multiple rows was not properly transposed.

7.07.01

Fixed bug in gam print|show chromepolicies that caused a trap. Made additional updates to handle changes in the Chrome Policy API.

7.07.00

As of mid-October 2024, Google deprecated the API that retrieved the Global Address List.

The following commands have been eliminated.

gam info gal
gam print gal
gam show gal

These commands are a work-around for gam print gal.

gam config csv_output_row_filter "includeInGlobalAddressList:boolean:true" redirect csv ./UserGAL.csv print users fields name,gal
gam config csv_output_row_filter "includeInGlobalAddressList:boolean:true" batch_size 25 redirect csv ./GroupGAL.csv print groups fields name,gal

7.06.14

Updated gam create|update adminrole to allow specifying a collection of privileges with privileges select <FileSelector>|<CSVFileSelector> which makes copying roles much simpler.

Added option role <RoleItem> to gam print|show adminroles to allow display of information for a specific role.

7.06.13

Updated gam print group-members ... recursive and gam print cigroup-members ... recursive to expand groups representing chat spaces.

7.06.12

Deleted commands to display Analytic UA properties; the API has been deprecated.

gam <UserTypeEntity> print|show analyticuaproperties

7.06.11

Improved gam checkconn.

Updated gam print group-members and gam print cigroup-members to recognize members that are groups representing chat spaces. For now, these groups are not expanded when recursive is specified.

7.06.10

Added the following license SKU.

1010020034 - Google Workspace Frontline Plus

7.06.09

Added gemini and geminiforworkspace to <ActivityApplicationName> for use in gam report <ActivityApplicationName>.

7.06.08

Fixed problem where Yubikeys caused a trap.

7.06.07

Updated private key rotation progress messages in gam create|use|update project and gam upload sakey.

Updated gam use project to display the following error message when the specifed project already has a service account.

Re-run the command specify a new service account name with: saname <ServiceAccountName>'

7.06.06

Native support for Windows 11 Arm-based devices.

Renamed some macOS and Linux binary installer files to align on terminology. Everything is "arm64" now, no "aarch64".

7.06.05

Updated code in gam delete|update chromepolicy to handle the policyTargetKey[additionalTargetKeys] field in a more general manner for future use.

7.06.04

Fixed bug in gam report <ActivityApplictionName> where a report with no activities was not displaying any output.

7.06.03

Fixed bug in gam <UserTypeEntity> print|show drivelastmodification that caused a trap when an empty drive was specified.

7.06.02

Updated gam <UserTypeEntity> print|show filecounts ... showlastmodification to include file mimetype and path information for the last modified file.

Added simple commands to get information about the last modified file on a drive. By default, a user's My Drive is processed; optionally, a Shared Drive can be processed.

gam <UserTypeEntity> print drivelastmodification [todrive <ToDriveAttribute>*]
        [select <SharedDriveEntity>]
        [pathdelimiter <Character>]
        (addcsvdata <FieldName> <String>)*
gam <UserTypeEntity> show drivelastmodification
        [select <SharedDriveEntity>]
        [pathdelimiter <Character>]

7.06.01

Updated gam <UserTypeEntity> create|update drivefileacl ... expiration <Time> to handle additional API errors.

Updated to Python 3.13.3.

7.06.00

Upgraded to OpenSSL 3.5.0.

Fixed bug in gam print cigroups where createTime, updateTime and statusTime were not converted according to gam.cfg timezone.

7.05.22

Updated progress messages for gam <UserTypeEntity> print filelist|filecounts|filesharecounts|filetree select shareddriveid <SharedDriveID> to display the ID of the SharedDrive that is being accessed.

Getting all Drive Files/Folders for user@domain.com on Shared Drive ID: <SharedDriveID
Got 33 Drive Files/Folders for user@domain.com on Shared Drive ID: <SharedDriveID>...

7.05.21

Fixed bug in gam update chromepolicy that generated an error like the following when JSON data was read from a file.

ERROR:  JSON: {'error': {'code': 400, 'message': 'Invalid enum value: {prefix}{value} for enum type: chrome.policy.api.v1.devicepolicy.AllowNewUsersEnum', 'status': 'INVALID_ARGUMENT'}}

Fixed bug in gam create chromepolicyimage that caused a trap.

7.05.20

Updated code to validate both <RegularExpression> and <ReplacementString> in the following command line options; this will expose errors when the command is being parsed rather than at run-time.

replaceregex <RegularExpression> <ReplacementString>
replacedescription <RegularExpression> <ReplacementString>
replacefilename <RegularExpression> <ReplacementString>

7.05.19

Added replaceregex <RegularExpression> <ReplacementString> <Tag> <String> to the following commands:

gam sendemail subject <String> <MessageContent>
gam <UserTypeEntity> sendemail subject <String> <MessageContent>

The <RegularExpression> is used as a match pattern against <String> to produce <ReplacementString>. Instances of {Tag} will be replaced by <ReplacementString> in the message subject and body.

Added replaceregex <RegularExpression> <ReplacementString> <Tag> <UserReplacement> to the following commands:

gam create user <NotifyMessageContent>
gam update user <NotifyMessageContent>
gam update users <NotifyMessageContent>
gam <UserTypeEntity> update users <NotifyMessageContent>
gam <UserTypeEntity> draft message <MessageContent>
gam <UserTypeEntity> import message <MessageContent>
gam <UserTypeEntity> insert messageo <MessageContent>
gam <UserTypeEntity> create sendas <SendAsContent>
gam <UserTypeEntity> update sendas <SendAsContent>
gam <UserTypeEntity> signature <SignatureContent>
gam <UserTypeEntity> vacation subject <String> <VacationMessageContent>

The <RegularExpression> is used as a match pattern against <UserReplacement> to produce <ReplacementString>. Instances of {Tag} will be replaced by <ReplacementString> in the indicated items.

For example, when adding a phone number to a signature, an unformatted number can be formatted:

replaceregex "(\d{3})(\d{3})(\d{4})" "(\1) \2-\3" Phone "9876543210"
replaces 9876543210 with (987) 654-3210

replaceregex "(\+\d{2})(\d{3})(\d{3})(\d{3})" "\1 \2 \3 \4" Phone "+61987654321"
replaces +61421221506 with +61 987 654 321

7.05.18

Updated gam calendars <CalendarEntity> show events and gam <UserTypeEntity> show events to display the event description according to show_convert_cr_nl in gam.cfg; previously, GAM assumed show_convert_cr_nl = true.

show_convert_cr_nl = false
description:
  Line 1
  Line 2
  Line 3

show_convert_cr_nl = true
description: Line 1\nLine 2\nLine 3\n

7.05.17

Updated commands that delete drive ACLs to handle the following error:

ERROR: 403: cannotDeletePermission - The authenticated user does not have the required access to delete the permission.

7.05.16

Added option transpose [<Boolean>] to redirect csv that causes GAM to transpose CSV output rows and columns. This will most useful when a countsonly option is used in a print or report command.

7.05.15

Updated gam <UserTypeEntity> get drivefile and gam <UserTypeEntity> create drivefile to allow downloading and uploading of Google Apps Scripts.

$ gam user user1@domain.com get drivefile 1ZY-YkS3E0OKipALra_XzfIh9cvxoILSbb8TRdHBFCpyB_mXI_J8FmjHv format json
User: user1@domain.com, Download 1 Drive File
  User: user1@domain.com, Drive File: Test Project, Downloaded to: /Users/gamteam/GamWork/Test Project.json, Type: Google Doc
$ gam user user2@domain.com create drivefile localfile "Test Project.json" mimetype application/vnd.google-apps.script+json drivefilename "Test Project"
User: user2@domain.com, Drive File: Test Project(1Ok_svw55VTreZ5CzcViJDLfEzVRi-Un8D9eG6I5pIeVyRl2YsmNiy3C_), Created with content from: Test Project.json

7.05.14

Added the following License SKU:

ProductId SKUId Display Name
101039 1010390002 Assured Controls Plus

7.05.13

Updated license product names to match Google.

7.05.12

Fixed bug in gam update chromepolicy where appid was misinterpreted for chrome.devices.kiosk policies and an error was generated.

ERROR: Chrome Policy Schema: customers/C123abc456/policySchemas/<Field>, Does not exist

7.05.11

Added the following License SKUs:

ProductId SKUId Display Name
Google-Apps 1010070001 Google Workspace for Education Fundamentals
Google-Apps 1010070004 Google Workspace for Education Gmail Only
101034 1010340007 Google Workspace for Education Fundamentals - Archived User

7.05.10

Updated various chat space commands to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable

7.05.09

Fixed bug in gam calendars <CalendarEntity> print events matchfield attendeesstatus required accepted resource_calendar@resource.calendar.google.com that caused a trap.

7.05.08

Added error message to gam report commands to indicate forbidden access; previously, no error message was displayed.

ERROR: Customer ID: C012abc34, Caller does not have access to the customers reporting data.

7.05.07

Fixed bug in gam calendars <CalendarEntity> info events and gam <UserTypeEntity> info events where option showdayofweek was not recognized.

7.05.06

Improve message displayed when a command is issued that requires Google Chat Bot setup; display a link to the Wiki Set up a Chat Bot instructions.

7.05.05

Added options password prompt and password uniqueprompt to gam create user <EmailAddress> and gam update users <UserTypeEntity> that prompt you to enter a password from stdin.

See User Passwords

7.05.04

Updated gam calendars <CalendarEntity> update events and gam <UserTypeEntity> update events to handle the following error:

ERROR 400: malformedWorkingLocationEvent - A working location event must have a visibility setting of public.

7.05.03

Fixed bug in gam all users print users issuspended false allfields that caused a trap.

7.05.02

Chat usage reports are now available. Added chat to <CustomerServiceName> and <UserServiceName> for use in gam report customer|user.

7.05.01

Updated from v1beta1 to v1 for Cloud Identity - Policy.

7.05.00

Enabled support for Limited Access as described here:

Note that the rollout may take 15 days.

Added option inheritedpermissionsdisabled [<Boolean>] to <DriveFileAttribute>; this attribute can be set on folders.

Added inheritedpermissionsdisabled to <DriveFieldName>.

Added capabilities.candisableinheritedpermissions and capabilities.canenableinheritedpermissions to <DriveCapabilitiesSubfieldName>.

Added option enforceexpansiveaccess [<Boolean>] to all commands that delete or update drive file ACLs/permissions.

gam <UserTypeEntity> delete permissions
gam <UserTypeEntity> delete drivefileacl
gam <UserTypeEntity> update drivefileacl
gam <UserTypeEntity> copy drivefile
gam <UserTypeEntity> move drivefile
gam <UserTypeEntity> transfer ownership
gam <UserTypeEntity> claim ownership
gam <UserTypeEntity> transfer drive

7.04.05

Added initial support for Meet API v2beta; you must be in the Developer Preview program for this to be effective.

Added meet_v2_beta Boolean variable to gam.cfg. When this variable is true, the following options are added to <MeetSpaceOptions> used in gam <UserTypeEntity> create|update meetspace.

        moderation <Boolean> |
        chatrestriction hostsonly|norestriction |
        reactionrestriction hostsonly|norestriction |
        presentrestriction hostsonly|norestriction |
        defaultjoinasviewer <Boolean> |
        recording <Boolean> |
        transcription <Boolean> |
        smartnotes <Boolean>

This isn't called beta for nothing, I have found problems and reported them.

7.04.04

Updated gam print group-members|cigroup-members to include the email column when fields <MembersFieldNameList> did not include email.

7.04.03

Added option minimal|basic|full to gam print cigroup-members:

  • minimal - Fields displayed: group, id, role, email
  • basic - Fields displayed: group, type, id, role, email
  • full - Fields displayed: group, type, id, role, email, createTime, updateTime; this is the default

Added option minimal|basic|full to gam show cigroup-members:

  • minimal - Fields displayed: role, email
  • basic - Fields displayed: type, role, email
  • full - Fields displayed: type, role, email, createTime, updateTime; this is the default

Upgraded gam print cigroup-members ... recursive to display sub-group email addresses rather than IDs.

7.04.02

Improved output formatting for the following commands:

gam info peoplecontact
gam show peoplecontacts
gam info peopleprofile
gam show peopleprofile
gam <UserTypeEntity> info contacts
gam <UserTypeEntity> show contacts
gam <UserTypeEntity> show peopleprofile

7.04.01

Fixed bug where multiple querytime<String> values in a query were not properly processed; only the last querytime<String> was processed.

Command line: query "sync:#querytime1#..#querytime2# status:provisioned" querytime1 -2y querytime2 -40w
Query: (sync:#querytime1#..2024-05-09T00:00:00 status:provisioned) Invalid

7.04.00

The Classic Sites API no longer functions, the following commands are deprecated:

gam [<UserTypeEntity>] create site
gam [<UserTypeEntity>] update site
gam [<UserTypeEntity>] info site
gam [<UserTypeEntity>] print sites
gam [<UserTypeEntity>] show sites
gam [<UserTypeEntity>] create siteacls
gam [<UserTypeEntity>] update siteacls
gam [<UserTypeEntity>] delete siteacls
gam [<UserTypeEntity>] info siteacls
gam [<UserTypeEntity>] show siteacls
gam [<UserTypeEntity>] print siteacls
gam [<UserTypeEntity>] print siteactivity

7.03.09

Added option maxmessagesperthread <Number> to gam <UserTypeEntity> print|show threads that limits the number of messages displayed per thread. The default is 0, there is no limit. For example, this can be used if you only want to see the first message of each thread.

gam user user@domain.com print|show threads maxmessagesperthread 1

Fixed bug in gam <UserTypeEntity> print filelist countsonly where extraneous columns were displayed.

Fixed bug in gam <UserTypeEntity> print filelist countsonly showsize where sizes were all shown as 0 unlesssizefield size was specified.

7.03.08

Improved pip install.

Yubikey as optional should now be working also. So:

pip install --upgrade gam7

skips Yubikey.

To install with yubikey support (assuming you have installed the necessary swig and libpcsclite-dev packages already) run:

pip install --upgrade gam7[yubikey]

7.03.07

Updated gam create vaultexport to include corpus gemini.

7.03.06

Added option rawfields "<BrowserFieldNameList>" to gam info|print|show browsers that allows specification of complex field lists with selected subfields.

7.03.05

Make GAM pip-installable: "pip install gam7"

7.03.04

Added option security to gam create cigroup that allows creation of a security group in a single command.

Updated to Python 3.13.2.

7.03.03

Fixed bug in gam update resoldcustomer that caused the following error:

ERROR: Got an unexpected keyword argument customerAuthToken

7.03.02

Updated gam <UserTypeEntity> show labels nested to properly display label nesting when labels have embedded / characters in their names.

7.03.01

Updated gam create project to retry the following unexpected error:

ERROR: 400 - invalidArgument - Service account gam-project-a1b2c@gam-project-a1b2c.iam.gserviceaccount.com does not exist.

7.03.00

Updated gam create|use project to discontinue use of the Identity-Aware Proxy (IAP) OAuth Admin APIs that are being deprecated by Google. You will see a set of instructions detailing how to configure the Oauth Consent screen and create the Oauth client.

Added options copypermissionroles <DriveFileACLRoleList> and copypermissiontypes <DriveFileACLTypeList> to gam <UserTypeEntity> copy drivefile that provide more control over what permissions are copied from the source files/folders to the destination files/folders.

7.02.11

Updated gam report <ActivityApplicationName> to display id:<actor.profileId> in the emailAddress column when actor.email is empty. This typically occurs when the actor is not in your workspace.

Updated gam <UserTypeEntity> copy drivefile to ignore ACLs referencing deleted user/groups.

7.02.10

Added option bydate to gam report <ActivityApplicationName> ... countsonly that provides an additional display option.

  • countsonly - Display a row per user across all dates with all event counts on one row
  • countsonly bydate - Display a row per user per date for all dates with any events with all events counts on the row
  • countsonly summary - Display a row per event with counts for each event summarized across users and dates

7.02.09

Added option clearresources to <EventUpdateAttribute> for use in gam <UserTypeEntity> update events that allows clearing all resources from a user's calendar events. For example, to clear all resources from a user's future events:

gam user user@domain.com update events primary matchfield attendeespattern @resource.calendar.google.com after now clearresources

Added option resource <ResourceID> to <EventAttribute> for use in gam <UserTypeEntity> create|update events that adds a resource to an event.

Added option removeresource <ResourceID> to <EventUpdateAttribute> for use in gam <UserTypeEntity> update events that removes a resource from an event.

7.02.08

Fixed bug in gam print|show chromepolicies that caused a trap when neither ou|orgunit <OrgUnitItem> nor group <GroupItem> was specified.

7.02.07

Updated gam delete|update chromepolicy to display the <AppID> or <PrinterID> (if specified) in the command status messages.

7.02.06

Added option <JSONData> to gam <UserTypeEntity> create|update form that allows for creation/modification of all fields in a form. <JSONData> is a list of form update requests.

7.02.05

Updated gam [<UserTypeEntity>] show shareddriveacls ... formatjson to not display this line which interferes with the JSON output.

User: user@domain.com, Show N Shared Drives

7.02.04

Updated code to eliminate trap caused by bug introduced in 7.02.00 that occurs when an invalid domain or OU is specified.

7.02.03

Added option archive to gam <UserTypeEntity> update license <NewSKUID> from <OldSKUID> that causes GAM to archive <UserTypeEntity> after updating their license to <NewSKUID>. This will be used when you want to archive a user with a non-archivable license. The <NewSKUID> license is assigned to the user and it then converts to the equivalent Archived User license when the user is archived.

<NewSKUID> must be one of the following SKUs:

Google-Apps-Unlimited - G Suite Business
1010020020 - Google Workspace Enterprise Plus
1010020025 - Google Workspace Business Plus
1010020026 - Google Workspace Enterprise Standard
1010020027 - Google Workspace Business Starter
1010020028 - Google Workspace Business Standard

7.02.02

Updated gam <UserTypeEntity> archive messages <GroupItem> to retry the following unexpected error that occurs after many messages have been successfully archived. ERROR: 404: notFound - Unable to lookup group

7.02.01

Added options locked and unlocked to gam update cigroups that allow locking/unlocking groups.

You'll have to do a gam oauth create and enable the following scope to use these options:

[*] 22)  Cloud Identity Groups API Beta (Enables group locking/unlocking)

7.02.00

Improved the error message displayed for user service account access commands when:

  • The API is not enabled
  • The user does not exist
  • The user exists but is in a OU where the service is disabled

7.01.04

Admin role assignments are now in the v1 stable API, use that and remove custom local workaround for the beta. #1724

Remove duplicate local JSON discovery files. #1724

Suppress "UserWarning: Attribute's length must be..." messages on service accounts with long emails. #1725

Added options internal, internaldomains <DomainNameList> and external to these commands that expand the options for viewing group members:

gam info group
gam print groups
gam print|show group-members
gam info cigroup
gam print cigroups
gam print|show cigroup-members

By default, when listing group members, GAM does not take the domain of the member into account.

  • internal internaldomains <DomainNameList> - Display members whose domain is in <DomainNameList>
  • external internaldomains <DomainNameList> - Display members whose domain is not in <DomainNameList>
  • internal external internaldomains <DomainNameList> - Display all members, indicate their category: internal or external
  • internaldomains <DomainNameList> - Defaults to value of domain in gam.cfg

Members without an email address, e.g. customer, chromeosdevice and cbcmbrowser are considered internal.

Updated to Python 3.13.1.

7.01.03

Fixed bug in gam update cigroups <GroupEntity> delete|sync|update where cbcmbrowser and chromeosdevice addresses were not properly handled.

7.01.02

Added option positivecountsonly to gam <UserTypeEntity> print|show filecomments that causes GAM to display the number of comments and replies only for files that have comments.

Added my_commentable_items to <DriveFileQueryShortcut> that can be used with gam <UserTypeEntity> print|show filecomments my_commentable_items to speed up processing.

Updated code that uses the Domain Shared Contacts API with an HTTPS proxy to avoid a trap:

Traceback (most recent call last):
...
File "atom/http.py", line 250, in _prepare_connection
AttributeError: module 'ssl' has no attribute 'wrap_socket'

7.01.01

Fixed bug in gam <UserTypeEntity> print|show filetree where no error message was generated if a user had Drive disabled.

7.01.00

Fixed bug in gam update chromepolicy that caused some policy updates to fail.

Added option showhtml to gam <UserTypeEntity> print|show messages that, when used with showbody, will display message body content of type HTML.

Added support for managing/displaying Chrome profiles.

7.00.40

Updated gam <UserTypeEntity> update serviceaccount to properly set the readonly scope for [R] 35) Meet API (supports readonly) as it is a special case.

7.00.39

Supported macOS versions are now in the download filename.

Minor code fixes.

7.00.38

Fixed logic flaw in gam print|show policies where non-matching policies were displayed.

7.00.37

Added options group <RegularExpression> and ou|org|orgunit <RegularExpression> to gam print|show policies that causes GAM to only display policies whose group email address or OU path match the <RegularExpression>.

Updated gam get|update|delete contactphotos to use the People API for domain shared contact photos as Google has deprecated the Domain Shared Contacts API for these commands. Unfortunately, the People API fails with gam update|delete contactphotos.

7.00.36

Updated gam print chromeapps to correct a trap caused by an API change.

7.00.35

Classification labels are now available for Gmail in addition to Drive.

The following command synonyms are available, there is no change in functionality:

gam [<UserTypeEntity>] info classificationlabels|drivelabels
gam [<UserTypeEntity>] print classificationlabels|drivelabels
gam [<UserTypeEntity>] show classificationlabels|drivelabels
gam [<UserTypeEntity>] create classificationlabelpermission|drivelabelpermission
gam [<UserTypeEntity>] delete classificationlabelpermission|drivelabelpermission
gam [<UserTypeEntity>] remove classificationlabelpermission|drivelabelpermission
gam [<UserTypeEntity>] print classificationlabelpermissions|drivelabelpermission
gam [<UserTypeEntity>] show classificationlabelpermissions|drivelabelpermission

7.00.34

Fixed bug introduced in 7.00.33 in gam print group-members that caused a trap.

7.00.33

Fixed bug in gam print group-members ... cachememberinfo that caused a trap.

7.00.32

Updated gam info policies to accept different policy specifications:

  • polices/<String> - A policy name, policies/ahv4hg7qc24kvaghb7zihwf4riid4
  • settings/<String> - A policy setting type, settings/workspace_marketplace.apps_allowlist
  • <String> - A policy setting type, workspace_marketplace.apps_allowlist

7.00.31

Updated gam info|print|show policies to make additional API calls for settings/workspace_marketplace.apps_allowlist to get the application name for the application ID. Use option noappnames to suppress these calls.

7.00.30

Added command to display selected Cloud Identity policies.

gam info policies <CIPolicyNameEntity>
        [nowarnings]
        [formatjson]

Removed option name <CIPolicyName> from gam print|show policies; use info policies.

7.00.29

Added option name <CIPolicyName> to gam print|show policies that displays information about a specific policy.

7.00.28

Fixed issue that caused gam print/show policies to fail on some group policies.

7.00.27

Updated gam <UserTypeEntity> collect orphans and all commands that print file paths to recognize that a file owned by a user that has no parents is not an orphan if sharedWithMeTime is set. This occurs when user A creates a file in a shared folder owned by user B and user B then removes user A's access to the folder.

Added commands to display Cloud Identity policies.

gam print policies [todrive <ToDriveAttribute>*]
        (filter <String>) [nowarnings]
        [formatjson [quotechar <Character>]]
gam show policies (filter <String>) [nowarnings]
        [formatjson]

7.00.26

Updated drive_dir in gam.cfg to allow the value . that causes redirect csv|stdout|stderr <FileName> to write <FileName> in the current directory without having to prefix <FileName> with ./.

Upgraded to OpenSSL 3.4.0 where possible.

7.00.25

Updated authentication process for gam print|show projects.

7.00.24

Updated gam print|show projects ... showiampolicies 0|1|3 to use non-service account authentication.

7.00.23

Updated gam <UserTypeEntity> create|delete chatmember to accept external (non-domain) email addresses.

7.00.22

Fixed bug in gam create vaultmatter ... showdetails that caused a trap.

7.00.21

Added csv_output_header_order variable to gam.cfg that is a list of <Strings> that are used to specify the order of column headers in the CSV file written by a gam print command. Any headers in the file but not in the list will appear after the headers in the list.

This might be used when the CSV file data is to be processed by another program that requires that the headers be in a particular order.

7.00.20

Fix Windows MSI installer issues on version upgrade. If you are having issues upgrading from a version older than 7.00.20 to this version or newer you may need to do a one time uninstall of GAM7 and then reinstall the new version. No configuration files will be lost during the uninstall / reinstall.

7.00.19

Updated gam update shareddrive <SharedDriveEntity> ou <OrgUnitItem> to handle the following error that occurs when an invalid <SharedDriveEntity> is specified.

ERROR: 400: invalidArgument - Invalid org membership name 0AJ3b2FTPakToUk9PVAxx.~

Updated gam print browsers to properly format the time field deviceIdentifiersHistory.records.0.firstRecordTime.

7.00.18

Updated gam create project to use a default project name of gam-project-a1b2c (a1b2c is a random string of 5 characters) instead of gam-project-abc-123-xyz to avoid the following warning:

Project: gam-project-abc-123-xyz, Service Account: gam-project-abc-123-xyz@gam-project-abc-123-xyz.iam.gserviceaccount.com, Extracting public certificate
init.py:12382: UserWarning: Attribute's length must be >= 1 and <= 64, but it was 70
init.py:12383: UserWarning: Attribute's length must be >= 1 and <= 64, but it was 70
Project: gam-project-abc-123-xyz, Service Account: gam-project-abc-123-xyz@gam-project-abc-123-xyz.iam.gserviceaccount.com, Done generating private key and public certificate

7.00.17

Update all user calendar commands to disable falling back to client access if service account authorization has never been performed. Previously, in this circumstance, the admin's calendars rather than the user's calendars were processed.

7.00.16

Updated gam <UserTypeEntity> claim|transfer ownership to show Got N Drive Files/Folders that matched query messages as files/folders are being identified for processing.

Added option <JSONData> to gam create|update caalevel.

Updated to Python 3.13.0.

7.00.15

Added options timestamp [<Boolean>] and timeformat <String> to gam <UserTypeEntity> create|update drivefile that allow adding a timestamp to a created/updated file name.

7.00.14

Retry the following unexpected errors in gam print users.

ERROR: 400: failedPrecondition - Precondition check failed.
ERROR: 500: unknownError - Unknown Error.

7.00.13

Version bump in order to confirm MSI installs are operating properly

7.00.12

Updated option showlastmodification to gam <UserTypeEntity> print|show filecounts to handle the case where all users owning files are suspended. In this case the lastModifyingUser column will show the user's display name as the API doesn't return the user's email address.

Updated support for Folders with limited access; this is a work in progress.

Windows builds now use PyInstaller's onedir config for improved performance. You may notice a lib folder now exists underneath the GAM install path. GAM commands should start significantly faster.

7.00.11

Updated to Python 3.12.7 where possible.

7.00.10

Handled the following error that occurs when gam create user is immediateley followed by gam update user.

ERROR: 412: conditionNotMet - User creation is not complete.

Updated support for Folders with limited access; this is a work in progress.

7.00.09

Added initial support for Folders with limited access; you must be enrolled in the Beta preview.

Updated api_call_tries_limit variable to gam.cfg that limits the number of tries for Google API calls that return an error that indicates a retry should be performed. The default value is 10 and the range of allowable values is 3-30.

7.00.08

Fixed bug in gam <UserTypeEntity> delete groups that caused the command to fail when enable_dasa = true in gam.cfg.

7.00.07

Updated <PeopleContactAttribute> fields address,email,phone,url to allow an empty type field.

address "" formatted "My Address" primary
email "" user@gmail.com primary
phone "" "510-555-1212" primary
url "" "https://www.domain.com" primary

7.00.06

Updated gam <UserTypeEntity> create|update chatspace to support the new permissions settings for Chat spaces that are in Developer Preview.

7.00.05

Fixed bug that caused an error when creating a calendar birthday event.

7.00.04

Improved performance of gam report users orgunit <OrgUnitPath> when showorgunit is not specified.

Added option birthday <Date> to gam <UserTypeEntity> create event <UserCalendarEntity> that adds an annual recurring event to the calendar.

Added birthday to <EventType> for use in various calendar event commands.

7.00.03

Updated gam delete ou and gam print admins to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

7.00.02

Added option showlastmodification to gam <UserTypeEntity> print|show filecounts that adds the following fields to the output: lastModifiedFileId,lastModifiedFileName,lastModifyingUser,lastModifiedTime; these are for the most recently modified file.

Added option keepforever [<Boolean>] to gam <UserTypeEntity> update filerevisions that allows setting Keep forever in revisions.

Upgraded to Python 3.12.6 where possible.

7.00.01

Added option shownames to gam <UserTypeEntity> print|show sheet that causes GAM to make an additional API call to get and display the sheet file name that is not supplied by the Sheets API.

7.00.00

Merged GAM-Team version

6.81.02

Updated gam update group postmaster@domain.com to handle the error that is generated.

6.81.01

Fixed bug in gam <UserTypeEntity> create meetspace that caused errors due to Developer Preview options being included.

6.81.00

Added support for groups when defining Chrome policies.

Added support for the Meet API.

Added option countsonly to the following course commands that displays the number of items in a course but not the details of the items.

gam print course-announcements
gam print course-materials
gam print course-submissions
gam print course-topics
gam print course-work

6.80.21

Updated gam <UserTypeEntity> archive messages to handle the following error:

googleapiclient.errors.MediaUploadSizeError: Media larger than: 26214400

6.80.20

Updated gam report usage user and gam report users to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.80.19

Fixed bug in gam create inboundssoprofile that caused a trap due to an unexpected API result.

Updated gam create inboundssoprofile ... returnnameonly to return inProgress if the API does not return a complete result.

Upgraded to OpenSSL 3.3.2 where possible.

6.80.18

Updated gam print|show admins to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.80.17

Updated gam <UserTypeEntity> modify messages to improve error handling.

6.80.16

Fixed bug in gam print vaultcounts that caused a trap.

6.80.15

Fixed bug in gam <UserTypeEntity> print filelist ... countsrowfilter that caused a trap.

Added option continueoninvalidquery [<Boolean>] to gam <UserTypeEntity> print filelist|filecounts that can be used in special cases where a query of the form query "'labels/mRoha85IbwCRl490E00xGLvBsSbkwIiuZ6PRNNEbwxyz' in labels" causes Google to issue an error saying that the query is invalid when, in fact, it is but the user does not have a license that suppprts drive file labels. When continueoninvalidquery` is true, GAM prints an error message and proceeds to the next user rather that terminating as it does now. Of course, if the query really is invalid, you will get the message for every user.

6.80.14

Updated gam <UserTypeEntity> print messages|threads to display all default headers even if no messages are to be displayed. This eliminates error messages of the following form that occurred because only the headers User,threadId,id were displayed.

WARNING: csv_output_row_filter column "^Date$" does not match any output columns

6.80.13

Added my_publishable_items to <DriveFileQueryShortcut> that can be used in gam <UserTypeEntity> print filerevisions to select only those items that can be published to the web: documents, forms, presentations(slides), spreadsheets. With row filtering, this allows identification of files that have been published outside your domain.

6.80.12

Updated gam print vaultcounts to correctly display accounts with errors.

6.80.11

Updated gam <UserTypeEntity> delete|purge|trash|untrash <DriveFileEntity> shortcutandtarget that when <DriveFileEntity is a shortcut, to have GAM validate that the shortcut and target can be successfully processed before proceeding.

6.80.10

Added option followshortcuts [<Boolean>] to gam <UserTypeEntity> print|show fileinfo|filepath <DriveFileEntity> that when true and <DriveFileEntity is a shortcut, causes GAM to display information about the target of the shortcut rather than the shortcut itself.

Added option shortcutandtarget [<Boolean>] to gam <UserTypeEntity> delete|purge|trash|untrash <DriveFileEntity> that when true and <DriveFileEntity is a shortcut, causes GAM to process the shortcut and the target of the shortcut.

6.80.09

Added options allschemas|(schemas|custom|customschemas <SchemaNameList>) to gam print group-members that display any custom schema values for the group members.

6.80.08

Updated gam print|show oushareddrives to display the Shared Drive ID, name and orgUnitPath as individual, separate entities in the output.

6.80.07

Updated dateheaderformat iso in gam <UserTypeEntity> info|print|show messages to include a colon between the hours and minutes in the timezone portion of the string as in all other time strings.

6.80.06

Added option tdreturnidonly [<Boolean>] to <ToDriveAttribute> that when true (the default), causes GAM to display only the uploaded file ID to stdout. This can be captured and used in subsequent commands, tdfileid <DriveFileID> that will update the same file.

6.80.05

Added option individualstudentcoursework copy|delete|maptoall to gam create|update course ... copyfrom that controls how individual student coursework in the copyfrom course is processed.

  • individualstudentcoursework copy - Copy individual student coursework; this is the default. You will get an error if a student is not a member of the course
  • individualstudentcoursework delete - Delete individual student coursework
  • individualstudentcoursework maptoall - Map individual student coursework to all student coursework

For convenience, setting individualstudentassignments sets all of the following to the same value: *individualstudentannouncements *individualstudentmaterials *individualstudentcoursework

6.80.04

Cleaned up progress messages in gam create|update course ... copyfrom.

6.80.03

Added option stripcrsfromname to gam <UserTypeEntity> print driveactivity that causes carriage returns, linefeeds and nulls to be stripped from file names.

6.80.02

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print filecounts that adds additional columns of data to the CSV file output.

Added options individualstudentannouncements copy|delete|maptoall and individualstudentmaterials copy|delete|maptoall to gam create|update course ... copyfrom that controls how individual student announcements and materials in the copyfrom course are processed.

  • individualstudentannouncements copy - Copy individual student announcements; this is the default. You will get an error if a student is not a member of the course
  • individualstudentannouncements delete - Delete individual student announcements
  • individualstudentannouncements maptoall - Map individual student announcements to all student announcements
  • individualstudentmaterials copy - Copy individual student materials; this is the default. You will get an error if a student is not a member of the course
  • individualstudentmaterials delete - Delete individual student materials
  • individualstudentmaterials maptoall - Map individual student materials to all student materials

6.80.01

Added options showstudentsaslist [<Boolean>] and delimiter <Character> to gam print course-work. By default, when course work is assigned to individual students, the student IDs are displayed in multiple indexed columns. Use these options to display the student IDs in a single column as a delimited list.

Updated gam <UserTypeEntity> vacation [<Boolean>] to make <Boolean> optional; this allows changes to other fields without affecting the current responder state.

Updated gam <UserTypeEntity> print|show vacation to avoid a trap when invalid start or end dates have been entered in the Gmail user interface. Invalid dates are represented as 1970-01-01.

6.80.00

Fixed bug in gam <UserTypeEntity> print users ... license ... formatjson that caused a trap.

Upgraded to Python 3.12.5 where possible.

6.79.12

Fixed bug in gam user admin@domain.com print chatspaces asadmin that caused the following error:

Chat Admin: admin@domain.com(asadmin), Print Failed: This method doesn't support non-admin user authentication. Authenticate with an admin account.

6.79.11

Fixed bug in gam <UserItem> print|show chatmembers where the filter <String> was not applied.

6.79.10

Updated commands to handle a trap that occurs when oauth2service.json specifies a YubiKey but the YubiKey is not inserted.

6.79.09

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print teamdriveacls that adds additional columns of data to the CSV file output. This can be used when ACLs for selected users are to be replaced with a different user email address.

6.79.08

Clarified action to perform messages when creating/deleting/updating licenses.

6.79.07

Added option totalonly to gam <UserTypeEntity> print|show groups that displays the user email address and the total number of groups to which it belongs. This is in contrast to countsonly that has to make an additional API call per group per user to get the user's role. When countsonly is specified, an additional column Total is displayed that is the sum of the role counts.

6.79.06

Fixed bug in gam calendars <CalendarEntity> update event ... removeattendee <EmailAddress> that caused a trap if the event had no attendees.

6.79.05

Updated gam <UserTypeEntity> empty drivetrash <SharedDriveEntity> to handle this error that occurs when the user is not a Manager of the Shared Drive.

ERROR: 403: insufficientFilePermissions - The user does not have sufficient permissions for this file.

6.79.04

Added options filename <FileName> and movetoou <OrgUnitItem> to gam check ou <OrgUnitItem> that causes GAM to create a batch file of GAM commands that will move any remaining items in ou <OrgUnitItem> to movetoou <OrgUnitItem>; executing the batch file will then allow ou <OrgUnitItem> to be deleted if desired.

6.79.03

Added column|field assignedToUnknown to gam print|show admins that will be True when the API assignedTo value can not be converted to an email address; it will be False when the email address is determinable.

6.79.02

Updated gam print admins to handle the following error that occurs when a service account admin no longer exists.

ERROR: 404: notFound - Requested entity was not found.

6.79.01

Updated commands that take <RoleItem> as an argument to take the value in any case, e.g., _SEED_ADMIN_ROLE or _seed_admin_role.

6.79.00

Updated code to work around a Cryptography library change that caused service account private key creation to fail.

6.78.00

Added command to check if an OU contains items; this is useful when tryng to delete an OU as it must not contain any items in order to be deleted.

6.77.18

Added option showitemcountonly to gam print domainaliases that causes GAM to display the number of domain aliasess on stdout; no CSV file is written.

6.77.17

Added option showitemcountonly to gam print domains that causes GAM to display the number of domains on stdout; no CSV file is written.

6.77.16

Fixed bug in gam <UserTypeEntity> print filelist that caused a trap.

6.77.15

Updated gam calendars <CalendarEntity> import event icaluid <iCalUID> json <JSONdata> to handle API constraints on recurring events.

6.77.14

Fixed bug in gam calendars <CalendarEntity> import event icaluid <iCalUID> json <JSONdata> that caused an error.

6.77.13

Updated gam <UserTypeEntity> print|show filecounts to reflect that Shared Drives now have a capacity of 500000 files/folders/shortcuts.

6.77.12

Fixed bug in gam <UserTypeEntity> print chatspaces todrive that caused an error.

6.77.11

Added option convertmbtogb to gam report usage customer|user and gam report customer|user that causes GAM to convert parameters expressed in megabytes (name ends with _in_mb) to gigabytes (name converted to _in_gb) with two decimal places.

6.77.10

Fixed bug in gam <UserTypeEntity> get profilephoto where data written to stdout, e.g. > filename, was not properly base64 encoded.

6.77.09

Added option usertokencounts to gam <UserTypeEntity> print|show tokens that causes GAM to display each user and their number of access tokens; there are no details.

6.77.08

Fixed bugs in gam <UserTypeEntity> delete chatmember <ChatSpace> ... group <GroupItem> and gam <UserTypeEntity> sync chatmember <ChatSpace> ... groups <GroupEntity> that caused an error.

6.77.07

Fixed bug in gam <UserTypeEntity> create chatmember <ChatSpace> ... group <GroupItem> that caused an error.

6.77.06

Updated gam update ou <OrgUnitItem> ... parent <OrgUnitItem> to handle the following error that occurs when parent <OrgUnitItem> is the same as or a sub-OU of ou <OrgUnitItem>.

ERROR: 412: conditionNotMet - OrgUnit hierarchy has cycle

6.77.05

Added option onlyusers <UserTypeEntity> to gam <UserTypeEntity> claim ownership <DriveFileEntity> that causes GAM to only claim ownership of files/folders owned by onlyusers <UserTypeEntity>. This option is multually exclusive with skipusers <UserTypeEntity>.

6.77.04

Fixed bug in gam report users ... range <Date> <Date> where an extraneous API call was made if a date was reached where no API data was available.

6.77.03

Thanks to jay, added the following Colab License SKUs:

1010500001 - Colab Pro
1010500002 - Colab Pro+

Thanks to Jay, updated gam print|show admins to properly display addresses of service accounts with admin role assignments.

Added option limitdatechanges <Integer> to gam report users|customers.

If no report is available for the specified date, can an earlier date be used?

  • `limitdatechanges -1' - Back up to earlier dates to find report data; this is the default.
  • `limitdatechanges 0 | nodatechange' - Do not report on an earlier date if no report data is available for the specified date.
  • `limitdatechanges N' - Back up to earlier dates to find report data; do not back up more than N times.

By default, when gam report user user <UserItem> is specified and no report data is available, there is no output. If csv_output_users_audit = true in gam.cfg, then a row with columns email,date will be displayed where date is the earliest date for which report data was requested.

6.77.02

Cleaned up problems with some of the new Chat API asadmin commands. Some remaining problems may require a Google fix.

6.77.01

Thanks to Jay, added column verificationCodesCount to gam <UserTypeEntity> print backupcodes that displays the number of available backup codes in addtion to the codes.

Added option countsonly that displays only the number of available backup codes but not the codes themselves.

Thanks to Jay, added option nokey to gam create project that creates a project with no service account key, oauth2service.json.

6.77.00

Added option individualstudentassignments copy|delete|maptoall to gam create|update course ... copyfrom that controls how individual student assignments in the copyfrom course are processed.

  • individualstudentassignments copy - Copy individual student assignments; this is the default. You will get an error if a student is not a member of the course
  • individualstudentassignments delete - Delete individual student assignments
  • individualstudentassignments maptoall - Map individual student assignments to all student assignments

Upgraded to Python 3.12.4 where possible.

Added option asadmin to the following Chat commands that allows admin access. These commands are in Developer Preview, your project must have Developer Preview enabled for the Chat API in order to use these commands.

gam <UserItem> delete chatspace asadmin
gam <UserItem> update chatspace asadmin
gam <UserItem> info chatspace asadmin
gam <UserItem> print|show chatspaces asadmin
gam <UserItem> create chatmember asadmin
gam <UserItem> delete|remove chatmember asadmin
gam <UserItem> update|modify chatmember asadmin
gam <UserItem> sync chatmembers asadmin
gam <UserItem> info chatmember asadmin
gam <UserItem> print|show chatmembers|asadmin

Added use_chat_admin_access Boolean variable to gam.cfg.

* When False, GAM uses user access when making all Chat API calls. For calls that support admin access,
    this can be overridden with the asadmin command line option.
* When True, GAM uses admin access for Chat API calls that support admin access; other calls will use user access.
* Default: False

6.76.15

Fixed bug in gam <UserTypeEntity> print|show filesharecounts summary only summaryuser <String> that printed an erroneous row if <UserTypeEntity> specified a single user and <String> matched the user's email address.

6.76.14

Added the following Gemini License SKUs:

1010470004 - Gemini Education
1010470005 - Gemini Education Premium

6.76.13

Updated gam <UserTypeEntity> show fileinfo ... showlabels and gam <UserTypeEntity> print filelist ... showlabels to retry these errors that occur when trying to get the drive labels for a file/folder.

ERROR: 500: unknownError - Unknown Error.
ERROR: 503: serviceNotAvailable - The service is currently unavailable.

Upgraded to OpenSSL 3.3.1 where possible.

6.76.12

Fixed bug in gam <UserTypeEntity> print|show chatspaces that caused the following error:

ERROR: Got an unexpected keyword argument orderBy

6.76.11

Thanks to Jay, added gam report vault.

Thanks to Jay, added the following Gemini License SKUs:

1010470006 - AI Security
1010470007 - AI Meetings and Messaging

Updated gam <UserTypeEntity> print filelist ... showshareddrivepermissions to display progress messages to stderr as a separate API call must be made for every file/folder on the Shared Drive to get its permissions. As this can take a long time, the progress messages indicate that progress is being made.

6.76.10

Added fromgmail to <EventType> that can be used in gam calendars <CalendarEntity> print|show events ... eventtype fromgmail.

6.76.09

Updated gam update|delete|info adminrole to handle the following error:

ERROR: 400: failedPrecondition - Precondition check failed.

6.76.08

Updated <SchemaNameList> to "<SchemaName>|<SchemaFieldName>(,<SchemaName>|<SchemaFieldName>)*" that allows schemas <SchemaNameList> in gam info user and gam print users to display all fields or selected fields of the specified custom schemas.

6.76.07

Fixed bug where control-C was not recognized when GAM had processed all rows in a CSV file and was Waiting for N running processes to finish before terminating.

6.76.06

Fixed bug in gam <UserTypeEntity> print messages ... positivecountsonly where message counts with value 0 were deiplayed.

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print messages that adds additional columns of data to the CSV file output.

Added option showusagebytes to gam <UserTypeEntity> print|show drivesettings that displays the following fields in bytes usageBytes,usageInDriveBytes,usageInDriveTrashBytes in addition to the fields in their formatted form with units: usage,usageInDrive,usageInDriveTrash. This will be most useful with print as the rows can be sorted based on the usagexxxBytes columns.

6.76.05

Added options deletefromoldowner, addtonewowner <CalendarAttribute>* and nolistmessages to gam <UserTypeEntity> transfer calendars <UserItem> that allow manipulation of the old and new owners's calendar lists.

6.76.04

Added the following fields to <CrOSFieldName>:

autoupdatethrough
extendedsupporteligible
extendedsupportstart
extendedsupportenabled

6.76.03

Added option folderpathonly [<Boolean>] to the following commands that causes GAM to display only the folder names when displaying the path to a file. This folder only path an be used in gam <UserTypeEntity> create drivefolderpath to recreate the folder hierarchy.

gam <UserTypeEntity> info drivefile ... filepath|fullpath
gam <UserTypeEntity> show fileinfo ... filepath|fullpath
gam <UserTypeEntity> print|show filepath
gam <UserTypeEntity> print filelist ... filepath|fullpath

6.76.02

Updated gam update group to handle the following error:

ERROR: 400: invalidArgument - Failed request validation in update settings: WHO_CAN_VIEW_MEMBERSHIP_CANNOT_BE_BROADER_THAN_WHO_CAN_SEE_GROUP

6.76.01

Fixed bug in gam create vaulthold matter <MatterItem> ... corpus calendar that caused a trap.

6.76.00

Updated versions of gam create|use project that use keyword options to also accept the following options to define non-default Service Account key characteristics.

(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION yubikey_serialnumber <String>)

6.75.05

Added option csv [todrive <ToDriveAttribute>*] to gam <UserTypeEntity> archive|delete|modify|spam|trash|untrash messages|threads that causes GAM to display the command results in CSV form.

6.75.04

Added a command to print user counts by OrgUnit. By default, all users in the workspace are counted; you can specify a domain to only count users in that domain.

gam print usercountsbyorgunit [todrive <ToDriveAttribute>*]
        [domain <String>]

Added option uploadattachments [<DriveFileParentAttribute>] to gam <UserTypeEntity> show messages|threads that causes GAM to upload all message attachments to the user's My Drive, the default, or to a specific folder. The existing option attachmentnamepattern <RegularExpression> can be used to select attachments to upload.

6.75.03

Fixed bug in gam batch|tbatch where the line sleep <Integer> in the batch file caused the error:

ERROR: Invalid argument: Expected <gam|commit-batch|print>

6.75.02

Updated gam report <ActivityApplictionName> to retry/handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.75.01

Added option admin <EmailAddress> to gam upload sakey.

6.75.00

Updated gam create project to simplify handling the situation where your workspace is configured to disable service account private key uploads.

Added command gam upload sakey to aid in this process.

6.74.02

Fixed bug in gam <UserTypeEntity> print shareddrives ... formatjson that caused a trap.

6.74.01

Updated gam create|update drivefileacl <DriveFileEntity> ... expiration <Time> to handle the following error caused by tryig to add an expiration time to a member of a Shared Drive.

ERROR: 403: expirationDateNotAllowedForSharedDriveMembers - Expiration dates are not allowed for shared drive members.

6.74.00

Added truncate_client_id Boolean variable to gam.cfg. Prior to version 6.74.00, GAM stripped '.apps.googleusercontent.com' from client_id in oauth2.txt and passed the truncated value in API calls. At Jay's suggestion this is no longer performed by default; setting truncate_client_id = true restores the previous behavior.

Do gam oauth delete and gam oauth create to set the untruncated value of client_id in oauth2.txt.

6.73.00

The Google Chat API has been updated so that chat members can now have their role set to manager.

6.72.16

Updated emailaddressList <EmailAddressList> and domainlist|notdomainlist <DomainNameList> in <PermissionMatch> to perform case-insensitive matches as the API is returning mixed case ACL email addresses in some cases.

6.72.15

Updated all commands that display tasks to display the due date in GMT as the time portion is not supported by the API and converting the due date to local time may display the wrong date.

Renamed license SKU 1010400001 from Beyond Corp Enterprise to Chrome Enterprise Premium.

6.72.14

Upgraded to Python 3.12.3 where possible.

6.72.13

Added the following option to <EventMatchProperty> that can be used to select events based on the domains of the attendees.

matchfield attendeesonlydomainlist <DomainNameList>

This returns true if all attendee's email addresses are in a domain in <DomainNameList>; for example this lets you look for events with attendees only in your internal domains.

6.72.12

Added the following options to <EventMatchProperty> that can be used to select events based on the domains of the attendees.

matchfield attendeesdomainlist <DomainNameList>
matchfield attendeesnotdomainlist <DomainNameList>

The first returns true if any attendee's email address is in a domain in <DomainNameList>; for example this lets you look for events with attendees in specific external domains.

The second returns true if any attendee's email address is in a domain other than those in <DomainNameList>; for example this lets you look for events with attendees not in your internal domains.

6.72.11

Added option oneitemperrow to 'gam print vaultholds` to have each of a hold's accounts displayed on a separate row with all of the other hold fields.

6.72.10

Added timeofdayrange=<HH:MM>/<HH:MM> and timeofdayrange!=<HH:MM>/<HH:MM> to <RowValueFilter> that allows CSV row filtering based on time-of-day.

6.72.09

Updated countsonly option of gam <UserTypeEntity> print|show notes to additionally display the total number of notes.

6.72.08

Added option countsonly to gam <UserTypeEntity> print|show notes that displays the number of notes a user owns and the number of notes a user can edit.

6.72.07

Updated commands that send emails to not downshift 'First Last<firstlast@domain.com>' to 'first last<firstlast@domain.com>'.

6.72.06

Updated the following commands to properly handle emailaddress lists containing addresses of the form: 'First Last<firstlast@domain.com>'.

gam <UserTypeEntity> sendemail recipient|to <RecipientEntity> [cc <RecipientEntity>] [bcc <RecipientEntity>] [singlemessage]
gam create|update user ... notify <EmailAddressList>

6.72.05

Cleaned up code for all commands that display Chat objects.

6.72.04

Added commands to display Chat events.

6.72.03

Fixed bug in gam <UserTypeEntity> create chatspace that caused a trap.

6.72.02

Updated gam delete admin <RoleAssignmentId> to handle the following error that occurs when <RoleAssignmentId> references a user that has been deleted.

ERROR: 404: resourceNotFound - Does not exist

6.72.01

Improved commands to display drive file comments.

6.72.00

Added commands to display drive file comments.

6.71.18

Updated <CrOSFieldName> to include cpuinfo and backlightinfo.

6.71.17

Added depth column to output of gam <UserTypeEntity> print diskusage <DriveFileEntity> that can be used to filter the depth of the folders displayed. Depth -1 is the top level folder, depth 0 are its immediate children, depth 2 are the children of depth 1 and so forth.

gam config csv_output_row_filter "depth:count<1" user organizer@domain.com  print diskusage teamdriveid <TeamDriveID>

6.71.16

Updated gam <UserTypeEntity> create|update sendas <EmailAddress> ... replyto <EmailAddress> to allow uppercase letters in sendas <EmailAddress> and replyto <EmailAddress>.

6.71.15

Updated gam create project to handle the following error:

ERROR: 403: permissionDenied - Authentication error: 7; Error Details: User not allowed to access GCP services.

This error occurs when the Google Workspace admin or GCP project manager email address used in the command is in an OU where Google Cloud Platform is not enabled in Apps/Additional Google services.

6.71.14

Added a command to update a Gmail label's settings by specifying it's ID rather than it's name.

gam <UserTypeEntity> update labelid <LabelID> [name <String>]
        [messagelistvisibility hide|show] [labellistvisibility hide|show|showifunread]
        [backgroundcolor "<LabelColorHex>|<LabelBackgroundColorHex>|custom:<ColorHex>"]
        [textcolor "<LabelColorHex>|<LabelTextColorHex>|custom:<ColorHex>"]

6.71.13

Updated <UserMultiAttribute>.location.buildingid <String> to allow non-validated building IDs by specifying nv: at the beginning of <String>; e.g., nv:Building X' sets the building ID to Building X`.

6.71.12

Added option showmimetype category <MimeTypeNameList> to gam <UserTypeEntity> print|show filecounts|filelist|filetree

<MimeTypeName> ::= application|audio|font|image|message|model|multipart|text|video
<MimeTypeNameList> ::= "<MimeTypeName>(,<MimeTypeName>)*"

gam user user@domain.com print filelist fields id,name,mimetype showmimetype prefixes audio,video

Fix bug in gam <UserTypeEntity> info|show sheet <DriveFileEntity> that caused a trap.

6.71.11

Added option addcsvdata <FieldName> <String> to gam print cros that adds additional columns of data to the CSV file output. Typically, you would read CSV file of device IDs/serial numbers to generate a CSV file of results and copy data from the input CSV to the outout CSV.

6.71.10

Reverted change made in 6.71.09 to gam <UserTypeEntity> print filelist when showmimetype and filepath|fullpath were both specified. The change improved the performance when showmimetype selected a small number of files; the information for just those files was downloaded and then additional API calls were made to construct the file paths. However, if a large number of files were selected, the additional APIs calls decreased performance.

Added option mimetypeinquery can be used when you expect the query to return a small number of files relative to the total number of files.

6.71.09

Improved the performance of gam <UserTypeEntity> print filelist when showmimetype and filepath|fullpath are both specified.

6.71.08

Added option oneitemperrow to 'gam print admins|adminroles` to have each of a roles privileges displayed on a separate row with all of the other admin/role fields. This produces a CSV file that can be used in subsequent commands without further script processing.

6.71.07

Added command to upload changes to Google Docs.

6.71.06

Added additional error handling to Gmail Client Side Encryption commands.

Added license product Education Endpoint Management

  • ProductID - 101049

Added license SKU Endpoint Education Upgrade

  • ProductID - 101049
  • SKUID - 1010490001 | eeu

6.71.05

Fixed a bug introduced in 6.71.00 that caused a trap in gam <UserTypeEntity> print filelist.

Added option tdfrom <EmailAddress> to <ToDriveAttribute> that causes GAM to use <EmailAddress> as the from address in all emails sent. By default, the from address is the Google Workspace Admin in gam oauth info.o

6.71.04

Updated gam <UserTypeEntity> create|update cseidentity to accept either of the following key pair options:

  • primarykeypairid <KeyPairID> - The configuration of a CSE identity that uses the same key pair for signing and encryption.
  • signingkeypairid <KeyPairID> encryptionkeypairid <KeyPairID> - The configuration of a CSE identity that uses different key pairs for signing and encryption.

Updated CSV output row sorting to avoid a trap that occurred when a row was missing one of the sort fields.

6.71.03

Added option tdalert <EmailAddress> to <ToDriveAttribute>. When a todrive file is created or updated, GAM will send notification emails to all tdalert <EmailAddress> users if tdnotify is true. <EmailAddress> must be valid within your Google Workspace.

6.71.02

Added additional error handling to Gmail Client Side Encryption commands.

6.71.01

Fixed bug in gam audit monitor create that caused a trap.

6.71.00

Added csv_output_sort_headers string list variable to gam.cfg that causes GAM to sort CSV output rows by the column headers specified in the variable. The column headers are case insensitive and if column header does not appear in the CSV output, it is ignored.

Added sortheaders <StringList> to redirect csv <FileName> that has the same effect as above.

The sort keys specified in redirect csv ... sortheaders <StringList> take precedence over the values from gam.cfg.

Added option tdsubject <String> to <ToDriveAttribute> that causes GAM to use <String> as the subject in all emails sent. In <String>, #file# will, be replaced by the file title and #sheet# will be replaced by the sheet/tab title. By default, the subject is the file title.

6.70.09

Added additional error handling to Gmail Client Side Encryption commands.

Added options showpem and showkaclsdata to all Gmail CSE commands that process/display CSE key pairs. By default, the pem and kaclsdata fields will not be displayed unless the corresponding show option is specified.

6.70.08

Fixed bug in gam <UserTypeEntity> create cseidentity <KeyPairID> that caused an error.

6.70.07

Updated user instructions in gam oauth create and gam <UserTypeEntity> update serviceaccount and changed s from selecting all scopes to selecting default scopes.

6.70.06

Updated gam info users <UserTypeEntity> to not include group tree infornation unless option grouptree is specified.

6.70.05

Added commands to create|delete|display Drive Label permissions.

6.70.04

Added option showvalidcolumn to gam print users that can be used to identify whether users are defined in the domain. Typically, you would read CSV file of email addresses to verify as domain members.

Added option addcsvdata <FieldName> <String> to gam print users that adds additional columns of data to the CSV file output. Typically, you would read CSV file of email addresses to generate a CSV file of results and copy data from the input CSV to the outout CSV.

6.70.03

Renamed license product DuetAI to Gemini

  • ProductID - 101047

Renamed license SKU DuetAI for Google Workspace to Gemini Enterprise

  • ProductID - 101047
  • SKUID - 1010470001 | geminient | duetai

Added support for license SKU Gemini Business

  • ProductID - 101047
  • SKUID - 1010470003 | geminibiz

6.70.02

In 6.69.00, GAM starting using course owner access when using copyfrom in gam create|update course regardless of the value of gam.cfg/use_course_owner_access. This prevents copying from courses with a deleted user. GAM now uses the value of gam.cfg/use_course_owner_access when copyfrom is used.

6.70.01

Added gmail_cse_incert_dir and gmail_cse_inkey_dir path variables to gam.cfg that provide default values for the incertdir <FilePath> and inkeydir <FilePath> options in gam <UserTypeEntity> create csekeypair.

6.70.00

Added support for Gmail Client Side Encryption.

This is an initial, minimally tested release; proceed with care and report all issues.

6.69.00

Added use_course_owner_access Boolean variable to gam.cfg that controls how GAM gets classroom member information and removes students/teachers. Client/admin access does not provide complete information about non-domain students/teachers.

  • False - Use client/admin access; this is the default. Use if you don't have non-domain members in your courses.
  • True - Use service account access as the classroom owner. An extra API call is required per course to authenticate the owner; this will affect performance

Added the following command which must be used to delete classroom invitations for non-domain students/teachers.

gam delete classroominvitation courses <CourseEntity> (ids <ClassroomInvitationIDEntity>)|(role all|owner|student|teacher)

You can obtain the classroom invitation IDs with these commands:

gam show classroominvitations (course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
        [role all|owner|student|teacher] [formatjson]
gam print classroominvitations [todrive <ToDriveAttribute>*] (course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
        [role all|owner|student|teacher] [formatjson [quotechar <Character>]]

6.68.08

Updated gam <UserTypeEntity> print filelist|drivefileacls|shareddriveacls ... oneitemperrow to print ACLs with multiple permission details on separate rows for each basic permission/permission detail combination. This case occurs when a member of a Shared Drive has access to a file and also has explicitly granted access to the same file.

Added permtype member|file to <PermissionMatch> that allows determining whether an ACL on a Shared Drive file was derived from membership or explicitly granted.

6.68.07

Updated gam info user ... locations formatjson to include the buildingName field in the locations entries. If gam.cfg contains quick_info_user = true or the quick option is included on the command line, add the option buildingnames to the command line.

6.68.06

Fixed bug in gam <UserTypeEntity> copy drivefile <DriveFileID> ... mergewithparent that incorrectly named the copied file with the name of the parent folder.

Updated gam <UserTypeEntity> copy|move drivefile to avoid copying/moving the same file twice.

6.68.05

Updated gam print groups ... ciallfields|(cifields <CIGroupFieldNameList>) to account for an API shortcoming that failed to get all of the Cloud Identity fields.

6.68.04

Added option skiprows <Integer> to gam csv|loop that causes GAM to skip processing the first <Integer> filtered rows.

6.68.03

Fixed bug in gam <UserTypeEntity> create drivefileacl that caused a trap.

6.68.02

Upgraded to Python 3.12.2 where possible.

Added options restricted|(audience <String>) to gam <UserTypeEntity> create|update chatspace that sets the access options for the chat space. These options are in Developer Preview and will not be generally available.

6.68.01

Fixed <PermissionMatch> bug for real.

6.68.00

Fixed <PermissionMatch> bug introduced in 6.67.35 that caused a command error like the following or would not properly match type|nottype <DriveFileACLType> and role|notrole <DriveFileACLRole>.

ERROR: permission attribute allowfilediscovery/withlink not allowed with type {'a', 'y', 'e', 'o', 'n'}

My sincere apologies.

6.67.39

Added option wait <Integer> <Integer> to gam create datatransfer that causes GAM to wait for the transfer to complete. The first <Integer> must be in the range 5-60 and is the number of seconds between checks to see if the transfer has completed. The second <Integer> is the maximum number of checks to perform. By default, GAM does not wait for the transfer to complete.

6.67.38

Added option tdnotify [<Boolean>] to <ToDriveAttribute> that causes GAM to send notification emails to all tdshare <EmailAddress> users when the file is uploaded/updated.

6.67.37

Fixed bug in gam <UserTypeEntity> show messages ... showattachments to avoid a trap when text/plain attachments in character sets other than UTF-8 are displayed.

6.67.36

Updated gam batch <BatchContent> and gam tbatch <BatchContent> commands to accept lines with the following form:

sleep <Integer>

Batch processing will suspend for <Integer> seconds before the next command line is processed.

6.67.35

Added the following options to <PermissionMatch> that allow more powerful matching.

nottype <DriveFileACLType>
typelist <DriveFileACLTypeList>
nottypelist <DriveFileACLTypeList>
rolelist <DriveFileACLRoleList>
notrolelist <DriveFileACLRoleList>

6.67.34

Added option movetoorgunitdelay <Integer> to gam <UserTypeEntity> create shareddrive <Name> ... ou|org|orgunit <OrgUnitItem>. GAM creates the Shared Drive, verifies that it has been created and then tries to move it to <OrgUnitItem>. Google seems to require a delay or the following error is generated.

ERROR: 409: 409 - The operation was aborted.

movetoorgunitdelay defaults to 20 seconds which seems to work; <Integer> can range from 0 to 60.

6.67.33

Upgraded to OpenSSL 3.2.1 where possible.

Fixed bug in gam <UserTypeEntity> print shareddrives where role was improperly displayed as fileOrganizer rather than writer.

Added option guiroles [<Boolean>] to gam <UserTypeEntity> info|print|show shareddrive that maps the Drive API role names to the Google Drive GUI role names.

API: GUI
commenter: Commenter
fileOrganizer: Content manager
organizer: Manager
reader: Viewer
writer: Contributor

6.67.32

Updated <ToDriveAttribute> to allow multiple tdshare <EmailAddress> commenter|reader|writer options.

Fixed bug in gam <UserTypeEntity> print shareddrives where role was improperly displayed as unknown rather than reader when Allow viewers and commenters to download, print, and copy files was unchecked for the Shared Drive.

6.67.31

Updated gam <UserTypeEntity> claim|transfer ownership <DriveFileEntity> to properly handle the case where <DriveFileEntity> referencess a Drive shortcut.

6.67.30

Fixed bug where the fullpath option in various commands was not converting the generic shared drive name Drive to the drive's actual name.

6.67.29

Added optional argument owneraccess to gam courses <CourseEntity> remove teachers|students [owneracccess] <UserTypeEntity and gam course <CourseID> remove teacher|student [owneraccess] <EmailAddress> in order to test a possible API change.

Updated code to avoid a trap when gam config auto_batch_min 1 csv file.csv gam ... was entered. The config auto_batch_min 1 is not appropriate in this context and will be ignored.

6.67.28

Improved handling of Bad Request error in gam <UserTypeEntity> collect orphans.

6.67.27

Updated gam <UserTypeEntity> collect orphans to handle the following error:

ERROR: 400: badRequest - Bad Request

6.67.26

Fixed bug in gam print vaultexports ... formatjson that caused a trap.

6.67.25

Added option owneraccess to gam info courses <CourseEntity> and gam info course <CourseID> in order to test a possible API change.

6.67.24

Fixed bug that caused HTML password notification email messages to be displayed in raw form.

6.67.23

Use local copy of googleapiclient to remove static discovery documents to improve performance.

6.67.22

Added permissionidlist <PermissionIDList> to <PermissionMatch> that allows matching any permission ID in a list.

Added option exportlinkeddrivefiles <Boolean> to gam create vaultexport that is used with corpus mail.

6.67.21

Updated gam remove aliases <EmailAddress> user|group <EmailAddressEntity> to give a more informative error message when the target/alias combination does not exist.

Old: User: testsimple@domain.com, User Alias: tsalias@domain.com, Remove Failed: Invalid Input: resource_id
New: User: testsimple@domain.com, User Alias: tsalias@domain.com, Remove Failed: Does not exist

6.67.20

Added option onelicenseperrow|onelicenceperrow to gam print users ... licenses that causes GAM to print a seperate user information row for each license a user is assigned. This makes processing the licenses in a script possible and allows better sorting in a CSV File.

By default, all licenses for a user are displayed in a list on one row:

primaryEmail,LicensesCount,Licenses,LicensesDisplay
user@domain.com,2,1010020020 1010330004,Google Workspace Enterprise Plus Google Voice Standard

With onelicenseperrow|onelicenceperrow, each license is on a separate row:

primaryEmail,License,LicenseDisplay
user@domain.com,1010020020,Google Workspace Enterprise Plus
user@domain.com 1010330004,Google Voice Standard

6.67.19

Updated gam create|update user ... notify to encode the characters <>& in the password so that they display correctly when the notify message content is HTML.

6.67.18

Cleaned up Getting/Got messages for gam print courses|course-participants.

6.67.17

Added option showitemcountonly to various commands that causes GAM to display the item count on stdout; no CSV file is written.

6.67.16

By default, gam print group-members membernames displays Unknown for members whose names can not be determined. Added option unknownname <String> that let's you specify an alternative value.

Further improved performance of gam print group-members membernames cachememberinfo.

6.67.15

Update gam print group-members membernames to handle the following error:

ERROR: 400: failedPrecondition - Precondition check failed.

Added option cachememberinfo [Boolean] to gam print group-members that causes GAM to cache member info so that only one API call is made to get information for each user/group. This consumes more memory but dramatically reduces the number of API calls.

6.67.14

Updated reseller commands to handle the following error:

ERROR: 400: invalid - Customer domain [domain.com] is linked to one or more email verified customers, please provide a customer id.

6.67.13

Updated gam create domain <DomainName> to handle the following error:

ERROR: 409: conflict - Domain in request is in use by an email verified customer.

6.67.12

Added option addcsvdata <FieldName> <String> to gam print datatransfers that adds additional columns of data to the CSV file output.

6.67.11

Updated various Gmail related commands to handle this error:

ERROR: 403: permissionDenied - Insufficient Permission

when the following service account scopes are selected:

[ ] 23)  Gmail API - Basic Settings (Filters,IMAP, Language, POP, Vacation) - read/write, Sharing Settings (Delegates, Forwarding, SendAs) - read
[ ] 24)  Gmail API - Full Access (Labels, Messages)
[ ] 25)  Gmail API - Full Access (Labels, Messages) except delete message
[*] 26)  Gmail API - Full Access - read only
[ ] 27)  Gmail API - Send Messages - including todrive
[ ] 28)  Gmail API - Sharing Settings (Delegates, Forwarding, SendAs) - write

6.67.10

Fixed bug that caused a trap when optional argument charset <Charset> was used with emlfile <FileName> in gam <UserTypeEntity> draft|import|insert message.

6.67.09

Added option maxevents <Number> to gam report <ActivityApplictionName> that limits the number of events displayed for each activity; the default is 0, no limit. Setting options maxactivities 1 maxevents 1 maxresults 1 can be used to as efficiently as possible show the most recent activity/event; this can be useful when reporting drive activity for individual drive files.

6.67.08

Added optional argument charset <Charset> to emlfile <FileName> in gam <UserTypeEntity> draft|import|insert message; the default value is ascii.

6.67.07

Updated gam <UserTypeEntity> delete message to handle this error:

ERROR: 403: permissionDenied - Insufficient Permission

when the following service account scopes are selected:

[ ] 24)  Gmail API - Full Access (Labels, Messages)
[*] 25)  Gmail API - Full Access (Labels, Messages) except delete message

6.67.06

Updated commands that create ACLs to handle the following error:

ERROR: 400: abusiveContentRestriction - Bad Request. User message: "You cannot share this item because it has been flagged as inappropriate."

6.67.05

Updated the following commands:

gam <UserTypeEntity> create|delete|update delegate
gam <UserTypeEntity> forward
gam <UserTypeEntity> create|delete forwardingaddresses
gam <UserTypeEntity> create|delete sendas

to handle this error:

ERROR: 403: permissionDenied - Insufficient Permission

when the following serice account scope is not enabled:

[ ] 28)  Gmail API - Sharing Settings (Delegates, Forwarding, SendAs) - write

6.67.04

Updated user attribute replace <Tag> <UserReplacement> to allow field:photourl which allows embedding a link to a user's photo in their signature. Formatting the signature HTML to properly display the photo is left to the GAM admin.

6.67.03

Fixed bug introduced in 6.67.02 in gam <UserTypeEntity> claim ownership that caused a trap.

6.67.02

Added option skipids <DriveFileEntity> to gam <UserTypeEntity> copy drivefile that handles special cases where you want to prevent selected files/folders from being copied.

Updated commands that create files/folders on Shared Drives to handle the following errors:

storageQuotaExceeded
teamDriveFileLimitExceeded
teamDriveHierarchyTooDeep

6.67.01

Fixed bug in gam print vaultcounts that caused a trap.

6.67.00

Updated gam <CrOSTypeEntity> update action <CrOSAction> to use the new API function batchChangeStatus that replaces the old API function action; ChromeOS devices are now processed in batches. The batch size defaults to 10, the actionbatchsize <Integer> option can be used to set a batch size between 10 and 250.

Updated gam create vaultexport matter <MatterItem> to support corpus calendar.

6.66.16

Added option convertcrnl to gam update chromepolicy to properly handle carriage returns (\r) and line feeds (\n) in value strings entered on the command line in the <Field> <Value> form.

gam update chromepolicy convertcrnl chrome.devices.DisabledDeviceReturnInstructions
    deviceDisabledMessage "Please return device to:\nSchool\n123 Main Street\nAnytown US" ou /Path/to/OU

6.66.15

Added option copysubfilesownedby any|me|others to gam <UserTypeEntity> copy drivefile that allows specification of which source folder sub files to copy based on file ownership; the default is any. This only applies when files are being copied from a 'My Drive'.

6.66.14

Updated gam <UserTypeEntity> modify messages to recognize the following error:

ERROR: 400: invalid - Invalid label: SENT

Updated gam update alias <EmailAddressEntity> user|group|target <EmailAddress> to avoid the following problem.

$ gam update alias testalias@domain.com user testuser
User Alias: testalias@domain.com, Deleted
User Alias: testalias@domain.com, User: testuser@domain.com, Update Failed: Duplicate, Email Address: testalias@domain.com

GAM updates an alias to point to a new target by deleting the alias and then recreating the alias pointing to the new target. Unfortunately, if these commands are executed back-to-back; Google generates the Update Failed: Duplicate error. Now, GAM waits 2 seconds between the delete and the insert which seems to eliminate the problem. If the problem persists, the option waitafterdelete <Integer> can be used to increase the wait time to a maximum of 10 seconds.

6.66.13

Updated functionality of option preservefiletimes in gam <UserTypeEntity> update drivefile <DriveFileEntity>.

  • Current
    • preservefiletimes localfile <FileName> - modifiedTime of <DriveFileEntity> is set to that of localfile <FileName>
    • preservefiletimes - No effect
  • Updated
    • preservefiletimes localfile <FileName> - modifiedTime of <DriveFileEntity> is set to that of localfile <FileName>
    • preservefiletimes - modifiedTime of <DriveFileEntity> retains its current value

6.66.12

Upgraded to Python 3.12.1 where possible.

Updated all drive commands to handle the following error:

ERROR: 401: Active session is invalid. Error code: 4 - authError

This is due to the Drive SDK API being disabled in the user's OU.

6.66.11

Fixed/improved handling of shortcuts in gam <UserTypeEntity> transfer drive.

6.66.10

Updated gam create datatransfer to handle the following error:

ERROR: 401: Active session is invalid. Error code: 4 - authError

6.66.09

Fixed bug in gam <UserTypeEntity> print filelist ... allfields that caused a trap when gam.cfg contained drive_v3_native_names = False.

6.66.08

Added additional columns isBase and baseId to gam <UserTypeEntity> print fileparenttree to simplify processing the output in a script.

6.66.07

Fixed bug in gam <UserTypeEntity> print diskusage that caused a trap.

6.66.06

Added a command the print the parent tree of file/folder.

gam <UserTypeEntity> print fileparenttree <DriveFileEntity> [todrive <ToDriveAttribute>*]
        [stripcrsfromname]

6.66.05

Added column space.name to gam <UserTypeEntity> print chatmembers.

6.66.04

Updated Chat info|show|print commands to display all time fields in local time if specified in gam.cfg.

6.66.03

Fixed bug in gam <UserTypeEntity> print filelist select <DriveFileEntity> where stripcrsfromname was not being applied to files below the selected folder.

6.66.02

Updated device commmands to handle the following error caused by an invalid query.

ERROR: 400: invalidArgument - Request contains an invalid argument.

Added fields deviceid and hostname to <DeviceFieldName>.

6.66.01

Added the following variables to gam.cfg that allow control over whether \ is used as an escape character when reading/writing CSV files.

csv_input_no_escape_char - default value True
csv_output_no_escape_char - default value False
todrive_no_escape_char - default value True

When the value is True, \ is ignored as an escape character; when the value is False, \\ on input is converted to \, \ on output is converted to \\.

6.66.00

Added support for Focus Time and Out of Office status events in user's primary calendars.

Updated gam <UserTypeEntity> print|show messages to allow option show_size to be used with option countsonly to display the cumulative size of the messages selected.

gam user user@domain.com print messages query "newer_than:31d" countsonly showsize
Getting all Messages for user@domain.com
Got 16 Messagess for user@domain.com...
User,messages,size
user@domain.com,16,92806

6.65.17

Added the option mappermissionsdomain <DomainName1> <DomainName2> to gam <UserTypeEntity> create drivefileacl <DriveFileEntity> that maps <DomainName1> to <DomainName2> in the user <UserItem>)|(group <GroupItem>)|(domain <DomainName>) options; <UserItem> and <GroupItem> must specify email addresses for the mapping to succeed. The option can be specified multiple times to provide different mappings. This option will be most useful when reading a CSV file containing ACLs referencing <DomainName1> and you want a new ACL with the same options but in <DomainName2>.

6.65.16

Fixed bug in gam <UserTypeEntity> print filecounts where Item Cap showed an incorrect value.

Added option addorigfieldstosubject to gam <UserTypeEntity> forward messages|threads that causes GAM to append the original from, to and date fields to the message subject.

Fwd: Ross to TestUser (Original From: Ross Scroggs <ross.scroggs@gmail.com> To: testuser@domain.com Date: Thu, 23 Nov 2023 07:01:59 -0800)

6.65.15

Added additional options to gam <UserTypeEntity> print|show youtubechannels.

6.65.14

Fixed bug in gam copy|move drivefile` that caused a trap.

UnboundLocalError: cannot access local variable 'emailAddress' where it is not associated with a value

6.65.13

Added support for user language en-CA.

Added option sizefield quotabytesused|size to the following commands that specifies which file size field to use when totaling file sizes; the default value is quotabytesused; previous versions used size.

gam <UserTypeEntity> print|show filecounts
gam <UserTypeEntity> print filelist
gam <UserTypeEntity> print|show filetree
gam <UserTypeEntity> print diskusage

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Users-Drive-Files-Display#file-size-fields

6.65.12

Additional updates on macOS when a gam csv command is interrupted with a contol-C.

6.65.11

Updated multiprocessing to handle the following error that occurs on macOS when a gam csv command is interrupted with a contol-C.

multiprocessing/resource_tracker.py:224: UserWarning: resource_tracker: There appear to be N leaked semaphore objects to clean up at shutdown

Fixed bug in gam print|show crostelemetry where no CrOS device data was displayed if no selection options were chosen; now, data is displayed for all CrOS devices as documented.

6.65.10

Fixed bug in gam print crostelemetry that caused a trap: KeyError: 'reportTime'.

6.65.09

Added option noduplicate to gam <UserTypeEntity> create drivefile that causes GAM to issue a warning and not perform the create if a non-trashed item with the same name (regardless of MIME type) exists in the parent folder.

Updated gam <UserTypeEntity> get drivefile <DriveFileEntity> to handle the following error that seems to occur when multiple tabs from a Google sheet are being downloaded in parallel.

Download Failed: HTTP Error: 429

6.65.08

Added option addcsvdata <FieldName> <String> to gam report <ActivityApplicationName> that adds additional columns of data to the CSV file output.

Added option shownoactivities to gam report <ActivityApplicationName> that causes GAM to display a row with a key value of NoActivities when there are no activities to report.

For example, to find Shared Drives with no activity, see: https://github.com/taers232c/GAMADV-XTD3/wiki/Reports#find-shared-drives-with-no-activity

6.65.07

Updated gam delete building to handle the following error:

ERROR: 412: conditionNotMet - Cannot delete building because there are Calendar resources associated with it.

6.65.06

Improved error message when trying to add external students/teachers to a course.

gam courses 544906261666 add student user@gmail.com
Course: 544906261666, Add 1 Student
  Course: 544906261666, Student: user@gmail.com, Add Failed: 403: permissionDenied - @CannotDirectAddUser Unable to directly add the user to the course. Please check that the user account exists and is within the course admin's domain. Add external user with: gam user user@gmail.com create classroominvitation courses 544906261666 role Student

6.65.05

Updated gam info users <UserTypeEntity> to make option grouptree effective when used with option formatjson.

Added option [formatjson [quotechar <Character>]]] to these commands so that event details are displayed in CSV format.

gam print|show grouptree <GroupEntity>
gam <UserTypeEntity> print|show grouptree

Added option querytime<String> <Date> to all commands that process messages. For example, you can identify all messages within a particular time period, in this case, all messages unread in the last 30 days.

gam user user@domain.com  print messages querytime30d -30d query "after:#querytime30d# is:unread"

Updated gam <UserTypeEntity> import|insert message to allow replace <Tag> <UserReplacement> as documented.

Updated non-owner permission handling in gam <UserTypeEntity> copy|move drivefile.

6.65.04

Fixed bug where license SKU 1010020031 (Google Workspace Frontline Standard) was improperly entered making it unusable; its alias wsflwstan was usable.

Added support for Google Workspace Additional Storage.

  • ProductID - 101043
  • SKUID - 1010430001 | gwas | plusstorage

6.65.03

Fixed bug in commands that display calendar events where event start and end times were not properly displayed when gam.cfg had timezone utc. The API returns the start and end times expressed in the calendar timezone but GAM replaced the timezone specifier with a Z; the date and time values were as expected. This became a problem when event data was exported and used to create or update events.

6.65.02

Updated gam print|show browsers to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.65.01

Added option showmimetypesize to gam <UserTypeEntity> print|show filecounts and gam <UserTypeEntity> print filelist countsonly that displays the total file size for each MIME type.

6.65.00

Fixed bug in gam <UserTypeEntity> create contact <JSONData> that caused a trap when contacts were being copied from one user to another.

Updated the following commands to allow specification of a task list by its title.

<TaskListTitle> ::= tltitle:<String>
<TasklistTitleList> ::= "'<TasklistTitle>'(,'<TasklistTitle>')*"
<TasklistEntity> ::=
        <TasklistIDList> | <TaskListTitleList> | <FileSelector> | <CSVFileSelector>

gam <UserTypeEntity> create task <TasklistEntity>
gam <UserTypeEntity> show tasks [tasklists <TasklistEntity>]
gam <UserTypeEntity> print tasks [tasklists <TasklistEntity>]
gam <UserTypeEntity> update tasklist <TasklistEntity>
gam <UserTypeEntity> delete tasklist <TasklistEntity>
gam <UserTypeEntity> clear tasklist <TasklistEntity>
gam <UserTypeEntity> info tasklist <TasklistEntity>

6.64.16

Fixed bug in gam <UserTypeEntity> create task <TasklistIDEntity> that caused a trap when an invalid TaskListID was specified.

6.64.15

Updated lookerstudioassets|lookerstudiopermissions commands to handle the following error:

ERROR: 500: internalError - Internal error encountered.

6.64.14

Cleaned up and renamed gam info appdetails to gam info chromeapp.

6.64.13

Added command to get chrome app details.

gam info appdetails android|chrome|web <AppID> [formatjson]

6.64.12

Upgraded to Python 3.12.0 where possible. Upgraded to OpenSSL 3.1.3 where possible.

6.64.11

Added support for Google Workspace Labs license.

  • ProductID - 101047
  • SKUID - 1010470002 | gwlabs | workspacelabs

6.64.10

Fixed bug introduced in 6.64.09 that caused a trap when gam redirect csv <FileName> multiprocess was used.

6.64.09

Eliminated extraneous permisssions.0.xxxx headers in gam <UserTypeEntity> print filelist ... oneitemperrow that appeared when some user in <UserTypeEntity> had no files to display.

6.64.08

Fixed bug in redirect csv - todrive tdtitle "File Title" tdsheettitle "Sheet Title" where "Sheet Title" was not assigned to the new sheet.

6.64.07

Updated gam <UserTypeEntity> move drivefile to handle the following error:

ERROR: 403: targetUserRoleLimitedByLicenseRestriction - Cannot set the requested role for that user as they lack the necessary license

6.64.06

Added fields devicelicensetype and osupdatestatus to <CrOSFieldName>.

6.64.05

Added matchfield organizerself <Boolean> to <EventMatchProperty> to simplify selecting events where the user in the following commands is/is not the organizer of the event.

gam <UserTypeEntity> update events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> delete events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> purge events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> move events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> info events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> show events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> print events <UserCalendarEntity> [<EventEntity>]
gam <UserTypeEntity> update calattendees <UserCalendarEntity> <EventEntity>

6.64.04

Updated gam calendars <CalendarEntity> move events and gam <UserTypeEntity> move events <UserCalendarEntity> to handle the following error:

ERROR: 400: badRequest - Bad Request

6.64.03

Updated gam <UserTypeEntity> get drivefile to allow downloading Jamboard files; they must be downloaded with format pdf.

6.64.02

Updated gam <UserTypeEntity> transfer drive to handle the following error:

ERROR: 400: Bad Request. User message: "The action cannot be performed on an item of mime-type: application/vnd.google-apps.shortcut" - invalidSharingRequest

6.64.01

Updated gam <UserTypeEntity> print|show youtubechannels to handle the following error:

ERROR: 403: unsupportedSupervisedAccount - Access Forbidden. The authenticated user cannot access this service.

6.64.00

Added support for displaying users YouTube channels.

6.63.19

Fixed bug in gam print vacation where endDate value was not converted to yyyy-mm-dd format.

6.63.18

Updated gam print|show ownership to show the correct file owner when the most recent event is change_owner.

6.63.17

Added support for Duet AI license.

  • ProductID - 101047
  • SKUID - 1010470001 | duetai

Added api_call_tries_limit variable to gam.cfg that limits the number of tries for Google API calls that return an error that indicates a retry should be performed. The default value is 10 and the range of allowable values is 3-10.

6.63.16

Arguments noinherit, blockinheritance and blockinheritance true have been removed from the following commands due to an upcoming API change that no longer allows blocking OU setting inheritance. Arguments inherit and blockinheritance false are still valid.

gam create org <OrgUnitPath>
gam update org <OrgUnitItem>
gam update orgs <OrgUnitEntity>

6.63.15

Added print_cros_ous and print_cros_ous_and_children variables to gam.cfg that provide a default list of OUs for these commands:

gam print cros
gam print crosactivity

Updated group commands that manage members to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

Updated Data Studio to Looker Studio; added the following command synonyms:

  • lookerstudioassets for datastudioassets
  • 'lookerstudiopermissionsfordatastudiopermissions`

Corrected error message in gam add datastudiopermissions:

  • Old -ERROR: Missing argument: Expected <DataStudioAssetMembersEntity>
  • New - `ERROR: Missing argument: Expected

6.63.14

Added option verifyorganizer [<Boolean>] to gam <UserTypeEntity> copy|move drivefile. When a copy/move operation involves a Shared Drive, GAM verifies that the user is an organizer. Unfortunatley, this fails when the user is not a direct organizer but is a member of a group that is an organizer. Specifying verifyorganizer false suppresses the verification.

Updated the following commands to be able to specify a list of domains rather than a single domain:

gam print alias|aliases
gam print groups
gam print|show group-members
gam print users

Added print_agu_domains variable to gam.cfg that provides a default list of domains for these commands.

When multiple domains are specified and a query/queries are specified, an API call is made for each domain/query combination.

$ gam print users domains school.org,students.school.org queries "'email:admin*','email:test*'"
Getting all Users that match query (domain=school.org, query="email:admin*"), may take some time on a large Google Workspace Account...
Got 3 Users: admin@school.org - admindirector@school.org
Getting all Users that match query (domain=school.org, query="email:test*"), may take some time on a large Google Workspace Account...
Got 20 Users: testusera@school.org - testuserx@school.org
Getting all Users that match query (domain=students.school.org, query="email:admin*"), may take some time on a large Google Workspace Account...
Got 1 User: admin@students.school.org - admin@students.school.org
Getting all Users that match query (domain=students.school.org, query="email:test*"), may take some time on a large Google Workspace Account...
Got 1 User: testuser1@students.school.org - testuser1@students.school.org
primaryEmail
...

6.63.13

Updated gam <UserTypeEntity> print filelist ... showdrivename and gam <UserTypeEntity> show fileinfo <DriveFileEntity> ... showdrivename to show the actual name of Shared Drives in other domains rather than Drive.

6.63.12

Updated commands that call the Reports API (including gam info domain) to handle a change in the Reports API that generated the following warning:

WARNING: End date greater than LastReportedDate.

Added option showdeleted [<Boolean>]' to gam print|show chatmessages`.

6.63.11

Added option ou_and_children <OrgUnitItem> to gam print|show crostelemetry to simplify getting telemetry data for all ChromeOS devices in an OU and its children.

6.63.10

Added option addcsvdata <FieldName> <String> to these commands. This adds additional columns of data to the CSV file output when the csv option is used. If a CSV file of calendar information is being used to specify the calenders, fields, e.g., summary can be added to the ACL output file.

gam <UserTypeEntity> print calendaracls <UserCalendarEntity>
gam resource <ResourceID> print calendaracls
gam resources <ResourceEntity> print calendaracls
gam calendar <CalendarEntity> printacl
gam calendars <CalendarEntity> print acls

Added commands to show the number of CrOS devices or Users in an entity.

gam <CrOSTypeEntity> show count
gam <UserTypeEntity> show count

Updated gam create project to prompt user to mark GAM Project Creation as a trusted app.

6.63.09

Updated gam create teamdrive to handle the following error:

ERROR: 403: userCannotCreateTeamDrives - The authenticated user cannot create new shared drives.

6.63.08

Updated cigroup commands to handle the following error:

ERROR: 400: invalidArgument - Request contains an invalid argument.

6.63.07

Fixed bug in gam <UserTypeEntity> append sheetrange that caused a trap when appending to an empty sheet.

Upgraded to Python 3.11.5 where possible.

6.63.06

Updated cigroup commands to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.63.05

Updated inboundsso commands to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.63.04

Added option ignorerole to gam update groups|cigroups <GroupEntity> sync [<GroupRole>|ignorerole] ... <UserTypeEntity> that causes GAM to remove members regardless of role and add new members with role MEMBER. This is a special purpose option, use with caution and ensure that <UserTypeEntity> specifies the full desired membership list of all roles.

6.63.03

Added option externalusersallowed <Boolean> to gam <UserTypeEntity> create chatspace that allows creation of chat spaces that allow external users.

Updated commands that process chat members to allow external users.

6.63.02

Fixed bug in gam <UserTypeEntity> collect orphans where shortcuts were being created unnecessarily when useshortcuts was false; either by default or when explicitly set.

6.63.01

Added process_wait_limit variable to gam.cfg that controls how long (in seconds) GAM should wait for all batch|csv processes to complete after all have been started. If the limit is reached, GAM terminates any remaining processes. The default is 0 which specifies no limit.

Following Jay's lead, added option alwaysevict to gam create|update user that is used to specify GAM's behavior when verifynotinvitable is not specified and there is a conflict with an unmanaged account.

By default, when creating a user that has a conflict with an unmanaged account, GAM will honor the setting on this page:

Specifying alwaysevict forces GAM to select this setting: Replace conflicting unmanaged accounts with managed ones

With gam update user, alwaysevict only applies if createifnotfound is specified and the user was not found to update and must be created.

6.63.00

Added support for calendar working location events.

6.62.08

Added option addcsvdata <FieldName> <String> to these commands. This adds additional columns of data to the CSV file output when the csv option is used.

gam create contact
gam <UserTypeEntity> create contact
gam <UserTypeEntity> create contactgroup

6.62.07

Added option csv [todrive <ToDriveAttribute>*] to these commands that causes GAM to output the contact creator and contact ID in CSV form. This will be useful when bulk contacts are created.

Added returnidonly to these commands that causes GAM to return just the contact ID as output. This will be useful in scripts that create a contact and then want to perform subsequent GAM commands on the contact.

gam create contact
gam <UserTypeEntity> create contact
gam <UserTypeEntity> create contactgroup

6.62.06

Added output Item cap to gam <UserTypeEntity> print filecounts select select <SharedDriveEntity> that displays the total number of files/folders on the Shared Drive divided by 400000, the maximum number of file/folders on a Shared Drive.

6.62.05

Added progress messages (suppressible) to gam <UserTypeEntity> print diskusage.

6.62.04

Added command gam <UserTypeEntity> print diskusage to display disk usage by folder.

6.62.03

Handled Google Directory API bug in gam print groups that caused a trap.

6.62.02

Fixed bug introduced in 6.62.01 that caused a trap that broke redirect csv ... multiprocess. My apologies.

6.62.01

Updated code so that when gam.cfg variables csv_output_timestamp_column and output_timeformat are both specified, the timestamp is output in the alternate output time format.

6.62.00

Added output_dateformat and output_timeformat variables to gam.cfg that provide alternate output date and time formats that may be required by programs that will be processing the data. GAM will not accept alternate date/time formats as input.

6.61.21

Updated gam <UserTypeEntity> empty drivetrash <SharedDriveEntity> to use new Drive API v3 functionality for emptying the trash of a Shared Drive with a single API call. Previously, GAM had to purge each individual file and folder in the trash.

6.61.20

Remove audit.googleapis.com from the list of project APIs.

6.61.19

Fixed bug in gam <UserTypeEntity> print|show chatmembers <ChatSpace> that caused a trap.

6.61.18

Added the following options to gam [<UserTypeEntity>] create shareddrive to allow better control of the create/update process when attributes other than themeid are specified.

errorretries <Integer> - Number of create/update error retries; default value 5, range 0-10
updateinitialdelay <Integer> - Initial delay after create before update: default value 10, range 0-60
updateretrydelay <Integer> - Retry delay when update fails; default value 10, range 0-60

6.61.17

Updated gam print|show vaultexports|vaultholds|vaultqueries to not set a non-zero return code when a vault matter changes state from OPEN to CLOSED|DELETED while the command is being processed.

Updated gam create shareddrive <Name> ou|org|orgunit <OrgUnitItem> to handle the following error:

ERROR: 403: permissionDenied - Request had insufficient authentication scopes.

It's not clear what causes the error.

6.61.16

Added the following license SKUs.

1010060005 - Google Workspace Essentials Plus
1010020031 - Google Workspace Frontline Standard
1010340005 - Google Workspace Business Starter - Archived User
1010340006 - Google Workspace Business Standard - Archived User

6.61.15

Added option contentrestrictions ownerrestricted [<Boolean>] to <DriveFileAttribute>.

6.61.14

Added aggregatebyuser [Boolean] option to gam report user to allow data aggregation for users across multiple dates. Options aggregatebyuser and aggregatebydate are mutually exclusive.

6.61.13

Added commands to display Analytic UA properties.

gam <UserTypeEntity> print analyticuaproperties [todrive <ToDriveAttribute>*]
        accountid [accounts/]<String>
        [maxresults <Integer>]
        [formatjson [quotechar <Character>]]
gam <UserTypeEntity> show analyticuaproperties
        accountid [accounts/]<String>
        [maxresults <Integer>]
        [formatjson]

6.61.12

Updated gam print|show vaultexports|vaultholds|vaultqueries to handle the case where a vault matter changes state from OPEN to CLOSED|DELETED while the command is being processed.

6.61.11

Added option returnidonly to gam create vaultexport|vaulthold|vaultmatter that causes GAM to return just the ID of the item created as output.

6.61.10

Fixed bug in gam oauth create admin <EmailAddress> which caused no scopes to be selected.

6.61.09

Updated gam oauth create to handle case where Google takes a very long time to respond after you have allowed access to the scopes.

6.61.08

Updated gam <UserTypeEntity> print messages showlabels to include a column LabelsCount to display the number of labels a message has. Use option useronly to limit the labels to user labels.

Updated gam <UserTypeEntity> print messages to display these columns, if applicable, as the last columns in the CSV file.

SizeEstimate, LabelsCount, Labels, Snippet, Body

6.61.07

Improved action messages in gam update org|ou <OrgUnitItem> sync <UserTypeEntity> [removetoou <OrgUnitItem>].

6.61.06

Added option csv to gam <UserTypeEntity> check group|groups that displays the results in CSV format.

$ gam user testuser check groups csv testgroup1,testgroup2,alladmin
User: testuser@domain.com, Check in 3 Groups
user,group,role
testuser@domain.com,alladmin@domain.com,Not a MEMBER|OWNER|MANAGER
testuser@domain.com,testgroup1@domain.com,MEMBER
testuser@domain.com,testgroup2@domain.com,MANAGER

6.61.05

Fixed bug in gam print contacts that caused a trap when show_gettings = False in gam.cfg.

6.61.04

Updated gam create shareddrive <Name> to wait longer between creating the Drive and updating any attributes that could not be specified as part of the creation; i.e., <SharedDriveRestrictionsFieldName>, hidden, customtheme, color and orgunit. The initial wait is 30 seconds. Previously, GAM was not waiting long enough; the Drive would be created but the update would fail; the attributes were not set.

6.61.03

Updated processing of <UserMultiAttribute> externalid to allow an empty custom type.

externalid account|customer|login_id|network|organization|(custom <String>)|<String> <String>

These are equivalent ways of expressing an empty custom type:

externalid "" "Value"
externalid custom "" "Value"

6.61.02

Fixed bug in gam update groups <GroupEntity> sync introduced in 6.60.31 that caused this error:

ERROR: 409: generic409 - Member already exists.

6.61.01

Added option noactionifalias to gam delete groups <GroupEntity> that prevents GAM from deleting a group if <GroupEntity> specifies an alias rather than a primary email address.

6.61.00

Following Jay's lead, added no_short_urls variable to gam.cfg. When false, the long scopes URLs in gam oauth create and gam <UserTypeEntity> check|update serviceaccount will be shortened at the site https://gam-shortn.appspot.com; the shortened URL redirects to the long URL. For existing configurations, no_short_urls defaults to true; the long URLs are used as is. For new configurations the no_short_urls defaults to false unless there is a file named noshorturls.txt in the folder specified by the environment variable OLDGAMPATH.

6.60.31

Added option addcsvdata <FieldName> <String> to gam print forms|formresponses. This adds additional columns of data to the CSV file output. This can be used to combine form information from several GAM commands.

Following Jay's lead, projects can now be created with consumer accounts.

6.60.30

Added option countsonly to gam <UserTypeEntity> print|show formresponses that causes GAM to display the number of responses to a form rather than displaying the response details.

6.60.29

Updated gam <UserTypeEntity> delete|print emptydrivefolders to show the path to the deleted folder rather than just its name. Added an option to allow a starting point other that the root of My Drive or a Shared Drive. Improved the commands performance.

6.60.28

Fixed bug in gam <UserTypeEntity> print filelist countsonly showsource stripcrsfromname where carriage returns, linefeeds and nulls were not stripped from file names.

6.60.27

Updated gam <UserTypeEntity> print filelist countsonly to process addcsvdata <FieldName> <String>. Additional fields are added before Size if present, otherwise Total.

6.60.26

Added option orgunit|org|ou <OrgUnitPath> to gam print|show teamdrives that limits the display to Shared Drives in the specified Org Unit.

6.60.25

Added option orgunit|org|ou <OrgUnitPath> to gam print|show teamdriveacls that limits the display of permissions to Shared Drives in the specified Org Unit.

6.60.24

Updated gam <UserTypeEntity> info|show|print chatmessages to show the sender email address when the sender is a human.

6.60.23

Fixed bug in config csv_input_row_filter|csv_output_row_filter where "field:date<today" was being processed as "field:date<=today" and "field:date>=today" was being processeed as "field:date>today".

6.60.22

Added option pathdelimiter <Character> to gam <UserTypeEntity> create drivefolderpath to simplify specifying folder paths where a folder name contains a /. In the example, some folder has a '/' in it's name so specifying pathdelimiter "|" allows fullpath to be properly processed. pathdelimiter defaults to '/'.

gam user user@domain.com create drivefolderpath pathdelimiter "|" fullpath "My Drive|Top Folder|Middle/Folder|Bottom Folder"

6.60.21

Fixed bug in gam <UserTypeEntity> copy|create|update drivefile where processing the following <DriveFileAttribute> attributes was not correct. Previously, if multiple properties of the same visibility were specified, only the first was processed; now, all values are processed.

privateproperty <PropertyKey> <PropertyValue>
publicproperty <PropertyKey> <PropertyValue>
property <PropertyKey> <PropertyValue> [private|public]

6.60.20

Updated gam <UserTypeEntity> get document|drivefile <DriveFileEntity> to handle shortcuts by downloading the file that the shortcut references as the shortcut itself is not downloadable. If you do not want this behavior and want GAM to report an error, use the option donotfollowshortcuts.

6.60.19

Updated gam <UserTypeEntity> archive messages to handle the following error:

ERROR: 400: failedPrecondition - Precondition check failed.

6.60.18

Updated gam <UserTypeEntity> print|show tokens to handle the following error that occurs when a group email address is specified rather than a user email address.

ERROR: 400: badRequest - Type not supported: userKey

6.60.17

Fixed bug in gam <UserTypeEntity> move drivefile that caused an error when moving the contents of a source Shared Drive to a target Shared Drive when mergewithparents was not specified or was explicitly set False.

6.60.16

Updated commands that create files to handle the following error:

403: storageQuotaExceeded - The user's Drive storage quota has been exceeded.

6.60.15

Updated gam print chromesnvalidity to do case insenstitive serial number comparisons.

6.60.14

Added command to help verify Chrome device serial number validity.

gam print chromesnvalidity [todrive <ToDriveAttribute>*]
        cros_sn <SerialNumberEntity> [listlimit <Number>]
        [delimiter <Character>]

See: https://github.com/taers232c/GAMADV-XTD3/wiki/ChromeOS-Devices#check-chromeos-device-serial-number-validity

6.60.13

Updated gam <UserTypeEntity> print|show chatspaces to handle the following error:

Error: 403: permissionDenied - Permission denied to perform the requested action on the specified resource

6.60.12

Added option tdretaintitle [<Boolean>] that, when True and used with tdfileid <DriveFileID>, causes GAM to not modify the CSV filename.

6.60.11

Fixed bug in gam print addresses where non-editable user/group aliases were not displayed.

6.60.10

Added a command to get information about a direct message chat space between two users.

gam <UserTypeEntity> info chatspacedm <UserItem>
        [formatjson]

6.60.09

Added option csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]] to these commands so that event details are displayed in CSV format.

gam calendar|calendars <CalendarEntity> create|import|update event
gam <UserTypeEntity> create|import|update event <UserCalendarEntity>

Added option additionalmembers [<GroupRole>] <EmailAddressEntity> to gam update group|groups <GroupEntity> sync that can be used to specify members in addition to those specified with <UserTypeEntity>.

gam update group teachers@domain.com sync member additionalmembers counselor@domain.com ou /Teachers

Added commands to display Analytic account/property/datastream information.

6.60.08

Upgraded to Python 3.11.4 where possible.

6.60.07

Simplified specifying a Chat space name; previously, the space keyword was required; now, it can be omittted and you can just enter spaces/<String>.

<ChatSpace> ::= spaces/<String> | space <String> | space spaces/<String>

6.60.06

Fixed bug in gam print aliases that caused a trap.

6.60.05

Updated Chrome Policy commands to handle the following error:

ERROR: 403: permissionDenied - The caller does not have permission.

6.60.04

Updated gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> to disallow copying/moving a folder into itself.

6.60.03

Updated commands to delete chatmembers; delete chatmembers now deletes members by specifying a chat space and user email addresses; remove chatmembers deletes members by specifying chatmember names.

gam <UserTypeEntity> delete chatmember space <ChatSpace>
        ((user <UserItem>)|(members <UserTypeEntity>))+
gam <UserTypeEntity> remove chatmember members <ChatMemberList>

6.60.02

Added option <ChatContent> to gam <UserTypeEntity> create chatspace to allow sending an initial message to the newly created chatspace.

6.60.01

Updated gam <UserTypeEntity> create chatspace to support chatspace types GROUP_CHAT and DIRECT_MESSAGE and to allow specification of members.

6.60.00

Added initial support for user chat spaces. This is a work in progress, test and report any problems.

Improved performance of gam <UserTypeEntity> delete|move|update othercontacts.

Upgraded to OpenSSL 3.1.1 where possible.

6.59.18

Updated gam <UserTypeEntity> update drivefile <DriveFileEntity> to handle the following error:

ERROR: 403: fileWriterTeamDriveMoveInDisabled - The domain administrator has not allowed writers to move items into a shared drive.

6.59.17

Added option pathdelimiter <Character> to the following commands that causes GAM to separate components in a folder path with <Character> rather than the default character /. This can help avoid confusion when Google folder names contain a /.

Previously, on Windows, path components were separated by \\ when written to a CSV file and \ when written to stdout; now, / or <Character> will be used in all cases.

gam <UserTypeEntity> info drivefile <DriveFileEntity>
gam <UserTypeEntity> show fileinfo <DriveFileEntity>
gam <UserTypeEntity> print filelist
gam <UserTypeEntity> print|show filepaths <DriveFileEntity>
gam <UserTypeEntity> transfer ownership <DriveFileEntity>
gam <UserTypeEntity> claim ownership <DriveFileEntity>

6.59.16

Updated <GroupSettingsAttribute> whocancontactowner to include option all_owners_can_contact.

6.59.15

Updated error reporting in gam delete|update chromepolicy <SchemaName> to show the <SchemaName> as originally entered when an unknown <SchemaName> is specified; previously, it was shown in lowercase which could cause confusion.

Updated column order in gam print chromeschemas to move schemaName, policyDescription and policyApiLifecycle.* to follow column name.

Added columns policyDescription and policyApiLifecycleStage to gam print chromeschemas formatjson to follow column name.

6.59.14

Improve bug fix for gam <UserTypeEntity> print groups|grouptree|groupslist.

6.59.13

Fixed bug in gam <UserTypeEntity> print groups|grouptree|groupslist that caused the following error whan an email address contained an apostrophe.

WARNING: Got 0 Groups: Invalid Member - test.o'user@domain.com

Fixed bug in gam <UserTypeEntity> print|show contacts ... filtercontactgroup <PeopleContactGroupItem> that returned no contacts when neither allfields or fields <PeopleFieldNameList> was specifiecd.

6.59.12

Fixed bug in gam create user <EmailAddress> ... immutableous <OrgUnitEntity> ... createifnotfound that generated the following error when the user <EmailAddress> did not exist and needed to be created.

User: <EmailAddress>, Service not applicable/Does not exist

6.59.11

Updated gam print|show chromepolicies to query the following nameapaces when namespace <NamespaceList> is not specified. Previously, only the namespaces marked with a * were queried. chrome.devices.managedguest was added in 6.59.10.

chrome.users *
chrome.users.apps *
chrome.users.appsconfig
chrome.devices *
chrome.devices.kiosk *
chrome.devices.kiosk.apps
chrome.devices.managedguest *
chrome.devices.managedguest.apps
chrome.networks.cellular
chrome.networks.certificates
chrome.networks.ethernet
chrome.networks.globalsettings
chrome.networks.vpn
chrome.networks.wifi
chrome.printers
chrome.printservers

6.59.10

Fixed bug in gam print|show chromepolicies where policies in namespace chrome.devices.managedguest were not displayed unless it was specified in namespace <NamespaceList>.

Improved error messages in gam <UserTypeEntity> move events.

6.59.09

Added option addnumericsuffixonduplicate <Number> to gam create user <EmailAddress> that will attempt to create a unique <EmailAddress> when the original value is a duplicate user address. If <EmailAddress> is <String>@<DomainName>, up to <Number> attempts will be made to create a unique <EmailAddress>; <Number> defaults to 0.

<String>1@<DomainName>
<String>2@<DomainName>
...

6.59.08

Fixed bug in csv_output_row_filter "FieldName:date<Operator>Never" that didn't properly detect matches. For example, the following command would not display users that had never logged in.

gam config csv_output_row_filter "lastLoginTime:date=Never" print users lastlogintime

6.59.07

Added option immutableous <OrgUnitEntity> to gam <UserTypeEntity> update user ... org <OrgUnitPath> that does not update the user's OU to <OrgUnitPath> if <OrgUnitPath> appears in <OrgUnitEntity>. All other fields are updated.

This can be used when a SIS outputs user data to be updated but students temporarily in special purpose OUs should not be updated to the SIS specified OU. <OrgUnitEntity> and <OrgUnitPath> must both specify OU paths, not IDs.

gam csv SISdata.csv gam update user "~primaryEmail" suspended off firstname "~First Name" lastname "~Last Name"
        ou "~OU" immutableous "'/Students/Lower School/Restricted,'/Students/Middle School/Restricted'"

6.59.06

Added option sources <PeopleProfileSourceNameList> to gam <UserTypeEntity> print|show peopleprofile that allows specification of the sources of the data to display. By default, data from all sources is displayed.

<PeopleProfileSourceName> ::=
        account|accounts|
        domain|domains|
        profile|profiles
<PeopleProfileSourceNameList> ::= "<PeopleProfileSourceName>(,<PeopleProfileSourceName>)*"

Added option updatefilepermissions [<Boolean>] to gam <UserTypeEntity> move drivefile <DriveFileEntity>. Previously, file permissions were not updated in the command; now, when updatefilepermissions is true, file permissions will be removed/created as specified by the following noptions:

excludepermissionsfromdomains <DomainNameList>
includepermissionsfromdomains <DomainNameList>
mappermissionsdomain <DomainName> <DomainName>

Additionally, permissions referencing deleted groups/users will be removed.

The permissions are updated on the file before it is moved.

Test before using in production.

6.59.05

Added option includepermissionsfromdomains <DomainNameList> to the following commands that copies only those permissions that reference any domain in <DomainNameList>. It is mutually exclusive with exludepermissionsfromdomains <DomainNameList>.

gam copy|sync teamdriveacls <SharedDriveEntity>
gam <UserTypeEntity> copy|sync teamdriveacls <SharedDriveEntity>
gam <UserTypeEntity> copy|move drivefile <DriveFileEntity>

6.59.04

Fixed bug in gam <UserTypeEntity> print|show filesharecounts where ACLs for deleted user/groups were miscounted as external shares.

6.59.03

Cleaned up Getting/Got messages for several commands.

Improved performance of gam print admins.

6.59.02

Updated the Analytic account/property commands to use service account access so that data can be retrieved for any user.

Fixed bug where the Analytics Admin API was not being added in gam update project forcing you to manually enable it.

6.59.01

Updated gam checkconnection to check connections to the following sites:

Contacts API - Domain Shared Contacts - www.google.com
Email Audit API - apps-apis.google.com
Sites API - sites.google.com

6.59.00

Added commands to display Analytic account/property information.

6.58.03

Fixed bug in gam [<UserTypeEntity>] print shareddriveacls oneitemperrow shownopermissionsdrives true where the Shared Drives with no ACLs were not shown; they were shown if oneitemperrow was omitted.

6.58.02

Updated gam <UserTypeEntity> print filelist ... filepath|fullpath to not display parent information for orphans. Previously, GAM would incorrectly display:

...,parents,parents.0.id,parents.0.isRoot,...
...,1,Orphans,False,...

Now the corrected display is:

...,parents,parents.0.id,parents.0.isRoot,...
...,,,,...

This change makes the output the same as when filepath|fullpath is omitted.

6.58.01

Added the following options to tag replace processing to allow control of the case of replacement data.

You can control the case of the letters in replace <Tag> <String> and replace <Tag> <UserReplacement>.

  • {PC}...{Tag1}...{Tag2}...{/PC} - For all sequences of letters between {PC} and {/PC}, the first letter is converted to uppercase, subsequent letters to lowercase.
  • {UC}...{Tag1}...{Tag2}...{/UC} - All letters between {UC} and {/UC} will be converted to uppercase
  • {LC}...{Tag1}...{Tag2}...{/LC} - All letters between {LC} and {/LC} will be converted to lowercase

6.58.00

Added license_max_results variable to gam.cfg. When retrieving licenses from License API, this variable controls how many should be retrieved in each chunk. The default value is 100; the range is 100-1000. As of 2023-04-27, larger numbers cause Google to return an incorrect numbert of licenses.

6.57.11

Fixed bug where the csv_output_header_force variable in gam.cfg was being interpreted as a list of <RegularExpressions> rather than a list of <Strings> as documented.

6.57.10

When doing commands similar to these:

gam redirect csv - multiprocess todrive csv Users.csv gam user "~primaryEmail" print filelist ...
gam config auto_batch_min 1 redirect csv - multiprocess todrive <UserTypeEntity> print filelist ...

GAM was including the name of the last user processed in the title of the uploaded Google Sheet; as this is not accurate, it has been eliminated.

6.57.09

Added emailaddresslist <EmailAddressList> to <PermissionMatch> that allows matching any email address in a list.

6.57.08

Updated gam <UserTypeEntity> print|show contacts|othercontacts to retry the following error:

serviceNotAvailable - The service is currently unavailable.

6.57.07

Updated code to recognize the following Google Drive API error that is issued when Google doesn't recognize an email address as valid.

$ gam user user@domain.com print filelist query "'j@ab.net' in writers" fields id,name
Getting all Drive Files/Folders that match query ('me' in owners and ('j@ab.net' in writers)) for user@domain.com

ERROR: 400: badRequest - Bad Request
$ gam user user@domain.com print filelist query "'j@ab.com' in writers" fields id,name
Getting all Drive Files/Folders that match query ('me' in owners and ('j@ab.com' in writers)) for user@domain.com
Got 0 Drive Files/Folders that matched query ('me' in owners and ('j@ab.com' in writers)) for user@domain.com...
Owner,id,name

6.57.06

Added inherited <Boolean> to <PermissionMatch> that applies only to Shared Drive files/folders; this makes it easy to identify files/folders on Shared Drive with non-inherited permissions.

gam user organizer@domain.com print filelist select teamdriveid <TeamDriveID> fields id,name,mimetype pm inherited false em pmfilter oneitemperrow

This clause will always cause a permission match failure on My Drive files/folders.

6.57.05

Updated gam batch <BatchContent> and gam tbatch <BatchContent> commands to accept lines with the following form:

clear keyword

This can improve performance as subsequent lines in <BatchContent> will not be scanned for %keyword%.

6.57.04

Updated gam batch <BatchContent> and gam tbatch <BatchContent> commands to accept lines with the following form:

set keyword value

Subsequent lines in <BatchContent> will have %keyword% replaced with value.

6.57.03

Updated gam <UserTypeEntity> info|print|show contacts|othercontacts and gam info|print|show peoplecontacts|peopleprofiles to default to displaying the fields names,emailaddresses,phonenumbers as documented rather than all fields.

6.57.02

Following Jay's lead, removed Google bug (237397223) workaround code in gam print devices|deviceusers|crostelemetry as the bug is now fixed.

6.57.01

Updated gam <UserTypeEntity> vacation to handle the following error:

ERROR: 400: failedPrecondition - Precondition check failed.

What the error means is unknown to me at the moment.

Updated GAM so that when the current project ID is required, it will first try to get it from oauth2service.json and if not successful, try to get it from client_secrets.json. There are cases, e.g., when DASA is enabled, that client_secrets.json is not present.

Previously, GAM checked for the existence of client_secrets.json on every command; this check has been eliminated as the file is only required by gam oauth create.

6.57.00

Following Jay's lead, updated gam create admin to allow assignment of a delegated admin role to a group. Updated gam print admins to display whether a role is assigned to a user or a group.

Updated version number to align with Standard GAM.

6.54.06

Added options users <EmailAddressList> and groups <EmailAddressList> to gam print aliases that is more efficient for getting aliases for specific users and groups.

Added option select <UserTypeEntity> to gam print aliases that allows specification of a list users by <UserTypeEntity>; e.g., a group or an org unit.

Added option delimiter <Character> to gam print aliases that is applicable when option onerowpertarget is specified. Previously, multiple aliases were separated by a space character. Now, by default, the aliases are separated by the csv_output_field_delimiter' from gam.cfg. The option delimiter ` overrides that value.

6.54.05

Added option addcsvdata <FieldName> <String> to gam print aliases. This adds additional columns of data to the CSV file output. This can be used when printing aliases for departed employees to indicate the new target for the user's alises. Subsequent commands using the CSV file can reassign the aliases to the new target.

6.54.04

Updated gam print|show channelcustomerentitlements to handle the following error when none of gam.cfg/channel_customer_id or command line arguments channelcustomerid or name are set.

ERROR: Parameter "parent" value "accounts/C03kt1789/customers/" does not match the pattern "^accounts/[^/]+/customers/[^/]+$"

6.54.03

By special request, British spelling of various keywords/arguments is now available.

backgroundcolor backgroundcolour
color colour
colorindex colourindex
costcenter costcentre
fileorganizer fileorganiser
foregroundcolor foregroundcolour
license licence
licenses licences
nolicenses nolicences
organization organisation
organizationname organisationname
organizations organisations
organizer organiser
organizeremail organiseremail
organizername organisername
textcolor textcolour

6.54.02

Updated gam <UserTypeEntity> get photo and gam <UserTypeEntity> get profilephoto to inspect the photo data and add the appropriate extension: jpg, png, gif. If the type of the photo can't be determined, img is used as the extenstion. If you use [filename <FileNamePattern>], #ext# will be replaced with the extension.

Updated gam <UserTypeEntity> [create|add] sendas <EmailAddress> [name] <String> to allow the optional argument name before <String> to make clear that <String> is the sendas display name.

6.54.01

Added commands to export messages/threads in EML/raw format.

6.54.00

Following Jay's lead, updated gam delete inboundssoassignment <SSOAssignmentSelector> to allow more flexibility in selecting assignments to delete.

Fixed bug in gam <UserTypeEntity> print|show filesharecounts that would cause a trap.

Updated gam <UserTypeEntity> print filelist ... fullpath showparent and gam <UserTypeEntity> print filepath to properly display the file path of My Drive.

Upgraded to Python 3.11.3 where possible.

Added commands to create and delete Chrome networks.

gam create chromenetwork
        <OrgUnitItem> <String> <JSONData>
gam delete chromenetwork
         <OrgUnitItem> <NetworkID>

6.53.03

gam gam print|show svcaccts now requires password authentication.

6.53.02

Added commands to display the share type counts of a user's files.

6.53.01

Following Jay's lead, added instructions to gam create project to have GAM be a trusted app.

6.53.00

Updated build steps to avoid trap with gam create project on M1 Macs.

Added option noshowtextplain to gam <UserTypeEntity> show messages|threads that suppresses the default display of text/plain attachment content when showattachments is specified.

6.52.08

Added maximumfilesize <Integer> to the following commands to allow selection of files with content of size <= <Integer>.

gam <UserTypeEntity> print filelist
gam <UserTypeEntity> print|show filetree
gam <UserTypeEntity> print|show filecounts

Added field workinglocationproperties to <EventFieldName>.

6.52.07

Fixed bug in gam <UserTypeEntity> copy drivefile that caused the following error:

ERROR: 403: parentNotAFolder - The specified parent is not a folder.

Current time is now printed in gam version.

6.52.06

Updated gam <UserTypeEntity> create|update drivefile to handle the following error that occurs when an attempt is made to create/move a third-party shortcut on/to a Shared Drive.

ERROR: 403: teamDrivesShortcutFileNotSupported - The application associated with this third-party shortcut file does not support shared drives.

6.52.05

Added option formatjson to all commands that display Vault Matters, Exports, Holds and Saved Queries.

Updated gam <UserTypeEntity> move drivefile to handle the following error that occurs when an attempt is made to move a third-party shortcut to a Shared Drive.

ERROR: 403: teamDrivesShortcutFileNotSupported - The application associated with this third-party shortcut file does not support shared drives.

6.52.04

Fixed bug in gam info vaultquery and gam print|show vaultqueries that caused a trap when the query field was omitted from the fields <VaultQueryFieldNameList>.

6.52.03

Added commands to display Vault Matter saved queries.

gam info vaultquery <QueryItem> matter <MatterItem>
        [fields <VaultQueryFieldNameList>] [shownames]
gam info vaultquery <MatterItem> <QueryItem>
        [fields <VaultQueryFieldNameList>] [shownames]
gam print vaultqueries [todrive <ToDriveAttribute>*] [matters <MatterItemList>]
        [fields <VaultQueryFieldNameList>] [shownames]
gam show vaultqueries [matters <MatterItemList>]
        [fields <VaultQueryFieldNameList>] [shownames]

Updated gam info resoldcustomer <CustomerID> to display the customer primary email.

Following Jay's lead, the following scopes will be off by default as changes to Google Cloud session control may require frequent use of gam aouth create.

[ ] 21)  Cloud Storage API (Read, Vault/Takeout Download)
[ ] 22)  Cloud Storage API (Write, Vault/Takeout Copy)

6.52.02

Following Jay's lead, added the following License SKUs:

1010380001 - AppSheet Core 
1010380002 - AppSheet Enterprise Standard
1010380003 - AppSheet Enterprise Plus

6.52.01

Fixed bug where API calls retry data was displaying incorrect values when processing CSV files.

6.52.00

Updated process handling for gam batch|csv.

6.51.08

Updated gam create|update user <EmailAddress> ... <JSONData> to exclude additional fields from the JSON data that can't be copied; the following error was displayed:

User: user@domain.com, Create Failed: Invalid Input: Bad request for

6.51.07

Fixed bug introduced in 6.51.06 that caused a trap in gam create project.

6.51.06

Following Jay's lead, added option validityhours <Number> to gam create|replace|update sakeys and gam rotate sakey that let's you set the length of time a Service Account key is valid.

6.51.05

With input from Jay, further upgraded gam <UserTypeEntity> check serviceaccount to avoid a trap when a proxy is being used.

6.51.04

Upgraded gam <UserTypeEntity> check serviceaccount to avoid a trap when a proxy is being used.

6.51.03

  • Upgraded to OpenSSL 3.1.0 where possible.

6.51.02

Added support for externalid, im, posix, relation, sshkeys and website subfields in gam <UserTypeEntity> signature and gam <UserTypeEntity> create|update sendas option replace <Tag> <UserReplacement>.

6.51.01

Added option nogcspath to gam download storagefile <StorageBucketObjectName> that causes GAM to store the downloaded file directly into the target folder without any Google Cloud Storage path information.

6.51.00

Added the ability to read data from Google Cloud Storage bucket objects.

<StorageBucketName> ::= <String>
<StorageObjectName> ::= <String>
<StorageBucketObjectName> ::=
        https://storage.cloud.google.com/<StorageBucketName>/<StorageObjectName>|
        https://storage.googleapis.com/<StorageBucketName>/<StorageObjectName>|
        gs://<StorageBucketName>/<StorageObjectName>|
        <StorageBucketName>/<StorageObjectName>

Anywhere you can enter gdoc|ghtml <UserGoogleDoc>) you can enter gcsdoc|gcshtml <StorageBucketObjectName>.

Anywhere you can enter gsheet <UserGoogleSheet>) you can enter gcscsv <StorageBucketObjectName>.

The Type of the Cloud Storage bucket objects must match the option keyword.

  • gcsdoc - text/plain
  • gcshtml - text/html
  • gcscsv - text/csv

These options require that scope Cloud Storage (Read, Vault/Takeout Download) be enabled in gam oauth create.

Added a command to download a Cloud Storage bucket object.

gam download storagefile <StorageBucketObjectName>
        [targetfolder <FilePath>]

6.50.14

Fixed bug in gam <UserTypeEntity> copy drivefile that caused a trap.

Fixed bug where removefeature but not removefeatures was recognized in gam update resource.

6.50.13

Added options addfeatures <FeatureNameList> and removefeatures <FeatureNameList> to <ResourceAttribute>. These can be used in in the following commands to make incremental changes to resource features.

gam update resource <ResourceID> <ResourceAttribute>*
gam update resources <ResourceEntity> <ResourceAttribute>*

Updated processing of <FeatureNameList> which is a <ResourceAttribute> to properly handle <FeatureName>s containing spaces. When entering <FeatureNameList> with <FeatureName>scontaining spaces, enclose the list in " and the names containing spaces in '.

features "CameraSet"
features "'Laptop Cart'"
features "CameraSet,'Laptop Cart'"

6.50.12

Handle new trap in gam <UserTypeEntity> forward messages.

6.50.11

Handle new trap in gam <UserTypeEntity> forward messages.

6.50.10

Fixed bug in gam <UserTypeEntity> forward messages altcharset <String> where <String> was marked as an invalid argument.

Updated gam <UserTypeEntity> copy drivefile <DriveFileEntity> to allow copying Google Sites.

6.50.09

Added command gam info adminrole <RoleItem> [privileges] that displays a specific admin role and optionally its privileges.

Added option privileges to gam print|show admins that displays the privileges for each role for the admin.

6.50.08

Added option altcharset <String> to gam <UserTypeEntity> forward messages to attempt to handle errors like the following which occur when the message can not be decoded with character set UTF-8. You can specify an alternate character set, e.g. latin1, that is used if the UTF-8 decode fails.

UnicodeDecodeError: 'utf-8' codec can't decode byte 0x92 in position 1643: invalid start byte

6.50.07

Fixed build bug that caused the following error:

ERROR: Discovery File: /usr/local/gamadv-xtd3/datastudio-v1.json, Does not exist or has invalid format, No data

6.50.06

Fixed bug in gam report usage customer where an extraneous column email was displayed.

6.50.05

Fixed bug in gam update resoldsubscription that caused an error:

ERROR: 400: invalid - The seats provided are not valid

6.50.04

Added allowcontentmanagerstosharefolders to <SharedDriveRestrictionsSubfieldName> that is used in gam create|update teamdrive. This terminology matches the Admin console setting Allow Content Managers to share folders.

Each pair of commands below are equivalent:

gam update teamdrive <SharedDriveEntity> allowcontentmanagerstosharefolders true
gam update teamdrive <SharedDriveEntity> sharingfoldersrequiresorganizerpermission false

gam update teamdrive <SharedDriveEntity> allowcontentmanagerstosharefolders false
gam update teamdrive <SharedDriveEntity> sharingfoldersrequiresorganizerpermission true

Updated status reporting in gam update chromepolicy to supply more details.

Fixed bug in gam update chromepolicy when processing an schema field with an empty list.

6.50.03

Fixed bug in gam update resoldsubscription that caused an error:

ERROR: 400: invalid - Request contains an invalid argument.

6.50.02

Fixed bug in gam create project where invalid data was written to client_secrets.json.

6.50.01

Fixed YubiKey issue that caused a trap.

6.50.00

Following Jay's lead (with many thanks), added commands to enable running GAM securely on a Google Compute Engine.

Following Jay's lead (with many thanks), added commands to enable using a Yubikey.

These Wiki pages are a work in progress, contact me if you need help.

Updated handling of seats option in gam create|update resoldsubscription to properly assign the API fields numberOfSeats and maximumNumberOfSeats. Previously, this is how the option was processed:

  • Plan name ANNUAL_MONTHLY_PAY or ANNUAL_YEARLY_PAY
    • seats <NumberOfSeats> - <NumberOfSeats> was properly passed to the API
    • seats <NumberOfSeats> <MaximumNumberOfSeats> - <NumberOfSeats> was properly passed to the API; <MaximumNumberOfSeats> was passed to the API which ignored it
  • Plan name FLEXIBLE or TRIAL
    • seats <NumberOfSeats> - <NumberOfSeats> was improperly passed to the API; an API error was generated
    • seats <NumberOfSeats> <MaximumNumberOfSeats> - <MaximumNumberOfSeats> was properly passed to the API; <NumberOfSeats> was passed to the API which ignored it

Now, you can still use the above option which has been corrected or you can specify seats <Number> which will be properly passed in the correct form to the API based on plan name.

Hopefully fixed a bug in gam <UserTypeEntity> forward messages that caused a trap when the subject contained Latin-1 characters.

6.42.10

Added option accesstype public|team|announcementonly|restricted to gam create|update group.

6.42.09

Cleaned up output in gam print crostelemetry; fields that are lists weren't being correctly sorted by index.

6.42.08

Added additional fields to <CrOSTelemetryFieldName>:

audiostatusreport|
bootperformancereport|
networkinfo|
networkdiagnosticsreport|
peripheralsreport|
thunderboltinfo|
networkdevices|

6.42.07

Improved gam <UserTypeEntity> create|add drivefolderpath to allow specifying paths as returned by gam <UserTypeEntity> print filepath.

6.42.06

Fixed another bug in gam <UserTypeEntity> create|add drivefolderpath that failed when trying to build a folder hierarchy on a Shared Drive.

6.42.05

Fixed bug in gam <UserTypeEntity> create|add drivefolderpath that failed when trying to build a folder hierarchy on a Shared Drive.

6.42.04

Added a command that creates a folder hierarchy.

6.42.03

Updated gam <UserTypeEntity> get drivefile <DriveFileEntity> ... csvsheet <SheetEntity> to allow selection of the output format with format <FileFormat>. Previously, csv was always selected and it is still the default. Valid formats are: csv,tsv,ods,pdf,xlsx.

6.42.02

Added sha1checksum and sha256checksum to <DriveFieldName>.

The SHA1/SHA256 checksum associated with a file, if available.
This field is only populated for files with content stored in Google Drive;
it isn't populated for Docs Editors or shortcut files.

Added option addcsvdata <FieldName> <String> to gam <UserTypeEntity> print filelist and gam print ownership. This adds additional columns of data to the CSV file output.

Get a list of a user's shortcuts
gam redirect csv ./TSShortcuts.csv user user@domain.com print filelist fields id,name,parents,shortcutdetails showmimetype gshortcut
Headers
Owner,id,name,parents,parents.0.id,parents.0.isRoot,shortcutDetails.targetId,shortcutDetails.targetMimeType

For each shortcut, get the target file information; add the shortcut id, name and parent to the output
gam redirect csv ./TSShortcutFiles.csv multiprocess csv ./TSShortcuts.csv gam user user@domain.com print filelist select "~shortcutDetails.targetId" norecursion showownedby any
    fields id,name,mimetype,parents,owners.emailaddress addcsvdata shortcut.id "~id" addcsvdata shortcut.name "~name" addcsvdata shortcut.parents "~parents.0.id"
Headers
Owner,id,name,mimeType,owners,owners.0.emailAddress,parents,parents.0.id,parents.0.isRoot,shortcut.id,shortcut.name,shortcut.parents

6.42.01

Updated processing of option matchlabel <LabelName> to replace the following characters with a - so that the query generated will work correctly. Previously, only (space) and / were replaced.

 &()"|{}/

6.42.00

Following Jay's lead, added commands commands to copy Google Vault and Organization Takeout data to your own GCS bucket.

Updated gam <UserTypeEntity> create contact to treat the following options as errors; previously, they were silently ignored.

addcontactgroup <ContactGroupItem>
removecontactgroup <ContactGroupItem>

Updated version number to align with Standard GAM.

6.32.05

Fixed bug in gam show chromepolicies that caused a trap.

Following Jay's lead, added sharingfoldersrequiresorganizerpermission to <SharedDriveRestrictionsFieldName> and <SharedDriveRestrictionsSubfieldName>.

6.32.04

Fixed bug in gam <UserTypeEntity> move drivefile <DriveFileEntity> where the following error was not retried when sendemailifrequired was specified.

    User: user@domain.com, Drive Folder: Test, Permission: noninherited/writer/user/user@external.com, Copy Failed: You are trying to invite user@external.com. Since there is no Google account
              associated with this email address, you must check the "Notify people" box to invite this recipient.

6.32.03

Following Jay's lead, updated gam create project to handle the following error:

ERROR: 403: Permission 'resourcemanager.projects.get' denied on resource

6.32.02

Added support for gender subfields in gam <UserTypeEntity> signature and gam <UserTypeEntity> create|update sendas option replace <Tag> <UserReplacement>.

<GenderSubfieldName> ::=
        addressmeas|
        customgender|
        type
<UserReplacementFieldSubfield> ::=
        ...
        gender.<GenderSubfieldName>|
        ...

6.32.01

Extended csv_input_row_filter, csv_input_row_drop_filter, csv_output_row_filter and csv_output_row_drop_filter to allow specification of filters based on text comparisons.

6.32.00

Added option oneitemperrow to gam <UserTypeEntity> print filelist to have each of a files permissions displayed on a separate row with all of the other file fields. This produces a CSV file that can be used in subsequent commands without further script processing.

Added option pmfilter to gam <UserTypeEntity> print filelist that is used in conjunction with permission matching. By default, permission matching simply selects which files to display, all ACLS are displayed. With pmfilter, only the ACLs that match are displayed.

6.31.09

Updated gam gam <UserTypeEntity> create label <String>, gam <UserTypeEntity> create labellist <LabelNameEntity> and gam <UserTypeEntity> update labelsettings <LabelName> to expand the choices for label colors.

<ColorHex> ::= "#<Hex><Hex><Hex><Hex><Hex><Hex>"
<LabelColorHex> ::=
        #000000|#076239|#0b804b|#149e60|#16a766|#1a764d|#1c4587|#285bac|
        #2a9c68|#3c78d8|#3dc789|#41236d|#434343|#43d692|#44b984|#4a86e8|
        #653e9b|#666666|#68dfa9|#6d9eeb|#822111|#83334c|#89d3b2|#8e63ce|
        #999999|#a0eac9|#a46a21|#a479e2|#a4c2f4|#aa8831|#ac2b16|#b65775|
        #b694e8|#b9e4d0|#c6f3de|#c9daf8|#cc3a21|#cccccc|#cf8933|#d0bcf1|
        #d5ae49|#e07798|#e4d7f5|#e66550|#eaa041|#efa093|#efefef|#f2c960|
        #f3f3f3|#f691b3|#f6c5be|#f7a7c0|#fad165|#fb4c2f|#fbc8d9|#fcda83|
        #fcdee8|#fce8b3|#fef1d1|#ffad47|#ffbc6b|#ffd6a2|#ffe6c7|#ffffff
<LabelBackgroundColorHex> ::=
        #16a765|#2da2bb|#42d692|#4986e7|#98d7e4|#a2dcc1|
        #b3efd3|#b6cff5|#b99aff|#c2c2c2|#cca6ac|#e3d7ff|
        #e7e7e7|#ebdbde|#f2b2a8|#f691b2|#fb4c2f|#fbd3e0|
        #fbe983|#fdedc1|#ff7537|#ffad46|#ffc8af|#ffdeb5
<LabelTextColorHex> ::=
        #04502e|#094228|#0b4f30|#0d3472|#0d3b44|#3d188e|
        #464646|#594c05|#662e37|#684e07|#711a36|#7a2e0b|
        #7a4706|#8a1c0a|#994a64|#ffffff

backgroundcolor "<LabelColorHex>|<LabelBackgroundColorHex>|custom:<ColorHex>"
textcolor "<LabelColorHex>|<LabelTextColorHex>|custom:<ColorHex>"

6.31.08

Updated csv_output_header_force variable in gam.cfg that is a list of <Strings> to be the exact list of headers to be included in the CSV file written by a gam print command. This might be used when the CSV file data is to be uploaded into a database and some headers may not be present in the output but must be included for the upload to work.

6.31.07

Added csv_output_header_force variable to gam.cfg that is a list of <Strings> that are forced for inclusion in the CSV file written by a gam print command. This might be used when the CSV file data is to be uploaded into a database and some headers may not be present in the output but must be included for the upload to work.

6.31.06

Added support for new ChromeOS device fields:

<CrOSFieldName> ::=
        deprovisionreason|
        firstenrollmenttime|
        lastdeprovisiontimestamp|

6.31.05

Google can return an error Internal error on API calls; by default, GAM retries these API calls an additional 9 times for a total of 10 tries. In some cases, determined by experience, the additional retries are unlikely to succeed and GAM performs 1 additional retry rather than 9 for a total of 2 tries.

Added bail_on_internal_error_tries variable to gam.cfg that is used by GAM to control the total number of tries for these API calls; Google seems to be sending this error when it is very busy. The default value is 2 and values from 1 to 10 are allowed. This is a rare event, this is an experiment to see if retrying these errors more times leads to success.

6.31.04

Added commands to display Chrome Devices Needing Attention counts.

gam print chromeneedsattn [todrive <ToDriveAttribute>*]
        [(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
         (ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
        [formatjson [quotechar <Character>]]
gam show chromeneedsattn
        [(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
         (ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
        [formatjson]

6.31.03

Added commands to display Chrome Auto Update Expiration counts.

gam print chromeaues [todrive <ToDriveAttribute>*]
        [(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
         (ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
        [minauedate <Date>] [maxauedate <Date>]
        [formatjson [quotechar <Character>]]
gam show chromeaues
        [(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
         (ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
        [minauedate <Date>] [maxauedate <Date>]
        [formatjson]

6.31.02

Updated gam <UserTypeEntity> vacation to process (replace <Tag> <String>)* in the subject.

6.31.01

Added option nofile to gam <UserTypeEntity> get photo|profilephoto that causes GAM to suppress writing the photo data to a file. This would typicically be used when you are capturing the photo data written to stdout.

6.31.00

Added retry_api_service_not_available variable to gam.cfg that is used to have GAM retry Service not applicable errors on API calls; Google seems to be sending this error when it is very busy. This is a rare event, this is an experiment to see if GAM can identify these errors and retry them.

6.30.18

Fixed bug in gam <UserTypeEntity> move drivefile where the modified time of files was inappropriately being changed.

6.30.17

Updated code for gam <UserTypeEntity> get profilephoto size <Integer> to account for API documentation error.

6.30.16

Added option nodefault to gam <UserTypeEntity> get profilephoto that causes GAM to display an error message and set the return code to 50 if the user has a default profile photo.

6.30.15

Added option gphoto <EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity> to gam <UserTypeEntity> update photo that specifies an owner and file to be used as the source of the photo.

6.30.14

Fixed bug in gam <UserTypeEntity> print|show peopleprofile fields ... where metadata was being displayed even when showmetadata was not specified.

6.30.13

Fixed bug in gam <UserTypeEntity> show fileinfo <DriveFileEntity> fields shortcutdetails.targetid that caused a trap.

Added option size <Integer> to gam <UserTypeEntity> get profilephoto that specifies the size in pixels of the file to download.

6.30.12

Updated gam update group <GroupEntity> update [<GroupRole>] [[delivery] <DeliverySetting>] <UserTypeEntity> to handle the following error when <UserTypeEntity> is an external member.

ERROR: 404: resourceNotFound - Does not exist

This is a Google bug where some external members can't be updated by email address.

6.30.11

Added option emailmatchpattern [not] <RegularExpression> to gam <UserTypeEntity> delete group|groups that allows deleting a user from all groups of which they are a member based on (not) matching the group email address.

6.30.10

Added the ability to specify fields when displaying calendars.

6.30.09

Added the following shortcuts to <DriveFileQueryShortcut>:

* my_top_files - "'me' in owners and mimeType != application/vnd.google-apps.folder and 'root' in parents"
* my_top_folders - "'me' in owners and mimeType = application/vnd.google-apps.folder and 'root' in parents"
* my_top_items - "'me' in owners and 'root' in parents"

6.30.08

Following Jay's lead, added the following License SKUs:

1010390001 - Assured Controls
1010400001 - Beyond Corp Enterprise

6.30.07

Added option sheetsfields <SpreadsheetSheetsFieldList> to gam <UserTypeEntity> print|show sheet <DriveFileEntity> that lets you specfiy the desired subfields from the sheets field of a spreadsheet that should be displayed. By default, all sheets subfields are displayed.

<SpreadsheetSheetsField> ::=
        bandedranges|
        basicfilter|
        charts|
        columngroups|
        conditionalformats|
        data|
        developermetadata|
        filterviews|
        merges|
        properties|
        protectedranges|
        rowgroups|
        slicers
<SpreadsheetSheetsFieldList> ::= "<SpreadsheetSheetsField>(,<SpreadsheetSheetsField>)*"

6.30.06

Fixed bug in gam <UserTypeEntity> create|update|delete drivefileacl <DriveFileEntity> ... updatesheetprotectedranges that caused a trap.

6.30.05

Cleaned up code for option updatesheetprotectedranges in gam <UserTypeEntity> create|update|delete drivefileacl <DriveFileEntity>.

6.30.04

Improved output formatting for field sheets in gam <UserTypeEntity> info sheet <DriveFileEntity>.

6.30.03

Updated gam <UserTypeEntity> create|update drivefileacl <DriveFileEntity> commands to handle the following error.

ERROR: 403: fileOrganizerOnFoldersInSharedDriveOnly - FileOrganizer role is only allowed on folders.

Added option updatesheetprotectedranges to gam <UserTypeEntity> create|update|delete drivefileacl <DriveFileEntity> commands that causes GAM to update Sheet Protected Ranges if <DriveFileEntity> is a Google Sheet.

6.30.02

Fixed error message in gam print cigroups when an invalid field was specified.

6.30.01

Fixed bug in gam create cigroup <EmailAddress> name <String> <GroupAttribute>+ where the group name was set to <EmailAddress> rather than <String>.

6.30.00

Added option returnidonly to gam <UserTypeEntity> show fileinfo <DriveFileEntity> that causes GAM to return just the file ID of the files in <DriveFileEntity> file as output.

$ gam user user@domain.com show fileinfo root returnidonly
0AHYenC8f12ALUk9xyz

$ gam user testsimple show fileinfo name "Test File" returnidonly
0B3YenC8f12ALflhUTmtNS3E2Vk9LSUpBVXRSUG5lQ29GWkRtWHM1VzU1blc4ZW1pb2FnNTA

Changed the display format of file paths for files on Shared Drives.

  • Old format - SharedDrive(TS Shared Drive 6)/TS SD6 Folder/TS TD6 Doc
  • New format -SharedDrives/TS Shared Drive 6/TS SD6 Folder/TS TD6 Doc

Added option returnpathonly to gam <UserTypeEntity> show filepath <DriveFileEntity> that causes GAM to return just the file path of the files in <DriveFileEntity> file as output.

$ gam user user@domain.com show filepath name "Test File" returnpathonly
My Drive/Classroom/Test File

$ gam user user@domain.com show filepath 0AJ6mqwXP9wHxUk9xyz returnpathonly
TS Shared Drive 6

$ gam user testsimple show filepath 0AJ6mqwXP9wHxUk9xyz returnpathonly fullpath
SharedDrives/TS Shared Drive 6

$ gam user user@domain.com show filepath teamdriveid 0AJ6mqwXP9wHxUk9xyz teamdrivefilename "TS TD6 Doc" returnpathonly
SharedDrives/TS Shared Drive 6//TS SD6 Folder/TS TD6 Doc

Added command gam comment <String>* that displays the comment data on stdout. This can be used to validate csv_input_row_filters and column value extraction.

$ more Comment.csv 
col1,col2
aaa,111
bbb,222
ccc,333
$ gam config csv_input_row_drop_filter "col1:regex:bbb" csv Comment.csv gam comment "Col1:~~col1~~" "Col2:~~col2~~"
2022-12-16T12:41:50.045-08:00,0/2,Using 2 processes...
Col1:aaa Col2:111
Col1:ccc Col2:333

Updated gam <UserTypeEntity> create|delete license <SKUIDList> to take a list of SKUs.

Updated gam create user <EmailAddress> ... license <SKUIDList> to take a list of SKUs.

Updated gam <UserTypeEntity> sync license <SKUIDList> to take a list of SKUs and added option allskus|onesku that is required when multiple SKUs are specified.

  • allskus indicates that users in <UserTypeEntity> will be updated to have all of the SKUs in <SKUIDList>.
    • This is typically used when assigning different types of licenses, such as an Enterprise license and a Voice license.
  • onesku indicates that users in <UserTypeEntity> with none of the licenses in<SKUIDList> will be updated to have the first available license SKU in <SKUIDList>.
    • This is typically used with Google Education Plus or Google Education Standard licenses, which are split across multiple SKUs.

Added option basic to gam print cigroups that causes GAM to display the basic Cloud Identity Group fields, i.e., those fields that do not require an additional API call per group.

Following Jay's lead, added option query <String> to gam print cigroups.

6.29.21

Fixed bugs in gam selectfilter that caused traps or inappropriate error messages.

6.29.20

Fixed bug in gam <UserTypeEntity> archive messages <GroupItem> that caused a trap.

6.29.19

Fixed bug introduced in 6.29.17 in todrive that caused a trap.

6.29.18

Added the following variables to gam.cfg to provide more flexibility when multiple row filters are specified.

  • csv_input_row_filter_mode allmatch|anymatch
    • allmatch - all filters must match to include in input; this is the default and is the current behavior
    • anymatch - any filter must match to include in input
  • csv_input_row_drop_filter_mode allmatch|anymatch
    • allmatch - all filters must match to drop from input
    • anymatch - any filter must match to drop from input; this is the default and is the current behavior
  • csv_output_row_filter_mode allmatch|anymatch
    • allmatch - all filters must match to include in output; this is the default and is the current behavior
    • anymatch - any filter must match to include in output
  • csv_output_row_drop_filter_mode allmatch|anymatch
    • allmatch - all filters must match to drop from output
    • anymatch - any filter must match to drop from output; this is the default and is the current behavior

6.29.17

Added option todrive tdcellnumberformat text|number that causes GAM to set the Sheet Number format when uploading files with todrive. If the option is not specified, no number format is specified.

6.29.16

Fixed bug introduced in 6.29.15 that caused an error like this:

ERROR: Config File: gam.cfg, Section: DEFAULT, Item: todrive_locale, Value: "en_us", Expected: ,ar-eg,az-az,be-by,bg-bg,bn-in,ca-es,cs-cz,cy-gb,da-dk,de-ch,de-de,el-gr,en-au,en-ca,en-gb,en-ie,en-us,es-ar,es-bo,es-cl,es

6.29.15

Updated gam [<UserTypeEntity>] info|print|show drivelabels languagecode <DriveLabelLanguageCode> to use the BCP-47 language code.

6.29.14

Added option stripcrsfromtitle to gam <UserTypeEntity> print|show datastudioassets that causes carriage returns, linefeeds and nulls to be stripped from asset titles.

6.29.13

Updated status messages in gam delete|update chromepolicy to be more informative.

Fixed bug in gam delete chromepolicy with schema chrome.users.apps.InstallType.

6.29.12

Fixed issue in gam update chromepolicy with schemas chrome.users.apps.ManagedConfiguration, chrome.devices.managedguest.apps.ManagedConfiguration and chrome.devices.kiosk.apps.ManagedConfiguration.

6.29.11

Improved performance of gam update chromepolicy.

6.29.10

Attempted to fix issues in gam update chromepolicy with schemas chrome.users.apps.InstallType and chrome.users.apps.IncludeInChromeWebStoreCollection.

6.29.09

Fixed bug in gam <UserTypeEntity> create tasklist that caused a trap.

Added countsonly option to gam <UserTypeEntity> print|show tasks|tasklists that causes GAM to display the number of tasks|tasklists for a user rather than listing the details.

Added option due <Time> to <TaskAttribute> that can be used to set a task due date in gam <UserTypeEntity> create|update task.

Fixed bug in gam update chromepolicy that caused an error with this prefix: 1 Chrome Policy Update Failed: Invalid enum value:

6.29.08

Fixed bug where csvfile -:fieldName was not properly recognized on Windows.

6.29.07

Added option from <EmailAddress> to gam create|update user ... notify <EmailAddressList> that uses <EmailAddress> as the from address rather than the admin user identified in oauth2.txt.

6.29.06

Following Jay's lead, added option returnnameonly to gam create|update inboundssoprofile that causes GAM to display just the profile name of the created|updated profile. This will be useful in scripts that create|update a profile and then want to perform subsequent GAM commands that reference the profile.

6.29.05

Improved code for gam [<UserTypeEntity>] create teamdrive <Name> ou <OrgUnitItem>.

6.29.04

Updated multiprocessing on macOS to use spawn instead of fork when starting subprocesses as fork was unreliable when large numbers (>20) of threads were used; subprocesses would hang and never complete.

6.29.03

Thanks to Jay, added support for the user field displayName that can be set independently of fullName.

6.29.02

Thanks to Jay, updated gam info|print|show crostelemetry to avoid the following trap: KeyError: 'temperatureCelsius'

6.29.01

Fixed bug in gam <UserTypeEntity> print|show labels where fields messageListVisibility, labelListVisibility and color were not displayed.

Fixed bug in gam <UserTypeEntity> draft|insert|import message emlfile <FileName> where the Date header in the file was overridden with the current date.

6.29.00

Added option emlfile <FileName> to gam <UserTypeEntity> draft|insert|import message that allows processing an EML message file. SMTP headers specified in the command will replace those in the message file.

Following Jay's lead, added commands to manage/display Inbound SSO.

6.28.12

Fixed bug in gam create|update user ... password random notify <EmailAddress> that caused a trap when the random password contained { and }.

6.28.11

Fixed bug in gam <UserTypeEntity> update contact ... birthday "" that caused a trap rather that clearing the birthday from the contact.

6.28.10

Added option addcsvdata <FieldName> <String> to gam create shareddrive ... csv. This adds additional columns of data to the CSV file output. For example, you are building student Shared Drives and want to add ACLs to them adding the students as organizers. By adding the student's primary email address to the CSV output, it can be used in subsequent commands.

StudentSharedDrives.csv
primaryEmail,Name
bob@domain.com,Bob Jones
mary@domain.com,Mary Smith
...

# Create the student Shared Drives
gam redirect stdout ./StudentSharedDrivesCreated.txt multiprocess redirect stderr stdout redirect csv ./StudentSharedDrivesCreated.csv multiprocess csv StudentSharedDrives.csv gam create shareddrive "~Name" csv addcsvdata primaryEmail "~primaryEmail"
# Add ACLs granting the students organizer access to their Shared Drives.
gam redirect stdout ./StudentSharedDrivesAccess.txt multiprocess redirect stderr stdout csv StudentSharedDrivesCreated.csv gam add drivefileacl "~id" user "~primaryEmail" role organizer

6.28.09

Updated `gam print filelist "query:mimeType='application/vnd.google-apps.folder'" to prevent the following error.

ERROR: Invalid choice (query:mimetype='application/vnd): Expected <capabilities|contentrestrictions|labelinfo|labels|lastmodifyinguser|owners|parents|permissions|sharinguser|shortcutdetails|trashinguser>

6.28.08

Added option today to gam report to look for events on the current day. This will be most useful with gam report <ActivityApplictionName> as gam report users|customers rarely has data for the current day.

Added option today to gam <UserTypeEntity> print|show driveactivity to look for events on the current day.

6.28.07

Added option csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)* to gam <UserTypeEntity> copy drivefile that causes GAM to output CSV data detailing the name, id and mimeType of the copied files and folders rather than text messages. These are the CSV headers:

User,name,id,newName,newId,mimeType

You can add additional columns of data from the command line to the CSV data with (addcsvdata <FieldName> <String>)*.

Added option suppressnotselectedmessages [<Boolean>] to gam <UserTypeEntity> copy drivefile that causes GAM to suppress text messages referencing files and folders not selected for copying by the following options:

copysubfiles false [filenamematchpattern <RegularExpression>] [filemimetype [not] <MimeTypeList>]
copysubfolders false [foldernamematchpattern <RegularExpression>
copysubshortcuts false [shortcutnamematchpattern <RegularExpression>

6.28.06

Fixed bug in gam <UserTypeEntity> print|show messages ... showbody that caused a trap.

Added code to handle the following error that occurs when copying permissions:

ERROR: 400: shareInNotPermitted - Bad Request. User message: "An item can't be shared with user@domain.com because of domain.com sharing policy"

6.28.05

Added the following items to <UserMultiAttribute>:

  • employeeid <String> as a synonym for externalids organization <String>
  • manager <String> as a synonym for relations manager <String>

Added the following items to <UserFieldName>:

  • employeeid as a synonym for externalids
  • manager as a synonym for relations

6.28.04

Added filtercontactgroup <PeopleContactGroupItem> to <PeoplePrintShowUserContactSelection> that is used by gam <UserTypeEntity> print|show contacts. When selectcontactgroup <PeopleContactGroupItem> is used in these commands, GAM makes an API call to get the list of contacts in <PeopleContactGroupItem> and then makes an API call per contact to get the details; this may exceed quota limits. When filtercontactgroup <PeopleContactGroupItem> is used, GAM makes an API call to get all contacts and then filters the list to only those in <PeopleContactGroupItem>; quota limits should not apply.

6.28.03

Build macOS x86_64 and arm64 executables.

6.28.02

Fixed bug in gam forward message|thread that misformatted the message when Cc: was present.

6.28.01

Fixed bug in gam forward message|thread where subject was blanked out.

6.28.00

  • Upgraded to Python 3.11.0 where possible.
  • Upgraded to OpenSSL 3.0.7 where possible.

Fixed bug in gam forward message where messages originally sent to multiple recipients were not forwarded correctly.

Added command to forward threads; all messages referenced by the thread are forwarded; this is experimental, test.

gam <UserTypeEntity> forward thread|threads recipient|to <RecipientEntity>
        (((query <QueryGmail>) (matchlabel <LabelName>) [or|and])+
         [quick|notquick] [doit] [max_to_forward <Number>])|(ids <MessageIDEntity>)
        [subject <String>]

6.27.21

Eliminated superfluous column header labels in gam print cigroups.

Added command to forward messages; this is experimental, test.

gam <UserTypeEntity> forward message|messages recipient|to <RecipientEntity>
        (((query <QueryGmail>) (matchlabel <LabelName>) [or|and])+
         [quick|notquick] [doit] [max_to_forward <Number>])|(ids <MessageIDEntity>)

6.27.20

Added option url <URL> to gam <UserTypeEntity> create|update drivefile that allows GAM to upload files referenced by URL to Google Drive.

Added csv_input_row_limit variable to gam.cfg that is used to limit the number of rows read from a CSV file.

Added csv_output_row_limit variable to gam.cfg that is used to limit the number of rows written to a CSV file.

6.27.19

Added option embedimage <FileName> <String> to the following commands that allows embedding images in HTML email messages.

gam sendemail [recipient|to] <RecipientEntity>
gam <UserTypeEntity> sendemail recipient|to <RecipientEntity>
gam <UserTypeEntity> sendemail from <EmailAddress>
gam <UserTypeEntity> draft|import|insert message

Your HTML message will contain lines like this:

<img src="cid:image1"/>
<img src="cid:image2"/>

Your command line will have: embedimage file1.jpg image1 embedimage file2.jpg image2

Added archive as a synonym for archived and suspend as a synonym for suspended in <UserBasicAttribute>.

6.27.18

Added option tdshare <EmailAddress> commenter|reader|writer to <ToDriveAttribute>. When a new todrive file is created, i.e., tdfileid <DriveFileID> is not specified, the uploaded file will be shared as specified. <EmailAddress> must be valid within your Google Workspace.

6.27.17

Updated todrive tdfileid <DriveFileID> to display an informative error message when Google generates an Internal Error. It appears that the file was successfully uploaded and converted to a sheet but the conversion took longer that the API was willing to wait, so it generated the error.

6.27.16

Updated todrive tdfileid <DriveFileID> to not perform retries for Internal Error when updating an existing file as the 6.27.15 update didn't fix the underlying problem.

6.27.15

Fixed bug in gam show chromeschemas that caused a trap due to unexpected data from Google.

Updated gam <UserTypeEntity> collect orphans to handle the error:

ERROR: 403: shortcutTargetInvalid - The specified file is not an allowed shortcut target type.

These are typically Google Backup & Sync images of laptops.

Fixed bug in gam <UserTypeEntity> sendemail from <EmailAddress> that reported:

User: user@domain.com, Send Email to 0 Recipients

Updated todrive tdfileid <DriveFileID> to perform retries for Internal Error when updating an existing file.

Added option noselfowner to all commands that print or show calendar ACls; it suppresses the display of ACLs that reference the calendar itself as its owner.

6.27.14

Extended gam print addresses to include information about domains and resource calendars. A new column Target was added that displays target information for user, group and domain aliases.

6.27.13

Added option showdate to gam <UserTypeEntity> print|show messages|threads that displays the internalDate field for a message|thread.

The internal message creation timestamp (epoch ms), which determines ordering in the inbox.
For normal SMTP-received email, this represents the time the message was originally accepted by Google,
which is more reliable than the Date header.

6.27.12

Added option labellist <LabelNameEntity> to gam <UserTypeEntity> print|show labels to allow selection of labels to display.

Added option cigrouptree to gam info user. Previously, the grouptree option used the Cloud Identity Groups API to display the users group tree structure. This API is licensed and the command would generate an error if you didn't have the license. Now, the grouptree option uses the Directory API and the cigrouptree option uses the Cloud Identity Groups API.

Updated gam <UserTypeEntity> collect orphans to not use shortcuts by default. If an orphan file can have its parent changed without affecting its access by other users, the parent is changed. If a parent change would affect the access by other users, a shortcut is created. You can still use the useshortcuts true option to force the use of shortcuts. If you specify the preview option, a new column, action, shows changeParent or createShortcut to indicate what action will be taken when preview is omitted.

6.27.11

Added options showparentsaslist [<Boolean>] and delimiter <Character> to gam print grouptree and gam <UserTypeEntity> print grouptree that display the group parent emails and names in two columns as delimited lists rather than multiple indexed columns.

Added options downloadattempts <Integer> and retryinterval <Integer> to gam download vaultexport that cause GAM to wait for a vault export to be completed. By default, GAM makes only one download attempt. If multiple attempts are specified with downloadattempts <Integer>, GAM waits retryinterval <Integer> seconds between attempts; the default retry interval is 30 seconds.

6.27.10

Added command gam <UserTypeEntity> print|show grouptree to display a user's groups and their parent groups.

6.27.09

Corrected JSON output in gam <UserTypeEntity> print userlist.

6.27.08

Added command gam <UserTypeEntity> print userlist to display the list of users in <UserTypeEntity> in a single row.

6.27.07

Fixed bug introduced in 6.27.06 that caused commands that get a list of groups for a specific user to fail; e.g., gam info user user@domain.com.

6.27.06

Fixed bug in gam print addresses where no output was generated.

Updated multiprocessing to fix issues on Mac OS where excuting commands from a CSV file would hang if the number of threads was 20 or greater.

6.27.05

Updated gam create vaultexport to handle the following error that occurs when the region option is specified but is not allowed by your licenses.

ERROR: 400: invalidArgument - Request contains an invalid argument.

6.27.04

Updated gam download vaultexport to replace : with - in the download filename to avoid issues on Windows.

6.27.03

Fixed update in 6.27.01 to allow empty resource calendar feature lists.

6.27.02

Added options labelinfo and <DriveLabelInfoSubfieldName> to <DriveFieldName> and option includelabels <DriveLabelIDList> to gam <UserTypeEntity> show fileinfo and gam <UserTypeEntity> print filelist to allow easier access to display drive file labels. This options do not require an extra API call like the showlabels details|ids option does.

gam user user@domain.com show fileinfo 1kM4T2K4l0CCdR8lmp0pdXcytghAzXZ2fe5ThQpDwxyz fields id,name,mimetype,labelinfo includelabels "mRoha85IbwCRl490E00xGLvBsSbkwIiuZ6PRNNEbbFcb"
gam user user@domain.com show fileinfo query "'labels/mRoha85IbwCRl490E00xGLvBsSbkwIiuZ6PRNNEbbFcb' in labels" fields id,name,mimetype,labelinfo.fields includelabels "mRoha85IbwCRl490E00xGLvBsSbkwIiuZ6PRNNEbbFcb"

6.27.01

Updated <ResourceAttribute> to allow features "" for resources.

6.27.00

Updated code to use Python yield functionality when downloading long lists of items from Google APIs.

6.26.17

Fixed bug in gam <UserTypeEntity> print filelist ... showparent where parent folder was not shown in all cases.

Following Jay's lead, updated gam info customer|domain to provide better information when executed by a non super admin.

6.26.16

Updated gam <UserTypeEntity> collect orphans to include orphaned folders that were previously excluded due to multi-parenting issues.

6.26.15

Updated gam <UserTypeEntity> collect orphans to use shortcuts by default rather than making parent changes.

This addresses the following issue:

  • testuser2 owns a file X1234 located in a folder owned by user testuser1 and shared with additional users
  • testuser1 removes testuser2's access to that folder
  • File X1234 now looks like an orphan to testuser2
  • gam user testuser2 collect orphans useshortcuts false
  • This moves X1234 to the folder testuser2 orphaned files; i.e., it has a new parent
  • testuser1 and all other users no longer have access to X1234 as it is now in a folder for which they have no access

Updated gam <UserTypeEntity> add|delete|update|print|show datastudiopermissions to display an appropriate error message, The caller does not have permission, when the user doesn't have permission to execute the command. Previously, the following incorrect error message was displayed: ERROR: Data Studio API not enabled. Please run "gam update project" and "gam user user@domain.com update serviceaccount"

6.26.14

Extended csv_input_row_filter, csv_input_row_drop_filter, csv_output_row_filter and csv_output_row_drop_filter to allow specification of filters based on field string length.

6.26.13

Fixed bug in gam <UserTypeEntity> copy othercontacts that caused it to move a contact rather than copy it.

6.26.12

Fixed bug in gam <UserTypeEntity> replacedomain contacts that caused the error ERROR: Invalid argument.

Fixed bug in gam <UserTypeEntity> print filetree where some orphaned files were not displayed.

6.26.11

Updated gam info group <GroupEntity> ... formatjson to omit "cloudIdentity": {}, from the output when no Cloud Identity fields are requested.

Updated gam info user <UserTypeEntity> error message reporting to give this message for non-existent users in the primary or sub domains.

User: user@domain.com, Does not exist
User: user@sub.domain.com, Does not exist

Previously, a non-existent user in a sub domain gave this error.

User: user@sub.domain.com, Service not applicable/Does not exist

6.26.10

Fixed bug in gam print deviceusers where command would never terminate. This would also occur in gam print devices when nodeviceusers was not specified.

Added option select <DeviceID> to gam print deviceusers that displays device users for a specific device.

6.26.09

With many thanks to Jay:

  • Added more OpenSSL 3.0.5 support
  • Added support for Linux Ubuntu 22.04 Jammy Jellyfish x86_64

6.26.08

  • Upgraded to Python 3.10.7
  • Updated google-api-python-client to version 2.60.0
  • Dropped support for Linux Precise (glibc 2.15)

6.26.07

Fixed bug in gam <UserTypeEntity> update photo "https://drive.google.com/thumbnail?sz=w300&id=xxxxxxxxxxxxxxxxx" that generated a Update Failed: Not Found: xxxxxxxxxxxxxxxxx error.

6.26.06

Added endpointverificationspecificattributes to <DeviceFieldName> used by gam info device and gam print devices.

6.26.05

Fixed bug in gam <UserTypeEntity> update contacts ... removecontactgroup <ContactGroupItem> that failed to remove the contact group <ContactGroupItem> when it was specified as the contact group formatted name as opposed to the resource name; e.g., Work Contacts as opposed to contactGroups/2ef39b48f4e361a.

6.26.04

Updated gam print courses ... aliasesincolumns to properly align Aliases columns.

6.26.03

Updated the following commands to display a usage error (ERROR: Invalid file selection with adminaccess|asadmin) if <DriveFileEntity> does not reference Shared Drives. Previously, execution errors (Shared drive not found: xxxx) would be displayed.

gam [<UserTypeEntity>] create|add drivefileacl <DriveFileEntity> [adminaccess|asadmin]
gam [<UserTypeEntity>] update drivefileacl <DriveFileEntity> <DriveFilePermissionIDorEmail> [adminaccess|asadmin]
gam [<UserTypeEntity>] delete drivefileacl <DriveFileEntity> <DriveFilePermissionIDorEmail> [adminaccess|asadmin]
gam [<UserTypeEntity>] info drivefileacl <DriveFileEntity> <DriveFilePermissionIDorEmail> [adminaccess|asadmin]
gam [<UserTypeEntity>] print drivefileacls <DriveFileEntity> [todrive <ToDriveAttribute>*] [adminaccess|asadmin]
gam [<UserTypeEntity>] show drivefileacls <DriveFileEntity> [adminaccess|asadmin]
gam [<UserTypeEntity>] create|add permissions <DriveFileEntity> <DriveFilePermissionsEntity> [adminaccess|asadmin]
gam [<UserTypeEntity>] delete permissions <DriveFileEntity> <DriveFilePermissionIDEntity> [adminaccess|asadmin]

6.26.02

Added option 'includederivedmembership' to gam <UserTypeEntity> check groups to allow checking if a user is a member of a group or one of its sub-groups.

6.26.01

Added option nodetails to gam print|show groups` that simply lists the user's groups without making the addtional API call per group to get role, status and delivery settings.

Added command that allows checking if a user is a member of specific groups and optionally has a specific role.

6.26.00

Build macOS universal version.

  • Upgraded to OpenSSL 3.0.5 where possible.

Updated code in gam create course <CourseAttribute>* copyfrom <CourseID> to avoid a trap caused by Google returning unexpected data in the DueTime field for course work.

6.25.21

Fixed bug in gam <UserTypeEntity> check drivefileshortcut that caused a trap when checking a shortcut on a Shared Drive.

6.25.20

Updated gam <UserTypeEntity> print|show shareddrives to handle spurious Google Drive API error.

ERROR: 404: fileNotFound - Does not exist

6.25.19

Updated code to reflect Google change in how Cloud Identity User Invitations API is authenticated.

6.25.18

Updated processing of CSV files to allow a Google Doc to be downloaded as plain text and processed as a CSV file.

These are allowed

gdoc <UserGoogleDoc>
gdoc:<FieldName>)+ <UserGoogleDoc>

wherever the following are allowed.

gsheet <UserGoogleSheet>
gsheet(:<FieldName>)+ <UserGoogleSheet>

6.25.17

Added options [formatjson [quotechar <Character>]] to gam print group-members|cigroup-members.

Following Jay's lead, improved command gam checkconnection.

6.25.16

Added the following option to gam <UserTypeEntity> copy drivefile ... recursive to allow more control over what sub files are copied when a top folder is copied.

filemimetype [not] <MimeTypeList>

6.25.15

Following Jay's lead, added command gam checkconnection that performs checks to verify the network connection to Google. This is an initial effort to help diagnose Google connection issues usually caused by firewalls and/or proxies.

  • Upgraded to Python 3.10.6

6.25.14

Added the following options to gam <UserTypeEntity> copy drivefile ... recursive to allow more control over what sub files, folders and shortcuts are copied when a top folder is copied.

copysubfiles [<Boolean>] filenamematchpattern <RegularExpression>
copysubfolders [<Boolean>] foldernamematchpattern <RegularExpression>
copysubshortcuts [<Boolean>] shortcutnamematchpattern <RegularExpression>

Added the following mutually exclusive options to gam <UserTypeEntity> delete|update|sync|print|show groups to allow more control over which groups are processed for a user. The customerid <CustomerID> option will be most useful to resellers.

domain <DomainName>
customerid <CustomerID>

6.25.13

Updated code in gam report users to handle bug in Report API that caused a trap; when the userEmail field is mistakenly omitted, GAM backs up to an earlier date.

Updated gam info user to display the same data (in different formats) when quick is used with and without formatjson.

6.25.12

Added option selectmaincontacts to <PeoplePrintShowUserContactSelection> to allow more flexibility in selecting contacts to display with gam <UserTypeEntity> print|show contacts.

6.25.11

Updated error handling for gam create|delete admin.

6.25.10

Added option norecursion [<Boolean>] to gam <UserTypeEntity> transfer ownership to allow ownership transfer of a folder but not its contents.

6.25.09

Fixed bug in gam oauth info that deleted the scopes in oauth2.txt if it had expired.

6.25.08

Added error checking to gam create datatransfer to avoid a trap.

6.25.07

Fixed bug introduced in 6.25.06 where only one row of a CSV file/Google Sheet was read by default.

6.25.06

Updated option maxrows <Integer> for gam csv|loop to be applied after input row filtering; this allows limiting the number of filtered rows processed as opposed to the number of rows read.

  • maxrows 0 - All rows are processed, this is the default
  • maxrows N - N filtered rows are processed

6.25.05

Added option maxrows <Integer> to gam csv|loop that allows you to limit the number of rows read from the CSV file/Google Sheet. This can be used during testing in order to verify the functioning of the command on a few rows before committing to all of the rows.

gam csv|loop <FileName>|-|(gsheet <UserGoogleSheet>) [charset <Charset>] [warnifnodata]
        [columndelimiter <Character>] [quotechar <Character>] [fields <FieldNameList>]
        (matchfield|skipfield <FieldName> <RegularExpression>)* [showcmds [<Boolean>]]
        [maxrows <Integer>]
        gam <GAMArgumentList>
  • maxrows -1 - All rows are read, this is the default
  • maxrows 0 - No rows are read
  • maxrows N - N rows are read

6.25.04

Updated gam create|update course ... copyfrom <CourseID> ... copytopics true to preserve the topics order.

6.25.03

Updated gam print users to properly display the languages attribute based on the output format:

  • default - languages column has the value en+
  • formatjson - JSON column contains "languages": [{"languageCode": "en", "preference": "preferred"}]

6.25.02

Added option missingtextvalue <String> to gam <UserTypeEntity> create note json ... that causes GAM to supply a value for JSON list and text items that are missing text fields. This option must appear before the json option. If not specified and a text field is missing, you'll get the following error: Request contains an invalid argument.

6.25.01

Updated license commands to retry the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

Updated https://apps.google.com/user/hub to https://workspace.google.com/dashboard in the new user email message; thanks to @jay-eleven.

6.25.00

Added initial support for the Drive Labels API. GAM can display drive labels and it can apply them to files and display drive labels on files. Please test/experiment and report any issues.

To use these commands you must add the 'Drive Labels API' to your project and update your service account authorization.

gam update project
gam user user@domain.com update serviceaccount

Supported editions for this feature: Business Standard and Business Plus; Enterprise; Education Standard and Education Plus; G Suite Business; Essentials.

6.24.27

Following Jay's lead, updated Cloud Identity API from v1beta1 to v1 for userinvitations commands.

6.24.26

Updated handling of shortcuts in gam <UserTypeEntity> claim|transfer ownership.

6.24.25

Corrected progress messages for gam print groups showownedby.

6.24.24

Added gradebooksettings to <CourseFieldName>.

6.24.23

Increase wait time in gam create project as Google is taking much longer to create projects.

6.24.22

Added option license <SKUID> [product|productid <ProductID>] to gam create user that assigns a license to a user at the time of creation.

6.24.21

Fixed bug in gam <UserTypeEntity> move drivefile ... createshortcutsfornonmovablefiles that caused the following error:

ERROR: 403: shortcutTargetInvalid - The specified file is not an allowed shortcut target type.

6.24.20

Fixed bug in gam <UserTypeEntity> claim ownership that caused a trap.

6.24.19

  • Upgraded to OpenSSL 1.1.1q

6.24.18

Added the following items to <CrOSTypeEntity>:

cros_ou_query <OrgUnitItem> <QueryCrOS>
cros_ou_and_children_query <OrgUnitItem> <QueryCrOS>
cros_ous_query <OrgUnitList> <QueryCrOS>
cros_ous_and_children_query <OrgUnitList> <QueryCrOS>
cros_ou_queries <OrgUnitItem> <QueryCrOSList>
cros_ou_and_children_queries <OrgUnitItem> <QueryCrOSList>
cros_ous_queries <OrgUnitList> <QueryCrOSList>
cros_ous_and_children_queries <OrgUnitList> <QueryCrOSList>

These allow specifying an OU, or a list of OUs, and a query or a list of queries that apply to those OUs.

Example:

gam cros_ou_query /StudentChromebooks "sync:..2019-01-01" update ou "/OldChromebooks"

6.24.17

Updated gam report user to avoid a trap due to an unexpected change in the Reports API.

6.24.16

Fixed bug in gam update cros <CrOSEntity> ... updatenotes "#notes#"abc" that caused a trap when the ChromeOS device didn't previously have notes.

6.24.15

Added pre_provisioned_disable and pre_provisioned_reenable to <CrOSAction>.

Updated code to take advantage of an update to the directory API that simplifies getting ChromeOS devices from an OU and its children.

Fixed bug in gam create|update adminrole where child privileges were not recognized in <PrivilegesList>.

6.24.14

Fixed bug introduced in 6.24.13 that prevented specifying a contact group by name.

6.24.13

The Customer ID value that the Cloud Channel API describes is not the Google Workspace Customer ID value; it is unique to the Cloud Channel API.

Added channel_customer_id variable to gam.cfg that is used in gam print|show channelcustomercentitlements to specify the default value for customerid rather than customer_id from gam.cfg.

6.24.12

Changed how selectcontactgroup <ContactGroupItem> is processed in commands that process user contacts. Previously, GAM would download all of a user's contacts and locally filter to get only the contacts in <ContactGroupItem>. Now, the People API is used to get the list of contacts in <ContactGroupItem> and they are are individually downloaded for processing.

6.24.11

Following Jay's lead, updated gam print devices|deviceusers to try to work around a Google API internal bug (237397223) that generates the following error after an hour:

ERROR: 400: invalidArgument - Request contains an invalid argument.

6.24.10

Updated gam print devices to refresh the access token between listing the devices and listing the device users to try to avoid the following error:

ERROR: 400: invalidArgument - Request contains an invalid argument.

6.24.09

Updated gam print devices|deviceusers to handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.24.08

Added option adminaccess to gam [<UserTypeEntity>] delete teamdrive <SharedDriveEntity> to allow Super Admins to delete Shared Drives even if they are not an organizer.

Added option [<DriveFileParentAttribute>] to gam <UserTypeEntity> claim ownership <DriveFileEntity>. By default, claim ownership does not change the parents of <DriveFileEntity>; this options allows specification of a parent folder in the My Drive of the claiming user <UserTypeEntity>.

Added option [<DriveFileParentAttribute>] to gam <UserTypeEntity> transfer ownership <DriveFileEntity> <UserItem>. By default, transfer ownership does not change the parents of <DriveFileEntity>; this options allows specification of a parent folder in the My Drive of the target user <UserItem>.

  • Upgraded to Python 3.10.5
  • Upgraded to OpenSSL 1.1.1p

6.24.07

Updated commands that process group settings to handle the following error:

ERROR: 401: authError - Authorization Failed

6.24.06

Improved gam user user@domain.com print filecounts select teamdriveid "<DriveFileID>" summary only to display the Shared Drive ID and name on the summary line.

6.24.05

Updated option orderby completed|due|updated to gam <UserTypeEntity> print|show tasks to display tasks in date order regardless of the hierarchy.

Fixed bug in 6.24.03 bug fix in gam <UserTypeEntity> transfer drive <UserItem> ... targetfolderid root ....

6.24.04

Updated gam update chromepolicy to allow zero-length values for TYPE_STRING policy values; this is required to be able to clear a value from such a policy.

6.24.03

Fixed bug in gam <UserTypeEntity> transfer drive <UserItem> ... targetfolderid root ... that transferred data to the source user's root folder, not the target user's root folder.

6.24.02

Fixed bug in gam print crostelemetry that included a spurious column header, devicdId, in the output.

6.24.01

Updated gam <UserTypeEntity> print|show tasks to display tasks in hierarchical order.

Added option orderby completed|due|updated to gam <UserTypeEntity> print|show tasks to display tasks in date order within the hierarchy.

6.24.00

Added commands to manage and display Google Tasks.

6.23.01

Updated gam <UserTypeEntity> create|update|show|print form to give a better error message when the Forms API is not enabled.

ERROR: 403: permissionDenied - Google Forms API has not been used in project XXXXXXX before or it is disabled. Enable it by visiting https://console.developers.google.com/apis/api/forms.googleapis.com/overview?project=XXXXXXX then retry. If you enabled this API recently, wait a few minutes for the action to propagate to our systems and retry.

is replaced with

ERROR: Forms API not enabled. Please run "gam update project" and "gam user user@domain.com update serviceaccount"

6.23.00

Updated gam <UserTypeEntity> copy|move drivefile to produce more informative progress messages. The source file name(ID) are shown as well as the target parent folder name(ID) and target file/folder name(ID).

Deleted options copytopfileparents, copytopfolderparents copysubfileparents and copysubfolderparents from gam <UserTypeEntity> copy drivefile as multi-parent file/folders can not be copied with multiple parents.

Updated gam <UserTypeEntity> copy drivefile to use shortcuts when the same file appears more that once in the copy. The first time the file is processed, it is copied; if it is processed again (because of multiple parents within the source folder structure), a shortcut is created that points to the first copy.

Added option copiedshortcutspointtocopiedfiles [<Boolean>] to gam <UserTypeEntity> copy drivefile. In previous versions, copying shortcuts caused an error because shortcuts can't be copied, they must be re-created.

If a shortcut in the source structure points to a file/folder that is not in the source structure:

  • The shortcut is re-created to point to the original file/folder. If a shortcut in the source structure points to a file/folder that is in the source structure:
  • copiedshortcutspointtocopiedfiles omitted or copiedshortcutspointtocopiedfiles true - The shortcut is re-created to point to the copied file/folder.
  • copiedshortcutspointtocopiedfiles false - The shortcut is re-created to point to the original file/folder.

Deleted options copysubfileparents and copysubfolderparents from gam <UserTypeEntity> move drivefile as multi-parent file/folders can not be moved with multiple parents.

Added option createshortcutsfornonmovablefiles [<Boolean>] to gam <UserTypeEntity> move drivefile to control processing of non-movable files; for example, files owned by users outside of your domain. It causes GAM to create a shortcut in the target folders for files in the source folders that are not movable.

  • createshortcutsfornonmovablefiles omitted or createshortcutsfornonmovablefiles false - No shortcuts are created and an error message is given explaining why the file can't be moved.
  • createshortcutsfornonmovablefiles true - A shortcut is created that points to the non-movable file.

6.22.22

Fixed bug in gam <UserTypeEntity> create|update contact where the relation property was not properly processed.

6.22.21

Fixed bug where redirected stderr output from Gam main process was written after GAM sub processes redirected stderr output.

6.22.20

The following update applies to one or two GAM users, if you're not one of them, stop reading.

When GAM is processing commands with data from a CSV file, csv_input_row_drop_filter and csv_input_row_filter are evaluated and utilized by the GAM main process and are not evaluated or processed by the GAM sub processes.

When GAM is processing commands with data from a CSV file, csv_output_header_drop_filter, csv_output_header_filter, csv_output_row_drop_filter and csv_output_row_filter are evaluated by the GAM main process and utilized by the GAM sub processes.

Evaluating the row filters once in the GAM main process means that <RowValueFilter> forms data:<DataSelector> and notdata:<DataSelector> only read the data from <DataSelector> once.

6.22.19

Updated code to handle OUs with a % in their name. OUs with a + in their name are still handled incorrectly by the API when accessed directly.

6.22.18

Added option oneitemperrow to gam print vaultexports|exports to have each of an exports cloudStorageSink files displayed on a separate row.

Added options bucketmatchpattern <RegularExpression> and objectmatchpattern <RegularExpression> to gam download vaultexport|export to allow selective downloading of export files.

6.22.17

Added quick_cros_move variable to gam.cfg that is used to provide the default value for quickcrosmove [<Boolean>] in:

gam update cros <CrOSEntity> <CrOSAttribute>+ [quickcrosmove [<Boolean>]] [nobatchupdate]
gam <CrOSTypeEntity> update <CrOSAttribute>+ [quickcrosmove [<Boolean>]] [nobatchupdate]
gam update org|ou <OrgUnitItem> add|move <CrOSTypeEntity> [quickcrosmove [<Boolean>]]
gam update org|ou <OrgUnitItem> sync <CrOSTypeEntity> [removetoou <OrgUnitItem>] [quickcrosmove [<Boolean>]]

Added use_projectid_as_name variable to gam.cfg that modifies gam create project to set the default project name to the project ID instead of 'GAM Project' and to set the default app name to the project ID instead of 'GAM'.

Improved error handling for the following error that occurs when the Customer ID is invalid.

ERROR: 400: invalidInput - Invalid Input

6.22.16

Corrected spelling of spreadcheetid to spreadsheetid and spreadcheeturl to spreadsheeturl in <SpreadsheetField> used by gam <UserTypeEntity> info|print|show sheet <DriveFileEntity>.

<SpreadsheetField> ::=
        developermetadata|
        namedranges|
        properties|
        sheets|
        spreadsheetid|
        spreadsheeturl

6.22.15

Updated code to handle the following Oauth2 error:

ERROR: Authentication Token Error - access_denied: Account restricted

6.22.14

Added option stripcrsfromname to gam <UserTypeEntity> print|show filepath that causes carriage returns, linefeeds and nulls to be stripped from file names.

Added option fullpath to gam <UserTypeEntity> print|show filepath and gam <UserTypeEntity> show fileinfo that adds additional path information indicating that a file is an Orphan or Shared with me.

Added keywords mydriveid and rootid to <DriveFileEntity> as synonyms for mydrive and root in all commands except gam <UserTypeEntity> print filelist|filetree. In those commands, select mydrive|root is used to select a class of files; select mydriveid|rootid is used to select a folder starting point.

6.22.13

Updated code to handle another Google API problem when updating the OU of a Chromebook.

6.22.12

Updated code to handle a Google API problem when updating the OU of a Chromebook.

6.22.11

Updated gam download vaultexport|export to avoid a trap when the usenewexport true option was used on the gam create vaultexport|export command that created the matter.

6.22.10

Dropped deprecated argument enforcesingleparent <Boolean> from these commands:

gam <UserTypeEntity> create|add|update drivefile
gam <UserTypeEntity> create|add drivefileacl
gam <UserTypeEntity> create|add permissions
gam <UserTypeEntity> create|add sheet

6.22.09

Fixed bug in gam print cros ...showdvrsfp that caused a 'ZeroDivisionError: division by zero' trap.

6.22.08

Fixed bug where gam info people was not recognized as a valid command.

6.22.07

Fixed bug in gam <UserTypeEntity> print|show filetree select <DriveFileEntity> where the stripcrsfromname option was not applied.

6.22.06

Updated code to handle Enterprise Licensing API issue with SKU 1010060001 (Google Workspace Essentials).

6.22.05

Fixed bug introduced in 6.22.04 in gam print users that caused a trap.

6.22.04

Fixed bug in gam update drivefile <DriveFileEntity> ... parentid <DriveFolderID> newfilename <DriveFileName> where the file was not renamed.

The Enterprise License Manager API doesn't provide an option to get a list of the licenses a user holds. For gam info user, GAM makes a batch API call with 47 product/SKU pairs querying whether the user holds a license for the product/SKU. An error is returned (and suppressed) for each product/SKU pair for which the user does not hold a license.

Currently, when you specify the license option with gam print users, GAM downloads all licenses for the domain and from that data determines which licenses a user holds. For large numbers of users this works reasonably well; for a small number of users the all license download might be overly expensive. The following options (synonyms) licensebyuser|licensesbyuser|licencebyuser|licencesbyuser were added to gam print users that cause it to use the batch API call method to retrieve the licenses for each user.

Additionally, these options (products <ProductIDList>)|(skus <SKUIDList>) can be used with both gam info user and gam print users to limit the licenses retrieved.

Added license_skus variable to gam.cfg that defines the SKUs that will be processed when getting licenses. Each item in the list can be a <SKUID> which will be validated or <ProductID>/<SKUID> which will not. The default, an empty string, means that all SKUs will be processed when getting licenses.

6.22.03

Fixed bug in gam report customers|users ... date <Date> nodatechange where previous bug fix in 6.20.10 changed the format of the output.

6.22.02

Google has updated the Directory API to explicitly allow updating the OU of a Chromebook with the OU ID rather than the OU path. The update_cros_ou_with_id variable in gam.cfg specifies whether to use the OU ID or path to update the OU of a Chromebook.

The Directory API now supports displaying the OU ID of a Chromebook; added orgunitid to <CrOSFieldName> to allow display of this attribute in gam info|print cros.

Added display of the OU ID of a Chromebook to gam print crosactivity.

6.22.01

Fixed bug in code introduced in 6.22.00 that caused a trap.

6.22.00

Extended csv_input_row_filter, csv_input_row_drop_filter, csv_output_row_filter and csv_output_row_drop_filter to allow specification of filter values from a list, flat file or CSV file.

6.21.07

When setting a multivalued custom schema field for a user, if type home|other|work|(custom <String>) is not specified, work will be assigned. Previously, if type was not specified, Google would accept the field without a type but would eventually set type to work itself in the background.

Added ProuctID 101036: Google Meet Global Dialing and SKUID meetdialing|googlemeetglobaldialing; thanks to @jay-eleven.

Added option formatjson to gam info resoldcustomer <CustomerID>.

6.21.06

Fixed bug in gam update|use project that caused the command to fail on Windows.

6.21.05

Fixed bug in gam print|show projects|svcaccts that caused a trap.

Added support for new calendar event read-only field eventType; thanks to @josemdv.

6.21.04

Updated handling of multivalued custom schema fields that are specified without a type; the type will be shown as work as Google eventually sets the type to work itself in the background.

6.21.03

Fixed bug in gam info|show schema that caused a trap.

6.21.02

Updated gam update chromepolicy to allow specification of policy data with JSON. For complex policies, this is the only way to enter the policy data.

gam update chromepolicy
        (<SchemaName>
          (<Field> <Value>)+ |
          (json [charset <Charset>] <JSONData>) |
          (json file <FileName> [charset <Charset>])
        )+
        ou|org|orgunit <OrgUnitItem> [(printerid <PrinterID>)|(appid <AppID>)]

6.21.01

Added clock_skew_in_seconds variable to gam.cfg that defines the number of seconds of clock skew allowed between local time and Google time. The default value is 10 seconds which was the previous hard-coded value.

Updated GAM spreadsheet commands to handle the following error:

ERROR: 400: failedPrecondition - This operation is not supported for this document

6.21.00

Added option allowitemdeletion to gam [<UserTypeEntity>] delete shareddrive <SharedDriveEntity> that allows deletion of non-empty Shared Drives. This option requires a Super Admin user.

6.20.10

Fixed bug in gam report customers|users ... date <Date> nodatechange where no data was returned in some cases when allverifyuser <UserItem> was not specified.

6.20.09

Added option aliasmatchpattern <RegularExpression> to gam print users that limits the display of aliases to those that match <RegularExpression>.

6.20.08

Fixed bug in gam <UserTypeEntity> copy|move drivefile that caused a trap when a Shared Drive was involved.

6.20.07

Additional fixes to bug that caused a trap when config csv_output_timestamp_column and formatjson were used in the same command.

6.20.06

Fixed bug that caused a trap when config csv_output_timestamp_column and formatjson were used in the same command.

6.20.05

Updated options notarchived|archived in gam update group|groups <GroupEntity> add|remove|sync to be usable with additional <UserTypeEntity>.

6.20.04

Added option dynamicsecurity|makedynamicsecuritygroup to gam update cigroups <GroupEntity> so you can update a dynamic group to be a security group. You should use this option if you use this option security|makesecuritygroup and get this error:

ERROR: 400: invalidArgument - Error(2022): Removing labels is not supported.

6.20.03

Fixed handling of Shared Drive API errors that was broken in 6.20.00.

6.20.02

Fixed bug in gam <UserTypeEntity> create drivefileacl <DriveFileEntity ... csv formatjson that caused a trap.

6.20.01

Added code to validate values in <CAARegionList> in gam create|update caalevel.

6.20.00

Following Jay's lead, updated gam [<UserTypeEntity>] print|show teamdrives to display the orgUnit path for a Shared Drive in addition to its orgUnitId. The org unit information is only available when the command is run as an administrator. Additional API calls are necessary to get the orgUnit path; the option noorgunits disables the additional API calls and display of the path .

Following Jay's lead, added option ou|org|orgunit <OrgUnitItem> to gam [<UserTypeEntity>] update teamdrive to move the Team Drive to the specified OU. This option is only available when the command is run as an administrator. As Jay says: THIS FEATURE IS CURRENTLY ALPHA.

Follwing Jay's lead, added commands to manage/display Context-Aware Access Levels.

6.18.04

Added the ability to upload Note attachments to Google Drive.

6.18.03

Added command to download Note attachments.

Updated gam delete|update schema to handle the following error:

ERROR: 500: FIELD_IN_USE - Cannot delete a field in use.resource.fields

6.18.02

Updated gam create project to proceed even if one or two APIs fail to be enabled; currently, any failure terminates the project creation.

6.18.01

  • Upgraded to Python 3.10.4

6.18.00

Added initial support for the Cloud Channel API; this is used by resellers.

6.17.02

Added a command to update basic form settings.

gam <UserTypeEntity> update form <DriveFileEntity>
        [title <String>] [description <String>] [isquiz [Boolean>]

6.17.01

Fixed bug in gam <UserTypeEntity> print forms that caused a trap when a form has no title.

6.17.00

Added initial support for the Forms API.

Fixed bug in gam <UserTypeEntity> print|show filecounts ... showmimetype [not] <MimeTypeList> that removed 'me' in owners from the query.

  • Upgraded to Python 3.10.3
  • Upgraded to OpenSSL 1.1.1n

6.16.19

Fixed bug in gam print vaultcounts matter <MatterItem> corpus mail accounts <EmailAddressEntity> where extraneous lines emails,0, appeared in the output.

6.16.18

Fixed bug in gam update contactphotos and gam <UserTypeEntity> update contactphotos where option drivedir|(sourcefolder <FilePath>) was not properly processed. Unfortunately, the Domain Shared Contacts API seems to be broken when trying to manage contact photos.

6.16.17

Updated gam <UserTypeEntity> replacedomain contacts emailmatchpattern <RegularExpression> domain <OldDomainName> <NewDomainName> to only replace <OldDomainName> with <NewDomainName> in the email addresses within the contact that match <RegularExpression>. Previously, emailmatchpattern <RegularExpression> selected a contact and all email addresses within the contact had their domain names updated if applicable.

6.16.16

Added option aggregateusersby clientid|appname to gam <UserTypeEntity> print|show tokens that aggregates the users by clientid|appname and displays a count of the number of users rather than the individual users for each clientid|appname.

6.16.15

Updated to allow new 10 million cell limit in Google Sheets.

6.16.14

Added command to replace domain names in contact email addresses; this can be useful when merging/renaming domains.

gam <UserTypeEntity> replacedomain contacts
        [<PeopleResourceNameEntity>|<PeopleUserContactSelection>]
        (domain <OldDomainName> <NewDomainName>)+

Fixed sorting of permissions in gam <UserTypeEntity> print drivefileacls.

6.16.13

Fixed the fix in 6.16.12.

6.16.12

Updated code to eliminate fix for a Python 3.10.0 bug that caused gam <UserTypeEntity> print notes ... formatjson to display quotes in note text incorrectly.

6.16.11

Fixed bug in gam <UserTypeEntity> show notes that caused a trap when a note has no text or a check box has no text.

6.16.10

Fixed bug in gam <UserTypeEntity> print notes ... formatjson where carriage returns and line feeds were not properly displayed.

Fixed bug in gam <UserTypeEntity> create note ... json where carriage returns and line feeds were not properly input.

6.16.09

Added option role|roles <DriveFileACLRoleList> to gam <UserTypeEntity> print|show drivefileacls to simplify limiting displayed ACLs by role.

6.16.08

Added command to upload image files for use in Chrome policies.

<ChromePolicyImageSchemaName> ::=
        chrome.devices.managedguest.avatar |
        chrome.devices.managedguest.wallpaper |
        chrome.devices.signinwallpaperimage |
        chrome.users.avatar |
        chrome.users.wallpaper

gam create chromepolicyimage <ChromePolicyImageSchemaName> <FileName>

6.16.07

Extended option stripcrsfromname in the following commands to strip nulls and linefeeds from displayed file names in addition to carriage returns.

gam <UserTypeEntity> info drivefile <DriveFileEntity>
gam <UserTypeEntity> print|show filerevisions <DriveFileEntity>
gam <UserTypeEntity> show fileinfo <DriveFileEntity>
gam <UserTypeEntity> print|show filetree
gam <UserTypeEntity> print filelist

6.16.06

Updated code to remove Python 3.9 dependency introduced in 6.16.05.

6.16.05

Added option domain <DomainName> to gam print aliases to simplify printing aliases from a secondary domain.

6.16.04

Fixed bug in gam <UserTypeEntity> get drivefile that caused a trap when the target file couldn't be written.

6.16.03

Fixed bug that broke vault commands.

Updated gam oauth create to use client access authentication flow as in Standard GAM, config no_browser true is no longer necessary.

6.16.02

Following Jay's lead, added option removeresetlock to gam wipe device <DeviceEntity> that will remove the account lock on the Android or iOS device. This lock is enabled by default and requires the existing device user to log in after the wipe in order to unlock the device.

Following Jay's lead, added option usenewexport <Boolean> to gam create vaultexport ... corpus mail.

6.16.01

Updated gam oauth create to allow retries when no_browser is true and the user enters an invalid authentication code.

6.16.00

With many thanks to Jay, updated gam oauth create to use a new client access authentication flow as required by Google for headless computers/cloud shells; this is required as of February 28, 2022.

6.15.24

Cleaned up gam report commands again to improve verification that valid data has been received.

Fixed bug in gam <UserTypeEntity> dedup contacts where <PeopleResourceNameEntity>|<PeopleUserContactSelection> was not optional as documented.

6.15.23

Added option replacefilename <RegularExpression> <String> to gam <UserTypeEntity> copy|create|update drivefile that allows using regular expressions to modify the copied/updated file name.

gam user user@domain.com update drivefile query "name contains '2020-2021'" replacefilename "2020-2021" "2021-2022"
gam user user@domain.com copy drivefile name Template parentid root recursive replacefilename Template NewCustomer

6.15.22

Cleaned up gam report commands to improve verification that valid data has been received.

6.15.21

Added email audit monitor commands that were deleted in 5.34.00.

gam audit monitor create <EmailAddress> <DestEmailAddress> [begin <DateTime>] [end <DateTime>]
        [incoming_headers] [outgoing_headers] [nochats] [nodrafts] [chat_headers] [draft_headers]
gam audit monitor delete <EmailAddress> <DestEmailAddress>
gam audit monitor list <EmailAddress>

To use these commands, you should do:

gam update project
gam oauth create

6.15.20

Fixed bug in gam <UserTypeEntity> print datastudiopermissions where todrive was not recognized.

6.15.19

Further cleanup of gam create|update alias.

6.15.18

After discussions with Jay, the default for creating/updating aliases is to verify that the target <UniqueID>|<EmailAddress> exists by making extra API calls; if you know that the target exists, you can suppress the verification with notargetverify.

6.15.17

Added option verifytarget to gam create|update alias <EmailAddressEntity> user|group|target <UniqueID>|<EmailAddress> that causes Gam to verify that the target <UniqueID>|<EmailAddress> exists.

6.15.16

Updated gam <UserTypeEntity> deprovision and gam <UserTypeEntity> delete|update backupcodes to give a more informative error message when a user is suspended and backup codes can't be deleted|updated.

6.15.15

Fixed bug in gam print crosactivity recentusers oneuserperrow that caused a trap.

6.15.14

Added option setchangepasswordoncreate [<Boolean>] to gam <UserTypeEntity> update user that can be used to force created (as opposed to updated) users to change their password at their next login.

6.15.13

Updated error messages in gam <UserTypeEntity> update user createifnotfound.

6.15.12

Added option notifyonupdate [<Boolean>] to gam <UserTypeEntity> update user that can be used to suppress the email notificaton when options notify <EmailAddressList> notifypassword <String> are specified for use in the case when the user must be created but not used when the user does exist and is simply updated.

6.15.11

Updated gam create cigroup to handle the following error:

ERROR: 403: permissionDenied - Error(3006): This feature (Dynamic Groups) requires a premium SKU.

6.15.10

Fixed bug in gam update ou / add|move ... that caused the following error:

ERROR: 400: invalid - Invalid field selection orgUnitPath

6.15.09

Updated option corpus in gam print vaultcounts to only allow mail and groups as required by the API.

6.15.08

Following Jay's lead, added option condition securitygroup|nonsecuritygroup to gam create admin and option condition to gam print|show admins.

6.15.07

Updated code in gam print cros to handle a missing data field that caused a trap.

6.15.06

Added option dateheaderconverttimezone [<Boolean>]> to gam <UserTypeEntity> print|show messages|threads that converts <SMTPDateHeader> values to the gam.cfg timezone.

Updated option dateheaderformat iso|rfc2822|<String> to gam <UserTypeEntity> print|show messages|threads that allows reformatting of any <SMTPDateHeader> value from RFC2822 format to the the following:

6.15.05

Added option dateheaderformat <String> to gam <UserTypeEntity> print|show messages|threads that allows reformatting of the message Date header from RFC2822 format to the format specified by <String>. If <String> is iso, then ISO 8601 format is used, otherwise see: https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior If the Date header can't be parsed as RFC2822, it is left unchanged.

6.15.04

Fixed bug in gam <UserTypeEntity> copy drivefile <DriveFileEntity> ... excludepermissionsfromdomains <DomainNameList> that caused a trap.

6.15.03

Updated <CourseAttribute> and <CourseFieldName> to use descriptionheading and heading synonymously.

6.15.02

Added the following options to gam <UserTypeEntity> copy drivefile <DriveFileEntity> that provide more flexibility in managing permissions when copying/moving folders.

  • Thanks to Kevin Sanghvi for suggesting these enhancements.
copysheetprotectedrangesinheritedpermissions [<Boolean>]
copysheetprotectedrangesnoninheritedpermissions [<Boolean>]

6.15.01

Fixed bug in gam <UserTypeEntity> print|show messages ... showattachments|saveattachments where some attachments were not recognized.

  • Thanks to Craig Millsap for spending the time with me to find the solution.

6.15.00

Updated processing of teamdrive <SharedDriveName> in the following commands. Previously, if there were multiple Shared Drives with the same <SharedDriveName>, GAM silently processed the first one which may not have been the desired action. Now, a message is issued listing the multiple <DriveFileIDs> and no processing is performed. Determine which Shared Drive ID is desired and reissue the command with teamdriveid <DriveFileID>.

gam <UserTypeEntity> print filelist select teamdrive <SharedDriveName>
gam <UserTypeEntity> print|show filecounts select teamdrive <SharedDriveName>
gam <UserTypeEntity> print|show filetree select teamdrive <SharedDriveName>
gam <UserTypeEntity> update teamdrive teamdrive <SharedDriveName>
gam <UserTypeEntity> delete teamdrive teamdrive <SharedDriveName>
gam <UserTypeEntity> hide teamdrive teamdrive <SharedDriveName>
gam <UserTypeEntity> unhide teamdrive teamdrive <SharedDriveName>
gam <UserTypeEntity> info teamdrive teamdrive <SharedDriveName>
gam <UserTypeEntity> print emptydrivefolders teamdrive <SharedDriveName>
gam <UserTypeEntity> delete emptydrivefolders teamdrive <SharedDriveName>
gam <UserTypeEntity> empty drivetrash teamdrive <SharedDriveName>

Added the following commands to transfer top level ACLs from one Shared Drive to another.

gam [<UserTypeEntity>] copy teamdriveacls <SharedDriveEntity> to <SharedDriveEntity>
        [adminaccess|asadmin]
        [showpermissionsmessages [<Boolean>]]
        [excludepermissionsfromdomains <DomainNameList>]
        (mappermissionsdomain <DomainName> <DomainName>)*
gam [<UserTypeEntity>] sync teamdriveacls <SharedDriveEntity> with <SharedDriveEntity>
        [adminaccess|asadmin]
        [showpermissionsmessages [<Boolean>]]
        [excludepermissionsfromdomains <DomainNameList>]
        (mappermissionsdomain <DomainName> <DomainName>)*

Added option shownopermissionsdrives false|true|only to gam <UserTypeEntity> print|show teamdriveacls that controls whether Shared Drives with no permissions are displayed.

  • false - Do not display Shared Drives with no permissions; this is the default
  • true - Display Shared Drives with no permissions in addition to Shared Drives with permissions
  • only - Display only Shared Drives with no permissions

Added the option mappermissionsdomain <DomainName1> <DomainName2> to gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> that maps <DomainName1> to <DomainName2> in any non-inherited permissions that are copied. The option can be specified multiple times to provide different mappings.

  • Thanks to Kevin Sanghvi for suggesting this enhancement.

Updated gam <UserTypeEntity> delete othercontacts to retry the delete step when notFound errors are returned after the update step.

Fixed bug in gam courses <CourseEntity> add|remove students|teachers that caused API call retries to fail with the following error:

Temporary error: notFound - @CourseNotFound The course was not found.

Improved performance when converting Shared Drive names to IDs.

Updated code to handle Shared Drive names that contain single quotes.

6.14.07

Corrected gam.cfg variable cmdlog_max__backups to be cmdlog_max_backups.

6.14.06

Fixed bug in gam sync devices where option serialnumber_column was not recognized.

Fixed bug in gam sync devices where a trap occurred when option assigned_missing_action was not specified.

6.14.05

Upgraded the countsonly suboption showsource in gam <UserTypeEntity> print filelist to display the name of the source drive/folder (Name column) in addition to its ID (Source Column).

6.14.04

Added a command to move Other Contacts to My Contacts.

gam <UserTypeEntity> move othercontacts <OtherContactResourceNameEntity>|<OtherContactSelection>

Improved action performed messages in gam <UserTypeEntity> update othercontacts.

6.14.03

Added a command to delete Other Contacts.

gam <UserTypeEntity> delete othercontacts <OtherContactResourceNameEntity>|<OtherContactSelection>

Added a command to update Other Contacts and move them to My Contacts.

gam <UserTypeEntity> update othercontacts <OtherContactResourceNameEntity>|<OtherContactSelection>
        <PeopleContactAttribute>+
        (contactgroup <ContactGroupItem>)*

6.14.02

Updated gam print|show teamdriveacls to display the creation time of the Team/Shared drives.

6.14.01

Added the option excludepermissionsfromdomains <DomainNameList> to gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> that excludes permissions that reference any domain in <DomainNameList> from being copied.

  • Thanks to Kevin Sanghvi for suggesting this enhancement.

Fixed bug gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> where option copymergewithparentfolderpermissions was not recognized.

6.14.00

Added the following options to gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> that provide more flexibility in managing permissions when copying/moving folders.

  • Thanks to Kevin Sanghvi for suggesting these enhancements.
copyfileinheritedpermissions [<Boolean>]
copyfilenoninheritedpermissions [<Boolean>]
copymergewithparentfolderpermissions [<Boolean>]
copymergedtopfolderpermissions [<Boolean>]
copytopfolderiheritedpermissions [<Boolean>]
copytopfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders
copymergedsubfolderpermissions [<Boolean>]
copysubfolderinheritedpermissions [<Boolean>]
copysubfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders

Following Jay's lead, added command gam <UserTypeEntity> show vaultholds to display all vault holds affecting a user. This allows you to investigate the error Delete Failed: Precondition is not met. when trying to delete a user.

Added option buildpath [<Boolean>] to gam <UserTypeEntity> create filter label <LabelName> that controls whether <LabelNames> of the form Top/Middle/Bottom will be created as single-level or multi-level.

Added option hidden <Boolean>' to gam update teamdrive`.

Fixed bug in gam print|show matters matterstate <MatterStateList> that caused a trap.

Fixed bug in gam update mobile <MobileEntity> action block that caused the following error:

ERROR: 400: invalidInput - Invalid value for: action_block is not a valid value
  • Upgraded to Python 3.10.2
  • Updated google-api-python-client to version 2.35.0

6.13.09

Fixed bug in gam <UserTypeEntity> update chromepolicy that caused a trap.

Fixed bug in gam print|show datatransfers oldowner|newowner <UserItem> that did not properly handle <UserItem> of form uid:<String>.

6.13.08

  • Upgraded to OpenSSL 1.1.1m

Added command gam info currentprojectid that displays the current Project ID.

6.13.07

Added options showpermissionmessages and sendemailifrequired to gam <UserTypeEntity> copy|move drivefile <DriveFileEntity>. Previously, when attempting to copy ACLs, GAM would report any errors; some errors were generated when an attempt was made to inappropriately copy an ACL. Now, GAM will not attempt to copy ACLs unless they are appropriate. When showpermissionmessages is specified GAM will display messages about ACLs not copied, ACLs that were copied and any remaining copy errors.

When copying an ACL that references a non Google account, an error is generated unless an email is sent to the account; by default, no email notifications are sent. The sendemailifrequired options instructs GAM to send an email notification in this case.

6.13.06

Added option formatjson to gam <UserTypeEntity> info filters and gam <UserTypeEntity> show filters.

6.13.05

Handle the following error in gam <UserTypeEntity> signout:

ERROR: 400: invalidInput - Invalid Input

This can be caused by applying the command to a suspnded user.

6.13.04

Added option showsize to gam <UserTypeEntity> print|show filecounts that displays the size (in bytes) of the files counted.

Following Jay's lead, added commands to display ChromeOS device telemetry data.

To use these commands you must authorize an additional scope:

  • Chrome Management API - Telemetry read only
gam oauth create

Added option reverselists <ListFieldNameList> to commands that display ChromeOS device information. For each list in <ListFieldNameList>, the list order is changed from ascending (oldest to newest) to descending (newest to oldest); this makes it easy to get the N most recent values with listlimit N reverselists <ListFieldNameList>.

6.13.03

Added options parentselector <OrgUnitSelector> and childselector <OrgUnitSelector> to gam print orgs|ous that add an additional column orgUnitSelector to the output. This column value can be used in subsequent gam csv commands to appropriately select members without duplication.

<OrgUnitSelector> ::=
        cros_ou | cros_ou_and_children|
        ou| ou_ns | ou_susp|
        ou_and_children | ou_and_children_ns | ou_and_children_susp

Get file count summaries by OU; top level selector is ou, sub level selectors are ou_and_children

gam redirect csv ./TopLevelOUs.csv print ous showparent toplevelonly parentselector ou childselector ou_and_children fields orgunitpath
gam redirect csv ./FileCounts.csv multiprocess csv ./TopLevelOUs.csv gam "~orgUnitSelector" "~orgUnitPath" print filecounts excludetrashed summary only summaryuser "~orgUnitPath"

6.13.02

Updated error handling in gam <UserTypeEntity> copy drivefile when copying files to a shared drive folder.

6.13.01

Added option summaryuser <String> to gam <UserTypeEntity> print filecounts and gam <UserTypeEntity> print filelist countsonly that replaces the default summary user Summary with <String>.

gam redirect csv ./FileCounts.csv multiprocess csv ./OUs.csv gam ou_ns "~orgUnitPath" print filecounts excludetrashed summary only summaryuser "~orgUnitPath"

Uodated `gam update drivefile teamdriveparentid to handle the following error:

ERROR: 400: shareOutNotPermitted - Bad Request. User message: "shareOutNotPermitted"

6.13.00

Fixed bug in gam <UserTypeEntity> copy drivefile where contentManager|fileOrganizer ACLs were not copied from a source shared drive folder to a target shared drive folder.

6.12.06

Fixed bug where redirect csv - multiprocess todrive redirect stdout - multiprocess would disable multiprocess for redirect csv which resulted in multiple files being uploaded.

Added option showshareddrivepermissions to gam <UserTypeEntity> show fileinfo <DriveFileEntity> that is applicable when no fields are selected and <DriveFileEntity> is a shared drive file/folder. In this case, the Drive API returns the permission IDs but not the permissions themselves so GAM makes an additional API call to get the permissions.

Added option showshareddrivepermissions to gam <UserTypeEntity> print filelist that is applicable when no fields are selected and shared drives are queried/selected. In this case, the Drive API returns the permission IDs but not the permissions themselves so GAM makes an additional API call per file to get the permissions.

Added commands that can process lists of Gmail labels.

6.12.05

Updated gam info|print cros showdvrsfp formatjson to include diskVolumeReports.volumeInfo.storageFreePercentage.

Improved error messages for gam create resource when options capacity <Number> and floor <String> are required but not provided.

6.12.04

Added option showdvrsfp to gam info|print cros that causes GAM to display a field diskVolumeReports.volumeInfo.storageFreePercentage which is calculated as:

  • (diskVolumeReports.volumeInfo.storageFree/diskVolumeReports.volumeInfo.storageTotal)*100

You can use an output row filter to only show ChromeOS devices with a limited amount of free space:

  • config csv_output_row_filter "diskVolumeReports.volumeInfo.0.storageFreePercentage:countrange=1/15" Use countrange=1/15 instead of count<15 as the latter will display ChromeOS devices with no diskVolumeReports; a blank entry is treated as a zero.

ChromeOS devices can have multiple diskVolumeReports; some experimentation may be required to get the desired results.

6.12.03

The 6.12.02 bug fix in gam <UserTypeEntity> print|show filetree select <DriveFileEntity> was too aggressive; when showing a file tree, folders owned by others must be processed so that files owned by the user within those folders are displayed.

6.12.02

When running gam oauth create and gam.cfg no_browser = true, the authorization link is no longer copied to the file gamoauthurl.txt as this functionality required modifying a Google supplied library.

Removed the option writeurltofile from gam check| svcacct that caused GAM to write the authorization link to the file gamsvcaccturl.txt.

Fixed bug in gam <UserTypeEntity> print|show filetree select <DriveFileEntity> where file ownership was not being checked which resulted in files not owned by the user being displayed.

6.12.01

Updated code to perform retries when a serviceNotAvailable error occurs when listing file permissions.

6.12.00

Fixed bug in gam <UserTypeEntity> copy drivefile <DriveFileEntity> <DriveFileParentAttribute> recursive that mis-copied files when the target parent folder <DriveFileParentAttribute> was within the folder structure of <DriveFileEntity>.

Fixed bug in gam <UserTypeEntity> check drivefileshortcut <DriveFileEntity> csv that caused a trap.

6.11.07

Added command gam <UserTypeEntity> delete labelid <LabelID> that is used to delete Gmail labels by ID rather than by name.

6.11.06

Fixed bug in 6.11.05 for updating Chromebook OU by ID.

6.11.05

Added update_cros_ou_with_id variable to gam.cfg that causes GAM to update the OU of a Chromebook with the OU ID rather than the OU path. Set this value to true if you are getting the following error:

400: invalidInput - Invalid Input: Inconsistent Orgunit id and path in request

6.11.04

When specifying <UserAttribute> languages, it is an error to specify a custom language with a preference suffix +-.

Added option includederivedmembership to gam print|show cigroup-members. This option causes the API to list indirect members of groups. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Cloud-Identity-Groups-Membership

Updated gam oauth export|refresh to privent the following error.

ERROR: Authentication Token Error - Not all requested scopes were granted by the authorization server, missing scopes , https://sitesgooglecom/feeds, https://wwwgooglecom/m8/feeds

6.11.03

Added option noinvitablecheck to gam whatis <EmailItem> that suppresses the user invitation check to avoid exceeding quota limits when checking a large number of addresses.

Following Jay's lead, updated processing of <UserAttribute> languages. You could always set a user's languages via the API; Google has added the ability to indicate whether a language is preferred or not_preferred. This is implemeted in GAM by optionally appending a + to a language code to set preferred and a '-' to set not_preferred. In the user's profile, only preferred languages are displayed.

gam update user user@domain.com languages en+,fr+.

Updated all Cloud Identity API group calls to use version v1 of the API rather than version v1beta1.

6.11.02

Added option nobatchupdate to gam <CrOSTypeEntity> update ou <OrgUnitPath> and gam update cros <CrOSEntity> ou <OrgUnitPath> that prevents GAM from using batch mode to update the devices; this allows handling the rateLimitExceeded error described below.

6.11.01

Updated code to to handle the following error as retryable:

403: rateLimitExceeded - Quota exceeded for quota metric 'Queries' and limit 'Queries per minute per user' of service 'admin.googleapis.com' for consumer 'project_number: (project)'

6.11.00

Updated gam print groups and gam print|show group-members to allow identification of groups with the All users in the organization member with: member id:<CustomerID>.

Upgraded to Python 3.10.1

6.10.05

Added option to the copyfrom option used with gam create/update course that modifies how course work and materials are copied.

  • markdraftaspublished - Mark all draft course work and materials as published

Updated todrive options to simplify updating an existing sheet within an existing file. Previously, if you specified tdfileid <DriveFileID> tdsheet (id:<Number>)|<String> tdupdatesheet, the sheet had to exist. The updated behavior is:

  • tdfileid <DriveFileID> tdsheet id:<Number> tdupdatesheet - The specified sheet must exist
  • tdfileid <DriveFileID> tdsheet <String> tdupdatesheet - The specified sheet will be created if necessary

6.10.04

Fixed bug introduced in 6.10.03 that broke gam <UserTypeEntity> update drivefileacl <DriveFileEntity>.

Updated gam whatis <EmailItem> to give a better message if <EmailItem> is not a group/user email address or alias and Service Account scope Cloud Identity User Invitations API is not enabled.

Renamed client access scope Directory API Printers to Chrome Printer Management API; there is no change in functionality.

6.10.03

Updated gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> <DriveFileParentAttribute> to enforce the requirement that the specified user be a Shared Drive organizer if either <DriveFileEntity> or <DriveFileParentAttribute> specifies a Shared Drive.

Added options csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]] to gam <UserTypeEntity> create|update drivefileacl <DriveFileEntity> that causes GAM to output the new ACL details in CSV form rather than indented keywords and values.

6.10.02

Following Jay's lead, fixed obscure problem when creating a project in timezones ahead of GMT.

6.10.01

Updated gam create domainalias|aliasdomain <DomainAlias> <DomainName> to handle error when an invalid <DomainAlias> is specified.

6.10.00

Added csv_output_subfield_delimiter and people_max_results variables to gam.cfg.

csv_output_subfield_delimiter
    Character used to delimit fields and subfields in headers when writing CSV files;
    this must be a single character
    Default: '.'

people_max_results
    When retrieving lists of People from API,
    how many should be retrieved in each API call
    Default: 100
    Range: 0 - 1000

6.08.31

Updated <UserBasicAttribute> so that an OU ID can be specified in addition to an OU path.

<UserBasicAttribute> ::=
        org|ou|orgunitpath <OrgUnitPath>|<OrgUnitID>

This is applicable to gam create|update user; n.b., the API requires a path so an additional API call must be made to convert the ID to a path.

6.08.30

Added option showsize to gam <UserTypeEntity> print filelist countsonly that adds an additional column Size that indicates the total size (in bytes) of the files represented on the row.

6.08.29

Added options onerowpertarget and suppressnoaliasrows to gam print aliases.

By default, the CSV output has three columns: Alias,Target,TargetType; if a target has multiple aliases, there will be multiple rows, one per alias. Specifying onerowpertarget changes the three columns to: Target,TargetType,Aliases; all aliases for the target are space-separated in the Aliases column.

Specifying both onerowpertarget and suppressnoaliasrows causes GAM to not display any targets that have no aliases.

Added command gam remove aliases|nicknames <EmailAddress> user|group <EmailAddressEntity> to more efficiently delete the aliases in <EmailAddressEntity> from the user|group <EmailAddress>.

You can combine these two changes as follows:

gam redirect csv ./OldDomainAliases.csv print aliases aliasmatchpattern ".*@olddomain.com" onerowpertarget suppressnoaliasrows
gam csv ./OldDomainAliases.csv gam remove aliases "~Target" "~TargetType" "~Aliases"

Fixed bug in gam user user@domain.com sendemail ... ghtml ... that caused an inappropriate error.

ERROR: User: user@domain.com, Drive File: Email Doc, Data Not Retrieved: Invalid mimeType application/vnd.google-apps.document, must be text/html

6.08.28

Updated Google API libraries.

6.08.27

Reverted update 6.08.26 as it couldn't accurately distinguish between the following cases in all instances:

  • A Service Account scope is not authorized
  • A user with a service disabled
  • A user from outside your domain

6.08.26

Improved the error message displayed when a Service Account scope is not authorized so it can be distinguished from a user with the service disabled.

6.08.25

Updated gam create|use project to handle the following spurious Google error:

ERROR: 500: Failed to convert server response to JSON - 500

6.08.24

Fixed bug in gam <UserTypeEntity> print|show contacts fields ... that caused an error when retrieving other contacts.

Revert Google Auth library to version 2.0.2 to avoid the following error:

ERROR: Token used too early, 1634572527 < 1634572532. Check that your computer's clock is set correctly.

6.08.23

Updated code to format Google timestamps with fractional seconds, e.g., 2021-10-13T13:35:42.590124Z and timezone = utc in gam.cfg.

6.08.22

Fixed bug in gam create|clear|dedup|delete|info|print|show|update contacts where the command would fail if the domain was not defined in gam.cfg

6.08.21

Fixed bug gam <UserTypeEntity> print contactdelegates that caused a trap.

6.08.20

Updated gam print|show ownership to display the event name of the most recent primary event. If the event name is delete, then you'll know who the owner was but won't be able to do much with the file.

6.08.19

Fixed bug in gam update group where field memberKey was mistakenly converted to preferredMemberKey; this caused a trap.

6.08.18

Updated code to work around issue in Cloud Identity Groups API where a group member of type CUSTOMER is not properly marked as that type; this caused a trap.

6.08.17

Fixed bug in gam show cigroup-members where the deprecated field memberKey was still being used; it was replaced with preferredMemberKey.

6.08.16

Fixed bug in metacommand multiprocessexit where GAM would not terminate when the condition was met by one process while multiple other processes terminated simultaneously with the condition not met.

6.08.15

In 6.07.24, delivery_settings was added to the default list of fields in gam print group-members. Unfortunately, it is still the case that an additional API call per member is required to get this setting; this makes getting group members very slow for large groups.

delivery_settings has been removed from the default list of fields and the option showdeliverysettings adds this field to the default list of fields. You can always specify a specific list of fields that includes delivery_settings.

6.08.14

Fixed bug in gam redirect csv ... multiprocess ... that caused a trap when running on Windows.

6.08.13

Fixed bugs in gam <UserTypeEntity> copy othercontacts that rendered it unusable; sigh.

Following Jay's lead, added support for newly announced group member restrictions. You can update groups to restrict membership to only include users, groups or service accounts as well as internal users and groups.

Added option nosecuritysettings to gam info cigroups <GroupEntity>. By default, GAM makes an additional API call to get the SecuritySettings; this option suppresses that call.

Added option memberrestrictions <QueryMemberRestrictions> to gam update cigroups <GroupEntity> to define member restrictions.

Added option memberrestrictions to gam print cigroups that causes GAM to make an additional API call to get the member restrictions from the SecuritySettings.

6.08.12

Added (json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>]) to <PrinterAttribute> that allows specification of printer attributes from JSON data in gam create|update printer.

<PrinterAttribute> ::=
        (description <String>)|
        (displayname <String>)|
        (json [charset <Charset>] <JSONData>)|(json file <FileName> [charset <Charset>])|
        (makeandmodel <String>)|
        (ou|org|orgunit <OrgUnitItem>)|
        (uri <String>)|
        (driverless [<Boolean>])

6.08.11

Added option copysheetprotectedranges [<Boolean>] to gam <UserTypeEntity> copy drivefile that causes GAM to copy the Google Sheet permissions and protected ranges from the source file to the target file.

Updated gam update cigroups <GroupEntity> update [<GroupRole>] expires <Time> <UserTypeEntity> to handle the following error:

ERROR: 403: permissionDenied - Error(3005): Non-premium customers do not have access to certain premium features.

6.08.10

Fixed bug in gam <UserTypeEntity> clear contacts that caused a trap.

6.08.09

Changed license SKU Google-Apps name Google Workspace Free/Standard to G Suite Legacy to be consistent with Google.

6.08.08

Updated all commands that reference Cloud Identity Group members to use the field preferredMemberKey rather than the deprecated field memberKey which would cause traps.

6.08.07

Fixed bug in gam <UserTypeEntity> create|update contact json <JSONData> that failed to delete the read-only field updateTime which caused the command to fail.

Added the following keyword to gam.cfg that causes GAM to add a timestamp column to the CSV output file; the value in each row is time at which the command started.

csv_output_timestamp_column
        Name of column in the CSV output file to contain a timestamp
        Default: ''

Added option timestampcolumn to <Redirect> that causes GAM to add a timestamp column labeled <String> to the output CSV file; the value in each row is time at which the command started. This overrides the csv_output_timestamp_column value in gam.cfg.

<Redirect> ::=
        redirect csv <FileName> [multiprocess] [append] [noheader] [charset <Charset>]
                     [columndelimiter <Character>] [quotechar <Character>]
                     [timestampcolumn <String>]
                     [todrive <ToDriveAttribute>*] |

6.08.06

Added formatjson to gam info|show resoldsubscriptions and formatjson [quotechar <Character>] to gam print resoldsubscriptions.

Handle the following error as retryable when managing user's contacts:

ERROR: API access Denied

6.08.05

Added option addcsvdata <FieldName> <String> to gam create drivefile ... csv. This adds additional columns of data to the CSV file output. For example, you are building student folders on a Shared Drive as an admin and want to add ACLs to the folders allowing the student write access and you want a shortcut on the student's My Drive pointing to the folder. By adding the student's primary email address to the CSV output, it can be used in subsequent commands. Substitute for admin@domain.com and <TeamDriveID>.

Students.csv
primaryEmail,Name
bob@domain.com,Bob Jones
mary@domain.com, Mary Smith
...

# Create the student folders on the Shared Drive
gam redirect csv ./StudentFolders.csv multiprocess csv Students.csv gam user admin@domain.com create drivefile mimetype gfolder drivefilename "~~Name~~ Digital Portfolio" parentid <TeamDriveID> csv addcsvdata primaryEmail "~primaryEmail"
# Add ACLs granting the students write access to their folders; ~User refers to admin@domain.com
gam csv StudentFolders.csv gam user "~User" add drivefileacl "~id" user "~primaryEmail" role fileorganizer
# Add a shortcut to the folder on the student's My Drive
gam csv StudentFolders.csv gam user "~primaryEmail" create drivefileshortcut "~id" parentid root

6.08.04

Handle the following error in gam move drivefile:

ERROR: 400: crossDomainMoveRestriction - Bad Request. User message: "crossDomainMoveRestriction"

Improved error messages when an unknown contact ID is used in a command.

6.08.03

Use Python library pathvalidate to clean up filenames in gam get drivefile|document. If you are using the source verson of GAMADV-XTD3, do the following command to update your Python libraries.

pip install --upgrade -r src/requirements.txt

6.08.02

Updated gam sync devices to include the assetTag field, if specified, as part of the device comparison key in addition to serialNmmber and deviceType.

6.08.01

Fixed bug in gam create device that caused a trap.

Updated gam print|show chromeapps|chromedevices|chromeversions to handle the following error.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.08.00

GAM now uses the People API to manage user contacts rather than the Contacts API.

Most commands will work unchanged but Google has completely changed how the data is presented. If you have scripts that process the output from print contacts for example, they will have to be changed.

You might want to keep an older version of GAM available so you can compare the output from the two versions and make adjustments as necessary.

This is work in progress, report issues/problems.

6.07.31

Fixed bugs in gam sync devices that rendered it useless.

Deleted most local copies of Google and non-standard Python libraries. If you are using the source verson of GAMADV-XTD3, do the following command to update your Python libraries.

pip install --upgrade -r src/requirements.txt

You should delete the following files from src/gam:

distro.py,filelock.py

You should delete the following directories from src/gam:

dateutil,google,google_auth_httplib2,googleapiclient,
httplib2,oauthlib,passlib,requests,requests_oauthlib

6.07.30

Update Google API libraries.

6.07.29

Removed agreed2terms|agreedtoterms <Boolean> from <UserBasicAttribute>; this is a read-only attribute and can't be modified.

6.07.28

Fixed bug in gam user user@domain.com remove calendars courses_with_teacher user@domain.com that caused a trap.

6.07.27

Updated from Cloud Identity Groups API version v1beta1 to version v1.

6.07.26

Added metacommand multiprocessexit (rc<Operator><Number>)|(rcrange=<Number>/<Number>)|(rcrange!=<Number>/<Number>) that will terminate processing of a CSV or batch file when one of the subprocesses returns a matching return code. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Meta-Commands-and-File-Redirection#specify-multiprocessing-termination-return-code

This change was inspired by the brute force approach to finding the owner of a file by stepping through all users. Once the owner is found, there is no need to process the remaining users; this change allows processing to be terminated when the owner is found.

gam config auto_batch_min 1 multiprocessexit rc=0 redirect csv - multiprocess redirect stderr null multiprocess all users print filelist select id <DriveFileID> fields id,name,owners.emailaddress norecursion showownedby any

6.07.25

Cleaned up License Product/SKU names; replaced G Suite with Google Workspace where appropriate.

6.07.24

Added option defaultsender self|group to <GroupSettingsAttribute>.

Added delivery_settings to the default list of fields in gam print group-members.

6.07.23

Update Google API libraries, remove unused libraries.

6.07.22

Updated gam info domain to generate an error when the customer_id and oauth2_txt values are not consistent. This typically happens when the wrong customer ID is assigned to a gam.cfg section.

6.07.21

Fixed bug in gam create datatransfer <OldOwnerID> <DataTransferServiceList> <NewOwnerID> where the privacy level was not being set in all applications if more than one was specified in <DataTransferServiceList>.

6.07.20

  • Upgraded to Python 3.9.7
  • Upgraded to OpenSSL 1.1.1l

6.07.19

Fixed bug in gam print chromepolicies that caused the following error:

Chrome Policy: chrome.devices.*, Print Failed: Invalid page token, request parameters do not match page token.

6.07.18

Updated gam create|update course copyfrom <CourseID> ... markpublishedasdraft to mark published course materials as draft as well as course work; this matches the console copy course behavior.

Updated more course related commands to handle the following error.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.07.17

Following Jay's suggestion, added option maxresults <Number> to gam print|show resoldsubscriptions; the default value is 100 and the range is 1-100.

6.07.16

Updated gam <UserTypeEntity> claim|transfer ownership <DriveFileEntity> to handle the following error:

ERROR: 403: insufficientFilePermissions - The user does not have sufficient permissions for this file.

6.07.15

Updated gam <UserTypeEntity> copy drivefile <DriveFileEntity> to allow more attributes to be specified on the copy. These only apply when a single file/folder is being copied.

<DriveFileCopyAttribute> ::=
        (contentrestrictions readonly false)|
        (contentrestrictions readonly true [reason <String>])|
        (copyrequireswriterpermission [<Boolean>])|
        (description <String>)|
        ignoredefaultvisibility|
        (keeprevisionforever|pinned)|
        (lastviewedbyme <Time>)|
        (modifieddate|modifiedtime <Time>)|
        (mimetype <MimeType>)|
        (ocrlanguage <Language>)|
        (privateproperty <PropertyKey> <PropertyValue>)|
        (publicproperty <PropertyKey> <PropertyValue>)|
        (property <PropertyKey> <PropertyValue> [private|public])|
        (viewerscancopycontent [<Boolean>])|
        (writerscanshare|writerscantshare [<Boolean>])

6.07.14

Following Jay's suggestions, updated gam download vaultexport <ExportItem> matter <MatterItem> targetname <FileName> to avaid data loss when <FileName> does not contain #filename# and there are multiple top level files with the same extension. The files will be named FileName-N.ext where N is 1,2,3,....

6.07.13

Fixed gam <UserTypeEntity> print filelist ... formatjson nodataheaders <String> to output only <String> when there is no data.

6.07.12

Updated various course related commands to handle the following error.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.07.11

Fixed bug in gam <UserTypeEntity> modify messages|threads removelabel <LabelName> where <LabelName> was being created inappropriately.

6.07.10

Due to missing API documentation, gam <UserTypeEntity> print|show datastudioassets orderby title ascending|descending' displayed in the opposite of the specified order.

Fixed bug that caused a trap in gam print|show chromeschemas std.

6.07.09

Following Jay's suggestion, added all to assettype in all datastudioassets and datastudiopermissions commands so you can get information on both reports and datasources in a single command.

6.07.08

Fixed bug that caused a trap in gam <UserTypeEntity> transfer calendars <UserItem> <UserCalendarEntity> append description|location|summary.

6.07.07

Added option alias|aliases <EmailAddressList> to gam create user that causes GAM to create the user aliases in <EmailAddressList> after creation of the user. The same option was added to gam update user createifnotfound and applies when a user is not found and must be created.

6.07.06

Handle the following error in gam create|update drivefileacl:

ERROR: 400: publishOutNotPermitted - Bad Request. User message: "publishOutNotPermitted"

6.07.05

Updated gam print|show datatransfers status completed|failed|inprogress; previously, pending was allowed but it generates an error.

6.07.04

Updated gam copy drivefile to avoid the following error when copying a shortcut to a folder.

ERROR: 403: fieldNotWritable - The resource body includes fields which are not directly writable.

6.07.03

Fixed bug in gam show ownership that always showed file name as blank.

6.07.02

Updated various Google libraries and httplib2.

6.07.01

Updated gam print|show admins to allow specification of both user <UserItem> and role <RoleItem> and then avoid the undocumented API rule that disallows both.

6.07.00

Added the following keywords to gam.cfg to provide logging of GAM commands.

cmdlog
        Path to GAM Log file
        Default: ''
cmdlog_max_backups
        Maximum number of backup log files
        Default: 5
        Range: 1 - 10
cmdlog_max_kilo_bytes
        Maximum kilobytes per log file
        Default: 1000
        Range: 100 - 10000

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Command-Logging-Progress#command-logging

Added the following keyword to gam.cfg to display commands to stderr when executing gam batch|tbatch|csv|loop.

show_commands
        Display commands to stderr when executing `gam batch|tbatch|csv|loop`.
        Default: False

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Command-Logging-Progress#command-progress

6.06.15

Updated optionshowcmds output in gam batch|csv|tbatch to show the total number of commands to be executed in addition to the current command number.

Added option showcmds [<Boolean>] option to gam loop; this causes GAM to display each command to stderr as it is initiated so you can monitor GAM's progress. If <Boolean> is omitted, True is assumed. When showcmds is not specified or False, the input file is processed line-by-line. When showcmds is True, the input file is pre-processed so the total number of commands is known.

6.06.14

The following options have been deprecated in gam <UserTypeEntity> copy drivefile <DriveFileEntity> as Google no longer supports multiple parents on files; using them will cause an error so as to alert you to review the command.

No existing parents are copied for source top/sub files/folders.

These options control the action GAM takes when a source top file/folder has multiple parents.
* `copytopfileparents all` - Copy all of the existing parents.
* `copytopfolderparents all` - Copy all of the existing parents.

These options control the action GAM takes when a source sub file/folder has multiple parents.
* `copysubfileparents nonpath` - Copy all of the existing parents except the parent on the path from the top folder; this is the default action.
* `copysubfileparents all` - Copy all of the existing parents.
* `copysubfolderparents nonpath` - Copy all of the existing parents except the parent on the path from the top folder; this is the default action.
* `copysubfolderparents all` - Copy all of the existing parents.

6.06.13

Fixed bug in gam info user <UserItem> quick that generated the following error:

Cloud Identity Group: groups/-, Lookup Failed: Error(4016): Insufficient permissions to retrieve membership graph.

Added option domainlist|notdomainlist <DomainNameList> to <PermissionMatch> to make it easier to specify a list of domains.

Added option notrole <DriveFileACLRole> to <PermissionMatch> to make it possible to match any role other that the specified role.

6.06.12

Fixed bug in gam report <ActivityApplicationName> where only the last subevent of an event was shown rather than all subevents.

6.06.11

Following Jay's lead, improved error messages when invalid client_secrets.json, oauth2service.json and oauth2.txt files are encountered.

6.06.10

Code cleanup for internal routines cleanJSON, flattenJSON, showJSON.

6.06.09

Fixed more issues caused by update to Cloud Resource Manager API v3.

6.06.08

Fixed bug in gam update project that caused a trap.

6.06.07

Defined <ProjectIDEntity> to allow selection of project IDs from a flat or CSV file in addition to the current options.

<ProjectIDList> ::= "<ProjectID>(,<ProjectID>)*"
<ProjectIDEntity> ::=
        current | gam | <ProjectID> | (filter <String>) |
        (select <ProjectIDList> | <FileSelector> | <CSVFileSelector>)
gam update project [[admin] <EmailAddress>] [<ProjectIDEntity>]
gam delete project [[admin] <EmailAddress>] [<ProjectIDEntity>]
gam show projects [[admin] <EmailAddress>] [all|<ProjectIDEntity>]
        [states all|active|deleterequested] [showiampolicies 0|1|3]
gam print projects [[admin] <EmailAddress>] [all|<ProjectIDEntity>] [todrive <ToDriveAttribute>*]
        [states all|active|deleterequested] [showiampolicies 0|1|3 [onememberperrow]]
        [delimiter <Character>]] [[formatjson [quotechar <Character>]]

gam create|add svcacct [[admin] <EmailAddress>] [<ProjectIDEntity>]
        [saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
        [sadescription <ServiceAccountDescription>]
gam delete svcacct [[admin] <EmailAddress>] [<ProjectIDEntity>]
        (saemail <ServiceAccountEmail>)|(saname <ServiceAccountName>)|(sauniqueid <ServiceAccountUniqueID>)
gam show svcaccts [[admin] <EmailAddress>] [all|<ProjectIDEntity>]
        [showsakeys all|system|user]
gam print svcaccts [[admin] <EmailAddress>] [all|<ProjectIDEntity>]
        [showsakeys all|system|user]
        [todrive <ToDriveAttribute>*]
        [formatjson [quotechar <Character>]]

6.06.06

Fixed issues caused by update to Cloud Resource Manager API v3.

Following Jay's lead, added command to create a Google Cloud Platform folder. This folder can be used in a subsequent gam create project command.

gam create gcpfolder <String>
gam create gcpfolder [admin <EmailAddress] folder <String>

6.06.05

Updated gam print|show|update chromepolicy to handle the following special case policies:

chrome.users.AutoUpdateCheckPeriodNew autoupdatecheckperiodminutesnew
chrome.users.BrowserSwitcherDelayDuration browserswitcherdelayduration
chrome.users.FetchKeepaliveDurationSecondsOnShutdown fetchkeepalivedurationsecondsonshutdown
chrome.users.MaxInvalidationFetchDelay maxinvalidationfetchdelay
chrome.users.PrintingMaxSheetsAllowed printingmaxsheetsallowednullable
chrome.users.PrintJobHistoryExpirationPeriodNew printjobhistoryexpirationperioddaysnew
chrome.users.SecurityTokenSessionSettings securitytokensessionnotificationseconds
chrome.users.SessionLength sessiondurationlimit
chrome.users.UpdatesSuppressed updatessuppresseddurationmin
chrome.users.UpdatesSuppressed updatessuppressedstarttime

6.06.04

Fixed bug in gam print|show chromepolicies that caused a trap.

6.06.03

Fixed gam print|show chromepolicies to display targetKey.additionalTargetKey fields.

Updated gam info|show|print note to display owner and ownedByMe fields.

Following Jay's lead, updated to Cloud Resource Manager API v3.

6.06.02

Improved Google Keep notes commands.

6.06.01

Code cleanup for Google Keep notes commands.

6.06.00

Added commands to manage and display Google Keep notes.

6.04.25

Updated random password processing in gam create|update user.

As in prior versions of Advanced GAM, if you create a user and don't specify a password or specify password random, a password of length 25 comprised of letters, numbers and special characters is created. This does not match Standard GAM; it generates an unusable login password. You can specify the length of the random password with password random <Integer>, <Integer> must be between 8 and 100; this is not available in Standard GAM.

If you specify password blocklogin, a password of length 4096 comprised of random Unicode characters is created; it's purpose is to create a password that blocks logins. This matches the password random option of Standard GAM.

6.04.24

Handle the following error in gam <UserTypeEntity> copy drivefile <DriveFileEntity>:

ERROR: 400: invalidLinkVisibility - Bad Request. User message: ""

6.04.23

Following Jay's lead, improved gam <UserTypeEntity> waitformailbox [retries <Number>].

6.04.22

Added additional code to handle the following error in gam print group-members.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

6.04.21

Fixed bugs in gam <UserTypeEntity> print|show messages|threads sendermatchpattern <RegularExpression> countsonly.

6.04.20

Added option sendermatchpattern <RegularExpression> to gam <UserTypeEntity> print|show messages|threads that causes GAM to display messages and threads only if the sender matches the <RegularExpression>. This is used to display messages sent by a paticular delegate for a delegator; the message is from the delegator but sent by the delegate.

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Users-Gmail-Messages-Threads#display-messages-sent-by-delegates-for-delegator

6.04.19

Updated processing of query <QueryGmail> that contains (after|before|newer|older):YYYY/MM/DD so that GAM results match Gmail results. YYYY/MM/DD is interpreted as midnight on the given date but GAM has to adjust the time to be consistent with gam.cfg timezone.

6.04.18

Handle the following error in gam <UserTypeEntity> print filelist select teamdriveid <SharedDriveID> when <SharedDriveID> is not valid.

ERROR: 404: fileNotFound - Does not exist

6.04.17

  • Upgraded to Python 3.9.6
  • Upgraded to Google API Python Client 2.10.0
  • Upgraded to Google Auth 1.32.0

Added option groupidfilter <String> to gam report <ActivityApplictionName>.

From the API documentation: https://developers.google.com/admin-sdk/reports/reference/rest/v1/activities/list

Comma separated group ids (obfuscated) on which user activities are filtered,
i.e, the response will contain activities for only those users that are a
part of at least one of the group ids mentioned here. Format: "id:abc123,id:xyz456"

Is obfuscated explained? No. Does the option work in my testing? No. Updates when I figure out what's going on.

6.04.16

Added fields resourcekey and linksharemetadatato`.

Added option securityupdate <Boolean> to <DriveFileAttribute> that sets linkShareMetadata.securityUpdateEnabled to <Boolean>.

6.04.15

Fixed bug in gam <UserTypeEntity> sendemail newuser <EmailAddress> ... that caused a trap.

6.04.14

Fixed bug in `gam print filelist filetree|filepath ..." where all files were not displayed.

  • showownedby not specified - Files owned by the user in Shared with me were not displayed
  • showownedby me - Files owned by the user in Shared with me were not displayed
  • showownedby others - Files not owned by the user that are orphans were not displayed

6.04.13

Added option clearfilter to gam <UserTypeEntity> update drivefile <DriveFileEntity> csvsheet <SheetEntity> that causes GAM to clear the spreadsheet basic filter when uploading data to the existing sheet so hidden data will be overwritten.

6.04.12

Added option addsheet <String> to gam <UserTypeEntity> update drivefile <DriveFileEntity> that allows creating a new sheet within a Google spreadsheet with data from localfile <FileName>. Remember, when updating a file with addsheet|csvsheet and localfile <FileName>, you may want to use the retainname option so that the spreadsheet file is not renamed to <FileName>.

6.04.11

Updated Contacts API calls to handle the following error generated by Google as a reminder to switch to the People API.

Contacts API is being deprecated. Migrate to People API to retain programmatic access to Google Contacts.
See: https://developers.google.com/people/contacts-api-migration.

6.04.10

Fixed bug in gam print resources formatjson that caused a trap.

Added ability to display output in JSON format to gam info|print|show buildings.

Added command to display empty drive folders on My Drive or a selected Shared Drive.

gam <UserTypeEntity> print emptydrivefolders [todrive <ToDriveAttribute>*]
        [select <SharedDriveEntity>]

6.04.09

Handle the following error generated by gam report ... fields xxx.

ERROR: 400: invalidInput - Invalid value 'xxx'. Values must match the following regular expression: '(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+,)*(((accounts)|(classroom)|(cros)|(gmail)|(calendar)|(docs)|(gplus)|(sites)|(device_management)|(drive)):[^,]+)'

6.04.08

Updated processing of <DriveFileURL> as Google introduced this new form of a folder URL that GAM didn't recognize and thus couldn't isolate <DriveFileID>.

https://drive.google.com/drive/folders/<DriveFileID>?resourcekey=<String>

6.04.07

Changed config csv_input_row_filter|csv_output_row_filter processing of blank fields for count<Operator><Number> and boolean:<Boolean>. Previously, a blank field was always treated a mismatch; now a blank field will be interpreted as False for <Boolean> and 0 for <Number> and the match test will be performed.

Added options primary and default to the following commands so that only the primary or default sendas is displayed for each user in <UserTypeEntity> rather than all sendas.

gam <UserTypeEntity> show sendas [compact|format|html]
        [primary] [default] [verifyonly]
gam <UserTypeEntity> print sendas [compact]
        [primary] [default] [verifyonly] [todrive <ToDriveAttribute>*]

Added options primary and default to the following commands so that the primary or default signature is displayed for each user in <UserTypeEntity> rather than the current signature.

gam <UserTypeEntity> show signature [compact|format|html]
        [primary] [default] [verifyonly]
gam <UserTypeEntity> print signature [compact]
        [primary] [default] [verifyonly] [todrive <ToDriveAttribute>*]

Added option verifyonly to the commands shown above; it causes a Boolean to be displayed in the signature field rather that the signature text; this simplifies checking for users with undefined signatures.

For example, this command will display a list of users without a primary email address signature (wrapped for readability):

gam config csv_output_row_filter "signature:boolean:false" csv_output_header_filter "User,displayName,signature"
    auto_batch_min 1 num_threads 10 redirect csv ./NoPrimarySignature.csv multiprocess
    all users print signature primary verifyonly

Explanation:
config csv_output_row_filter "signature:boolean:false" - Output rows that indicate no signature
csv_output_header_filter "User,displayName,signature" - Output basic headers
auto_batch_min 1 num_threads 10 - Turn on parallel processing
redirect csv ./NoPrimarySignature.csv multiprocess - Intelligently combine output from all processes
all users - Process all non-suspended users
print signature primary verifyonly - Display state of primary email address signature

6.04.06

Eliminated ios from <DeviceType> ::= android|chrome_os|google_sync|linux|mac_os|windows as company owned IOS devices can not be created with gam create device.

6.04.05

Fixed bug in gam <UserTypeEntity> get drivefile where extensions were inappropriately applied to files that Google reported as having no extension.

6.04.04

Fixed bug in gam <UserTypeEntity> move drivefile ... duplicatefiles uniquename that caused a trap when the source file name contained a '(' with no following ')' or contained a '['.

Updated gam <UserTypeEntity> move drivefile ... duplicatefiles uniquename to not treat the rightmost '.' followed by more than five characters as an extension.

  • foo.abcde will be renamed to foo(1).abcde when moved into a folder containing foo.abcde
  • foo.abcdef will be renamed to foo.abcdef(1) when moved into a folder containing foo.abcdef

6.04.03

Fixed bug in gam report where event names were not put in upper case for: chrome, contextawareaccess, datastudio and jamboard.

6.04.02

Added chrome, contextawareaccess and datastudio to <ActivityApplicationName> so you can do gam report xxx.

6.04.01

Added keep to <ActivityApplicationName> so you can do gam report keep.

Handle the following error when trying to share a folder on a Team Drive to a domain.

ERROR: 400: invalidLinkVisibility - Bad Request. User message: ""

6.04.00

Following Jay's lead, added chat bot commands.

6.03.34

Updated gam copy drivefile to handle the following error:

ERROR: internalError - Internal Error

6.03.33

Added option stripnameprefix <String> to gam create|copy|update drivefile to aid in the following situation. You have a CSV file listing some files owned by an external user; your ultimate goal is to move them to a Shared Drive. This is not possible so you decide to make locally owned copies, backup the externally owned originals and then rename the copies to have the original name and then move those copies to thw Shared Drive.

# Make copies of the externally owned files
gam csv ./ExtFiles.csv gam user user@domain.com copy drivefile "~id"
# You now have `FileName` and 'Copy of Filename`; move the originals to a backup folder
gam csv ./ExtFiles.csv gam user user@domain.com update drivefile "~id" parentid <BackupParentFolderID>
# Generate a list of the "Copy of " copied files
gam redirect csv ./CopyOfFiles.csv user user@domain.com print filelist fields id,name query "name contains 'Copy of '"
# Rename the files stripping off the "Copy of " prefix
gam csv ./CopyOfFiles.csv gam user user@domain.com update drivefile "~id" newfilename "~name" stripnameprefix "Copy of "

6.03.32

Added option notdomain <RegularExpression> to <PermissionMatch> to make it easier to select files owned by someone outside of your domain.

gam user user@domain.com print filelist showownedby others fields id,name,owners.emailaddress pm type user role owner notdomain domain.com em

6.03.31

Fixed a bug in gam create|update user where the required area field in location could be omitted and no error message was given.

6.03.30

Added option addtitle <String> to gam print|show drivefileacls to provide more useful output when reading file IDs from a CSV file. By default, just the file ID is displayed with the permissions; the showtitles option adds the file name to the output at the expense of an additional API call. If you have the file name in the CSV file, you can use the addtitle option to supply the file name. For example, to get the ACLs for your Team Drives with the Team Drive name included in the output:

gam redirect csv ./TeamDrives.csv print teamdrives
gam redirect csv ./TeamDriveACLs.csv multiprocess csv ./TeamDrives.csv gam print drivefileacls teamdriveid "~id" addtitle "~name" fields id,domain,emailaddress,role,type,deleted

6.03.29

Added option stripcrsfromname to the following commands that causes carriage returns \r to be stripped from drive file names. This option is special purpose and will not generally be used.

gam <UserTypeEntity> show fileinfo
gam <UserTypeEntity> print filelist
gam <UserTypeEntity> print|show filetree
gam <UserTypeEntity> print|Show filerevisions

How did a carriage return get added to a drive file name? Good question; the files seen so far are named Icon\r.

6.03.28

Fixed bug in gam <UserTypeEntity> print filelist where blank lines were being displayed after the Got n Drive File/Folder ... messages.

6.03.27

Updated gam print courses to handle the following error.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

Updated gam <UserTypeEntity> move events <UserCalendarEntity> <EventEntity> to|destination <CalendarItem> to correct an incorrect error message from Google.

  • Incorrect message: Move Failed: You need to have reader access to this calendar.
  • Correct message: Move Failed: You need to have writer access to both calendars.

6.03.26

Updated the following commands to allow selection of archived users from a source group.

gam update group add|delete|update|sync
gam update cigroups add|delete|update|sync

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Groups-Membership See: https://github.com/taers232c/GAMADV-XTD3/wiki/Cloud-Identity-Groups-Membership

Updated the following command to allow selection of archived users to be cleared.

gam update group clear

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Groups-Membership

Updated the following commands to allow selection of archived users for display.

gam info group
gam print groups
gam print group-members

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Groups

Added new option to <UserTypeEntity> that allows selection of group members based on their archived status.

group_users_select <GroupList>
       [members] [managers] [owners]
       [notsuspended|suspended] [notarchived|archived]
       [primarydomain] [domains <DomainNameList>] [recursive|includederivedmembership] end

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Collections-of-Users#selected-users-from-groups

6.03.25

Updated gam create project to handle Google change that causes the following error:

ERROR: 403: Permission iam.serviceAccountKeys.create is required to perform this operation on service account

6.03.24

Added option showdetails to gam <UserTypeEntity> create drivefile that adds the parent folder ID and MIME type to the output.

6.03.23

Updated <BrowserFieldName>:

  • Added deviceidentifiershistory
  • Removed installedbrowserversion

Updated gam print browsers to avoid token expiration and minimize memory usage.

6.03.22

Fixed bug in gam <UserTypeEntity> update drivefile where the options retainname | (newfilename <DriveFileName>) were ignored if they appeared after option localfile <FileName>; the options can now appear in any order.

6.03.21

Updated the processing of <UserTypeEntity> to minimize memory usage when getting users directly in an OU.

ou|ou_ns|ou_susp <OrgUnitItem>
ous|ous_ns|ous_susp <OrgUnitList>

Updated gam [<UserTypeEntity>] create|update teamdrive <Name> ... customtheme <DriveFileID> <Float> <Float> <Float> to better handle errors.

Updated gam [<UserTypeEntity>] create teamdrive <Name> to output the name of the newly created Team Drive in addition to its ID.

$ gam user user@domain.com create teamdrive Test
User: user@domain.com, Shared Drive Name: Test, Shared Drive ID: 0ALHCDtCDTx_4Uk9XYZ, Created

6.03.20

Updated gam <UserTypeEntity> print filelist select <DriveFileEntity> to display progress messages as it recurses through the folder tree.

Updated gam <UserTypeEntity> print filelist select <DriveFileEntity> norecursion to retrieve the selected folder without retrieving its direct children which aren't going to be displayed.

6.03.19

Added option showattachments [attachmentnamepattern <RegularExpression>] to gam <UserTypeEntity> print messages|threads. This adds the column Attachments that shows the number of attachments and columns Attachments.n.name and Attachments.n.mimeType that show the attachment names and MIME types.

6.03.18

Added commands to delete specific domain contacts and user's contacts using the People API.

gam delete domaincontacts <PeopleResourceNameEntity>
gam <UserTypeEntity> delete peoplecontacts <PeopleResourceNameEntity>

Updated various google libraries.

6.03.17

Corrected 6.03.16 code fix to avoid trap on Windows when doing the following:

gam config debug_level 1 redirect stdout foo.txt multiprocess ..

It fixed the trap but disabled the redirect.

6.03.16

Fixed code to avoid trap on Windows when doing the following:

gam config debug_level 1 redirect stdout foo.txt multiprocess ..

Updated code to handle the following error in gam copy drivefile:

ERROR: 400: badRequest - Bad Request

Updated code in gam info resoldcustomer <CustomerID> to avoid a trap when <CustomerID> is not a resold customer ID.

Fixed bug in gam <UserTypeEntity> print filelist ... formatjson that caused a trap when no files were listed.

6.03.15

Fixed bug in gam update cigroup where dynamic <QueryDynamicGroup> was marked as invalid.

6.03.14

Added code to handle the following errors when adding an ACL on a Team Drive file.

ERROR: 403: cannotShareTeamDriveWithNonGoogleAccounts - Cannot share a shared drive with non Google accounts.
ERROR: 400: shareOutNotPermitted - Bad Request. User message: "This email address is linked to a personal Google Account. <Your domain> doesn't allow sharing with personal accounts."

6.03.13

Added option show all|direct|inherited to gam print|show chromepolicies which allows selection of policies by whether the policy is set directly on the OU or is inherited from a parent OU; the default is all. A Boolean field/column, direct, has been added to the output. This makes copying only direct policies from one OU to another easy.

# Display direct policies
gam redirect csv ChromePolicies.csv print chromepolicies ou "/Path/To/OU1" show direct
gam csv ChromePolicies.csv gam update chromepolicy "~name" "~fields.0.name" "~fields.0.value" "~fields.1.name" "~fields.1.value" ou "/Path/To/OU2"

# Display all policies, select direct on update
gam redirect csv ChromePolicies.csv print chromepolicies ou "/Path/To/OU1"
gam config csv_input_row_filter "direct:boolean:true" csv ChromePolicies.csv gam update chromepolicy "~name" "~fields.0.name" "~fields.0.value" "~fields.1.name" "~fields.1.value" ou "/Path/To/OU2"

6.03.12

Updated gam update chromepolicy (<SchemaName> (<Field> <Value>)+)+ to allow empty <Field> <Value> pairs. This makes copying a set of policies from one OU to another easy without having to deal with policies with differing numbers of fields.

gam redirect csv ChromePolicies.csv print chromepolicies ou "/Path/To/OU1"
gam csv ChromePolicies.csv gam update chromepolicy "~name" "~fields.0.name" "~fields.0.value" "~fields.1.name" "~fields.1.value" ou "/Path/To/OU2"

Following Jay's lead, added option 'grouptreetogam info userandmembertreetogam info cigroup`.

6.03.11

Upgraded to Python 3.9.5.

Following Jay's lead, Google time is now checked against admin.googleapis.com rather than www.googleapis.com.

Updated code to convert the Shared Drive file field trashedTime from UTC according to gam.cfg timezone.

6.03.10

Fixed bug in gam create course ... copyfrom <CourseID> ... copytopics ... copymaterialsfiles true materialstates "all" that generated the following error:

ERROR: 400: invalidArgument - Request contains an invalid argument.

6.03.09

Added command to print Chrome policies.

gam print chromepolicies [todrive <ToDriveAttribute>*]
        [filter <String>]
        ou|org|orgunit <OrgUnitItem> [(printerid <PrinterID>)|(appid <AppID>)]
        [[formatjson [quotechar <Character>]]

6.03.08

Added commands to display specific domain profiles and user's contacts using the People API.

gam info domainprofiles <PeopleResourceNameEntity>
        [allfields|(fields <PeopleFieldNameList>)]
        [formatjson]
gam <UserTypeEntity> info peoplecontacts <PeopleResourceNameEntity>
        [allfields|(fields <PeopleFieldNameList>)]
        [formatjson]

6.03.07

Updated code to properly set the values for the following Chrome Policy schema values:

  • chrome.users.SessionLength - sessionDurationLimit
  • chrome.users.BrowserSwitcherDelayDuration - browserSwitcherDelayDuration
  • chrome.users.MaxInvalidationFetchDelay - maxInvalidationFetchDelay
  • chrome.users.SecurityTokenSessionSettings - securityTokenSessionNotificationSeconds
  • chrome.users.PrintingMaxSheetsAllowed - printingMaxSheetsAllowedNullable

6.03.06

Added enhanced commands for displaying Chrome Policy schemas.

gam info chromeschema <SchemaName>
        <ChromePolicySchemaFieldName>* [fields <ChromePolicySchemaFieldNameList>]
        [formatjson]
gam show chromeschemas
        [filter <String>]
        <ChromePolicySchemaFieldName>* [fields <ChromePolicySchemaFieldNameList>]
        [formatjson]
gam print chromschemas [todrive <ToDriveAttribute>*]
        [filter <String>]
        <ChromePolicySchemaFieldName>* [fields <ChromePolicySchemaFieldNameList>]
        [[formatjson [quotechar <Character>]]

6.03.05

Added commands to print Gmail imap/pop/language settings to CSV files.

gam <UserTypeEntity> print imap|imap4 [todrive <ToDriveAttribute>*]
gam <UserTypeEntity> print pop|pop3 [todrive <ToDriveAttribute>*]
gam <UserTypeEntity> print language [todrive <ToDriveAttribute>*]

6.03.04

Added commands to display user's other contacts using the People API.

To use this feature you must add the People API to your project and authorize the appropriate scopes:

gam update project
gam user user@domain.com update serviceaccount

Added commands to display user's contact groups using the People API.

6.03.03

Added commands to display user's contacts using the People API.

Simplified commands for displaying domain contacts/profiles with the People API.

6.03.02

Changed the time window for api_calls_rate_check from 100 seconds to 60 seconds as Google seems to be changing quota limits to be measured over 60 seconds.

6.03.01

Added option showsource to gam <UserTypeEntity> print filelist countsonly that adds an additional column Source that indicates the top level folder ID from which the counts are derived.

6.03.00

As the Contacts API is being deprecated in June, additional support for the People API has been added. This is the first step of many required to make the transition.

The existing commands get profilephoto, print|show peopleprofile have been changed to use Service Account Access to avoid having to make additional Directory API calls to convert the user email address to the people ID.

To use these features you must add the People API to your project and authorize the appropriate scopes:

gam update project
gam oauth create
gam user user@domain.com update serviceaccount

Following Jay's lead, added new license SKU Cloud Search.

6.02.04

Updated code to handle the following error:

ERROR: Authentication Token Error - Not all requested scopes were granted by the authorization server, missing scopes , https://sites.google.com/feeds, email, https://www.google.com/m8/feeds, profile.

6.02.03

Added optional argument convertalias to all commands that manipulate Gmail delegates. If not specified, the extra API call introduced in 6.02.00 to convert potential delegate email aliases to primary email addresses is not performed; if you specify an alias as a delegate, the command will fail. If you know that all of the delegate email addresses are primary, you can omit convertalias and avoid the extra API calls.

6.02.02

Thanks to Jay's assistance in getting a Data Studio API discovery document, updated the Data Studio permissions commands.

6.02.01

Fixed bug in gam <UserTypeEntity> add datastudiopermissions that caused a trap.

6.02.00

Following Jay's lead, aliases are converted to primary email addresses when adding delegates.

Added commands to display Data Studio assets and display/manage Data Studio permissions.

To use these commands you must add the Data Studio API to your project and update your service account authorization.

gam update project
gam user user@domain.com update serviceaccount

This is a first release from me, experiment and use with caution.

6.01.09

Added support for localfile - in gam <UserTypeEntity> create|update drivefile which allows commands/programs to output data to stdout which can then be uploaded to a Google Drive file.

generatedata | gam user user@domain.com create drivefile drivefilename test.csv localfile - mimetype gsheet

6.01.08

Following Jay's lead, cleaned up field names in gam print chromehistory.

Following Jay's lead, added new license SKU Google Workspace Frontline.

6.01.07

Following Jay's lead, added additional columns to gam print chromehistory.

6.01.06

Updated gam whatis <EmailItem> to check if <EmailItem> is an unmanaged account if it is not a group/user email address or alias.

Following Jay's lead, switched all commands referencing unmanaged accounts to use Service Account access rather than Client access. This avoids the Invalid Scope issue when doing gam oauth create. The Cloud Identity User Invitations API has been dropped from gam oauth create for now.

6.01.05

Added the capability to display Chrome version history.

Added the option verifynotinvitable to gam create|update alias|group|user that causes GAM to verify that the email address being created/updated is not that of an unmanaged account; if it is, the command is not performed.

To use this option you must add the Cloud Identity API to your project and authorize the appropriate scope: Cloud Identity User Invitations API.

You'll have to do gam update project and gam oauth create to enable this option.

Updated google-api-python-client to version 2.1.0.

6.01.04

Fixed bug in gam report usage customer that caused a trap.

Upgraded to Python 3.9.4.

6.01.03

Upgraded to Python 3.9.3.

Upgraded to OpenSSL 1.1.1k.

6.01.02

Updated google_auth, google_auth_httplib2, google_auth_oauthlib, googleapiclient, httplib2 libraries.

6.01.01

Updated gam print|show chromeversions to avoid a trap where a version was returned without a version field.

6.01.00

Added the capability to access two new areas.

You'll have to do gam update project and gam oauth create to enable these commands.

As with any initial release, report any problems.

Improved error reporting when trying to add/remove licenses with an administrator that is not authorized to do so.

6.00.08

Fixed bug in gam print course-materials fields <CourseAnnouncementFieldNameList> that caused the following error:

Course: <CourseID>, Print Failed: Request contains an invalid argument.

Code cleanup for gam print course-work and gam print course-materials.

6.00.07

Added option splitupdate to gam <UserTypeEntity> update calattendees to handle replacing an email alias with its primary email in the event attendee list. By default, when you try to replace an email alias with its primary email, the Google Calendar API detects that the underlying user ID is the same and doesn't change the address. The splitupdate option causes GAM to make two updates to the attendee list; the first removes the alias and the second adds the primary email.

6.00.06

Added command gam print addresses [todrive <ToDriveAttribute>*] that produces a two column CSV file (headers Type, Email) that displays all group and user primary email addresses and aliases. The types are: Group, GroupAlias, GroupNEAlias, SuspendedUser, User, UserAlias, UserNEAlias. 'NE' is and abbreviation for NonEditable.

6.00.05

Fixed bug in gam print vaultcounts ... everyone which caused the following error:

ERROR: getUsersToModify coding error

6.00.04

Updated <CalendarAttribute> to allow specifying a list of email notification event types.

Previously, you had to specify each email notification event type individually (this still works).

<CalendarEmailNotificatonEventType> ::=
        eventcreation|eventchange|eventcancellation|eventresponse|agenda
<CalendarEmailNotificatonEventTypeList> ::=
        <CalendarEmailNotificatonEventType>(,<CalendarEmailNotificatonEventType>)*

<CalendarAttribute> ::=
...
        (notification clear|(email <CalendarEmailNotificatonEventTypeList>))|

gam user user@domain.con update calendar primary notification email eventchange,eventcancellation

6.00.03

Fixed bug in gam calendar update event introduced in 5.34.02 where updating an event's start or end time appeared to work but no change was actually made.

6.00.02

Added support for stand-alone course materials; these were not previously supported by the Google Classroom API.

To use the course materials features you must authorize the appropriate scope: 'Classroom API - Course Work/Materials'.

gam oauth create
gam user user@domain.com check|update serviceaccount

6.00.01

Improve error handling in gam delete|update chromepolicy and gam show chromepolicies.

When showing Chrome Policies, display OU and optional printerid/appid at top of output.

6.00.00

Following Jay's lead, added the capability to manage three new areas.

You'll have to do gam update project and gam oauth create to enable these commands.

As with any initial release, proceed with care and report any problems.

Updated gam report customer|user to continue processing subsequent dates when Google indicates that no data is available for a particular date.

Improved gam report Got messages so it is easier to monitor progress.

Removed extraneous email header in gam report user ... aggregatebydate.

5.35.08

Fixed bug in gam calendar <CalendarEntity> create|import|update event where noreminders was not disabling reminders.

5.35.07

Fixed bug in all gam browser|browsertoken commands that displayed an error like this:

ERROR: 400: invalid - Invalid Customer ID: customers/xxx

5.35.06

Fixed bug in gam <UserTypeEntity> create filter that caused a trap.

5.35.05

Modified how gam cros_ou_and_children <OrgUnitItem> ... and gam cros_ous_and_children <OrgUnitList> ... are processed. The Google Directory API does not support getting all CrOS devices in an OU and its sub OUs; previously, when these options were used, GAM made a single API call to retrieve the entire list of CrOS devices and selected the desired devices. For customers with a small number of CrOS devices this didn't cause an issue, for customers with large numbers of CrOS devices, this could be slow. Now, GAM makes a separate API call for the OU and each of its sub OUs to retrieve the CrOS devices.

Expanded the options to select CrOS devices by OU in gam print cros and gam print crosactivity.

(limittoou|cros_ou|cros_org <OrgUnitItem>)|(cros_ou_and_children|cros_org_and_children <OrgUnitItem>)|
 (cros_ous|cros_orgs <OrgUnitList>)|(cros_ous_and_children|cros_orgs_and_children <OrgUnitList>)]

Using gam print cros cros_ou /Students fields ... will be much faster than gam cros_ou /Students print cros fields ... as the second form makes one API call to retrieve the CrOS device IDs and then another API call per device to get the fields. In the first form, GAM makes a single API call to retrieve the devices and their fields.

5.35.04

Fixed bug in gam <UserTypeEntity> delete|update filerevisions <DriveFileEntity> select last 1 where GAM incorrectly reported No Drive File Revisions matched if the file had only one revision.

5.35.03

Fixed bug in permission matching where pm domain domain.com em would match an ACL referencing a deleted user.

Updated google-api-python-client to version 2.0.2.

5.35.02

Fixed bug in gam <UserTypeEntity> move events where destination was not recognized as a synonym for to.

5.35.01

Fixed bug in gam print users that caused a trap when limittoou <OrgUnitItem> and allfields were both specified.

Added option pmselect to gam [<UserTypeEntity>] print|show drivefileacls and gam [<UserTypeEntity>] print|show teamdriveacls to allow selection of files/Shared Drives matching the specified permissions without filtering the permissions themselves.

5.35.00

Reconfigured GAM source so that GAM can be imported/called from a Python script.

  • A new subfolder gam was created under src; all source files were moved there
  • gam.py was renamed to __init__.py, this is what allows you to import gam
  • __main__.py was created in gaml; it is used by the GAM executable
  • A new gam.py was created in src that allows calling gam as a single .py file

If you're not using the source code, this change should have no impact.

5.34.04

Code cleanup.

5.34.03

Code cleanup.

Allow empty annotatedAssetId for Chromebooks; the API previously didn't allow this.

Following Jay's lead, updated hashing of passwords passed to Google.

5.34.02

Fixed bug in gam <UserTypeEntity> update calattendees ... csv <FileName> that caused a trap.

5.34.01

Fixed bug introduced in 5.33.00 where gam version checkrc incorrectly set the return code to 1 even when you have the current version of GAM.

Added new Google Workspace for Education products and SKUs.

5.34.00

Eliminated all gam audit commands that used the Email Audit API; use vault commands as replacements.

The Mac OS version specific builds (gamadv-xtd3-5.xy.wz-macos-10.vv-x86_64.tar) have been eliminated; the all version build (gamadv-xtd3-5.xy.wz-macos-x86_64.tar) is now the only Mac OS build. You can download the new executable with (the -b allmacos option is no longer required):

bash <(curl -s -S -L https://git.io/fhZWP) -l

5.33.00

Eliminated automatic checking for a new GAM version, no_update_check in gam.cfg is now ignored. Previously, when no_update_check was false, a file was opened and read on every execution of GAM. You can check for a new version with gam version check.

A new GAM executable (gamadv-xtd3-5.xy.wz-macos-x86_64.tar) that should run on all versions of Mac OS from 10.10 on is now being built. For now, the version specific executables will still be built. You can download the new executable with:

bash <(curl -s -S -L https://git.io/fhZWP) -l -b allmacos

5.31.28

Added option oneuserperrow to gam print crosactivity recentusers to make the output of the recent users easier to process.

5.31.27

Upgraded to Python 3.9.2.

5.31.26

Upgraded to OpenSSL 1.1.1j.

5.31.25

Added option showorgunit to the following gam report commands that causes a column labelled orgUnitPath to be added to the output. GAM makes an additional API call to get the email addresses of the users in <OrgUnitPath>.

gam report usage user orgunit|org|ou <OrgUnitPath> showorgunit ...
gam report <ActivityApplicationName> orgunit|org|ou <OrgUnitPath> showorgunit ...
gam report user orgunit|org|ou <OrgUnitPath> showorgunit ...

5.31.24

Added todrive_upload_nodata [<Boolean>] to gam.cfg and tduploadnodata [<Boolean>] to <ToDriveAttribute>.

  • When True, the default, CSV files with no data rows will be uploaded; this is the existing behavior.
  • When False, CSV files with no data rows will be not be uploaded; the message No CSV data to upload will be displayed and the return code will be set to 77.

5.31.23

Updated gam showsections to display section names in sorted order.

5.31.22

Updated gam <UserTypeEntity> get document|drivefile <DriveFileEntity> to add *|~ to the list of characters in Google Drive file names that are changed to _; the complete list is now \/:*|~. This is to prevent local file system errors.

5.31.21

Added meta-command showsections that displays all of the sections in gam.cfg and marks the currently selected section with a *.

gam showsections
$ gam showsections
Config File: /Users/admin/GamConfig/gam.cfg
  DEFAULT
  Client1
  Client2
  Client3 *
  Client4

5.31.20

Added option labelmatchpattern <RegularExpression> to gam <UserTypeEntity> print|show messages|threads that causes only messages with some label that matches <RegularExpression> to be displayed.

5.31.19

Updated code to handle the following error when moving calendar events:

ERROR: 400: invalid - Cannot have multiple conferences of type Hangout and NamedHangout.

5.31.18

Updated gam info cros <CrOSEntity> and gam print cros to avoid trap caused by change in API behavior.

5.31.17

Updated gam <UserTypeEntity> create|add teamdrive <Name> to handle the following error:

ERROR: 403: insufficientFilePermissions - The user does not have sufficient permissions for this file.

5.31.16

Deleted option previewupdate from gam <UserTypeEntity> print|show filerevisions <DriveFileEntity> as it served no purpose.

5.31.15

Added command to manage publishing file revisions to the web.

5.31.14

Fixed bug in gam <UserTypeEntity> print filters formatjson quotechar <Character> that caused a trap.

5.31.13

Updated gam update|delete|info resoldsubscription to allow SKU abbreviations.

5.31.12

Fixed bug in gam print licenses allskus|gsuite that produced garbage output.

5.31.11

Updated code to handle the following error when getting lists of students/teachers from courses.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

Fixed bug in gam <UserTypeEntity> transfer drive <UserItem> select <DriveFileItem> that caused files to be orphaned.

Added option mergewithtarget to gam <UserTypeEntity> transfer drive <UserItem> select <DriveFileItem> to allow transferring a folder without creating a new folder in the target user folder. The contents of the folder, but not the folder itself, are transferred to the new owner.

gam user oldowner@domain.com transfer drive newowner@domain.com select name "Old Owner Folder" targetfoldername "New Owner Folder" targetuserfoldername "" mergewithtarget true

5.31.10

Updated code to avoid a trap when an input CSV file is not encoded in UTF-8. You'll still get an error but not a trap.

UnicodeDecodeError: 'utf-8' codec can't decode byte 0xf3 in position 893: invalid continuation byte
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 0: invalid start byte

Updated gam print cigroups to suppress this message,

Got n Cloud Identity Groups: %%first_item%% - %%last_item%%

5.31.09

Updated create project and check|update serviceaccount URLs to include administrator email address.

5.31.08

Enhanced gam update course <CourseID> teacher <UserItem> to handle special situations better.

5.31.07

Updated gam <UserTypeEntity> print users to handle the following error:

ERROR: 403: rateLimitExceeded - Quota exceeded for quota group 'default' and limit 'Queries per user per 100 seconds'
of service 'admin.googleapis.com' for consumer 'project_number:Project#Here'.

5.31.06

Updated gam <UserTypeEntity> print|create filter to make it easier to copy filters from one user to another.

5.31.05

Improved error message generated when trying to move a calendar event to a calender without write access.

Updated all commands/options that reference License Products and SKUs to validate the values entered.

Updated gam create course copyfrom <CourseID> and gam update course <CourseID> copyfrom <CourseID> to remove Course Work due dates that fall before the current time; if not removed, the Course Work can not be copied.

  • removeduedate false - Remove due dates before the current time; this is the default
  • removeduedate|removeduedate true - Remove all due dates

Fixed bug in gam print courses that caused a trap when there were no courses to print due to filtering.

5.31.04

Added a command to download a Google Document in JSON format.

You'll have to do gam update project and gam <UserTypeEntity> check|update serviceaccount to enable this command.

5.31.03

Fixed bug in gam <UserTypeEntity> move drivefile <DriveFileEntity> that caused a trap when an invalidSharingRequest error was reported by the Drive API.

Updated gam <UserTypeEntity> transfer drive to not try changing parents of Shared with me files/folders that do not have parents in My Drive.

5.31.02

Added initial support for Chrome Browser Enrollment Token API.

Updated gam <UserTypeEntity> draft|import|insert message to disallow content-type header that caused a trap. Ths value of this header is derived from other arguments and can not be explicitly set.

5.31.01

When creating an alias, group or user, additional informations is given when the item is a duplicate.

$ gam create alias techassistant user user2@domain.com
User Alias: techassistant@domain.com, User: user2@domain.com, Create Failed: Duplicate, User Alias: techassistant@domain.com, User: user1@domain.com

$ gam create group technology@domain.com
Group: technology@domain.com, Create Failed: Duplicate, Group: technology@domain.com
$ gam create group appletech@domain.com
Group: appletech@domain.com, Create Failed: Duplicate, Group Alias: appletech@domain.com, Group: technology@domain.com

$ gam create user user1@domain.com
User: user1@domain.com, Create Failed: Duplicate, User: user1@domain.com
$ gam create user techassistant@domain.com
User: techassistant@domain.com, Create Failed: Duplicate, User Alias: techassistant@domain.com, User: user1@domain.com
$ gam create user appletech@domain.com
User: appletech@domain.com, Create Failed: Duplicate, Group Alias: appletech@domain.com, Group: technology@domain.com

5.31.00

Removed all Cloud Print related commands,

Extended support for Cloud Identity Groups. This is Beta software from Google and a first release from me, experiment and use with caution.

5.25.20

Changed processing of <FieldNameFilter> when performing column row filtering to simplify specifying field names that should match a field but none of its subfields. If <FieldNameFilter> doesn't contain any of the following regular expression characters ^$*+|$[{(, it will be surrounded with ^$ so that it doesn't match any subfields that begin with <FieldNameFilter> as a prefix. In previous versions, you had to surround <FieldNameFilter> with ^$ to get this behavior.

5.25.19

Fixed bug introduced in 5.25.18 where using todrive_noemail false or tdnoemail false caused a trap.

5.25.18

The Google message id was added to the output from gam sendemail. This allows you to easily get details about the message sent, e.g, the SMTP Message-ID.

Added options (<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)* to gam sendemail that allows adding user specified headers to the message being sent.

5.25.17

Currently, when doing CSV row filter matching, lf you specify a regular expression for a field name that matches several columns, the filter matches if any of the columns has a match. In the case of notregex|notregexcs, the filter matches if none (not any) of the columns has a match.

This has been extended to allow specifying that the filter will match only if all of the columns have a match. In the case of notregex|notregexcs, the filter matches if some (not all) of the columns have a match.

5.25.16

Fixed bug in gam <UserTypeEntity> print messages showlabels countsonly that caused a trap.

5.25.15

Updated commands that create and update schemas to convert spaces to _ in schema and field names as spaces are not valid. The schema and field display names will retain the spaces. Added options to allow specification of the schema/field display name as independent of the schema/field name.

<SchemaFieldDefinition> ::=
        field <FieldName> [displayname <String>]
            (type bool|date|double|email|int64|phone|string)
            [multivalued|multivalue] [indexed] [restricted]
            [range <Number> <Number>]
        endfield

gam create|add schema|schemas <SchemaName> [displayname <String>] <SchemaFieldDefinition>+
gam update schema <SchemaName> [displayname <String>] <SchemaFieldDefinition>* (deletefield <FieldName>)*
gam update schemas <SchemaEntity> [displayname <String>] <SchemaFieldDefinition>* (deletefield <FieldName>)*

Updated gam <UserTypeEntity> move drivefile <DriveFileEntity> to move a folder from a Shared Drive to My Drive by updating the parent rather than creating a new folder.

Upgraded to Python 3.9.1.

5.25.14

Following Jay's lead, added commands to support Contact Delegation,

You must perform gam oauth create and select this API to use these commands.

  • Contact Delegation API (supports readonly)

This is Beta software from Google, experiment and use with caution.

Following Jay's lead, added commands to support Chrome Browser Cloud Management

You must perform gam oauth create and select this API to use these commands.

  • Chrome Browser Cloud Management API (supports readonly)

This is Beta software from Google, experiment and use with caution.

5.25.13

Following Jay's lead, added commands to display and update Cloud Identity Device User Client States.

This is Beta software from Google, experiment and use with caution.

Following Jay's lead, added a command to display item counts retained in Google Vault.

Updated gam <UserTypeEntity> create drivefileshortcut <DriveFileEntity> to not create duplicate shortcuts. A duplicate shortcut is one that is in the same folder as another shortcut of the same name pointing to the same target file/folder.

5.25.12

Added more error handling for gam <UserTypeEntity> process messages|threads.

5.25.11

Google does not support / in group email addresses but doesn't give an error if you assign an address that contains a /. The Directory API will accept such an address but the Group Settings API won't; this update maps / to %2F so the Group Settings will accept the address.

5.25.10

Extended 5.25.09 to handle additional errors in gam <UserTypeEntity> process messages|threads.

5.25.09

In gam <UserTypeEntity> delete messages|threads, handle the following error:

ERROR: 400: failedPrecondition - Precondition check failed.

5.25.08

When getting group settings, handle the following error:

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

Added tdsheetdaysoffset <Number> and tdsheethoursoffset <Number> to <ToDriveAttribute>. These allow setting timestamp offset information on a sheet (tab) that is different than the timestamp information on the Google spreadsheet file.

5.25.07

Perform retries when Google returns an error instead of Google Sheet data when using gsheet <UserGoogleSheet>. This seems to happen when you quickly execute a series of GAM commands that access the same Google Sheet to retrieve data for each command.

When creating/copying files/folders, handle the following error:

ERROR: 403: teamDriveHierarchyTooDeep - The shared drive hierarchy depth will exceed the limit.

5.25.06

Added option scope|scopes <APIScopeURLList> to gam <UserTypeEntity> update serviceaccount to allow specification of the desired scopes on the command line. Entering <APIScopeURLList> by hand would be tedious at best but could be used in a script.

5.25.05

Added options thismonth and previousmonths <Integer> to gam report to provide calendar oriented date/time ranges.

5.25.04

Updated gam <UserTypeEntity> check|update serviceaccount to avoid ERROR: No Service Account Access allowed when getting Service Account key age and Identity and Access Management API is not enabled.

5.25.03

Updated gam <UserTypeEntity> check|update serviceaccount to add &dn=<DomainName> to the end of the end of the authorization URL. This will be most useful to Google Resellers managing multiple accounts.

5.25.02

Updated gam <UserTypeEntity> create drivefileacl to handle the following error:

ERROR: 400: shareOutNotPermittedToUser - Bad Request.

5.25.01

Updated code in gam report admin to handle event parameters with no value; this is what caused the trap fixed in 5.25.00. This update formats those parameters in the same manner as other parameters.

5.25.00

Added csv_input_row_filter and csv_input_row_drop_filter to gam.cfg to allow CSV row filtering of input CSV Files.

Updated code in gam report admin to avoid a trap caused by a change the Report API.

5.24.14

Fixed error that didn't allow blank tdsheet.

5.24.13

Added option countsonly to gam <UserTypeEntity> print|show groups that causes GAM to display the number of groups, by role, to which a user belongs rather than listing the group details.

Updated todrive to improve formatting of blank tdtitle and tdsheet when using tdtimestamp true and tdsheettimestamp true. Previously, a - followed by the timestamp was appended to the title resulting in something like this: - 2020-11-18T12.34.56Z; now, the - is omitted.

Upgraded to Python 3.9.0.

5.24.12

Updated gam <UserTypeEntity> show messages|threads saveattachments to convert the characters / and : to _ in attachment names so that they can be saved.

5.24.11

Updated gam <CrOSTypeEntity> getcommand commandid <CommandID> to handle the following error:

ERROR: 404: notFound - Requested entity was not found.

5.24.10

Fixed bug in gam <UserTypeEntity> copy drivefile <DriveFileEntity> that caused a trap.

5.24.09

Fixed gam print courses show all|students|teachers to eliminate duplicated columns.

5.24.08

Removed restrictions in gam <UserTypeEntity> copy|move drivefile <DriveFileEntity> that prevented adding ACLs to folders on Shared Drives as it was not allowed; Google now allows this.

5.24.07

Added an additional line of output to gam version that displays some basic configuration data.

Config File: /Users/Admin/.gam/gam.cfg, Section: DEFAULT, customer_id: C01234567, domain: domain.com

5.24.06

Corrected 5.24.05 update to properly handle an unexpected HttpError 500 that caused a trap.

5.24.05

Updated gam <UserTypeEntity> transfer drive to handle an unexpected HttpError 500 that caused a trap.

5.24.04

Updated gam <UserTypeEntity> print|show forward to handle the following error:

ERROR: 400: failedPrecondition - Precondition check failed.

5.24.03

Fixed bug in gam <UserTypeEntity> print filecounts showmimetype <MimeTypeList> that caused a trap.

5.24.02

Updated gam calendar <CalendarEntity> move events and gam <UserTypeEntity> move events <UserCalendarEntity> to handle the following error:

ERROR: 403 requiredAccessLevel - You need to have writer access to this calendar.

5.24.01

Fixed bug introduced in 5.23.06 where todrive tdfileid <FileID> tdaddsheet tdsheet "Sheet Title" caused the error:

ERROR: Drive File ID: <FileID>, Sheet: "Sheet Title", Not Found

Added code to verify that todrive tdfileid <FileID> tdaddsheet tdsheet "Sheet Title" does not reference an existing sheet.

5.24.00

Added a new environment variable GAMCFGSECTION that selects a [Section] within gam.cfg. This allows multiple users with distinct logins on the same computer to share gam.cfg but each reference a unique [Section]. This might be used if you want each user to have their own GAM project for auditing purposes. When GAMCFGSECTION is set, the user will not be allowed to select a different [Section].

Updated gam <UserTypeEntity> delete photo to handle Error 500 Internal error.

5.23.08

Added optional qualifier not to match patterns in gam print groups and gam print|show group-members. The groups will be selected if the matchpattern does not match the <RegularExpression>.

emailmatchpattern [not] <RegularExpression>
namematchpattern [not] <RegularExpression>
descriptionmatchpattern [not] <RegularExpression>

Added option useshortcuts [<Boolean>] to gam <UserTypeEntity> collect orphans. By default, GAM adds the target user folder as a parent of an orphan. This may now fail as the orphan may have parents belonging to other users and files can now have only one parent. With useshortcuts true, GAM puts a shortcut to the orphan into the target user folder and does not modify the orphan's parents. GAM will not duplicate an existing shortcut.

5.23.07

Fixed code in gam <UserTypeEntity> transfer drive <UserItem> that caused the following error:

ERROR: 403: cannotAddParent - Increasing the number of parents is not allowed

This was caused by the Google change effective 2020-10-01 that prevents files/folders from having more that one parent. When transferring files from userA to userB, files owned by userC directly in userA's My Drive (or in the top level of select <DriveFileEntity>) can't have their parents changed; now, userB will get a shortcut to those files.

5.23.06

Added todrive_sheet_timestamp [<Boolean>] and todrive_sheet_timeformat <String> to gam.cfg. Added tdsheettimestamp [<Boolean>] and tdsheettimeformat <String> to <ToDriveAttribute>. These allow setting timestamp information on a sheet (tab) that is different than the timestamp information on the Google spreadsheet file.

Removed option tdaddsheettitle <String> from <ToDriveAttribute>; use the existing tdsheet <String> option with tdaddsheet to name the new sheet (tab).

** This is not a backwards compatible change, but it is simpler; I apologize for the inconvenience.**

Added option returnlinkonly to gam <UserTypeEntity> create|update drivefile that causes GAM to return just the webViewLink of the created/updated file as output. This would typically be used with localfile <FileName> mimetype gdoc|gsheet|gpresentation where Google converts the local file <FileName> to a Google document.

$ gam user user@domain.com create drivefile localfile local.xlsx returnlinkonly mimetype gsheet
https://docs.google.com/spreadsheets/d/12340ar1pW3GkiNlVhTFaNigkP3nZnoE5iTynjFjwxyz/edit?usp=drivesdk

5.23.05

Added option tdaddsheettitle <String> to <ToDriveAttribute>. When used with tdaddsheet, the new sheet (tab) can be named independently of the existing Google spreadsheet file.

5.23.04

Added option tdaddsheet [<Boolean>] to <ToDriveAttribute>. When used with tdfileid, a new sheet (tab) within an existing Google spreadsheet can be created with a gam print todrive command.

5.23.03

Updated gam print teamdriveacls user <EmailAddress> to handle the following error:

ERROR: 403: insufficientAdministratorPrivileges - The requesting user does not have the administrator privileges required to access shared drive

5.23.02

Fixed bug in gam info group <GroupEntity> ciallfields that caused the error:

ERROR: expected string or bytes-like object

5.23.01

Added quick_info_user to gam.cfg to control how much information requiring additional API calls is displayed with gam info user. The default behavior (quick_info_user = False) is to display aliases, building names, groups, licenses and all custom schemas. You use options to disable whatever additional information you don't want.

With quick_info_user = true, then none of the additional information is displayed by default. You use options to enable whatever additional information you do want.

Added lastknownnetwork to <CrOSFieldName>.

5.23.00

Added preview option to gam <UserTypeEntity> create|update|delete|sync license commmands; if specified, the changes will be previewed but not executed.

Added actioncsv option to gam <UserTypeEntity> create|update|delete|sync license commands. For create, 'delete and 'sync, this will produce a CSV file with columns user,productId,skuId,action,message. For update, this will produce a CSV file with columns user,productId,oldskuId,skuId,action,message. This file shows the actions performed when processing the licenses.

Added addonly|removeonly options to gam <UserTypeEntity> sync license commands. By default, a sync will perform add and remove operations; these options limit the operations as specified.

gam <UserTypeEntity> create|add license <SKUID> [product|productid <ProductID>] [preview] [actioncsv]
gam <UserTypeEntity> update license <SKUID> [product|productid <ProductID>] [from] <SKUID> [preview] [actioncsv]
gam <UserTypeEntity> delete license <SKUID> [product|productid <ProductID>] [preview] [actioncsv]
gam <UserTypeEntity> sync license <SKUID> [product|productid <ProductID>] [addonly|removeonly] [preview] [actioncsv]

Updated commit-batch command in batch files to take an optional argument that causes GAM to wait for user input before continuing.

  • commit-batch
    • GAM waits for all running GAM commands to complete
    • GAM continues
  • commit-batch <String>
    • GAM waits for all running GAM commands to complete
    • GAM prints <String> and waits for the user to press any key
    • GAM continues

Fixed bug in gam <UserTypeEntity> sync license where an attempt was made to add a license to an existing license holder.

5.22.13

Following Jay's lead, added commands to send commands to ChromeOS devices.

<CrOSCommand>
        reboot|
        remote_powerwash|
        set_volume <0-100>|
        wipe_users|
        take_a_screenshot

gam issuecommand cros <CrOSEntity> command <CrOSCommand> [times_to_check_status <Integer>] [doit]
gam <CrOSTypeEntity> issuecommand command <CrOSCommand> [times_to_check_status <Integer>] [doit]
gam getcommand cros <CrOSEntity> commandid <CommandID> [times_to_check_status <Integer>]
gam <CrOSTypeEntity> getcommand commandid <CommandID> [times_to_check_status <Integer>]

5.22.12

Added check for more than one parent in gam create|update|copy|move drivefile and gam create sheet; multiple file parents are no longer allowed.

Added option showgroupnameslist to gam <UserTypeEntity> print contacts that is used in conjunction with formatjson to add the key ContactGroupsList with a list of contact group names to the JSON output. This key and its values can be used when creating contacts with the json option to set contact groups.

5.22.11

Fixed bug where csv_output_row_drop_filter was not being processed when formatjson was specified.

5.22.10

Updated gam user <UserItem> print driveactivity to do additional checking to find values for user.name and user.emailAddress. Events return a user if a logged in user performed the action; events return an impersonation if an action was performed on behalf of a user via the Drive API; GAM now handles impersonation as well as user.

5.22.09

Fixed bug in gam user <UserItem> print driveactivity where the actor user names were incorrectly shown as the user <UserItem> rather than the actual user.

5.22.08

Fixed bug in gam create device that caused a trap.

Fixed bug in gam print org fromparent <OrgUnitPath> showparent that caused ERROR: API access Denied when <OrgUnitPath> had no sub OUs.

Handle error when gam device commands are issued but Service Account access is not enabled.

5.22.07

Deleted options alias|aliases <AliasList> and dynamic <QueryDynamicGroup> from gam update cigroup as the options are only applicable when the group is created.

5.22.06

The Drive Activity API v1 has been deprecated, thus gam print|show driveactivity will now always use Drive Activity API v2. The v2 option is ignored; the options allevents, combinedevents and singleevents are ignored as they have no meaning with Drive Activity API v2.

5.22.05

Added options to gam create|update drivefile to manage content restrictions.

<DriveFileAttribute> ::=
        (contentrestrictions readonly false)|
        (contentrestrictions readonly true [reason <String>])|

Added new Workspace licenses SKUs.

<SKUID> ::=
        wsentplus|workspaceenterpriseplus|gae|gse|enterprise|gsuiteenterprise|1010020020|
        wsbizplus|workspacebusinessplus|1010020025|
        wsentstan|workspaceenterprisestandard|'1010020026|
        wsbizstart|workspacebusinessstarter|1010020027|
        wsbizstan|workspacebusinessstandard|1010020028|
        wsess|workspaceesentials|gsuiteessentials|essentials|d4e|driveenterprise|drive4enterprise|1010060001|
        wsentess|workspaceenterpriseessentials|1010060003|

5.22.04

The following additions are derived from initial work by Jay.

Added commands to manage Cloud Identity groups. This is a work in progress.

5.22.03

Added options alias|aliases <AliasList> and dynamic <QueryDynamicGroup> to gam update group to allow setting options on Cloud Identity groups.

5.22.02

Changed option notify <EmailAddress> in gam create|update user to notify <EmailAddressList> so that notifications about account creation|update can be sent to multiple recipients.

Fixed bug where gam config csv_output_column_delimiter "x" was not being properly processed.

5.22.01

Handle the following error when deleting members from groups. This is an invalid message from Google, the member is in the group but Google seems to think that it is an invalid email address. I'm not sure what the long term solution is but this fix keeps GAM from terminating.

ERROR: 404: resourceNotFound - Does not exist

5.22.00

The following additions are derived from initial work by Jay.

Added commands to support the new Device Management API.

To use these commands you must update your service account authorization.

gam user user@domain.com update serviceaccount

In the following places a Google Admin email address is required; by default the admin email address in oauth2.txt is used.

  • Managing Shared Drives as an administrator.
  • Executing gam alert|alertfeedback commands.
  • Sending email when a from user is not specified
  • Uploading files with todrive when neither todrive_user or tduser is specified.
  • All gam printer commands when <UserTypeEntity> is omitted.

Added admin_email to gam.cfg which will supercede the value from oauth2.txt.

Added enable_dasa to gam.cfg. When True, GAM will use a Delegated Admin Service Account for all API access. This is the initial step in getting GAM to use Service Account access for all API calls. This is for testing only!

The following variables in gam.cfg must be set when enable_dasa is True: admin_email, customer_id and domain, customer_id may not be set to my_customer.

5.12.10

Fixed bug introduced in 5.12.09 when removing batch processing for licenses.

5.12.09

Remove batch processing from licensing commands as Jay reports that it generates many errors.

5.12.08

Following Jay's lead, added the following command to synchronize users and licenses.

gam <UserTypeEntity> sync license <SKUID> [product|productid <ProductID>]
  • GAM determines which users currently hold a license for <SKUID>.
  • The license will be deleted for all current license holders that are not in <UserTypeEntity>.
  • The license will be added for all users in <UserTypeEntity> that are not current license holders.

All license commands now use batch processing to improve performance.

5.12.07

Handle the following error when executing gam courses <CourseEntity> create|delete|clear|sync students|teachers.

ERROR: 503: serviceNotAvailable - The service is currently unavailable.

5.12.06

Fixed bug in gam print groups that caused the following error:

ERROR: 400: invalid - Request contains an invalid argument.

5.12.05

Added option oneitemperrow to gam <UserTypeEntity> print asps to have each of a user's Application Specific Passwords displayed on a separate row.

gam <UserTypeEntity> print asps|applicationspecificpasswords [todrive <ToDriveAttribute>*]
        [oneitemperrow]

5.12.04

Added command to display Application Specific Passwords in CSV format.

gam <UserTypeEntity> print asps|applicationspecificpasswords [todrive <ToDriveAttribute>*]

5.12.03

Fixed bug in gam print users ... groups|groupsincolumns that caused no rows to be output when config csv_output_row_filter "GroupCounts:count>n or config csv_output_row_filter "^Groups$:count>n was specified.

5.12.02

Updated processing of scalar schema fields in gam create|update user to allow suppression of empty values; these fields show up as Undefined in the Contacts directory. It is already the case that empty values can be suppressed for multivalued fields.

<UserBasicAttribute> ::=
        (<SchemaName>.<FieldName> [scalarnonempty|
                                   [multivalued|multivalue|value|multinonempty [type home|other|work|(custom <String>)]]]
                                  <String>)

An empty scalar field will be defined.

gam update user user@domain.com SchemaName.FieldName ""

An empty scalar field will be suppressed.

gam update user user@domain.com SchemaName.FieldName scalarnonempty ""

5.12.01

Added code to handle the following error when an attempt is made to copy a site:

ERROR: 400: badRequest - The requested conversion is not supported.

5.12.00

Changed regex:<RegularExpression> and notregex:<RegularExpression> processing in csv_output_row_filter. In prior versions, the <RegularExpression> was processed in a case sensitive manner; in many cases this is probably not desirable; e.g., matching file names which are case insensitive.

Now, <RegularExpression> is processed in a case insensitive manner. This is a change in behavior. To get the prior case sensitive processing, use regexcs:<RegularExpression> and notregexcs:<RegularExpression>.

5.11.06

Starting from preliminary code from Jay, added commands to manage administrative roles.

gam create adminrole <String> privileges all|all_ou|<PrivilegesList> [description <String>]
gam update adminrole <RoleItem> [name <String>] [privileges all|all_ou|<PrivilegesList>] [description <String>]
gam delete adminrole <RoleItem>

Added options signout and turnoff2sv to gam <UserTypeEntity> deprovision to sign out a user and turn off their 2-Step Verification when deprovisioning.

5.11.05

Added a command to sign a user out of all web and device sessions and reset their sign-in cookies. The user will have to sign in by authenticating again.

gam <UserTypeEntity> signout

Added a command to turn off 2-Step Verification for a user. If successful this call will turn off 2-Step Verification and also remove all registered second steps on the user account. This call will fail if the user is not enrolled in 2-Step Verificationin or has 2-Step Verification enforced, or is enrolled in the Advanced Protection Program.

gam <UserTypeEntity> turnoff2sv

5.11.04

Added todrive_clearfilter to gam.cfg and tdclearfilter to <ToDriveAttribute> that cause GAM to clear the spreadsheet basic filter when uploading data to an existing sheet in an existing file. When False, the current/default behavior, the data suppressed by an existing filter is not replaced by the uploaded data. This might be desirable if you wanted to compare the previous and current data, but in general you probably want a value of True so that the uploaded data completely replaces the existing data.

5.11.03

Added additional retries to gam course add|sync teachers|students when Google reports that the teacher|student email address is not found. In certain (not well defined) circumstances Google reports valid email addresses as not found.

5.11.02

Changed the prompt for a login email address for all gam project commands to reflect that what is required is a GCP project manager email address. For most cases, this will be a G Suite super admin but in some cases GCP and G Suite management is separated and a GCP project manager email address is required.

$ gam show projects filter gam
Enter your G Suite admin or GCP project manager email address authorized to manage project(s): filter gam?
$ gam update project
Enter your G Suite admin or GCP project manager email address authorized to manage project(s): gam-project-abc-123-xyx?

Added option scalarsfirst to gam print users that, when column headers are sorted, causes the scalar user fields to appear before the user fields with repeating values.

5.11.01

Improved performance of gam print groups ciallfields|(cifields <CIGroupFieldNameList>).

Handled bug in Cloud Identity Groups API where groups with whoCanJoin INVITED_CAN_JOIN can't be accessed by the API.

This is Beta software from Google, use with caution.

5.11.00

Added options ciallfields and cifields <CIGroupFieldNameList> to gam info|print groups. These allow display of Cloud Identity Groups information.

Added option makesecuritygroup to gam update groups to update a Google Group to a Security Group.

To use these features you must add the Cloud Identity Groups API to your project and authorize the appropriate scope.

gam update project
gam oauth create

This is Beta software from Google, use with caution.

5.10.02

Improve Bad Gateway API error handling.

5.10.01

Added csv_output_row_drop_filter to gam.cfg to allow CSV row filtering by specifying filters that cause the row to be dropped if any of the filters match.

5.10.00

Added multiprocess_pool_limit to gam.cfg; it controls how GAM passes commands to the multiprocessing pool. This is a special use case for testing.

  • -1 - Pass all commands to the multiprocessing pool immediately
  • 0 - Pass commands to the multiprocessing pool in batches of size num_threads; this the default
  • >0 - Pass commands to the multiprocessing pool in batches of the indicated size

5.09.02

Added option showdayofweek to gam calendar <CalendarEntity> info|show|print events and gam <UserTypeEntity> info|show|print events <UserCalendarEntity> to display the day of week when event start and end times are displayed.

5.09.01

Fixed bug gam <UserTypeEntity> draft|import|insert message where htmlmessage, htmlfile and ghtml were not properly processed and the HTML code was handled as plain text.

5.09.00

Update to new Google site for authorizing Service Account scopes.

5.08.22

Extended code to handle the following error when adding/removing aliases/teachers to courses:

429: quotaExceeded - Quota exceeded for quota metric 'Requests' and limit 'Requests per minute per user' of service 'classroom.googleapis.com'

5.08.21

Added code to handle the following error when adding students to courses:

429: quotaExceeded - Quota exceeded for quota metric 'Requests' and limit 'Requests per minute per user' of service 'classroom.googleapis.com'

5.08.20

Updated maximum value for num_threads and num_tbatch_threads in gam.cfg to 1000. This is a special use case, do not use values much higher than 20 in normal circumstances.

5.08.19

Fixed bug in gam update user <UserItem> createifnotfound that gave the following error even though all of the required fields were specified.

Update Failed: Unable to create not found user, some required field (givenName, familyName, password/notfoundpassword) not present

5.08.18

Updated gam [<UserTypeEntity>] print drivefileacls <DriveFileEntity> to display output even if <DriveFileEntity> doesn't have any ACLs.

Owner,id,permissions
user@domain.com,abcyKMQf_RK8iUk9xyz,0

5.08.17

Improved error handling in gam create vaultexport matter <MatterItem> of quotaExceeded - Exceeded running export limit of 20 concurrent exports..

5.08.16

Updated code in gam <UserTypeEntity> get drivefile <DriveFileEntity> csvsheet <SheetEntity> and gsheet(:<FieldName>)+ <UserGoogleSheet> to handle unexpected data in Spreadsheet URL.

5.08.15

Fixed bug in gam courses <CourseEntity> clear|sync that misinterpreted <CourseEntity> when it was a course alias containing a space.

5.08.14

Suppress Not authorized to access this feed error message in gam [<UserTypeEntity>] print|show sites roles all|<SiteACLRoleList>; users with role reader can't access the site ACLs to get the roles and the message is misleading.

5.08.13

Added exportlinks to <DriveFieldName>.

5.08.12

Updated gam report users to create a column accounts:disabled_time from the timestamp in the column accounts:disabled_reason. This makes it possible to filter on the time. For example, to see all users suspended more than a year ago:

gam config csv_output_row_filter "accounts.is_suspended:boolean:true,accounts.disabled_time:date<-1y" report user user all parameters accounts:is_suspended,accounts:disabled_reason

5.08.11

Handle ERROR: 403: requiredAccessLevel - You need to have owner access to this calendar. in gam <UserTypeEntity> modify|remove calendars.

5.08.10

Fixed bug in gam calendars <CalendarEntity> <Command> event commands where service account access was not used when <CalendarEntity> specified a user's primary calendar.

  • <Command>=add - The event creator would be the administrator rather than the user
  • <Command>=update - Some fields in the event were not updated, e.g., reminder

5.08.09

Added option rangelist <SpreadsheetRangeList> to gam clear|info|print|show sheetrange`. This allows specifying multiple ranges with a single argument.

5.08.08

Added option valuerangesonly to gam <UserTypeEntity> print|show sheetrange which, in conjunction with formatjson limits the display to just the valueRanges data. This will make it simpler to capture the sheetrange data, modify it, and update the sheet with the modified data.

Added oauthuser to <UserTypeEntity>; it represents the admin email address from oauth2.txt.

This will typically be used when multiple customers/domains are defined in gam.cfg. For example, to get information about the admin.

$ gam oauth info
Client OAuth2 File: /GamConfig/oauth2.txt
...
G Suite Admin: admin@domain.com
Expires: 2020-07-29T14:26:50-07:00

$gam oauthuser info user
User: admin@domain.com
  Settings
...

5.08.07

Fixed bug in gam print group-members recursive noduplicates where a groups members would not be displayed if it was processed as a subgroup of another group before it was processed as a top level group.

Handle ERROR: 400: badRequest - Bad Request in gam <UserTypeEntity> transfer drive <UserItem>.

5.08.06

Improved error handling in gam create|update course ... copyfrom <CourseID> when trying to copy links to inaccessible materials files.

Updated definition of <RowValueFilter> in config csv_output_row_filter to avoid a parsing error. The two elements in a range must now be separated by a forward slash /, not by a space as this caused the error.

<RowValueFilter> ::=
        count<Operator><Number>|
        countrange=<Number>/<Number>|
        countrange!=<Number>/<Number>|
        date<Operator><Date>|
        daterange=<Date>/<Date>|
        daterange!=<Date>/<Date>|
        time<Operator><Time>|
        timerange=<Time>/<Time>|
        timerange!=<Time>/<Time>|
        boolean:<Boolean>|
        regex:<RegularExpression>|
        notregex:<RegularExpression>

5.08.05

Fixed bug in config csv_output_row_filter "<FieldName>:date<Operator><Date>" that caused a trap.

5.08.04

Updated code in gam <UserTypeEntity> collect orphans to avoid Temporary error: internalError - Internal Error.

5.08.03

Added option countsrowfilter to gam <UserTypeEntity> print filelist ... countsonly that causes GAM to apply config csv_output_row_filter to the file counts rather than the file details.

Display file counts for users with files of size greater that 100MB, csv_output_row_filter is applied to the file details.

gam config csv_output_row_filter "size:count>100000000" all users print filelist countsonly fields size

Display file counts for users with more than 100 video/mp4 files, csv_output_row_filter is applied to the file counts.

gam config csv_output_row_filter "video/mp4:count>100" csv_output_header_filter "Owner,video/mp4" all users print filelist countsonly countsrowfilter

Fixed bug in processing csv_output_row_filter "field:regex:^$" where a row without the field column would not match. It should match as the filter is trying to match an empty field.

Upgraded to Python 3.8.5.

5.08.02

Handle ERROR: 409: conflict - Conflicting requests. Please try again when adding members to groups.

5.08.01

Simplified gam csv recoding.

5.08.00

Recoded gam csv processing to avoid hangs, particularly on Windows.

Fixed code in gam info drivefileacl ... showtitles and gam print|show drivefileacls ... showtitles to scucessfully get the Team Drive name.

5.07.01

Added option showpermissionslast to gam <UserTypeEntity> print filelist which causes GAM to display all permissions fields as the right-most columns in the CSV file. This option does not apply when formatjson is specified.

5.07.00

In versions of GAM before 5.07.00, when you did gam <UserTypeEntity> update users password random and <UserTypeEntity> specified multiple users, all of them were assigned the same random password; this is the same behavior as in Standard GAM. Additionally, there was a bug where the same notification information was sent for all users when notify <EmailAddress> was specified; this is fixed.

If you would like each of the users in <UserTypeEntity> to be assigned a unique random password, specify password uniquerandom.

Added option no_action_if_alias to gam <UserTypeEntity> update|delete|suspend|unsuspend users; the specified action will not be performed if <UserTypeEntity> specifies an alias rather than a primary email address.

5.06.12

Fixed bug in gam sendemail where PDF attachements weren't properly encoded.

5.06.11

Added option eventrowfilter to gam report <ActivityApplictionName> ... countsonly that causes GAM to apply config csv_output_row_filter to the event details rather than the event counts. For example, you're interested in files with extension xyz created yesterday.

Details for each file
gam config csv_output_row_filter "doc_title:regex:\.xyz" report drive event create yesterday

Number of files by each user
gam config csv_output_row_filter "doc_title:regex:\.xyz" report drive event create yesterday countsonly eventrowfilter

Number of files summarized across all users
gam config csv_output_row_filter "doc_title:regex:\.xyz" report drive event create yesterday countsonly summary eventrowfilter

5.06.10

Fixed bug that caused trap in gam print course-work ... showtopicnames.

5.06.09

Handle ERROR: 500: internalError - Internal error encountered. in gam <UserTypeEntity> update license.

5.06.08

Fixed bug in gam course <CourseID> sync students that caused a trap.

Handle LookupError: unknown encoding trap in gam print messages.

5.06.07

Added option showtopicnames to gam print course-work which causes GAM to include the column topicName in the output. An additional API call per course is required to get the topicId to topicName map.

Upgraded to Python 3.8.4.

5.06.06

Added option makefirstteacherowner to the following commands:

gam course <CourseID> create|add teachers [makefirstteacherowner] <UserItem>
gam course <CourseID> sync teachers [addonly|removeonly] [makefirstteacherowner] <UserTypeEntity>
gam courses <CourseEntity> create|add teachers [makefirstteacherowner] <UserTypeEntity>
gam courses <CourseEntity> sync teachers [addonly|removeonly] [makefirstteacherowner] <UserTypeEntity>

In each command the only/first user in <UserItem> or <UserTypeEntity> will be updated to be the owner of the Course(s).

5.06.05

Added option timerangeorder ascending|descending to gam print cros|crosactivity. By default, the Google Directory API returns activeTimeRanges for CrOS devices in ascending (oldest to newest) order. Specifying timerangeorder descending causes GAM to re-order activeTimeRanges in descending (newest to oldest) order. This makes it easy to get the N most recent values with activetimeranges listlimit N timerangeorder descending.

Added option ignorenullpassword to gam create|update user to cause GAM to ignore options like password "" or password ~password where the CSV entry password is null. This would typically be used when processing CSV files where only selected user's passwords are being updated.

5.06.04

Handle ERROR: 400: invalidArgument - Request contains an invalid argument. in gam print|show alerts.

5.06.03

Added option lograndompassword <FileName> to gam create|update user. When this option and password random or notfoundpassword random are specified, the user email address and random password are appended to <FileName>. When bulk creating/updating users, this lets you log the random passwords without have to send a notification email.

5.06.02

Fixed bug where csv_output_header_drop_filter and csv_output_header_filter were not properly processed when formatjson was specified in a print command.

Added option addpathstojson to gam <UserTypeEntity> print filelist. When filepath|fullpath, formatjson and addpathstojson are all specified, the path information will be included in the JSON data rather than as additional columns.

Fixed gam <UserTypeEntity> show fileinfo <DriveFileEntity> to properly include path information in the JSON data when filepath and formatjson are specified.

5.06.01

Fixed bug in gam info user <UserItem> nolicenses that caused a trap.

5.06.00

Update google_auth, google_auth_httplib2, google_auth_oauthlib, googleapiclient, httplib2 libraries.

5.05.12

Updated gam info domain to get the first available user/license count data. The Reports API seems to be giving misleading messages that only partial data is available when, in fact, all of the data is available. Thus, GAM is backing up to an earlier date unnecessarily.

5.05.11

Added todrive_timeformat to gam.cfg and tdtimeformat <String> to <ToDriveAttribute>to allow customization of the timestamp format used in file names when files are uploaded with todrive.

5.05.10

Fixed bug in gam <UserTypeEntity> print|show messages that caused a trap.

Fixed bug in gam <UserTypeEntity> check|update serviceaccount.

5.05.09

Added option returnidonly to gam <UserTypeEntity> copy drivefile <DriveFileEntity> and gam <UserTypeEntity> update drivefile <DriveFileEntity> copy that causes GAM to return just the file ID of the copied file as output. This will be useful in scripts that copy a file and then want to perform subsequent GAM commands on the copied file. When copying folders, the option is only useful when copying a folder without recursion. This file ID will only be valid when the return code of the command is 0; program accordingly.

5.05.08

Added option writeurltofile to gam <UserTypeEntity> check|update serviceaccount to have GAM write the authorization URL into the file gamsvcaccturl.txt in the folder with the GAM executable. This is useful for older versions of Command Prompt and PowerShell that can't properly copy/paste multi line strings.

5.05.07

Fixed bug in gam info user where extraneous license information was displayed.

5.05.06

Added topicid to <CourseWorkFieldName>.

5.05.05

Fixed bug in gam <UserTypeEntity> print filelist|filecounts where files without permissions, shortcuts for example, were displayed/counted when a permission match was defined.

Updated code to avoid a trap in gam <UserTypeEntity> update drivefile <DriveFileEntity> ... csvsheet <SheetEntity>; the Google Sheets API was not returning the sheetId in a call where GAM expected it.

Following Jay's lead, added deprovision_upgrade_transfer to <CrOSAction>.

5.05.04

Fixed bug in gam <UserTypeEntity> print filelist where using query:"XXX" would improperly downshift XXX'; using query "XXX"` worked properly.

5.05.03

Added command to list all of the groups to which a user directly belongs. There are three columns:

  • User - The user email address
  • Groups - The number of groups
  • GroupsList - The delimiter <Character> separated list of group email addresses
gam <UserTypeEntity> print groupslist [domain <DomainName>] [todrive <ToDriveAttribute>*]
        [delimiter <Character>] [quotechar <Character>]

For example, to find all students that aren't in any groups:

gam config csv_output_row_filter "Groups:count=0" ou /Students print groupslist

5.05.02

Fixed bug in gam <UserTypeEntity> print filelist that caused a trap when filepath was specified but name was not included in fields.

5.05.01

Allow querytime.* <Time> option in conjunction with selectsubquery <QueryDriveFile> in gam <UserTypeEntity> print filelist. For example, you can identify all Meet recordings within a particular time period, in this case, all recordings older than 30 days.

gam user user@domain.com print filelist select name "Meet Recordings" querytime30d -30d selectsubquery "modifiedTime<'#querytime30d#'" fields id,name

5.05.00

Google Docs and Drive Files can be used to specify notes, messages and signatures.

Added option aliasesincolumns to gam print courses that alters the display of course aliases. When the aliases option is used, all aliases are displayed in the single column Aliases separated by a delimiter. As aliases can contain spaces, this format could make the data hard to interpret. When aliasesincolumns is specified, the Aliases column contains the number of aliases and Aliases.0, Aliases.1, ... contain the individual aliases.

5.04.11

Added option returnurlonly to gam get profilephoto` that causes GAM to return just the URL of the profile photo.

Following Jay's lead, switched to using the Service Usage API when enabling project APIs.

Fixed bug in gam course <CourseID> sync that caused spurious results when <CourseID> was an alias without the leading d:.

5.04.10

Added command to get a user's profile photo.

`gam <UserTypeEntity> get profilephoto [drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>] [noshow]

5.04.09

Following Jay's lead, added options base64-md5 and base64-sha1 to gam create|update user as alternative methods of specifying the password format. This allows pulling md5 and sha-1 passwords stored in OpenLDAP format into G Suite. This command sets the user password to "helloworld".

gam update user user@example.com password "{SHA}at+xg6SiyUovktq1redipHiJpaE=" base64-sha1

Added option notifypassword <String> to gam create|update user that allows providing a plain text password to be sent in a notification when a hashed password is specified on the command line.

5.04.08

Finally, fixed gam config no_browser true oauth create to write correct data to file gamoauthurl.txt so that the authorization URL can be copied from the file rather than from the screen.

5.04.07

Once again, fixed gam config no_browser true oauth create to write correct data to file gamoauthurl.txt so that the authorization URL can be copied from the file rather than from the screen.

5.04.06

Fixed gam config no_browser true oauth create to write correct data to file gamoauthurl.txt so that the authorization URL can be copied from the file rather than from the screen.

5.04.05

Fixed gam config no_browser true oauth create to write file gamoauthurl.txt so that the authorization URL can be copied from the file rather than from the screen.

5.04.04

Added command to check the validity of drive file shortcuts.

gam <UserTypeEntity> check drivefileshortcut <DriveFileEntity>
        [csv [todrive <ToDriveAttribute>*]]

5.04.03

Added additional error handling when managing licenses.

5.04.02

Added option copymaterialsfiles [<Boolean>] to gam create|update course copyfrom. When used in conjunction with announcementstates and workstates, any files referenced by materials in announcements or class work in the copyfrom course will be copied to the course being created/updated; by default, links to those files will be copied. You must verify that the teacher of the course being created/updated has access to the files in the copyfrom course. Files can only be copied to a course that is ACTIVE; GAM will adjust the course state as necessary.

5.04.01

Starting from code by Eduardo Mazolini submitted to Jay, added group_inde <GroupItem> and groups_inde <GroupList> to <UserTypeEntity>. These represent all users, regardless of suspension status, from the specified groups and their subgroups. They are equivalent to:

group_users <GroupItem> members managers owners includederivedmembership end
group_users <GroupItemList> members managers owners includederivedmembership end

5.04.00

Expanded options for selecting collections of files with gam <UserTypeEntity> print filelist.

Updated gam <UserTypeEntity> print filelist filepath|fullpath to include additional path information. Each path will start with:

  • My Drive - Files on My Drive that are not orphans
  • Orphans - Files on My Drive that are orphans
  • SharedWithMe - Files shared with the user that have no parent on My Drive
  • SharedDrive - Files on Shared Drives

Added options enforcesingleparent <Boolean> and movetonewownersroot <Boolean> to the relevant create|update drivefile and create drivefileacl commands to allow testing of an upcoming Google Drive change.

5.03.41

Added option convertparents to gam <UserTypeEntity> create|add drivefileshortcut <DriveFileEntity>; this option causes GAM to convert all but the last parent reference in <DriveFileEntity> to shortcuts. Previuosly, if you didn't specify the shortcutname <String> option, the shortcut was named Shortcut to <DriveFileName> where <DriveFileName> is the name of each file referenced in <DriveFileEntity>. Now, to be consistent with Google Drive, the shortcut will be named <DriveFileName>. <String> can contain the string #filename# which will be replaced with <DriveFileName>; this allows you to get the previous behavior with shortcutname "Shortcut to #filename#".

5.03.40

Fixed gam download vaultexport|export to properly handle the targetname <FileName> option. Previously, all of the top level files downloaded were given the same <FileName> and overwrote each other. Now, the extensions of the top level files will be appended to <FileName> so that distinct files are downloaded and written. Additionally, <FileName> can contain the strings #objectname#, #filename# and #extension# which will be replaced by the values from the orignal object names to construct a complete top level name.

5.03.39

Added option includederivedmembership to group_users|group_users_ns|group_users_susp <GroupList> as an alternative to the recursive option.

  • recursive - Expand subgroups but do not expand a member of type CUSTOMER (all users in a domain)
  • includederivedmembership - Expand subgroups and expand a member of type CUSTOMER (all users in a domain)

5.03.38

Improved performance of group_users|group_users_ns|group_users_susp <GroupList> when recursive is specified.

5.03.37

Updated gam <UserTypeEntity> get drivefile to properly set the end-of-line character on Windows when the gsheet|csvsheet <SheetEntity> option was used to download a Google Sheet.

5.03.36

Added option groupsincolumns to gam print users as an alternative to the groups option.

With groups', there will be two columns displayed: GroupsCountandGroups`.

  • GroupsCount - The number of groups to which the user belongs
  • Groups - A list of group email addresses

With groupsincolumns', there will be multiple columns displayed: GroupsandGroups.`.

  • Groups - The number of groups to which the user belongs
  • Groups.<Number> - A single group enail address

5.03.35

Fixed bug in gam print|show projects that caused a trap.

5.03.34

Updated code to properly handle gam.cfg section selection in conjunction with csv processung. This command structure now operates as expected; gam.cfg <SectionName> is used for all processing.

gam select <SectionName> ... csv <FileName> ... gam ...

Previously, you had to do either of the following to get gam.cfg <SectionName> to be used for all processing.

gam select <SectionName> save ... csv <FileName> ... gam ...
gam csv <FileName> ... gam select <SectionName> ...

5.03.33

Fixed bug in gam print projects that caused a trap when showiampolicies was used.

5.03.32

Fixed code in gam <UserTypeEntity> create drivefile to allow the parentid option to specify a Shared Drive.

Added option states all|active|deleterequested to gam print|show projects that allows selection of projects to display.

Added option showiampolicies 0|1|3 to gam print|show projects that adds project policy information to the display. This requires an additional API call per service account.

5.03.31

Added option showsakeys all|system|user to gam print|show svcaccts that adds service account key information to the display. This requires an additional API call per service account.

5.03.30

Updated code in gam report usageparameters to avoid a trap due to a Google API change.

5.03.29

Following Jay's lead, cleaned up code for gam report; in particular, backing up to earlier dates to find data.

5.03.28

Updated code in gam info domain to perform retries when getting license information to avoid this warning: WARNING: No User counts data available.

5.03.27

Added option formatjson to gam <UserTypeEntity> show fileinfo.

5.03.26

Updated code to properly handle specifying an expiration time when creating a drive file ACL. GAM must first create the ACL and then update it with the expiration time.

5.03.25

Fixed bug that caused a trap in gam <UserTypeEntity> show calendars showdeleted.

5.03.24

Fixed bug that caused a trap in gam <UserTypeEntity> create|update drivefile when localfile <FileName> was used and <FileName> started with ~.

5.03.23

Added options createdtime <Time> and modifiedtime <Time> to gam <UserTypeEntity> create drivefile to allow setting these values.

Added option preservefiletimes to gam <UserTypeEntity> create|update drivefile that, when used with localfile <FileName>, will set the createdtime and modifiedtime values from the local file.

On some Linux systems getting the createdtime is problematic.

5.03.22

Added option includederivedmembership to gam print groups that is effective when any of the options roles, 'members', 'managers' or owners is used. The includederivedmembership option causes the API to expand type GROUP and type CUSTOMER members to display their constituent members while still displaying the original member.

Added option totalcount to gam print groups that is effective when any of the options countsonly, 'memberscount', 'managerscount' or ownerscount is used. A column 'TotalCount' that is the total number of members in a group will be included.

The following command combines these two options to give you a listing of all of your groups with their membership counts. The counts will be higher than expected as the API returns both a group and its members.

gam print groups roles member,manager,owner countsonly totalcount includederivedmembership

5.03.21

Added code to wait for Service Account creation to complete in gam create project to avoid this error:

ERROR: 404: Requested entity was not found. - 404

5.03.20

Fixed bug that improperly set return code to 60 in gam <UserTypeEntity> create|add drivefile.

5.03.19

Added suboption summary none|only|plus to option countsonly in gam <UserTypeEntity> print filelist that specifies display of a summarization of file counts across all users specified in the command.

  • none - No summary is displayed; this is the default
  • only - Only the summary is displayed, no individual user file counts are displayed
  • plus - The summary is displayed in addition to the individual user file counts These are the same options as in gam <UserTypeEntity" print filecounts but print filelist offers mush more powerful file selection capabilities.

Following Jay's lead, enhanced gam oauth create to allow specification of the desired scopes on the command line. Entering <APIScopeURLList> by hand would be tedious at best but could be used in a script.

gam oauth|oauth2 create|request [admin <EmailAddress>] [scopes <APIScopeURLList>]

5.03.18

Fixed bug in gam print ownership where data was not being returned in CSV file.

5.03.17

Fixed bug in gam <UserTypeEntity> print drivesettings that caused a trap.

5.03.16

Handle ERROR: Authentication Token Error - invalid_grant: The account has been deleted

This message relates to users recently deleted; they are still defined.

This occurs when a user is specified as uid:<String> and <String> does not represent a valid user. This can occur when doing gam print course-work|course-submissions where the owner of a course has been deleted as GAM only gets the course owner in the form uid:<String> from the Classroom API.

5.03.15

Added compact option to gam <UserTypeEntity> print sendas|signature|vacation that causes GAM to strip embedded carriage returns and newlines from the uploaded signature/vacation message. This makes these values easier to process in the CSV file.

5.03.14

Handle ERROR: Authentication Token Error - invalid_request: Invalid impersonation &quot;sub&quot; field

This message relates to users that are no longer defined.

This occurs when a user is specified as uid:<String> and <String> does not represent a valid user. This can occur when doing gam print course-work|course-submissions where the owner of a course has been deleted as GAM only gets the course owner in the form uid:<String> from the Classroom API.

5.03.13

Improved error reporting when accessing group settings.

Fixed bug in gam <UserTypeEntity> print spreadsheets that caused a trap when multiple sheets were specified.

5.03.12

Added additional error handling when accessing courses.

5.03.11

Upgraded to googleapiclient 1.8.2.

5.03.10

Added option showdepth to gam <UserTypeEntity> print filelist. When used with filepath or fullpath, GAM will display a depth column. Files/folders directly in My Drive are at depth 0, the depth increases by 1 for each containing folder. For files with multiple parents, the maximum depth is displayed.

5.03.09

Upgraded to OpenSSL 1.1.1g. Upgraded to google-auth 1.14.1.

Added attributes to allow specifying calandar and event colors by name.

<CalendarColorName> ::=
        amethyst|avocado|banana|basil|birch|blueberry|
        cherryblossom|citron|cobalt|cocoa|eucalyptus|flamingo|
        grape|graphite|lavender|mango|peacock|pistachio|
        pumpkin|radicchio|sage|tangerine|tomato|wisteria|
<CalendarAttribute> ::=
        ...
        (color <CalendarColorName>)|
        ...
<EventColorName> ::=
        banana|basil|blueberry|flamingo|graphite|grape|
        lavender|peacock|sage|tangerine|tomato
<EventAttribute> ::=
        ...
        (color <EventColorName>)|
        ...

5.03.08

Enhanced error handling in gam <UserTypeEntity> update|delete smime when invalid data is entered.

Enhanced gam print|show smimes to allow more selection options as to which S/MIME configurations to display.

gam <UserTypeEntity> show smimes
        [primary|default|(sendas|sendasemail <EmailAddress>)]
gam <UserTypeEntity> print smimes [todrive <ToDriveAttribute>*]
        [primary|default|(sendas|sendasemail <EmailAddress>)]

5.03.07

Updated gam update verify to avoid getting: ERROR: A failure in the SSL library occurred (_ssl.c:1108)

5.03.06

Fixed bug in gam <UserTypeEntity> update calattendees where replacestatus and updatestatus were not properly updating the attendee status.

Added returnidonly to gam [<UserTypeEntity>] create teamdrive that causes GAM to return just the ID of the created Team Drive as output. This will be useful in scripts that create a Team Drive and then want to perform subsequent GAM command on the Team Drive. This ID will only be valid when the return code of the command is 0; program accordingly.

Linux/macOS
teamDriveId=`gam user user@domain.com create teamdrive ... returnidonly`
Windows PowerShell
$teamDriveId = & gam user user@domain.com create teamdrive ... returnidonly`

Handled Google delays in gam [<UserTypeEntity>] create teamdrive when trying to set Team Drive restrictions or hiding the Team Drive after it has been created.

5.03.05

Fixed bug where gam <UserTypeEntity> print filelist ... countsonly todrive did not upload the CSV file to Google Drive.

5.03.04

Allow relative dates in skipdates in gam report usage; e.g., skipdates -10d:-5d.

5.03.03

Improved error handling when parsing skipdates in gam report usage; made report title dates match actual dates used.

Updated error handling in gam update verify|verification <DomainName> cname|txt|text|site|file.

5.03.02

Handle ERROR: 429: 429 - Quota exceeded for quota group 'ReadGroup' and limit 'Read requests per user per 100 seconds' of service 'sheets.googleapis.com' for consumer 'project_number:#####'.

5.03.01

Fixed bug in gam report usage where skipdates were not processed and then enhanced skipdates to allow date ranges <Date>:<Date>.

5.03.00

Fixed bug in gam report usage user that caused a trap.

Added option showparentsidsaslist to gam <UserTypeEntity> show fileinfo and gam print filelist that causes GAM to display the parents of a drive file/folder as a list of IDs rather that discrete entities. In gam show fileinfo you will see:

parentsIds: ABCDE-EvX8uQ6H5tqZ73b2oAT4IIcK-JZ 012jnewfiM5G8S0lpNU05R0NCNHc

In gam print filelist you will see:

...,parents,parentsIds,...
...,2,ABCDE-EvX8uQ6H5tqZ73b2oAT4IIcK-JZ 012jnewfiM5G8S0lpNU05R0NCNHc,...

A significant Drive File change is coming later this year regarding files with multiple parents.

A new command has been added to create Drive File shortcuts.

gam <UserTypeEntity> create|add drivefileshortcut <DriveFileEntity> [shortcutname <String>]
        [<DriveFileParentAttribute>]
        [csv [todrive <ToDriveAttributes>*]] [returnidonly]

In <MimeTypeShortcut> gshortcut now refers to the new shortcuts and g3pshortcut to the previous third-party shortcuts.

Added items to <DriveFileQueryShortcut> that can be used in gam print filelist|filecounts|filetree:

all_shortcuts | all_3p_shortcuts |
my_shortcuts | my_3p_shortcuts |
others_shortcuts | others_3p_shortcuts

5.02.04

Fixed race condition on Windows involving locking oauth2.txt.lock. ERROR: [WinError 2] The system cannot find the file specified: 'C:\GAMConfig\oauth2.txt.lock'

5.02.03

Fixed bug where query:<QueryDriveFile> was not recognized on the command line.

Fixed bug where csv_output_header_drop_filter caused a trap when a CSV file was processed.

Added command to get Google Spreadsheet data in CSV format.

gam <UserTypeEntity> print sheet <DriveFileEntity> [todrive <ToDriveAttribute>*]
        [fields <SpreadsheetFieldList>] (range <SpreadsheetRange>)* [includegriddata [<Boolean>]]
        [formatjson] [quotechar <Character>]

5.02.02

Added returnidonly to gam <UserTypeEntity> create drivefile that causes GAM to return just the file ID of the created file as output. This will be useful in scripts that create a file and then want to perform subsequent GAM command on the file. This file ID will only be valid when the return code of the command is 0; program accordingly.

Linux/macOS
fileId=`gam user user@domain.com create drivefile ... returnidonly`
Windows PowerShell
$fileId = & gam user user@domain.com create drivefile ... returnidonly`

5.02.01

Added csv_output_header_drop_filter to gam.cfg to allow CSV header filtering by exclusion.

Thanks to @bousquf for the following enhancement. You want to send a message from an authorized group but a group email address can't be used in the Gmail API as the sender.

Added the option mailbox <EmailAddress> to gam sendemail to allow specifying the sender email address used in the Gmail API as different from from <EmailAddress>.

For example:

gam sendemail destination@email.com from "IT Group <group@domain.com>" mailbox user@domain.com subject "test subject" message "text body" ...

5.02.00

THERE IS A DEFAULT BEHAVIOR CHANGE WHEN UPDATING ATTENDEES IN EVENTS - READ CAREFULLY.

The default behavior of gam calendar <CalendarEntity> update events and gam <UserTypeEntity> update events <UserCalendarEntity> has been changed regarding attendees. In versions of GAM before 5.02.00, updating attendees in calendar events was complicated because you had to supply the complete attendee list even if you just wanted incremental changes. The default behavior now is to allow incremental changes to the attendees list; the current attendee list is downloaded and the specified changes are applied.

The replacemode option invokes the previous behavior from versions before 5.02.00; the current attendee list is replaced.

The following options have been added to allow removal of attendees:

  • clearattendees - Clear all current attendees from the attendee list
  • removeattendee <EmailAddress> - Remove a single attendee from the attendee list
  • selectremoveattendees <UserTypeEntity> - Remove a selected collection of attendees from the attendee list

Added option replacedescription <RegularExpression> <String> to the same update events commands. This allows you to make changes to the event description rather than re-entering it. The option can be repeated to make several changes.

Updated option query <QueryDriveFile> in gam print filelist|filecounts|filetree to avoid a potential problem. In these commands, the default query is 'me' in owners; when you specify query "query-clause", they are combined with and resulting in 'me' in owners and query-clause. OK so far. If, however, you specify query "query-clause or query-clause", the end result is 'me' in owners and query-clause or query-clause which almost certainly is not what you want. Now, parentheses are used and the result is 'me' in owners and (query-clause or query-clause). For full control over the query, use the fullquery <QueryDriveFile> option.

Added an additional service account scope Classroom API - Profile Emails so that student profile email addresses are displayed in gam print course-submissions showuserprofile. After upgrading issue the following command to enable this scope.

gam <UserTypeEntity> update serviceaccount

Starting from initial code from Jay, added commands to get customer and user usage reports over a date range.

5.01.09

Fixed bug that caused a trap in tag replace processing when setting a signature.

5.01.08

Added options tdbackupsheet (id:<Number>)|<String> and tdcopysheet (id:<Number>)|<String> to <ToDriveAttribute>. When you're using tdfileid <DriveFileID> tdsheet (id:<Number>)|<String> tdupdatesheet with todrive to update a sheet in a spreadsheet:

  • tdbackupsheet (id:<Number>)|<String> causes the current sheet data to be copied and pasted to another existing sheet before the sheet is updated
  • tdcopysheet (id:<Number>)|<String> causes the updated sheet data to be copied and pasted to another existing sheet after the sheet is updated Suppose you have a spreadsheet with sheets Monday ... Friday, Backup Monday ... Backup Friday and Latest. Each day you run a report to update the current day sheet (Tuesday), you want to backup the data first (Backup Tuesday) and you want the updated data copied to Latest so you don't have to remember what the day of the week is.
gam redirect csv - todrive tdfileid <DriveFileID> tdupdatesheet tdsheet Tuesday tdbackupsheet "Backup Tuesday" tdcopysheet "Latest" ...

5.01.07

Handle ERROR: 404: notFound - Requested entity was not found. in gam show peopleprofile.

5.01.06

Fixed bug in gam print course-submissions showuserprofile that caused a trap.

5.01.05

Code cleanup for calendar event processing.

Code cleanup for course alias processing.

Added option logdrivefileids [<Boolean>>] to gam create|update course copyfrom. This is a special purpose option added for research purposes.

5.01.04

Improved error handling when listing groups with an invalid userKey parameter; this is a rare event.

5.01.03

Added commands to add and remove topics to courses.

gam course <CourseID> create|add topic <CourseTopic>
gam course <CourseID> remove topic <CourseTopicID>
gam courses <CourseEntity> create|add topic <CourseTopicEntity>
gam courses <CourseEntity> remove topic <CourseTopicIDEntity>

Added option mapsharemodestudentcopy edit|view to gam create|update course copyfrom. Drive files with shareMode Each student will get a copy don't seem to be able to be copied; this option maps that shareMode to Students can edit file or Students can view file. When this option is not used, no shareMode mapping is performed.

Added additional error handling to gam create|update course copyfrom.

Code cleanup.

5.01.02

Fixed bug in gam create|update user where linefeed \n was not properly processed in message <String>.

5.01.01

Added option consolidationstrategy legacy|none to gam <UserTypeEntity> print|show driveactivity; the default is none. This option is only effective when option v2 is specified.

Added option idmapfile <FileName>|(gsheet <UserGoogleSheet>) [charset <String>] [columndelimiter <Character>] [quotechar <Character>] to gam <UserTypeEntity> print|show driveactivity.

Added option matchfield hangoutlink <RegularExpression> to <EventMatchProperty> so you can search for events with a specific Hangout Link.

Added additional error handling to gam create|update course copyfrom.

5.01.00

Upgraded to Python 3.8.2 and OpenSSL 1.1.1e.

Added synonyms endtime, starttime, originalstarttime for end, start, originalstart in <EventAttribute> and <EventFieldName>.

Added option groupingstrategy driveui|none to gam <UserTypeEntity> print|show driveactivity; the default is none. This option is only effective when option v2 is not specified.

Added options allevents|combinedevents|singleevents to gam <UserTypeEntity> print|show driveactivity to allow selection of the type of events to display. The default is combinedevents, the only events displayed in previous versions. This option is only effective when option v2 is not specified.

5.00.11

Changed code to shorten the public key lifetime in gam create|use project to stay within a Google limit. The old lifetime value caused this error:

ERROR: 400: 400 - The given public key has a lifetime of 315,446,400 seconds, which is longer than the max allowed lifetime of 315,360,000 seconds as specified in resource settings.

5.00.10

Google changed the Application type option when creating a project; previously you chose Other, now you choose Desktop App.

Fixed bug in gam transfer drive where action messages were incorrect.

5.00.09

Fixed issue where excessive API cache files were being generated. Issue the following command to set the optimal API caching scheme.

gam select default config cache_discovery_only true no_cache false save verify

You should clear the gamcache folder (indicated by cache_dir above) after updating to this version. Delete all files in this folder; do not delete the folder itself, just its contents.

5.00.08

Added option tdcellwrap clip|overflow|wrap to todrive options to allow specification of the cell wrapping strategy in Google spreadsheets.

Added option selectattendees [<AttendeeAttendance>] [<AttendeeStatus>] <UserTypeEntity> to <EventAttribute>. This simplifies adding multiple attendees to an event.

5.00.07

Fixed bug in gam report accesstransparency|gcp where event names were not properly passed to the API.

Fixed bug in gam batch|tbatch|csv showcmds where the timestamp was constant. The timestamp now shows milliseconds.

5.00.06

Fixed bug in `gam update groups update preview`` that caused a trap.

5.00.05

gam <UserTypeEntity> print users uses Google Directory API batches to improve performance when retrieving user data. In some cases Google returns the following error:

googleapiclient.errors.HttpError: <HttpError 302 when requesting https://www.googleapis.com/batch/admin/directory_v1 returned "Found">```

At the moment it's not clear to me how to handle this error so I'm providing a workaround; if you experience this error do the following:

gam config batch_size 1 save

5.00.04

Fixed bug in gam transfer drive that caused a trap.

5.00.03

Added commands to display Google people/person profile information. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Users-People-Profile

Upgraded googleapiclient library to 1.7.12.

Fixed bug in gam print groupmembers where the peoplelookup option would cause an error.

5.00.02

Updated httplib2 library to 0.17.0 and updated code to work around issue in library where uploading files > 100MB failed.

5.00.01

Updated code to account for Google API change that prevented clearing a user's recovery phone.

5.00.00

Replaced the deprecated oauth2client library with the google-auth library. This change requires a one-time update of the client access file oauth2.txt; GAM will continue to use the old version of oauth2.txt until you perform the update. There is a small performance impact until the update is performed. However, you can't use the updated version of oauth2.txt in prior versions of GAM; if you want to run GAM 5.00.00 and prior versions of GAM, do not perform the update until you no longer need to run the prior versions of GAM.

If you are running any GAM version 4.85.00 or later, perform the following command to perform the update.

gam oauth refresh

If you are running any GAM version before 4.85.00, perform the following command to perform the update.

gam oauth update

The following command has been deleted as it is no longer required:

gam oauth|oauth2 import <FileName>

Fixed bug in gam <UserTypeEntity> print users where the issuspended option was ignored.

Added option limittoou <OrgUnitItem> to gam print users to limit the display to those users directly in the OU <OrgUnitItem>.

4.99.28

Fixed bug in gam print filecounts that caused a trap:

UnboundLocalError: local variable 'teamDriveId' referenced before assignment

4.99.27

In gam print cros you can specify the property to use for sorting results.

orderby <CrOSOrderByFieldName> [ascending|descending]

Currently, there is a Google API bug that gives erroneous results when you specify ascending. Unfortunately, if you don't specify ascending|descending, GAM uses ascending. GAM now uses descending as the default to avoid the bug.

4.99.26

Fixed a bug where a comment line in a GAM batch file that contained an unmatched quote caused an error.

4.99.25

When you perform gam print users with the following todrive options to update a sheet within a Google Sheets file: tdfileid <DriveFileID> tdsheet <SheetEntity> tdupdatesheet and your data includes international phone numbers that start with a plus sign, Google Sheets generates a Formula parse error for those phone numbers. Use option quoteplusphonenumbers to have GAM add a single quote at the front of phone numbers that begin with a plus sign to cause Google Sheets to interpret the numbers as plain text. The single quote remains with the phone number. This option is not required when you're not updating a sheet as the error does not occur.

4.99.24

Added hangoutsmeet to <EventAttribute> so gam calendar add event and gam calendar update events can add Hangouts/Meet links to events with having to use the json option.

4.99.23

Added clearhangoutsmeet to <EventUpdateAttribute> so gam calendar update events can remove Hangouts/Meet links from events.

4.99.22

Allow calendar events with Hangouts/Meet links to be created.

4.99.21

Improved performance of gam print filelist when query and `showmimetype`` options are used.

Added explicitlytrashed and trashed to <FileTreeFieldName> so that files/folders in the trash can be identified in gam print/show filetree.

4.99.20

Fixed error handling for invalid drive queries.

4.99.19

When processing replace <Tag> <UserReplacement> in HTML, avoid areas that shouldn't have GAM tags, <head>.*</head>' and <script>.*</script>`.

4.99.18

Handle error in gam print licenses due to invalid product ID.

4.99.17

Fixed coding errors in gam tbatch.

4.99.16

Added showcmds option to gam csv to allow monitoring of execution processing.

4.99.15

Instruct user to perform gam update project when permission is denied to access service account keys.

4.99.14

Improve error handling in gam check serviceaccount when checking the age of the private key in oauth2service.json.

4.99.13

Following Jay's lead, updated gam check serviceaccount to check the age of the private key in oauth2service.json. GAM will warn you if the key is more than 30 days old. Google recommends rotating the key on a regular basis which can be done with gam update|rotate sakey.

Fixed bug in gam print/show messages where showlabels useronly option was not suppressing system labels.

4.99.12

Handle permissionDenied error when processing delegates.

4.99.11

Updated gam print/show messages to display message labels and counts.

4.99.10

Updated gam create/update sheet and gam append/update sheetrange to be able to read JSON data from a file as well as the command line.

4.99.09

Following Jay's lead, simplified gam create project and gam <UserTypeEntity> check serviceaccount. When creating a project, the initial screen where you entered the Application name and clicked Save has been eliminated. The Application name defaults to GAM but you can change it with the appname <Sring> option.

When check serviceaccount requires you to authorize scopes, the URL that you enter now fills in the Client Name and One or More API Scopes fields, you just click Authorize; you don't have to cut and paste these values.

Updated gam.cfg csv_output_row_filter to allow range checking on counts, dates, and times.

For example, to list files a user created in the last six months of 2019:

gam config csv_output_row_filter "'createdTime:daterange=2019-07-01 2019-12-31'" user user@domain.com print filelist fields id,name,createdtime

4.99.08

Added actioncsv option to gam update groups. This will produce a CSV file with columns group,email,role,action,message that shows the actions performed when updating the group.

4.99.07

Added error checking to handle badly-formatted oauth2.txt files.

4.99.06

Added additional options, 'chat' and gcp, and jamboard to <ActivityApplicationName> for gam report command.

4.99.05

Code cleanup.

4.99.04

Fixed bug in gam audit uploadkey that caused a trap.

4.99.03

Following Jay's lead, update default password encryption in gam create/update user.

4.99.02

Updated code to handle Directory API issue that prevents looking up the orgUnitId of OU /. This affected gam report if you used the orgunit / option. This affected gam create admin <UserItem> <RoleItem> org_unit /.

4.99.01

Updated gam.cfg csv_output_row_filter processing so that field names can contain colons.

4.99.00

Reworked code to use Python 'f' strings for most formatting; this feature was added in Python 3.6. If you are using the source version of GAM and have Python 3.5 or lower, you cannot use this version. There is no impact if you are using the executable version of GAM as it includes Python 3.8.1.

Added options to gam show messages|threads to allow downloading attachments.

[saveattachments [attachmentnamepattern <RegularExpression>]] [targetfolder <FilePath>] [overwrite [<Boolean>]]

4.98.17

Fixed bug in gam print/show matters that caused a trap.

4.98.16

Added fields <VaultMatterFieldNameList> option to gam info vaultmatter and gam print/show vaultmatters.

4.98.15

Fixed bug that caused a trap in gam print/show teamdriveacls when checkgroups was used without user <EmailAddress>.

4.98.14

Code cleanup.

4.98.13

Verify that tls_min_version and tls_max_version in gam .cfg have allowble values.

''|tlsv1|tlsv1_0|tlsv1.0|tlsv1_1|tlsv1.1|tlsv1_2|tlsv1.2|tlsv1_3|tlsv1.3

4.98.12

Updated httplib2 library from 0.13.0 to 0.16.0.

4.98.11

Updated googleapiclient library from 1.7.8 to 1.7.11.

4.98.10

Added additional error checking when reading JSON data from Google APIs as Google seems to be returning poorly formatted errors. For example, "ERROR: Expecting value: line 1 column 1 (char 0)".

4.98.09

Eliminated extraneous columns generated by gam print filelist when there were no data rows.

4.98.08

Eliminated admincreated as a settable option in gam update group; it is read-only.

4.98.07

Fixed bug that caused a trap in gam <UserTypeEntity> sendemail.

Improved error reporting when GAM uses SMTP to send email.

4.98.06

Added output confirming that email was sent when using SMTP to send email.

4.98.05

Fixed bug that caused a trap in gam update group csvkmd ....

4.98.04

Added ability to have GAM send email via SMTP.

4.98.03

Fixed bug that caused a trap when specifying fields <FieldsList>.

4.98.02

Added adminaccess|asadmin option to gam <UserTypeEntity> create teamdrive so that when a Team Drive is created with restrictions, admin access can be set if desired. Admin access must be used to set restrictions.adminmanagedrestrictions and the user specified in <UserTypeEntity> must be a domain administrator.

4.98.01

Added new forms of commands to check Service Account scopes that are equivalent to the old forms; the old forms are still defined.

New
gam check svcacct <UserTypeEntity> (scope|scopes <APIScopeURLList>)*
gam update svcacct <UserTypeEntity>

Old
gam <UserTypeEntity> check serviceaccount (scope|scopes <APIScopeURLList>)*
gam <UserTypeEntity> update serviceaccount

4.98.00

Added options saname <ServiceAccountName>, sadisplayname <ServiceAccountDisplayName> and sadescription <ServiceAccountDescription> to gam create/use project to allow specification of Service Account characteristics.

gam create project [admin <EmailAddress>] [project <ProjectID>]
        [projectname <ProjectName>] [parent <String>]
        [saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
        [sadescription <ServiceAccountDescription>]
gam use project [admin <EmailAddress>] [project <ProjectID>]
        [saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
        [sadescription <ServiceAccountDescription>]

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Authorization#manage-projects

Added commands to manage Service Accounts.

gam create|add svcacct [<EmailAddress>] [current|gam|<ProjectID>|(filter <String>)]
        [saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
        [sadescription <ServiceAccountDescription>]
gam delete svcacct [<EmailAddress>] [current|gam|<ProjectID>|(filter <String>)]
        (saemail <ServiceAccountEmail>)|(saname <ServiceAccountName>)|(sauniqueid <ServiceAccountUniqueID>)
gam show svcaccts [<EmailAddress>] [all|current|gam|<ProjectID>|(filter <String>)]
gam print svcaccts [<EmailAddress>] [all|current|gam|<ProjectID>|(filter <String>)]
        [todrive <ToDriveAttributes>*] [formatjson] [quotechar <Character>]

Note: this form of the command to add a Service Account has been replaced by the form show above:

gam addsvcacct project [<EmailAddress>] [current|gam|<ProjectID>|(filter <String>)]

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Authorization#manage-service-accounts

Starting from Jay's initial concept, added commands to manage Service Account keys.

gam create sakey [(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|(localkeysize 1024|2048|4096)]
gam update sakey [(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|(localkeysize 1024|2048|4096)]
gam replace sakeys [(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|(localkeysize 1024|2048|4096)]
gam delete sakeys <ServiceAccountKeyList>+ [doit]
gam show sakeys [all|system|user]

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Authorization#manage-service-accounts-keys

To use these commands you must update your gam project and service account authorization.

gam update project
gam user user@domain.com check serviceaccount

4.97.20

Added options <TeamDriveRestrictionsSubfieldName> <Boolean> and hide <Boolean> to gam create teamdrive so that a Team Drive can be created and have its restrictions and visibility set in a single Gam command.

<TeamDriveRestrictionsSubfieldName> ::=
        restrictions.adminmanagedrestrictions|
        restrictions.copyrequireswriterpermission|
        restrictions.domainusersonly|
        restrictions.teammembersonly
gam <UserTypeEntity> create|add teamdrive <Name>
        [(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
        (<TeamDriveRestrictionsSubfieldName> <Boolean>)*
        [hide <Boolean>]

4.97.19

Fixed bug that caused a trap in gam print group-members group group@example.com recursive.

Updated gam create/delete/update events to not stop when a forbidden error occurs.

4.97.18

Added option excludetrashed to gam print/show filetree to suppress display of files in the trash. This includes file that have been explicitly trashed and files that have been recursively trashed from a prent folder.

4.97.17

Added options json [charset <Charset>] <JSONData> and json file <FileName> [charset <Charset>] to <EventAttribute> that is used by gam create/import/update event. This allows the JSON data written by gam print events formatjson to be used as input to these commands.

4.97.16

Thanks to Jay, the gam create project steps are now simpler.

4.97.15

Fixed gam <UserTypeEntity> print teamdrives to show role as in prior versions.

4.97.14

Update instructions for creating a project as Google has changed the flow slightly.

4.97.13

Added option formatjson to gam print teamdriveacls.

Added field basicpermissions to <DriveFieldName> which is equivalent to:

permissions.allowFileDiscovery,
permissions.deleted,
permissions.domain,
permissions.emailAddress,
permissions.expirationTime,
permissions.id,
permissions.role,
permissions.type

In particular, this omits these fields:

permissions.displayName,
permissions.permissionDetails,
permissions.photoLink,
permissions.teamDrivePermissionDetails

This allows you to select the essential permission fields without enumerating them. Of course, you can specify permissions to get all of the fields, enumerate the specific fields you want or specify basicpermissions and additional permission fields, e.g., permissions.displayName.

4.97.12

Added option formatjson to gam print filelist.

4.97.11

Corrected code where permissions fields were unnecessarily downloaded in gam print filecounts/filelist/filepaths/filetree.

4.97.10

Added option todrive <ToDriveAttribute>* to redirect csv to allow setting of todrive options as part of the redirect. If you are doing redirect csv <FileName> multiprocess, it is more efficient to specify todrive <ToDriveAttribute>* as part of the redirect as verification of the todrive settings, which can invole several API calls, is done once rather than in each of the subprocesses.

Added option tdupdatesheet [<Boolean>] to todrive options. When used with tdfileid and tdsheet, a specific sheet within a Google spreadsheet can be updated with a gam print todrive command.

Added options gsheet|csvsheet <SheetEntity>, charset <CharSet> and delimiter <Character> options to gam update drivefile. This allows updating a specifc sheet within Google spreadsheet.

Added options json [charset <Charset>] <JSONData> and json file <FileName> [charset <Charset>] to <DriveFilePermissionEntity> and <DriveFilePermissionIDEntity> that are used by gam create permissions and gam delete permissions. This allows the JSON data written by gam print drivefileacls formatjson to be used as input to these commands.

Added options <PermissionMatch>* [<PermissionMatchAction>] to gam create permissions and gam delete permissions. This allows you to specify which permissions in the JSON data to process or skip.

Added options <PermissionMatch>* [<PermissionMatchAction>] to gam print/show drivefileacls. This allows you to specify which permissions to display or skip.

4.97.09

Added <RecipientEntity> ::= <EmailAddressEntity> | (select <UserTypeEntity>) which is used in gam sendemail to allow more choices in specifying recipients. For example:

gam sendemail select groups sales@domain.com,marketing@domain.com from salesmgr@domain.com subject "Sales Meeting Agenda" textfile MeetingAgenda.txt

4.97.08

Restored support for Drive Activity API v1 in gam print/show driveactivity.

Setting recoveryphone "" in gam update user will now clear the user's recovery phone number.

4.97.07

Fixed bug in gam print drivefileacls formatjson that caused a trap.

4.97.06

Fixed bug where using todrive gave an inappropriate Service not applicable/Does not exist error.

4.97.05

Added option excludetrashed to gam copy drivefile; this prevents files/folders in the trash from being copied.

4.97.04

In gam copy/move drivefile, do not copy permissions marked deleted.

4.97.03

Added additional Service Account scopes to gam update serviceaccount so that a user can be given access to the Drive and Sheets APIs for use with todrive without gaining access to other user's files/sheets.

'Gmail API - Send Messages - including todrive'

4.97.02

Fixed a bug where an {RT} or {RTL} with no closing {/RT} or {/RTL} would cause a loop. The following sequence should end with {/RTL} not {RTL}

{RTL}{RT}Office: {officephone} {/RT}{RT}Mobile: {mobilephone}{/RT}<br />{RTL}

The unpaired item will be replaced with ERROR(RT) or ERROR(RTL) so the error can be detected.

4.97.01

Fixed a bug where a command of the following form did not use "~" as the column delimiter for outfile.csv.

gam redirect csv outfile.csv multiprocess columndelimiter "~" csv infile.csv gam ... print ...

4.97.00

Support for Drive Activity API v1 in gam print/show driveactivity has been dropped.

Updated csv_output_row_filter "<FieldNameFilter>:boolean:<Boolean>" to properly select fields even if the field is a string rather than a Boolean; in particular, this applies to group settings.

Added command that adds additional service accounts to a project.

gam addsvcacct project [<EmailAddress>] [gam|<ProjectID>|(filter <String>)]
        name <ServiceAccountName> [displayname <String>]

Added command that allows selection of Service Account scopes.

gam <UserTypeEntity> update serviceaccount

These new commands allow you to more easily provide limited access to additional GAM users.

4.96.20

Handle Too Many Requests error when processing contacts.

4.96.19

Removed debugging code that caused gam create resoldcustomer to throw an exception.

4.96.18

Added the ability to select fields with gam info/show/print vaultexport/vaulthold.

Added optional <UserTypeEntity> to all gam printer/printjob commands to allow selection of a printer owner. Previously, all such commands could only access printers owned by the user in oauth2.txt.

To use this option you must update your Service Account authentication:

  • gam user user@domain.com check serviceaccount

4.96.17

Improved/corrected gam <UserTypeEntity> add/sync groups.

Updated gam <UserTypeEntity> print/show groups to include status and delivery settings.

Added command to update a user's group roles and delivery settings..

gam <UserTypeEntity> update groups ([<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)+

4.96.16

Improved/corrected gam <UserTypeEntity> add/sync groups.

4.96.15

Added group <GroupRole> <GroupList> option to gam create/update user to add a user to groups when they are created. For gam update user this only applies if createifnotfound is specified and the user has to be created.

gam create user salesmanager@domain.com firstname Sales lastname Manager ou /Staff password MakeQuota groups owner sales@domain.com groups member managers@domain.com,staff@domain.com

Added command to synchronize a user's group membership.

gam <UserTypeEntity> sync groups ([<GroupRole>] <GroupEntity>)+

4.96.14

Added notfoundpassword random|<Password> option to gam update user which is used in conjunction with the createifnotfound option to create a user during an update.

4.96.13

Added command to print backup verification codes to a CSV file.

gam <UserTypeEntity> print backupcodes|verificationcodes [todrive <ToDriveAttributes>*] [delimiter <Character>]

4.96.12

Handle bogus error ERROR: 403: cannotUpdatePermission - The authenticated user does not have the required access to update the permission. The API generates this error when you update an ACL on a Tean Drive with its current role.

# Create initial ACL: succeeds
$ gam add drivefileacls teamdrive "Test TeamDrive" user testuser@domain.com role reader
User: admin@domain.com, Add 1 Drive File/Folder ACL
  User: admin@domain.com, Drive File/Folder ID: 00002YhXYo2zyUkZZZZ, Permission ID: testuser@domain.com, Added
  Test Test User
    id: 00008704419089109999
    type: user
    emailAddress: testuser@domain.com
    domain: domain.com
    role: reader
    permissionDetails:
      role: reader
      type: member
      inherited: False
    deleted: False

# Update to same role: fails
$ gam update drivefileacls teamdrive "Test TeamDrive" testuser@domain.com role reader
User: admin@domain.com, Update 1 Drive File/Folder ACL
  User: admin@domain.com, Drive File/Folder ID: 00002YhXYo2zyUkZZZZ, Update Failed: The authenticated user does not have the required access to update the permission.

# Update to new role: succeeds
$ gam update drivefileacls teamdrive "Test TeamDrive" testuser@domain.com role writer
User: admin@domain.com, Update 1 Drive File/Folder ACL
  User: admin@domain.com, Drive File/Folder ID: 00002YhXYo2zyUkZZZZ, Permission ID: 00008704419089109999, Updated
  Test Test User
    id: 00008704419089109999
    type: user
    emailAddress: testuser@domain.com
    domain: domain.com
    role: writer
    permissionDetails:
      role: writer
      type: member
      inherited: False
    deleted: False

# Update to same role: fails
$ gam update drivefileacls teamdrive "Test TeamDrive" testuser@domain.com role writer
User: admin@domain.com, Update 1 Drive File/Folder ACL
  User: admin@domain.com, Drive File/Folder ID: 00002YhXYo2zyUkZZZZ, Update Failed: The authenticated user does not have the required access to update the permission.

4.96.11

Updated gam update labels merge and gam delete labels to process labels in reverse hierarchial order to avoid deleting a parent label before all of its child labels are deleted.

4.96.10

Fixed gam update labels merge to do special encoding of label query when finding messages to re-label. Prior to the fix, labels containing ( and { were not found.

4.96.09

Added countsonly option to gam print/show contacts; this causes Gam to display the number of contacts but no contact details.

4.96.08

Any command line argument that starts with teamdrive may also be given as shareddrive. shareddrive shareddrives shareddriveacls shareddriveadminquery shareddrivefilename shareddriveid shareddriveinfo shareddrivename shareddriveparent shareddriveparentid shareddriveparentname shareddrivequery shareddrivethemes

4.96.07

Use administrator access to get Shared(Team) Drive names in gam print filelist and gam show fileinfo. This handles an exceptional case where a user has access to a file on a Shared Drive but no access to the Shared Drive itself.

4.96.06

Added drivename to <DriveFieldName>; this allows you to display Shared(Team) Drive names in gam print filelist and gam show fileinfo. If you use allfields instead of a field list, use showdrivename to display Shared(Team) Drive names. An additional API call is required to get each Shared(Team) Drive name; the names are cached so there is only one additional API call per Shared(Team) Drive.

For example: gam user user@domain.com show fileinfo name "Test File" fields id,name,driveid,drivename gam user user@domain.com show fileinfo name "Test File" allfields showdrivename gam user user@domain.com show fileinfo name "Test File" showdrivename gam user user@domain.com print filelist corpora onlyteamdrives fields id,name,driveid,drivename gam user user@domain.com print filelist corpora onlyteamdrives allfields showdrivename

When you execute a gam print filelist command with a query or permission match, there may be no files output; in this case, there is only a header row: `Owner'. Subsequent gam commands to process the file will fail.

$ gam redirect csv ./Files.csv user user@domain.com print filelist query "name contains 'abcd'" fields id,name Getting all Drive Files/Folders that match query ('me' in owners and name contains 'abcd') for user@domain.com Got 0 Drive Files/Folders that matched query ('me' in owners and name contains 'abcd') for user@domain.com... $ more Files.csv Owner $ gam csv Files.csv gam user ~Owner show fileinfo ~id permissions Command: /Users/admin/bin/gam csv Files.csv gam user ~Owner show fileinfo >>>~id<<< permissions

ERROR: Header "id" not found in CSV headers of "Owner". Help: Syntax in file /Users/admin/bin/gam/GamCommands.txt Help: Documentation is at https://github.com/taers232c/GAMADV-XTD3/wiki

Now, the fields you select will be output on the header row and the subsequent command will not fail.

$ gam redirect csv ./Files.csv user user@domain.com print filelist query "name contains 'abcd'" fields id,name Getting all Drive Files/Folders that match query ('me' in owners and name contains 'abcd') for user@domain.com Got 0 Drive Files/Folders that matched query ('me' in owners and name contains 'abcd') for user@domain.com... $ more Files.csv Owner,id,name $ gam csv Files.csv gam user ~Owner show fileinfo ~id permissions $

If you specify allfields, a predefined set of headers are output.

$ gam redirect csv ./Files.csv user user@domain.com print filelist query "name contains 'abcd'" allfields Getting all Drive Files/Folders that match query ('me' in owners and name contains 'abcd') for user@domain.com Got 0 Drive Files/Folders that matched query ('me' in owners and name contains 'abcd') for user@domain.com... $ more Files.csv Owner,id,name,owners.0.emailAddress,permissions,permissions.0.allowFileDiscovery,permissions.0.deleted,permissions.0.displayName,permissions.0.domain,permissions.0.emailAddress,permissions.0.expirationTime,permissions.0.id,permissions.0.permissionDetails,permissions.0.photoLink,permissions.0.role,permissions.0.teamDrivePermissionDetails,permissions.0.type

You can also specify the headers you want in the case that there are no files selected; your script could test for this value.

$ gam redirect csv ./Files.csv user user@domain.com print filelist query "name contains 'abcd'" allfields nodataheaders "BadNews-NoData" Getting all Drive Files/Folders that match query ('me' in owners and name contains 'abcd') for user@domain.com Got 0 Drive Files/Folders that matched query ('me' in owners and name contains 'abcd') for user@domain.com... $ more Files.csv BadNews-NoData

4.96.05

Fixed gam <CrOSTypeEntity> print cros deviceid and gam <UserTypeEntity> print users primaryEmail to not make additional/unnecessary API calls; this imprroves their performance.

4.96.04

Enhanced member matching in gam info/print groups and gam print/show group-members by allowing matching customer IDs as well as email addresses. The API directly supports listing groups which have a specific user or group member, but not groups that have a member of type CUSTOMER (all users in a domain). This coommand prints all groups with customer ID "C0123456" as a member; GAM has to call the API for every group to check for the customer ID member.

gam config csv_output_row_filter "MembersCount:count>0" print groups memberemaildisplaypattern "C0123456" members

4.96.03

Code cleanup.

4.96.02

Include filename in error messages concerning file I/O errors.

4.96.01

For backwards compatibility with Basic Gam, in gam create/update sendas, allow a signature file to be specified as signature|sig file <FileName> [charset <CharSet>].

4.96.00

Build with Python 3.8.0.

4.95.12

Added check in gam version to detect when a 32-bit version of GAM is running on a 64-bit version of Windows.

4.95.11

Fixed a trap that occurred when a gam print filelist command had a query containing {}.

4.95.10

Fixed ERROR: Object of type UUID is not JSON serializable error in gam create building.

4.95.09

Output additional license info with gam info domain. These values are displayed:

accounts:gsuite_basic_total_licenses accounts:gsuite_basic_used_licenses accounts:gsuite_enterprise_total_licenses accounts:gsuite_enterprise_used_licenses accounts:gsuite_unlimited_total_licenses accounts:gsuite_unlimited_used_licenses accounts:vault_total_licenses

4.95.08

Handle permissionDenied error in gam update project.

4.95.07 These commands have been deleted as the API is being deprecated.

gam arrows gam pagesize 25|50|100 gam shortcuts gam snippets gam utf|utf8|utf-8|unicode gam webclips

4.95.06

Added option oneappperrow to gam print mobile; this causes each mobile device application to be displayed on a separate row with all of the other mobile device fields. By default, all applications are displayed on one row which can make an excessively long field.

4.95.05

Handle fileWriterTeamDriveMoveInDisabled error in gam move drivefile.

4.95.04

Added option types <GroupTypeList> to gam info group and gam print groups; only members with type in <GroupTypeList>will be displayed. By default, members of all types are displayed.

Added option memberemaildisplaypattern|memberemailskippattern <RegularExpression> to gam info group and gam print groups to allow displaying members based on their email address.

  • memberemaildisplaypattern <RegularExpression> - Members with email addresses that match <RegularExpression> will be displayed; others will not be displayed
  • memberemailskippattern <RegularExpression> - Members with email addresses that match <RegularExpression> will not be displayed; others will be displayed

See: https://github.com/taers232c/GAMADV-XTD3/wiki/Groups-Manage#display-information-about-individual-groups See: https://github.com/taers232c/GAMADV-XTD3/wiki/Groups-Manage#display-information-about-multiple-groups

4.95.03

Added option memberemaildisplaypattern|memberemailskippattern <RegularExpression> to gam print/show group-members to allow displaying members based on their email address.

4.95.02

Following Jay's lead, added scope|scopes <APIScopeURLList> option to gam check serviceaccount. This allows you to enable service account access for a set of specific scopes rather than the full set of scopes that GAM is capable of using. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Authorization#manage-gam-service-account-access

When no_update_check = false in gam.cfg and a GAM update is available, execution will not be interrupted; you will get a warning message on stderr: WARNING: Version update available, Current: 4.95.01, Latest: 4.95.02.

4.95.01

Fixed bug where lists of course aliases containing spaces were not properly parsed.

4.95.00

Added options emailclearpattern|emailretainpattern <RegularExpression> to gam update groups <GroupEntity> clear to allow clearing members based on their email address.

4.94.24

Fixed gam update groups <GroupEntity> clear to show actual role of cleared members; previuosly, all cleared members were displayed as MEMBER regardless of their actual role.

4.94.23

Define <Locale> values.

4.94.22

Fixed bug that caused trap when gam config timezone specified an invalid value.

Added tdlocale <Locale> and tdtimezone <TimeZone> to <ToDriveAttribute>. Added todrive_locale and todrive_timezone to gam.cfg. These settings are used to set Spreadsheet settings for files uploaded with todrive. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Todrive

4.94.21

Added gplus to <CustomerServiceName> which is used in gam report domain.

4.94.20

Fixed bug in gam project commands that used the current ProjectID rather than the specified ProjectID when command form gam <Action> project <ProjectID> was used.

4.94.19

Included photoUrl in gam print/show classroomprofile.

4.94.18

Added commands to display classroom user profiles. gam print classroomprofile [todrive *] gam show classroomprofile

4.94.17

Added option [admincreatedmatch <Boolean>] to gam print groups and gam print/show group-members to allow filtering of groups based on whether they were created by an administrator or a user.

4.94.16

Added onerow option to gam print cros. By default, when you specify a list field: activeTimeRanges, recentUsers, deviceFiles, cpuStatusReports, diskVolumeReports, systemRamFreeReports; there is one value of each each type per row, this allows for trivial sorting by those columns. The onerow option puts all of the list field values on one row.

Added option includederivedmembership to gam print/show group-members. This option causes the API to list indirect members of groups. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Group-Membership

4.94.15

Make unknownError - Unknown a retryable error when making API calls to list files.

4.94.14

Added execute <Command> <ArgumentList> to gam tbatch commands. This allows you to execute non-GAM commands in the batch. See https://github.com/taers232c/GAMADV-XTD3/wiki/Bulk-Processing#batch-files

4.94.13

Updated gam print/show matters to display the email address matching the permission accountId.

4.94.12

Added summary none|only|plus option to gam print filecounts that specifies display of a summarization of file counts across all users specified in the command.

  • none - No summary is displayed; this is the default
  • only - Only the summary is displayed, no individual user file counts are displayed
  • plus - The summary is displayed in addition to the individual user file counts

4.94.11

Fixed bug that caused trap in gam print messages showbody when a message has no body.

4.94.10

When show_gettings_got_nl = false in gam.cfg, short Got NN ... lines were not completely overwriting a longer previous line; this is fixed.

4.94.09

Changed gam report to show running total in Got N Activities\Reports ....

4.94.08

Added [aliasmatchpattern <RegularExpression>] to gam print aliases to allow filtering of aliases.

4.94.07

Added types <GroupTypeList> to gam print/show group-members; only members with type in <GroupTypeList> will be displayed. By default, members of all types are displayed. See: https://github.com/taers232c/GAMADV-XTD3/wiki/Group-Membership

4.94.06

Handle trap when a CSV file contains a NULL byte in the header row.

4.94.05

Fixed

FAQ

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally