Users Photo

Users - Photo

• API documentation
• Notes
• Definitions
• Upload a user's photo from a default file
• Upload a user's photo specifying file name
• Upload a user's photo specifying separate path and file name
• Upload a user's photo specifying a Google Drive owner and file name
• Download a user's photo
• Delete a user's photo
• Update photo fails to change user's photo
• Download a user's profile photo

API documentation

• Directory API - Users Photos

Notes

As of version 7.34.09, gam <UserTypeEntity> update photo was updated 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.

Definitions

• <DriveFileEntity>
• <UserTypeEntity>

Upload a user's photo from a default file

gam <UserTypeEntity> update photo

• The default file is named #email#.jpg in the current working directory.
  • #email# will be replaced by the user's full email address

Upload a user's photo specifying file name

gam <UserTypeEntity> update photo <FileNamePattern>

By default, the user's photo will be uploaded from the current working directory.

• <FileNamePattern> can be a full file path/name or just a file name
  • #email# and #user# will be replaced by the user's full email address
  • #username# will be replaced by the local part of the user's email address

Upload a user's photo specifying separate path and file name

gam <UserTypeEntity> update photo
        [drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>]

By default, the user's photo will be uploaded from the current working directory.

• drivedir - The photo will be uploaded from the directory specified by drive_dir in gam.cfg

• sourcefolder <FilePath> - The photo will be uploaded from <FilePath>

• filename <FileNamePattern> - A file name

  • #email# and #user# will be replaced by the user's full email address
  • #username# will be replaced by the local part of the user's email address

Upload a user's photo specifying a Google Drive owner and file name

gam <UserTypeEntity> update photo
        gphoto <EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>

• <DriveFileIDEntity> - A file ID
• <DriveFileNameEntity> - A file name
  • #email# and #user# will be replaced by the user's full email address
  • #username# will be replaced by the local part of the user's email address

Download a user's photo

gam <UserTypeEntity> get photo
        [drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
        [noshow] [nofile]

By default, the user's photo will be downloaded into the current working directory.

• drivedir - The photo will be downloaded to the directory specified by drive_dir in gam.cfg
• targetfolder <FilePath> - The photo will be downloaded to <FilePath>
• nofile - Suppress writing the photo data to a file

By default, the user's photo will be named #email#.#ext#; use the following option to specify a different file name.

• filename <FileNamePattern> - The downloaded file name will be <FileNamePattern>

In either case, the following substitutions will be made:

• #email# and #user# will be replaced by the user's full email address
• #username# will be replaced by the local part of the user's email address
• #ext# will be replaced by the appropriate extension based on the data: jpg, png, gif

By default, the Base64 encoded data is dumped to stdout.

• noshow - Suppress dumping the photo data to stdout

Delete a user's photo

gam <UserTypeEntity> delete|del photo

Update photo fails to change user's photo

If you use gam <UserTypeEntity> update photo ... to change a user's photo and the command succeeds but the photo doesn't change, use gam <UserTypeEntity> delete photo first and then do the update.