Skip to content

Users Drive Labels

Jump to bottom
Ross Scroggs edited this page Feb 25, 2024 · 10 revisions

Users - Drive - Labels

API documentation

Notes

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.

Definitions

<DriveLabelID> ::= <String>
<DriveLabelIDList> ::= "<DriveLabelID>(,<DriveLabelID)*"

<DriveLabelName> ::= labels/<DriveLabelID>[@latest|@published|@<Number>]
<DriveLabelNameList> ::= "<DriveLabelName>(,<DriveLabelName)*"
<DriveLabelNameEntity> ::=
        <DriveLabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>

<DriveLabelPermissionName> ::= labels/<DriveLabelID>[@latest|@published|@<Number>]/permissions/(audiences|groups|people)/<String>
<DriveLabelPermissionNameList> ::= "<DriveLabelPermissionName>(,<DriveLabelPermissionName>)*"
<DriveLabelPermissionNameEntity> ::=
        <DriveLabelPermissionNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>

<DriveLabelFieldID> ::= <String>
<DriveLabelSelectionID> ::= <String>
<DriveLabelSelectionIDList> ::= "<DriveLabelSelectionID>(,<DriveLabelSelectionID)*"

<BCP47LanguageCode> ::=
        ar-sa| # Arabic Saudi Arabia
        cs-cz| # Czech Czech Republic
        da-dk| # Danish Denmark
        de-de| # German Germany
        el-gr| # Modern Greek Greece
        en-au| # English Australia
        en-gb| # English United Kingdom
        en-ie| # English Ireland
        en-us| # English United States
        en-za| # English South Africa
        es-es| # Spanish Spain
        es-mx| # Spanish Mexico
        fi-fi| # Finnish Finland
        fr-ca| # French Canada
        fr-fr| # French France
        he-il| # Hebrew Israel
        hi-in| # Hindi India
        hu-hu| # Hungarian Hungary
        id-id| # Indonesian Indonesia
        it-it| # Italian Italy
        ja-jp| # Japanese Japan
        ko-kr| # Korean Republic of Korea
        nl-be| # Dutch Belgium
        nl-nl| # Dutch Netherlands
        no-no| # Norwegian Norway
        pl-pl| # Polish Poland
        pt-br| # Portuguese Brazil
        pt-pt| # Portuguese Portugal
        ro-ro| # Romanian Romania
        ru-ru| # Russian Russian Federation
        sk-sk| # Slovak Slovakia
        sv-se| # Swedish Sweden
        th-th| # Thai Thailand
        tr-tr| # Turkish Turkey
        zh-cn| # Chinese China
        zh-hk| # Chinese Hong Kong
        zh-tw  # Chinese Taiwan

Introduction

A domain administrator with the Drive and Docs administrator privilege can search for Shared Drives or update permissions for Shared Drives owned by their organization, regardless of the admin's membership in any given Shared Drive.

Three forms of the commands are available:

  • gam action ... - The administrator named in oauth2.txt is used, domain administrator access implied and labels of type SHARED and ADMINcan be processed
  • gam <UserTypeEntity> action ... adminaccess - The user named in <UserTypeEntty> is used, adminaccess indicates that labels of type SHARED and ADMINcan be processed
  • gam <UserTypeEntity> action ... - The user named in <UserTypeEntty> is used, access is limited, onlylabels of type SHARED can be processed

Display Drive Labels

gam [<UserTypeEntity>] info drivelabels <DriveLabelNameEntity>
        [[basic|full] [languagecode <BCP47LanguageCode>]
        [formatjson] [adminaccess|asadmin]
  • basic - Display fields: name,id,revisionId,labelType,properties.*; this is the default
  • full - Display all possible fields
  • languagecode <BCP47LanguageCode> - The BCP-47 language code to use for evaluating localized Field labels. When not specified, values in the default configured language will be used.
  • adminaccess|asadmin - Use the user's admin credentials. This will return all Labels within the customer.

By default, Gam displays the information as an indented list of keys and values.

  • formatjson - Display the fields in JSON format.
gam [<UserTypeEntity>] show drivelabels
        [basic|full] [languagecode <BCP47LanguageCode>]
        [publishedonly [<Boolean>]] [minimumrole applier|editor|organizer|reader]
        [formatjson] [adminaccess|asadmin]
  • basic - Display fields: name,id,revisionId,labelType,properties.*; this is the default
  • full - Display all possible fields
  • languagecode <BCP47LanguageCode> - The BCP-47 language code to use for evaluating localized Field labels. When not specified, values in the default configured language will be used.
  • minimumrole applier|editor|organizer|reader - Specifies the level of access the user must have on the returned Labels. Defaults to READER.
  • adminaccess|asadmin - Use the user's admin credentials. This will return all Labels within the customer.

By default, Gam displays the information as an indented list of keys and values.

  • formatjson - Display the fields in JSON format.
gam [<UserTypeEntity>] print drivelabels [todrive <ToDriveAttribute>*]
        [basic|full] [languagecode <BCP47LanguageCode>]
        [publishedonly [<Boolean>]] [minimumrole applier|editor|organizer|reader]
        [formatjson [quotechar <Character>]] [adminaccess|asadmin]
  • basic - Display fields: name,id,revisionId,labelType,properties.*; this is the default
  • full - Display all possible fields
  • languagecode <BCP47LanguageCode> - The BCP-47 language code to use for evaluating localized Field labels. When not specified, values in the default configured language will be used.
  • minimumrole applier|editor|organizer|reader - Specifies the level of access the user must have on the returned Labels. Defaults to READER.
  • adminaccess|asadmin - Use the user's admin credentials. This will return all Labels within the customer.

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

  • formatjson - Display the fields in JSON format.

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

Process File Drive Labels

<DriveLabelID>, <DriveLabelFieldID> and <DriveLabelSelectionID> values are obtained from the commands above.

gam <UserTypeEntity> process filedrivelabels <DriveFileEntity>
        (addlabel <DriveLabelIDList>)*
        (deletelabel <DriveLabelIDList>)*
        (addlabelfield <DriveLabelID> <DriveLabelFieldID>
            (text <String>)|selection <DriveLabelSelectionIDList>)|
            (integer <Number>)|(date <Date>)|(user <EmailAddressList>))*
        (deletelabelfield <DriveLabelID> <DriveLabelFieldID>)*
        [nodetails]

By default, details of the process labels are displayed, use nodetails to suppress this display.

Manage Drive Label Permissions

Create a permission for a Drive Label by specifying the label name and the principal.

gam [<UserTypeEntity>] create drivelabelpermission <DriveLabelNameEntity>
        (user <UserItem>) | (group <GroupItem) | (audience <String>)
        role applier|editor|organizer|reader
        [nodetails|formatjson] [adminaccess|asadmin]

By default, when a permission is created, GAM outputs details of the permission as indented keywords and values.

  • nodetails - Suppress the details output.
  • formatjson - Output the details in JSON format.

Delete a Drive Label permission by specifying the label name and the principal.

gam [<UserTypeEntity>] delete drivelabelpermission <DriveLabelNameEntity>
        (user <UserItem>) | (group <GroupItem) | (audience <String>)
        [adminaccess|asadmin]

Delete a Drive Label permission by specifying the label permission name.

gam [<UserTypeEntity>] remove drivelabelpermission <DriveLabelPermissionNameEntity>
        [adminaccess|asadmin]

Display Drive Label Permissions

Display permissions for a collection of Drive Label permission names.

gam [<UserTypeEntity>] show drivelabelpermissions <DriveLabelNameEntity>
        [formatjson] [adminaccess|asadmin]

By default, Gam displays the information as an indented list of keys and values.

  • formatjson - Display the fields in JSON format.
gam [<UserTypeEntity>] print drivelabelpermissions <DriveLabelNameEntity> [todrive <ToDriveAttribute>*]
        [formatjson [quotechar <Character>]] [adminaccess|asadmin]

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

  • formatjson - Display the fields in JSON format.

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

Need more help? Ask on the GAM Discussion Group

Update History

Installation

Configuration

Notes and Information

Definitions

Command Processing

Collections

Client Access

Special Service Account Access

Service Account Access

Clone this wiki locally