mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-03 22:01:39 +00:00
8999 lines
378 KiB
Plaintext
8999 lines
378 KiB
Plaintext
This document describes the GAM command line syntax in modified BNF, see https://en.wikipedia.org/wiki/Backus-Naur_Form
|
|
Skip the History section and start reading at Introduction.
|
|
|
|
Items on the command line are space separated, when an actual space character is required, it will be indicated by <Space>.
|
|
If an item contains spaces, it should be surrounded by ".
|
|
|
|
[] optional item
|
|
() group items
|
|
* item may appear zero or more times
|
|
+ item may appear one or more times
|
|
| separates alternative items
|
|
|
|
## Primitives
|
|
|
|
<Character> ::= a single character
|
|
<Digit> ::= 0|1|2|3|4|5|6|7|8|9
|
|
<Number> ::= <Digit>+
|
|
<Float> ::= <Digit>*.<Digit>+
|
|
<Hex> ::= <Digit>|a|b|c|d|e|f|A|B|C|D|E|F
|
|
<Space> ::= an actual space character
|
|
<String> ::= a string of characters, surrounded by " if it contains spaces
|
|
<FalseValues>= false|off|no|disabled|0
|
|
<TrueValues> ::= true|on|yes|enabled|1
|
|
|
|
<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
|
|
<Charset> ::= ascii|latin1|mbcs|utf-8|utf-8-sig|utf-16|<String>
|
|
<CalendarColorIndex> ::= <Number in range 1-24>
|
|
<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|
|
|
<ColorHex> ::= "#<Hex><Hex><Hex><Hex><Hex><Hex>"
|
|
<ColorNameGoogle> ::=
|
|
asparagus|bluevelvet|bubblegum|cardinal|chocolateicecream|denim|desertsand|
|
|
earthworm|macaroni|marsorange|mountaingray|mountaingrey|mouse|oldbrickred|
|
|
pool|purpledino|purplerain|rainysky|seafoam|slimegreen|spearmint|
|
|
toyeggplant|vernfern|wildstrawberries|yellowcab
|
|
<ColorNameWeb> ::=
|
|
aliceblue|antiquewhite|aqua|aquamarine|azure|beige|bisque|black|blanchedalmond|
|
|
blue|blueviolet|brown|burlywood|cadetblue|chartreuse|chocolate|coral|
|
|
cornflowerblue|cornsilk|crimson|cyan|darkblue|darkcyan|darkgoldenrod|darkgray|
|
|
darkgrey|darkgreen|darkkhaki|darkmagenta|darkolivegreen|darkorange|darkorchid|
|
|
darkred|darksalmon|darkseagreen|darkslateblue|darkslategray|darkslategrey|
|
|
darkturquoise|darkviolet|deeppink|deepskyblue|dimgray|dimgrey|dodgerblue|
|
|
firebrick|floralwhite|forestgreen|fuchsia|gainsboro|ghostwhite|gold|goldenrod|
|
|
gray|grey|green|greenyellow|honeydew|hotpink|indianred|indigo|ivory|khaki|
|
|
lavender|lavenderblush|lawngreen|lemonchiffon|lightblue|lightcoral|lightcyan|
|
|
lightgoldenrodyellow|lightgray|lightgrey|lightgreen|lightpink|lightsalmon|
|
|
lightseagreen|lightskyblue|lightslategray|lightslategrey|lightsteelblue|
|
|
lightyellow|lime|limegreen|linen|magenta|maroon|mediumaquamarine|mediumblue|
|
|
mediumorchid|mediumpurple|mediumseagreen|mediumslateblue|mediumspringgreen|
|
|
mediumturquoise|mediumvioletred|midnightblue|mintcream|mistyrose|moccasin|
|
|
navajowhite|navy|oldlace|olive|olivedrab|orange|orangered|orchid|
|
|
palegoldenrod|palegreen|paleturquoise|palevioletred|papayawhip|peachpuff|
|
|
peru|pink|plum|powderblue|purple|red|rosybrown|royalblue|saddlebrown|salmon|
|
|
sandybrown|seagreen|seashell|sienna|silver|skyblue|slateblue|slategray|
|
|
slategrey|snow|springgreen|steelblue|tan|teal|thistle|tomato|turquoise|violet|
|
|
wheat|white|whitesmoke|yellow|yellowgreen
|
|
<ColorName> ::= <ColorNameGoogle>|<ColorNameWeb>
|
|
<ColorValue> ::= <ColorName>|<ColorHex>
|
|
<DayOfWeek> ::= mon|tue|wed|thu|fri|sat|sun
|
|
<EventColorIndex> ::= <Number in range 1-11>
|
|
<EventColorName> ::=
|
|
banana|basil|blueberry|flamingo|graphite|grape|
|
|
lavender|peacock|sage|tangerine|tomato
|
|
<FileFormat> ::=
|
|
csv|doc|dot|docx|dotx|epub|html|jpeg|jpg|json|mht|odp|ods|odt|
|
|
pdf|png|ppt|pot|potx|pptx|rtf|svg|tsv|txt|xls|xlt|xlsx|xltx|zip|
|
|
ms|microsoft|openoffice|
|
|
<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
|
|
<LanguageCode> ::=
|
|
ach|af|ag|ak|am|ar|az|be|bem|bg|bn|br|bs|ca|chr|ckb|co|crs|cs|cy|da|de|
|
|
ee|el|en|en-ca|en-gb|en-us|eo|es|es-419|et|eu|fa|fi|fil|fo|fr|fr-ca|fy|
|
|
ga|gaa|gd|gl|gn|gu|ha|haw|he|hi|hr|ht|hu|hy|ia|id|ig|in|is|it|iw|ja|jw|
|
|
ka|kg|kk|km|kn|ko|kri|ku|ky|la|lg|ln|lo|loz|lt|lua|lv|
|
|
mfe|mg|mi|mk|ml|mn|mo|mr|ms|mt|my|ne|nl|nn|no|nso|ny|nyn|oc|om|or|
|
|
pa|pcm|pl|ps|pt-br|pt-pt|qu|rm|rn|ro|ru|rw|
|
|
sd|sh|si|sk|sl|sn|so|sq|sr|sr-me|st|su|sv|sw|
|
|
ta|te|tg|th|ti|tk|tl|tn|to|tr|tt|tum|tw|
|
|
ug|uk|ur|uz|vi|wo|xh|yi|yo|zh-cn|zh-hk|zh-tw|zu
|
|
<Language> ::=
|
|
<LanguageCode>[+|-]|
|
|
<String>
|
|
<Locale> ::=
|
|
''| #Not defined
|
|
ar-eg| #Arabic, Egypt
|
|
az-az| #Azerbaijani, Azerbaijan
|
|
be-by| #Belarusian, Belarus
|
|
bg-bg| #Bulgarian, Bulgaria
|
|
bn-in| #Bengali, India
|
|
ca-es| #Catalan, Spain
|
|
cs-cz| #Czech, Czech Republic
|
|
cy-gb| #Welsh, United Kingdom
|
|
da-dk| #Danish, Denmark
|
|
de-ch| #German, Switzerland
|
|
de-de| #German, Germany
|
|
el-gr| #Greek, Greece
|
|
en-au| #English, Australia
|
|
en-ca| #English, Canada
|
|
en-gb| #English, United Kingdom
|
|
en-ie| #English, Ireland
|
|
en-us| #English, U.S.A.
|
|
es-ar| #Spanish, Argentina
|
|
es-bo| #Spanish, Bolivia
|
|
es-cl| #Spanish, Chile
|
|
es-co| #Spanish, Colombia
|
|
es-ec| #Spanish, Ecuador
|
|
es-es| #Spanish, Spain
|
|
es-mx| #Spanish, Mexico
|
|
es-py| #Spanish, Paraguay
|
|
es-uy| #Spanish, Uruguay
|
|
es-ve| #Spanish, Venezuela
|
|
fi-fi| #Finnish, Finland
|
|
fil-ph| #Filipino, Philippines
|
|
fr-ca| #French, Canada
|
|
fr-fr| #French, France
|
|
gu-in| #Gujarati, India
|
|
hi-in| #Hindi, India
|
|
hr-hr| #Croatian, Croatia
|
|
hu-hu| #Hungarian, Hungary
|
|
hy-am| #Armenian, Armenia
|
|
in-id| #Indonesian, Indonesia
|
|
it-it| #Italian, Italy
|
|
iw-il| #Hebrew, Israel
|
|
ja-jp| #Japanese, Japan
|
|
ka-ge| #Georgian, Georgia
|
|
kk-kz| #Kazakh, Kazakhstan
|
|
kn-in| #Kannada, India
|
|
ko-kr| #Korean, Korea
|
|
lt-lt| #Lithuanian, Lithuania
|
|
lv-lv| #Latvian, Latvia
|
|
ml-in| #Malayalam, India
|
|
mn-mn| #Mongolian, Mongolia
|
|
mr-in| #Marathi, India
|
|
my-mn| #Burmese, Myanmar
|
|
nl-nl| #Dutch, Netherlands
|
|
nn-no| #Nynorsk, Norway
|
|
no-no| #Bokmal, Norway
|
|
pa-in| #Punjabi, India
|
|
pl-pl| #Polish, Poland
|
|
pt-br| #Portuguese, Brazil
|
|
pt-pt| #Portuguese, Portugal
|
|
ro-ro| #Romanian, Romania
|
|
ru-ru| #Russian, Russia
|
|
sk-sk| #Slovak, Slovakia
|
|
sl-si| #Slovenian, Slovenia
|
|
sr-rs| #Serbian, Serbia
|
|
sv-se| #Swedish, Sweden
|
|
ta-in| #Tamil, India
|
|
te-in| #Telugu, India
|
|
th-th| #Thai, Thailand
|
|
tr-tr| #Turkish, Turkey
|
|
uk-ua| #Ukrainian, Ukraine
|
|
vi-vn| #Vietnamese, Vietnam
|
|
zh-cn| #Simplified Chinese, China
|
|
zh-hk| #Traditional Chinese, Hong Kong SAR China
|
|
zh-tw #Traditional Chinese, Taiwan
|
|
<MimeTypeShortcut> ::=
|
|
gdoc|gdocument|
|
|
gdrawing|
|
|
gfile|
|
|
gfolder|gdirectory|
|
|
gform|
|
|
gfusion|
|
|
gjam|
|
|
gmap|
|
|
gpresentation|
|
|
gscript|
|
|
gsheet|gspreadsheet|
|
|
gshortcut|
|
|
g3pshortcut|
|
|
gsite|
|
|
shortcut
|
|
<MimeTypeName> ::= application|audio|font|image|message|model|multipart|text|video
|
|
<MimeType> ::= <MimeTypeShortcut>|(<MimeTypeName>/<String>)
|
|
<ProductID> ::=
|
|
nv:<String> |
|
|
101001 |
|
|
101005 |
|
|
101031 |
|
|
101033 |
|
|
101034 |
|
|
101035 |
|
|
101036 |
|
|
101037 |
|
|
101038 |
|
|
101039 |
|
|
101040 |
|
|
101043 |
|
|
101047 |
|
|
101049 |
|
|
101050 |
|
|
Google-Apps |
|
|
Google-Chrome-Device-Management |
|
|
Google-Drive-storage |
|
|
Google-Vault
|
|
<SKUID> ::=
|
|
nv:<String>:<String> |
|
|
20gb | drive20gb | googledrivestorage20gb | Google-Drive-storage-20GB |
|
|
50gb | drive50gb | googledrivestorage50gb | Google-Drive-storage-50GB |
|
|
200gb | drive200gb | googledrivestorage200gb | Google-Drive-storage-200GB |
|
|
400gb | drive400gb | googledrivestorage400gb | Google-Drive-storage-400GB |
|
|
1tb | drive1tb | googledrivestorage1tb | Google-Drive-storage-1TB |
|
|
2tb | drive2tb | googledrivestorage2tb | Google-Drive-storage-2TB |
|
|
4tb | drive4tb | googledrivestorage4tb | Google-Drive-storage-4TB |
|
|
8tb | drive8tb | googledrivestorage8tb | Google-Drive-storage-8TB |
|
|
16tb | drive16tb | googledrivestorage16tb | Google-Drive-storage-16TB |
|
|
aiexpandedaccess | 1010470009 | AI Expanded Access |
|
|
aimeetingsandmessaging | 1010470007 | AI Meetings and Messaging |
|
|
aisecurity | 1010470006 | AI Security |
|
|
appsheetcore | 1010380001 | AppSheet Core |
|
|
appsheetstandard | appsheetenterprisestandard | 1010380002 | AppSheet Enterprise Standard |
|
|
appsheetplus | appsheetenterpriseplus | 1010380003 | AppSheet Enterprise Plus |
|
|
assuredcontrols | 1010390001 | Assured Controls |
|
|
assuredcontrolsplus | 1010390002 | Assured Controls Plus |
|
|
bce | beyondcorp | beyondcorpenterprise | cep | chromeenterprisepremium | 1010400001 | Chrome Enterprise Premium |
|
|
cdm | chrome | googlechromedevicemanagement | Google-Chrome-Device-Management |
|
|
cloudidentity | identity | 1010010001 | Cloud Identity |
|
|
cloudidentitypremium | identitypremium | 1010050001 | Cloud Identity Premium |
|
|
cloudsearch | 1010350001 | Cloud Search |
|
|
colabpro | 1010500001 | Colab Pro |
|
|
colabpro+ | colabproplus | 1010500002 | Colab Pro+ |
|
|
eeu | 1010490001 | SKU Endpoint Education Upgrade |
|
|
gaiproedu | geminiedu | 1010470004 | Google AI Pro for Education |
|
|
geminibiz | 1010470003 | Gemini Business |
|
|
geminiedupremium| 1010470005 | Gemini Education Premium |
|
|
geminient| duetai | 1010470001 | Gemini Enterprise - Legacy |
|
|
geminiultra | 1010470008 | Google AI Ultra for Business |
|
|
gsuitebasic | gafb | gafw | basic | Google-Apps-For-Business |
|
|
gsuitebusiness | gau | gsb | unlimited | Google-Apps-Unlimited |
|
|
gsuitebusinessarchived | gsbau | businessarchived | 1010340002 | Google Workspace Business - Archived User |
|
|
gsuiteedu | gafe | gsuiteeducation | Google-Apps-For-Education |
|
|
gsuiteenterprisearchived | gseau | enterprisearchived | 1010340001 | Google Workspace Enterprise Plus - Archived User |
|
|
gsuiteenterpriseeducation | gsefe | e4e | 1010310002 | Google Workspace for Education Plus - Legacy |
|
|
gsuiteenterpriseeducationstudent | gsefes | e4es | 1010310003 | Google Workspace for Education Plus - Legacy (Student) |
|
|
gsuitegov | gafg | gsuitegovernment | Google-Apps-For-Government |
|
|
gsuitelite | gal | gsl | lite | Google-Apps-Lite |
|
|
gwef | workspaceeducationfundamentals | 1010070001 | Google Workspace for Education Fundamentals |
|
|
gwefau | gwefarchived | workspaceeducationfundamentalsarchived | 1010340007 | Google Workspace for Education Fundamentals - Archived User |
|
|
gwegmo | workspaceeducationgmailonly | 1010070004 | Google Workspace for Education Gmail Only |
|
|
gwep | workspaceeducationplus | 1010310008 | Google Workspace for Education Plus |
|
|
gwepstaff | workspaceeducationplusstaff | 1010310009 | Google Workspace for Education Plus (Staff) |
|
|
gwepstudent | workspaceeducationplusstudent | 1010310010 | Google Workspace for Education Plus (Extra Student)|
|
|
gwes | workspaceeducationstandard | 1010310005 | Google Workspace for Education Standard |
|
|
gwesstaff | workspaceeducationstandardstaff | 1010310006 | Google Workspace for Education Standard (Staff) |
|
|
gwesstudent | workspaceeducationstandardstudent | 1010310007 | Google Workspace for Education Standard (Extra Student)
|
|
gwetlu | workspaceeducationupgrade | 1010370001 | Google Workspace for Education: Teaching and Learning Upgrade |
|
|
gwlabs | workspacelabs | 1010470002 | Google Workspace Labs |
|
|
meetdialing | googlemeetglobaldialing | 1010360001 | Google Meet Global Dialing |
|
|
postini | gams | gsuitegams | gsuitepostini | gsuitemessagesecurity | Google-Apps-For-Postini |
|
|
standard | free | Google-Apps |
|
|
vault | googlevault | Google-Vault |
|
|
vfe | googlevaultformeremployee | Google-Vault-Former-Employee |
|
|
voicepremier | gvpremier | googlevoicepremier | 1010330002 | Google Voice Premier
|
|
voicestandard | gvstandard | googlevoicestandard | 1010330004 | Google Voice Standard |
|
|
voicestarter | gvstarter | googlevoicestarter | 1010330003 | Google Voice Starter |
|
|
wsas | plusstorage | 1010430001 | Google Workspace Additional Storage |
|
|
wsbizplus | workspacebusinessplus | 1010020025 | Google Workspace Business Plus |
|
|
wsbizplusarchived | workspacebusinessplusarchived | 1010340003 | Google Workspace Business Plus - Archived User |
|
|
wsbizstan | workspacebusinessstandard | 1010020028 | Google Workspace Business Standard }
|
|
wsbizstanarchived | workspacebusinessstandardarchived | 1010340006 | Google Workspace Business Standard - Archived User |
|
|
wsbizstarter | workspacebusinessstarter | wsbizstart | 1010020027 | Google Workspace Business Starter |
|
|
wsbizstarterarchived | workspacebusinessstarterarchived | 1010340005 | Google Workspace Business Starter - Archived User |
|
|
wsentess | workspaceenterpriseessentials | 1010060003 | Google Workspace Enterprise Essentials |
|
|
wsentplus | workspaceenterpriseplus | gae | gse | enterprise | gsuiteenterprise | 1010020020 | Google Workspace Enterprise Plus (formerly G Suite Enterprise) |
|
|
wsentstan | workspaceenterprisestandard | 1010020026 | Google Workspace Enterprise Standard |
|
|
wsentstanarchived | workspaceenterprisestandardarchived | 1010340004 | Google Workspace Enterprise Standard - Archived User |
|
|
wsentstarter | workspaceenterprisestarter | wes | 1010020029 | Workspace Enterprise Starter |
|
|
wsess | workspaceesentials | gsuiteessentials | essentials | d4e | driveenterprise | drive4enterprise | 1010060001 | Google Workspace Essentials (formerly G Suite Essentials) |
|
|
wsessplus | workspaceessentialsplus | 1010060005 | Google Workspace Enterprise Essentials Plus |
|
|
wsflw | workspacefrontline | workspacefrontlineworker | 1010020030 | Google Workspace Frontline Starter |
|
|
wsflwstan | workspacefrontlinestan | workspacefrontlineworkerstan | 1010020031 | Google Workspace Frontline Standard |
|
|
wsflwplus | workspacefrontlineplus | workspacefrontlineworkerplus | 1010020034 | Google Workspace Frontline Plus
|
|
|
|
## Items built from primitives
|
|
|
|
<Boolean> ::= <TrueValues>|<FalseValues>
|
|
<ByteCount> ::= <Number>[m|k|b]
|
|
<CIDRnetmask> ::= <Number>.<Number>.<Number>.<Number>/<Number>
|
|
<Year> ::= <Digit><Digit><Digit><Digit>
|
|
<Month> ::= <Digit><Digit>
|
|
<Day> ::= <Digit><Digit>
|
|
<Hour> ::= <Digit><Digit>
|
|
<Minute> ::= <Digit><Digit>
|
|
<Second> ::= <Digit><Digit>
|
|
<MilliSeconds> ::= <Digit><Digit><Digit>
|
|
<Date> ::=
|
|
<Year>-<Month>-<Day> |
|
|
(+|-)<Number>(d|w|y) |
|
|
never|
|
|
today
|
|
<DateTime> ::=
|
|
<Year>-<Month>-<Day>(<Space>|T)<Hour>:<Minute> |
|
|
(+|-)<Number>(m|h|d|w|y) |
|
|
never|
|
|
now|today
|
|
<Time> ::=
|
|
<Year>-<Month>-<Day>(<Space>|T)<Hour>:<Minute>:<Second>[.<MilliSeconds>](Z|(+|-(<Hour>:<Minute>))) |
|
|
(+|-)<Number>(m|h|d|w|y) |
|
|
never|
|
|
now|today
|
|
<RegularExpression> ::= <String>
|
|
See: https://docs.python.org/3/library/re.html
|
|
<REMatchPattern> ::= <RegularExpression>
|
|
<RESearchPattern> ::= <RegularExpression>
|
|
<RESubstitution> ::= <String>>
|
|
<ProjectID> ::= <String>
|
|
Must match this Python Regular Expression: [a-z][a-z0-9-]{4,28}[a-z0-9]
|
|
<ServiceAccountName> ::= <String>
|
|
Must match this Python Regular Expression: [a-z][a-z0-9-]{4,28}[a-z0-9]
|
|
<SiteName> ::= [a-z,0-9,-]+
|
|
<UniqueID> ::= id:<String>|uid:<String>
|
|
|
|
## Named items
|
|
|
|
<AccessToken> ::= <String>
|
|
<AdminAssigneeType> ::= group|user|serviceaccount|unknown
|
|
<AlertID> ::= <String>
|
|
<APIScopeURL> ::= <String>
|
|
<APPID> ::= <String>
|
|
<ASPID> ::= <String>
|
|
<AssetTag> ::= <String>
|
|
<BrowserTokenPermanentID> ::= <String>
|
|
<BuildingID> ::= <String>|id:<String>
|
|
<CAALevelName> ::= <String>
|
|
<CalendarACLScope> ::=
|
|
<EmailAddress>|user:<EmailAddress>|group:<EmailAddress>|
|
|
domain:<DomainName>|domain|default
|
|
<CalendarItem> ::= <EmailAddress>
|
|
<ChannelCustomerID> ::= <String>
|
|
<ChatEmojiName> ::= :[0-9a-z_-]+:
|
|
<ChatEmoji> ::= emojiname <ChatEmojiName> | customemojis/<String>
|
|
<ChatMember> ::= spaces/<String>/members/<String>
|
|
<ChatMessage> ::= spaces/<String>/messages/<String>
|
|
<ChatSection> ::= users/<String>/sections/<String> | sections/<String> | section <String>
|
|
<ChatSectionItem> ::= users/<String>/sections/<String>/items/<String> | sections/<String>/items/<String>
|
|
<ChatSpace> ::= spaces/<String> | space <String> | space spaces/<String>
|
|
<ChatThread> ::= spaces/<String>/threads/<String>
|
|
<ChromeProfilePermanentID> ::= <String>
|
|
<ChromeProfileName> ::= customers/<CustomerID>/profiles/<ChromeProfilePermanentID> | <ChromeProfilePermanentID>
|
|
<ChromeProfileCommandName> ::= <ChomeProfileName>/commands/<String>
|
|
<GIGroupAlias> ::= <EmailAddress>
|
|
<GIGroupItem> ::= <EmailAddress>|<UniqueID>|groups/<String>
|
|
<CIGroupMemberType> ::= cbcmbrowser|chromeosdevice|customer|group|other|serviceaccount|user
|
|
<CIPolicyName> ::= policies/<String>|settings/<String>|<String>
|
|
<ClassificationLabelID> ::= <String>
|
|
<ClassificationLabelFieldID> ::= <String>
|
|
<ClassificationLabelSelectionID> ::= <String>
|
|
<ClassificationLabelName> ::= labels/<ClassificationLabelID>[@latest|@published|@<Number>]
|
|
<ClassificationLabelPermissionName> ::= labels/<ClassificationLabelID>[@latest|@published|@<Number>]/permissions/(audiences|groups|people)/<String>
|
|
<ClassroomInvitationID> ::= <String>
|
|
<ClientID> ::= <String>
|
|
<CommandID> ::= <String>
|
|
<ContactID> ::= <String>
|
|
<ContactGroupID> ::= id:<String>
|
|
<ContactGroupName> ::= <String>
|
|
<ContactGroupItem> ::= <ContactGroupID>|<ContactGroupName>
|
|
<CorporaAttribute> ::= alldrives|allteamdrives|domain|onlyteamdrives|user
|
|
<CourseAlias> ::= <String>
|
|
<CourseAnnouncementContent> ::=
|
|
((text <String>)|
|
|
(textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
<CourseAnnouncementID> ::= <Number>
|
|
<CourseAnnouncementState> ::= draft|published|deleted
|
|
<CourseID> ::= <Number>|d:<CourseAlias>
|
|
<CourseMaterialID> ::= <Number>
|
|
<CourseMaterialState> ::= draft|published|deleted
|
|
<CourseParticipantType> ::= teacher|teachers|student|students
|
|
<CourseState> ::= active|archived|provisioned|declined|suspended
|
|
<CourseSubmissionID> ::= <Number>
|
|
<CourseSubmissionState> ::= new|created|turned_in|returned|reclaimed_by_student
|
|
<CourseTopic> ::= <String>
|
|
<CourseTopicID> ::= <Number>
|
|
<CourseWorkID> ::= <Number>
|
|
<CourseWorkState> ::= draft|published|deleted
|
|
<CrOSID> ::= <String>
|
|
<CustomerID> ::= <String>
|
|
<DateTimeFormat> ::= <String>
|
|
See: https://docs.python.org/3/library/datetime.html#strftime-and-strptime-format-codes
|
|
<DeliverySetting> ::=
|
|
allmail|
|
|
abridged|daily|
|
|
digest|
|
|
disabled|
|
|
none|nomail
|
|
<DeviceID> ::= devices/<String>
|
|
<DeviceType> ::= android|chrome_os|google_sync|ios|linux|mac_os|windows
|
|
<DeviceUserID> ::= devices/<String>/deviceUsers/<String>
|
|
<DomainAlias> ::= <String>
|
|
<DomainName> ::= <String>(.<String>)+
|
|
<DriveFileACLRole> ::=
|
|
commenter|
|
|
contentmanager|fileorganizer|
|
|
contributor|editor|writer|
|
|
manager|organizer|owner|
|
|
reader|viewer
|
|
<DriveFileACLType> ::= anyone|domain|group|user
|
|
<DriveFileID> ::= <String>
|
|
<DriveFileURL> ::=
|
|
https://drive.google.com/open?id=<DriveFileID>
|
|
https://drive.google.com/drive/files/<DriveFileID>
|
|
https://drive.google.com/drive/folders/<DriveFileID>
|
|
https://drive.google.com/drive/folders/<DriveFileID>?resourcekey=<String>
|
|
https://drive.google.com/file/d/<DriveFileID>/<String>
|
|
https://docs.google.com/document/d/<DriveFileID>/<String>
|
|
https://docs.google.com/drawings/d/<DriveFileID>/<String>
|
|
https://docs.google.com/forms/d/<DriveFileID>/<String>
|
|
https://docs.google.com/presentation/d/<DriveFileID>/<String>
|
|
https://docs.google.com/spreadsheets/d/<DriveFileID>/<String>
|
|
<DriveFileItem> ::= <DriveFileID>|<DriveFileURL>
|
|
<DriveFolderID> ::= <String>
|
|
<DriveFileName> ::= <String>
|
|
<DriveFolderName> ::= <String>
|
|
<DriveFolderPath> ::= <String>(/<String>)*
|
|
<DriveFilePermission> ::=
|
|
anyone;<DriveFileACLRole>|
|
|
anyonewithlink;<DriveFileACLRole>|
|
|
domain:<DomainName>;<DriveFileACLRole>|
|
|
domainwithlink:<DomainName>;<DriveFileACLRole>|
|
|
group:<EmailAddress>;<DriveFileACLRole>|
|
|
user:<EmailAddress>;<DriveFileACLRole>
|
|
<DriveFilePermissionID> ::= anyone|anyonewithlink|id:<String>
|
|
<DriveFilePermissionIDorEmail> ::= <DriveFilePermissionID>|<EmailAddress>
|
|
<DriveFileRevisionID> ::= <String>
|
|
<EmailAddress> ::= <String>@<DomainName>
|
|
<EmailItem> ::= <EmailAddress>|<UniqueID>|<String>
|
|
<EmailReplacement> ::= <String>
|
|
<EventID> ::= <String>
|
|
<EventName> ::= <String>
|
|
<ExportItem> ::= <UniqueID>|<String>
|
|
<ExportStatus> ::= completed|failed|inprogrsss
|
|
<FeatureName> ::= <String>
|
|
<FieldName> ::= <String>
|
|
<FileName> ::= <String>
|
|
<FileNamePattern> ::= <String>
|
|
<FilterID> ::= <String>
|
|
<FloorName> ::= <String>
|
|
<GroupItem> ::= <EmailAddress>|<UniqueID>|<String>
|
|
<GroupRole> ::= owner|manager|member
|
|
<GroupMemberType> ::= customer|group|user
|
|
<GuardianItem> ::= <EmailAddress>|<UniqueID>|<String>
|
|
<GuardianInvitationID> ::= <String>
|
|
<HoldItem> ::= <UniqueID>|<String>
|
|
<HostName> ::= <String>
|
|
<iCalUID> ::= <String>
|
|
<JSONData> ::= (json [charset <Charset>] <String>) | (json file <FileName> [charset <Charset>]) |
|
|
<Key> ::= <String>
|
|
<LabelID> ::= Label_<String>
|
|
<LabelName> ::= <String>
|
|
<LabelReplacement> ::= <String>
|
|
<LookerStudioAssetID> ::= <String>
|
|
<LookerStudioPermission> ::=
|
|
user:<EmailAddress>|
|
|
group:<EmailAddress>|
|
|
domain:<DomainName>|
|
|
serviceAccount:<EmailAddress>
|
|
<Marker> ::= <String>
|
|
<MatterItem> ::= <UniqueID>|<String>
|
|
<MatterState> ::= open|closed|deleted
|
|
<MeetConferenceName> ::= conferenceRecords/<String>
|
|
<MeetID> ::= <String>
|
|
Must match this Python Regular Expression: [a-z]{3}-[a-z]{4}-[a-z]{3}
|
|
<MeetSpaceName> ::= spaces/<String> | <String>
|
|
<MessageContent> ::=
|
|
(message|textmessage|htmlmessage <String>)|
|
|
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)
|
|
<MessageID> ::= <String>
|
|
<Namespace> ::= <String>
|
|
<NotesName> ::= notes/<String>
|
|
<NotifyMessageContent> ::=
|
|
(message|textmessage|htmlmessage <String>)|
|
|
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)
|
|
<NumberOfSeats> ::= <Number>
|
|
<NumberRange> ::= <Number>|(<Number>/<Number>)
|
|
<OrgUnitID> ::= id:<String>
|
|
<OrgUnitPath> ::= /|(/<String>)+
|
|
<OrgUnitItem> ::= <OrgUnitID>|<OrgUnitPath>
|
|
<OtherContactsResourceName> ::= otherContacts/<String>
|
|
<ParameterKey> ::= <String>
|
|
<ParameterValue> ::= <String>
|
|
<Password> ::= <String>
|
|
<PeopleResourceName> ::= people/<String>
|
|
<PrinterID> ::= <String>
|
|
<ProjectID> ::= <String>
|
|
Must match this Python Regular Expression: [a-z][a-z0-9-]{4,28}[a-z0-9]
|
|
<ProjectName> ::= <String>
|
|
Must match this Python Regular Expression: [a-zA-Z0-9 '"!-]{4,30}
|
|
<PropertyKey> ::= <String>
|
|
<PropertyValue> ::= <String>
|
|
<PubSubTopicName> ::= <String>
|
|
<QueryAlert> ::= <String>
|
|
See: https://developers.google.com/admin-sdk/alertcenter/guides/query-filters
|
|
<QueryBrowser> ::= <String>
|
|
See: https://support.google.com/chrome/a/answer/9681204#retrieve_all_chrome_devices_for_an_account
|
|
<QueryBrowserToken> ::= <String>
|
|
See: https://support.google.com/chrome/a/answer/9949706?ref_topic=9301744
|
|
<QueryCalendar> ::= <String>
|
|
<QueryCEL> ::= <String>
|
|
See: https://cloud.google.com/access-context-manager/docs/custom-access-level-spec
|
|
<QueryContact> ::= <String>
|
|
See: https://developers.google.com/google-apps/contacts/v3/reference#contacts-query-parameters-reference
|
|
<QueryCrOS> ::= <String>:<String>
|
|
See: https://support.google.com/chrome/a/answer/1698333
|
|
<QueryDevice> ::= <String>:<String>
|
|
See: https://support.google.com/a/answer/7549103
|
|
<QueryDriveFile> ::= <String>
|
|
See: https://developers.google.com/drive/api/v3/search-files
|
|
<QueryDynamicGroup> ::= <String>
|
|
See: https://cloud.google.com/identity/docs/reference/rest/v1/groups#dynamicgroupquery
|
|
<QueryGmail> ::= <String>
|
|
See: https://support.google.com/mail/answer/7190
|
|
<QueryGroup> ::= <String>
|
|
See: https://developers.google.com/admin-sdk/directory/v1/guides/search-groups
|
|
<QueryItem> ::= <UniqueID>|<String>
|
|
<QueryMemberRestrictions> ::= <String>
|
|
See: https://cloud.google.com/identity/docs/reference/rest/v1beta1/SecuritySettings#MemberRestriction
|
|
<QueryMobile> ::= <String>:<String>
|
|
See: https://support.google.com/a/answer/7549103
|
|
<QueryTeamDrive> ::= <String>
|
|
See: https://developers.google.com/drive/api/v3/search-parameters
|
|
<QueryUser> ::= <String>
|
|
See: https://developers.google.com/admin-sdk/directory/v1/guides/search-users
|
|
<QueryVaultCorpus> ::= <String>
|
|
See: https://developers.google.com/vault/reference/rest/v1/matters.holds#CorpusQuery
|
|
<RequestID> ::= <String>
|
|
<ResellerID> ::= <String>
|
|
<ResourceID> ::= <String>
|
|
<SchemaName> ::= <String>
|
|
<SchemaNameField> ::= <SchemaName>.<FieldName>
|
|
<Section> ::= <String>
|
|
<SendAsContent> ::=
|
|
(sig|signature|htmlsig <String>)|
|
|
(file|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)
|
|
<SerialNumber> ::= <String>
|
|
<ServiceAccountName> ::= <String>
|
|
Must match this Python Regular Expression: [a-z][a-z0-9-]{4,28}[a-z0-9]
|
|
<ServiceAccountDisplayName> ::= <String>
|
|
Maximum of 100 characters
|
|
<ServiceAccountDescrition> ::= <String>
|
|
Maximum of 256 chcracters
|
|
<ServiceAccountEmail> ::= <ServiceAccountName>@<ProjectID>.iam.gserviceaccount.com
|
|
<ServiceAccountUniqueID> ::= <Number>
|
|
<ServiceAccountKey> ::= <String>
|
|
<SheetEntity> ::= <String>|id:<Number>
|
|
<SignatureContent> ::=
|
|
(<String>)|
|
|
(file|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)
|
|
<SiteACLScope> ::=
|
|
<EmailAddress>|user:<EmailAddress>|group:<EmailAddress>|
|
|
domain:<DomainName>|domain|default
|
|
<SiteItem> ::= [<DomainName>/]<SiteName>
|
|
<S/MIMEID> ::= <String>
|
|
<SMTPHostName> ::= <String>
|
|
<StudentGroupID> ::= <Number>
|
|
<StudentItem> ::= <EmailAddress>|<UniqueID>|<String>
|
|
<SharedDriveACLRole> ::=
|
|
commenter|
|
|
contentmanager|fileorganizer|
|
|
contributor|editor|writer|
|
|
manager|organizer|owner|
|
|
reader|viewer
|
|
<SharedDriveID> ::= <String>
|
|
<SharedDriveName> ::= <String>
|
|
<StorageBucketName> ::= <String>
|
|
<StorageObjectName> ::= <String>
|
|
<StorageBucketObjectName> ::=
|
|
https://storage.cloud.google.com/<StorageBucketName>/<StorageObjectName>|
|
|
https://storage.googleapis.com/<StorageBucketName>/<StorageObjectName>|
|
|
gs://<StorageBucketName>/<StorageObjectName>|
|
|
<StorageBucketName>/<StorageObjectName>
|
|
<Tag> ::= <String>
|
|
<TagManagerAccountID> ::= <String>
|
|
<TagManagerAccountPath> ::= accounts/<TagManagerAccountID>
|
|
<TagManagerContainerID> ::= <String>
|
|
<TagManagerContainerPath> ::= accounts/<TagManagerAccountID>/containers/<TagManagerContainerID>
|
|
<TagManagerWorkspaceID> ::= <String>
|
|
<TagManagerWorkspacePath> ::= accounts/<TagManagerAccountID>/containers/<TagManagerContainerID>/workspaces/<TagManagerWorkspaceID>
|
|
<TagManagerTagID> ::= <String>
|
|
<TagManagerTagPath> ::= accounts/<TagManagerAccountID>/containers/<TagManagerContainerID>/workspaces/<TagManagerWorkspaceID>/tags/<TagManagerTagID>
|
|
<TakeoutBucketName> ::= takeout-export-[a-f,0-9,-]*
|
|
<TaskID> ::= <String>
|
|
<TaskListID> ::= <String>
|
|
<TaskListTitle> ::= tltitle:<String>
|
|
<TasklistIDTaskID> ::= <TasklistID>/<TaskID>
|
|
<ThreadID> ::= <String>
|
|
<TimeZone> ::= <String>
|
|
See: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
|
|
<Title> ::= <String>
|
|
<ToDriveAttribute> ::=
|
|
(tdaddsheet [<Boolean>])|
|
|
(tdalert <EmailAddress>)*|
|
|
(tdbackupsheet (id:<Number>)|<String>)|
|
|
(tdcellnumberformat text|number)|
|
|
(tdcellwrap clip|overflow|wrap)|
|
|
(tdclearfilter [<Boolean>])|
|
|
(tdcopysheet (id:<Number>)|<String>)|
|
|
(tddescription <String>)|
|
|
(tdfileid <DriveFileID>)|
|
|
(tdfrom <EmailAddress>)|
|
|
(tdlocalcopy [<Boolean>])|
|
|
(tdlocale <Locale>)|
|
|
(tdnobrowser [<Boolean>])|
|
|
(tdnoemail [<Boolean>])|
|
|
(tdnoescapechar [<Boolean>])|
|
|
(tdnotify [<Boolean>])|
|
|
(tdparent (id:<DriveFolderID>)|<DriveFolderName>)|
|
|
(tdretaintitle [<Boolean>])|
|
|
(tdreturnidonly [<Boolean>])|
|
|
(tdshare <EmailAddress> commenter|reader|writer)*|
|
|
(tdsheet (id:<Number>)|<String>)|
|
|
(tdsheettimestamp [<Boolean>] [tdsheettimeformat <DateTimeFormat>])
|
|
(tdsheettitle <String>)|
|
|
(tdsubject <String>)|
|
|
([tdsheetdaysoffset <Number>] [tdsheethoursoffset <Number>])|
|
|
(tdtimestamp [<Boolean>] [tdtimeformat <DateTimeFormat>]
|
|
[tddaysoffset <Number>] [tdhoursoffset <Number>])|
|
|
(tdtimezone <TimeZone>)|
|
|
(tdtitle <String>)|
|
|
(tdupdatesheet [<Boolean>])|
|
|
(tduploadnodata [<Boolean>])|
|
|
(tduser <EmailAddress>)
|
|
<TransferID> ::= <String>
|
|
<URI> ::= <String>
|
|
<URL> ::= <String>
|
|
<UserItem> ::= <EmailAddress>|<UniqueID>|<String>
|
|
<UserName> ::= <String>
|
|
<VacationMessageContent> ::=
|
|
(message|textmessage|htmlmessage <String>)|
|
|
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)
|
|
<YouTubeChannelID> ::= <String>
|
|
|
|
## Lists of basic items
|
|
|
|
<AdminAssigneeTypeList> ::= "<AdminAssigneeType>(,<AdminAssigneeType>)*"
|
|
<APIScopeURLList> ::= "<APIScopeURL>(,<APIScopeURL>)*"
|
|
<ASPIDList> ::= "<ASPID>(,<ASPID>)*"
|
|
<AssetTagList> ::= "<AssetTag>(,<AssetTag>)*"
|
|
<CalendarACLScopeList> ::= "<CalendarACLScope>(,<CalendarACLScope>)*"
|
|
<CalendarList> ::= "<CalendarItem>(,<CalendarItem>)*"
|
|
<ChatSpaceList> ::= "<ChatSpace>(,<ChatSpace>)*"
|
|
<ChromeProfileNameList> ::= "<ChromeProfileName>(,<ChromeProfileName>)*"
|
|
<ChromeProfileCommandNameList> ::= "<ChromeProfileCommandName>(,<ChromeProfileCommandName>)*"
|
|
<CIGroupAliasList> ::= "<CIGroupAlias>(,<CIGroupAlias>)*"
|
|
<CIGroupMemberTypeList> ::= "<CIGroupMemberType>(,<CIGroupMemberType>)*"
|
|
<CIPolicyNameList> ::= "<CIPolicyName>(,<CIPolicyName>)*"
|
|
<ClassificationLabelIDList> ::= "<ClassificationLabelID>(,<ClassificationLabelID>)*"
|
|
<ClassificationLabelNameList> ::= "<ClassificationLabelName>(,<ClassificationLabelName>)*"
|
|
<ClassificationLabelPermissionNameList> ::= "<ClassificationLabelPermissionName>(,<ClassificationLabelPermissionName>)*"
|
|
<ClassificationLabelFieldIDList> ::= "<ClassificationLabelFieldID>(,<ClassificationLabelFieldID>)*"
|
|
<ClassificationLabelSelectionIDList> ::= "<ClassificationLabelSelectionID>(,<ClassificationLabelSelectionID>)*"
|
|
<ClassroomInvitationIDList> ::= "<ClassroomInvitationID>(,<ClassroomInvitationID>)*"
|
|
<ContactGroupList> ::= "<ContactGroupItem>(,<ContactGroupItem>)*"
|
|
<ContactIDList> ::= "<ContactID>(,<ContactID>)*"
|
|
<CourseAliasList> ::= "<CourseAlias>(,<CourseAlias>)*"
|
|
<CourseAnnouncementIDList> ::= "<CourseAnnouncementID>(,<CourseAnnouncementID>)*"
|
|
<CourseAnnouncementStateList> ::= all|"<CourseAnnouncementState>(,<CourseAnnouncementState>)*"
|
|
<CourseIDList> ::= "<CourseID>(,<CourseID>)*"
|
|
<CourseMaterialIDList> ::= "<CourseMaterialID>(,<CourseMaterialID>)*"
|
|
<CourseMaterialStateList> ::= all|"<CourseMaterialState>(,<CourseMaterialState>)*"
|
|
<CourseStateList> ::= all|"<CourseState>(,<CourseState>)*"
|
|
<CourseSubmissionIDList> ::= "<CourseSubmissionID>(,<CourseSubmissionID>)*"
|
|
<CourseSubmissionStateList> ::= all|"<CourseSubmissionState>(,<CourseSubmissionState>)*"
|
|
<CourseTopicIDList> ::= "<CourseTopicID>(,<CourseTopicID>)*"
|
|
<CourseTopicList> ::= "<CourseTopic>(,<CourseTopic>)*"
|
|
<CourseWorkIDList> ::= "<CourseWorkID>(,<CourseWorkID>)*"
|
|
<CourseWorkStateList> ::= all|"<CourseWorkState>(,<CourseWorkState>)*"
|
|
<CrOSIDList> ::= "<CrOSID>(,<CrOSID>)*"
|
|
<DeviceIDList> ::= "<DeviceID>(,<DeviceID>)*"
|
|
<DeviceUserList> ::= "<DeviceUserID>(,<DeviceUserID>)*"
|
|
<DomainNameList> ::= "<DomainName>(,<DomainName>)*"
|
|
<DriveFileACLRoleList> ::= "<DriveFileACLRole>(,<DriveFileACLRole>)*"
|
|
<DriveFileACLTypeList> ::= "<DriveFileACLType>(,<DriveFileACLType>)*"
|
|
<DriveFileIDList> ::= "<DriveFileID>(,<DriveFileID>)*"
|
|
<DriveFileList> ::= "<DriveFileItem>(,<DriveFileItem>)*"
|
|
<DriveFilePermissionList> ::= "<DriveFilePermission>(,<DriveFilePermission>)*"
|
|
<DriveFilePermissionIDList> ::= "<DriveFilePermissionID>(,<DriveFilePermissionID>)*"
|
|
<DriveFileRevisionIDList> ::= "<DriveFileRevisionID>(,<DriveFileRevisionID>)*"
|
|
<DriveFolderIDList> ::= "<DriveFolderID>(,<DriveFolderID>)*"
|
|
<DriveFolderNameList> ::= "<DriveFolderName>(,<DriveFolderName>)*"
|
|
<EmailAddressList> ::= "<EmailAddress>(,<EmailAddress>)*"
|
|
<EmailItemList> ::= "<EmailItem>(,<EmailItem>)*"
|
|
<EventIDList> ::= "<EventID>(,<EventID>)*"
|
|
<EventNameList> ::= "<EventName>(,<EventName>)*"
|
|
<ExportStatusList> ::= "<ExportStatus>(,<ExportStatus>)*"
|
|
<FeatureNameList> ::= "'<FeatureName>'(,'<FeatureName>')*"
|
|
<FieldNameList> ::= "<FieldName>(,<FieldName>)*"
|
|
<FileFormatList> ::= "<FileFormat>(,<FileFormat>)*"
|
|
<FilterIDList> ::= "<FilterID>(,<FilterID>)*"
|
|
<GuardianItemList> ::= "<GuardianItem>(,<GuardianItem>)*"
|
|
<GuardianInvitationIDList> ::= "<GuardianInvitationID>(,<GuardianInvitationID>)*"
|
|
<GroupList> ::= "<GroupItem>(,<GroupItem>)*"
|
|
<GroupRoleList> ::= "<GroupRole>(,<GroupRole>)*"
|
|
<GroupMemberTypeList> ::= "<GroupMemberType>(,<GroupMemberType>)*"
|
|
<LabelIDList> ::= "<LabelID>(,<LabelID>)*"
|
|
<LabelNameList> ::= "'<LabelName>'(,'<LabelName>')*"
|
|
<LanguageList> ::= "<Language>(,<Language>)*"
|
|
<LookerStudioAssetIDList> ::= "<LookerStudioAssetID>(,<LookerStudioAssetID>)*"
|
|
<LookerStudioPermissionList> ::= "<LookerStudioPermission>(,<LookerStudioPermission>)*"
|
|
<MatterItemList> ::= "<MatterItem>(,<MatterItem>)*"
|
|
<MatterStateList> ::= "<MatterState>(,<MatterState>)*"
|
|
<MessageIDList> ::= "<MessageID>(,<MessageID>)*"
|
|
<MimeTypeList> ::= "<MimeType>(,<MimeType>)*"
|
|
<MimeTypeNameList> ::= "<MimeTypeName>(,<MimeTypeName>)*"
|
|
<NamespaceList> ::= "<Namespace>(,<Namespace>)*"
|
|
<NotesNameList> ::= "<NotesName>(,<NotesName>)*"
|
|
<NumberRangeList> ::= "<NumberRange>(,<NumberRange>)*"
|
|
<OrgUnitList> ::= "<OrgUnitItem>(,<OrgUnitItem>)*"
|
|
<OtherContactsResourceNameList> ::= "<OtherContactsResourceName>(,<OtherContactsResourceName>)*"
|
|
<PeopleResourceNameList> ::= "<PeopleResourceName>(,<PeopleResourceName>)*"
|
|
<PrinterIDList> ::= "<PrinterID>(,<PrinterID>)*"
|
|
<ProductIDList> ::= "(<ProductID>|<SKUID>)(,<ProductID>|<SKUID>)*"
|
|
<ProjectIDList> ::= "<ProjectID>(,<ProjectID>)*"
|
|
<QueryBrowserList> ::= "<QueryBrowser>(,<QueryBrowser>)*"
|
|
<QueryCrOSList> ::= "<QueryCrOS>(,<QueryCrOS>)*"
|
|
<QueryDeviceList> ::= "<QueryDevice>(,<QueryDevice>)*"
|
|
<QueryGroupList> ::= "<QueryGroup>(,<QueryGroup>)*"
|
|
<QueryMobileList> ::= "<QueryMobile>(,<QueryMobile>)*"
|
|
<QueryUserList> ::= "<QueryUser>(,<QueryUser>)*"
|
|
<ResourceIDList> ::= "<ResourceID>(,<ResourceID>)*"
|
|
<SchemaNameList> ::= "<SchemaName>|<SchemaFieldName>(,<SchemaName>|<SchemaFieldName>)*"
|
|
<SerialNumberList> ::= "<SerialNumber>(,<SerialNumber>)*"
|
|
<ServiceAccountKeyList> ::= "<ServiceAccountKey>(,<ServiceAccountKey>)*"
|
|
<SiteACLScopeList> ::= "<SiteACLScope>(,<SiteACLScope>)*"
|
|
<SiteList> ::= "<SiteItem>(,<SiteItem>)*"
|
|
<SKUIDList> ="<SKUID>(,<SKUID>)*"
|
|
<SMTPHeaderList> ::= "<SMTPDateHeader>|<SMTPHeader>(,<SMTPDateHeader>|<SMTPHeader>)*"
|
|
<SharedDriveACLRoleList> ::= "<SharedDriveACLRole>(,<SharedDriveACLRole>)*"
|
|
<SharedDriveIDList> ::= "<SharedDriveID>(,<SharedDriveID>)*"
|
|
<StringList> ::= "<String>(,<String>)*"
|
|
<StudentGroupIDList> ::= "<StudentGroupID>(,<StudentGroupID>)*"
|
|
<TagManagerAccountPathList> ::= "<TagManagerAccountPath>(,<TagManagerAccountPath>)*"
|
|
<TagManagerContainerPathList> ::= "<TagManagerContainerPath>(,<TagManagerContainerPath>)*"
|
|
<TagManagerWorkspacePathList> ::= "<TagManagerWorkspacePath>(,<TagManagerWorkspacePath>)*"
|
|
<TasklistIDList> ::= "<TasklistID>(,<TasklistID>)*"
|
|
<TasklistTitleList> ::= "'<TasklistTitle>'(,'<TasklistTitle>')*"
|
|
<TasklistIDTaskIDList> ::= "<TasklistIDTaskID>(,<TasklistIDTaskID>)*"
|
|
<ThreadIDList> ::= "<ThreadID>(,<ThreadID>)*"
|
|
<TimeList> ::= "<Time>(,<Time>)*"
|
|
<URLList> ::= "<URL>(,<URL>)*"
|
|
<UserList> ::= "<UserItem>(,<UserItem>)*"
|
|
<YouTubeChannelIDList> ::= "<YouTubeChannelID>(,<YouTubeChannelID>)*"
|
|
|
|
## Quoting rules
|
|
|
|
Items in a list can be separated by commas or spaces; if an item itself contains a comma, a space or a single quote, special quoting must be used.
|
|
Typically, you will enclose the entire list in double quotes and quote each item in the list as detailed below.
|
|
|
|
Items, separated by commas, without spaces, commas or single quotes in the items themselves
|
|
"item,item,item"
|
|
Items, separated by spaces, without spaces, commas or single quotes in the items themselves
|
|
"item item item"
|
|
Items, separated by commas, with spaces, commas or single quotes in the items themselves
|
|
"'it em','it,em',\"it'em\""
|
|
Items, separated by spaces, with spaces, commas or single quotes in the items themselves
|
|
"'it em' 'it,em' \"it'em\""
|
|
|
|
## Data from a user's Google Sheets file sheet
|
|
<UserGoogleDoc> ::=
|
|
<EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>|(<SharedDriveEntity> <SharedDriveFileNameEntity>)
|
|
<UserGoogleSheet> ::=
|
|
<EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>|(<SharedDriveEntity> <SharedDriveFileNameEntity>) <SheetEntity>
|
|
|
|
## Collections of ChromeOS Devices
|
|
|
|
Specify a collection of ChromeOS devices by directly specifying them or by specifying items that will yield a list of ChromeOS devices.
|
|
|
|
<CrOSTypeEntity> ::=
|
|
(all cros)|
|
|
(cros <CrOSIDList>)|
|
|
(cros_sn <SerialNumberList>)|
|
|
(cros_ou <OrgUnitItem>)|
|
|
(cros_ou_and_children <OrgUnitItem>)|
|
|
(cros_ous <OrgUnitList>)|
|
|
(cros_ous_and_children <OrgUnitList>)|
|
|
(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>)|
|
|
(crosquery <QueryCrOS>)|
|
|
(crosqueries <QueryCrOSList>)|
|
|
(crosfile
|
|
((<FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[delimiter <Character>])|
|
|
(crosfile_sn
|
|
((<FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[delimiter <Character>])|
|
|
(croscsvfile
|
|
((<FileName>(:<FieldName>)+ [charset <Charset>] )|
|
|
(gsheet(:<FieldName>)+ <UserGoogleSheet>)|
|
|
(gdoc(:<FieldName>)+ <UserGoogleDoc>)|
|
|
(gcscsv(:<FieldName>)+ <StorageBucketObjectName>)|
|
|
(gcsdoc(:<FieldName>)+ <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[delimiter <Character>])|
|
|
(croscsvfile_sn
|
|
((<FileName>(:<FieldName>)+ [charset <Charset>] )|
|
|
(gsheet(:<FieldName>)+ <UserGoogleSheet>)|
|
|
(gdoc(:<FieldName>)+ <UserGoogleDoc>)|
|
|
(gcscsv(:<FieldName>)+ <StorageBucketObjectName>)|
|
|
(gcsdoc(:<FieldName>)+ <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[delimiter <Character>])|
|
|
(datafile
|
|
cros|cros_sn|cros_ous|cros_ous_and_children
|
|
((<FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[delimiter <Character>])|
|
|
(csvdatafile
|
|
cros|cros_sn|cros_ous|cros_ous_and_children
|
|
((<FileName>(:<FieldName>)+ [charset <Charset>] )|
|
|
(gsheet(:<FieldName>)+ <UserGoogleSheet>)|
|
|
(gdoc(:<FieldName>)+ <UserGoogleDoc>)|
|
|
(gcscsv(:<FieldName>)+ <StorageBucketObjectName>)|
|
|
(gcsdoc(:<FieldName>)+ <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
(matchfield|skipfield <FieldName> <REMatchPattern>)*
|
|
[delimiter <Character>])|
|
|
(csvkmd
|
|
cros|cros_sn|cros_ous|cros_ous_and_children
|
|
((<FileName>|
|
|
(gsheet <UserGoogleSheet>)|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcscsv <StorageBucketObjectName>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[charset <Charset>] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>] [fields <FieldNameList>])
|
|
keyfield <FieldName> [keypattern <REMatchPattern>] [keyvalue <String>] [delimiter <Character>]
|
|
subkeyfield <FieldName> [keypattern <REMatchPattern>] [keyvalue <String>] [delimiter <Character>]
|
|
(matchfield|skipfield <FieldName> <REMatchPattern>)*
|
|
[datafield <FieldName>(:<FieldName>)* [delimiter <Character>]])
|
|
(croscsvdata <FieldName>(:<FieldName>*))
|
|
|
|
## Collections of Users
|
|
|
|
Specify a collection of Users by directly specifying them or by specifying items that will yield a list of users.
|
|
|
|
<UserTypeEntity> ::=
|
|
(all users|users_na|users_arch|users_ns|users_susp|users_arch_or_susp|users_na_ns|users_ns_susp)|
|
|
(all guests|guests_ns|guests_susp|guests_ns_susp)|
|
|
(all users_and_guests|users_and_guests_ns|users_and_guests_susp|users_and_guests_ns_susp)|
|
|
(user <UserItem>)|
|
|
(users <UserList>)|
|
|
(oauthuser)
|
|
(domains|domains_na|domains_arch|domains_ns|domains_susp|domains_na_ns <DomainNameListList>)|
|
|
(group|group_na|group_arch|group_ns|group_susp|group_na_ns|group_inde <GroupItem>)|
|
|
(groups|groups_na|groups_arch|groups_ns|groups_susp|groups_na_ns|groups_inde <GroupList>)|
|
|
(group_inde <GroupItem>)|(groups_inde <GroupList>)|
|
|
(group_users|group_users_na|group_users_arch|group_users_ns|group_users_susp|group_users_na_ns <GroupList>
|
|
[members] [managers] [owners]
|
|
[primarydomain] [domains <DomainNameList>] [recursive|includederivedmembership] end)|
|
|
(group_users_select <GroupList>
|
|
[members] [managers] [owners]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[primarydomain] [domains <DomainNameList>] [recursive|includederivedmembership] end)|
|
|
(ou|ou_na|ou_arch|ou_ns|ou_susp|ou_na_ns <OrgUnitItem>)|
|
|
(ou_and_children|ou_and_children_na|ou_and_children_arch|ou_and_children_ns|ou_and_children_susp|ou_and_children_na_ns <OrgUnitItem>)|
|
|
(ous|ous_na|ous_arch|ous_ns|ous_susp|ous_na_ns <OrgUnitList>)|
|
|
(ous_and_children|ous_and_children_na|ous_and_children_arch|ous_and_children_ns|ous_and_children_susp|ous_and_children_na_ns <OrgUnitList>)|
|
|
(courseparticipants <CourseIDList>)|
|
|
(students <CourseIDList>)|
|
|
(teachers <CourseIDList>)|
|
|
(license|licenses|licence|licences <SKUIDList>)|
|
|
(query <QueryUser>)|
|
|
(queries <QueryUserList>)|
|
|
(file
|
|
((<FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[delimiter <Character>])|
|
|
(csvfile
|
|
((<FileName>(:<FieldName>)+ [charset <Charset>] )|
|
|
(gsheet(:<FieldName>)+ <UserGoogleSheet>)|
|
|
(gdoc(:<FieldName>)+ <UserGoogleDoc>)|
|
|
(gcscsv(:<FieldName>)+ <StorageBucketObjectName>)|
|
|
(gcsdoc(:<FieldName>)+ <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[delimiter <Character>])|
|
|
(datafile
|
|
users|
|
|
groups|groups_na|groups_arch|groups_ns|groups_susp|groups_na_ns|groups_inde|
|
|
ous|ous_na|ous_arch|ous_ns|ous_susps|ous_na_ns|
|
|
ous_and_children|ous_and_children_na|ous_and_children_arch|ous_and_children_ns|ous_and_children_susp|ous_and_children_na_ns|
|
|
courseparticipants|students|teachers
|
|
((<FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[delimiter <Character>])|
|
|
(csvdatafile
|
|
users|
|
|
groups|groups_na|groups_arch|groups_ns|groups_susp|groups_na_ns|groups_inde|
|
|
ous|ous_na|ous_arch|ous_ns|ous_susps|ous_na_ns|
|
|
ous_and_children|ous_and_children_na|ous_and_children_arch|ous_and_children_ns|ous_and_children_susp|ous_and_children_na_ns|
|
|
courseparticipants|students|teachers
|
|
((<FileName>(:<FieldName>)+ [charset <Charset>] )|
|
|
(gsheet(:<FieldName>)+ <UserGoogleSheet>)|
|
|
(gdoc(:<FieldName>)+ <UserGoogleDoc>)|
|
|
(gcscsv(:<FieldName>)+ <StorageBucketObjectName>)|
|
|
(gcsdoc(:<FieldName>)+ <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[delimiter <Character>])|
|
|
(csvkmd
|
|
users|
|
|
groups|groups_na|groups_arch|groups_ns|groups_susp|groups_na_ns|groups_inde|
|
|
ous|ous_na|ous_arch|ous_ns|ous_susps|ous_na_ns|
|
|
ous_and_children|ous_and_children_na|ous_and_children_arch|ous_and_children_ns|ous_and_children_susp|ous_and_children_na_ns|
|
|
courseparticipants|students|teachers
|
|
((<FileName>|
|
|
(gsheet <UserGoogleSheet>)|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcscsv <StorageBucketObjectName>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[charset <Charset>] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>] [fields <FieldNameList>])
|
|
keyfield <FieldName> [keypattern <RESearchPattern>] [keyvalue <RESubstitution>] [delimiter <Character>]
|
|
subkeyfield <FieldName> [keypattern <RESearchPattern>] [keyvalue <RESubstitution>] [delimiter <Character>]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[datafield <FieldName>(:<FieldName>)* [delimiter <Character>]])
|
|
(csvdata <FieldName>(:<FieldName>*))
|
|
|
|
## Collections of Items
|
|
|
|
Specify a collection of items by directly specifying them; the item type is determined by context.
|
|
|
|
<CSVFileInput> ::=
|
|
((<FileName> [charset <Charset>] )|
|
|
(gsheet <UserGoogleSheet>)|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcscsv <StorageBucketObjectName>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
|
|
<FileSelector> ::=
|
|
file ((<FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[delimiter <Character>]
|
|
|
|
<CSVFileSelector> ::=
|
|
csvfile
|
|
((<FileName>(:<FieldName>)+ [charset <Charset>] )|
|
|
(gsheet(:<FieldName>)+ <UserGoogleSheet>)|
|
|
(gdoc(:<FieldName>)+ <UserGoogleDoc>)|
|
|
(gcscsv(:<FieldName>)+ <StorageBucketObjectName>)|
|
|
(gcsdoc(:<FieldName>)+ <StorageBucketObjectName>))
|
|
[warnifnodata] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[endcsv|(fields <FieldNameList>)]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[delimiter <Character>]
|
|
|
|
<CSVkmdSelector> ::=
|
|
csvkmd
|
|
users|
|
|
groups|groups_na|groups_arch|groups_ns|groups_susp|groups_inde|
|
|
ous|ous_na|ous_arch|ous_ns|ous_susp|
|
|
ous_and_children|ous_and_children_na|ous_and_children_arch|ous_and_children_ns|ous_and_children_susp|
|
|
courseparticipants|students|teachers
|
|
((<FileName>|
|
|
(gsheet <UserGoogleSheet>)|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcscsv <StorageBucketObjectName>)|
|
|
(gcsdoc <StorageBucketObjectName>))
|
|
[charset <Charset>] [columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>] [fields <FieldNameList>])
|
|
keyfield <FieldName> [keypattern <RESearchPattern>] [keyvalue <String>] [delimiter <Character>]
|
|
subkeyfield <FieldName> [keypattern <RESearchPattern>] [keyvalue <String>] [delimiter <Character>]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)*
|
|
[datafield <FieldName>(:<FieldName>)* [delimiter <Character>]]
|
|
<CSVSubkeySelector> ::= csvsubkey <FieldName>
|
|
<CSVDataSelector> ::= csvdata <FieldName>(:<FieldName>)*
|
|
|
|
## Named collections
|
|
|
|
<BrowserEntity> ::=
|
|
<DeviceIDList> |
|
|
(query:<QueryBrowser>)|(query:orgunitpath:<OrgUnitPath>)|(query <QueryBrowser>) |
|
|
(browserou <OrgUnitItem>) | (browserous <OrgUnitList>) |
|
|
<FileSelector> | <CSVFileSelector>
|
|
<CalendarACLScopeEntity> ::=
|
|
<CalendarACLScopeList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<CalendarEntity> ::=
|
|
<CalendarList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<ChromeProfileNameEntity> ::=
|
|
<ChromeProfileNameList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
(filter <String> (filtertime<String> <Time>)* [orderby <ChromeProfileOrderByFieldName> [ascending|descending]]) |
|
|
(commands <ChromeProfileCommandNameList>|<FileSelector>|<CSVFileSelector>)
|
|
<CIPolicyNameEntity> ::=
|
|
<CIPolicyNameList> | <FileSelector> | <CSVFileSelector>
|
|
<ClassificationLabelNameEntity> ::=
|
|
<ClassificationLabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
|
<ClassificationLabelPermissionNameEntity> ::=
|
|
<ClassificationLabelPermissionNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
|
<ClassroomInvitationIDEntity> ::=
|
|
<ClassroomInvitationIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<ContactEntity> ::=
|
|
<ContactIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<ContactGroupEntity> ::=
|
|
<ContactGroupList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<CourseAliasEntity> ::=
|
|
<CourseAliasList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<CourseEntity> ::=
|
|
<CourseIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector>
|
|
<CourseAnnouncementIDEntity> ::=
|
|
<CourseAnnouncementIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>
|
|
<CourseSubmissionIDEntity> ::=
|
|
<CourseSubmissionIDList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
|
<CourseTopicIDEntity> ::=
|
|
<CourseTopicIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>
|
|
<CourseWorkIDEntity> ::=
|
|
<CourseWorkIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>
|
|
<CourseMaterialIDEntity> ::=
|
|
<CourseMaterialIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>
|
|
<CrOSEntity> ::=
|
|
<CrOSIDList> | (cros_sn <SerialNumberList>) |
|
|
(query:<QueryCrOS>) | (query:orgunitpath:<OrgUnitPath>) | (query <QueryCrOS>)
|
|
<DeviceIDEntity> ::=
|
|
<DeviceIDList> | (device_sn <SerialNumber>)
|
|
(query:<QueryDevice>) | (query <QueryDevice>)
|
|
<DeviceFileEntity> ::=
|
|
<TimeList> |
|
|
(first|last|allexceptfirst|allexceptlast <Number>) |
|
|
(before|after <Time>) | (range <Time> <Time>) |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<DomainNameEntity> ::=
|
|
<DomainNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<DriveFileIDEntity> ::=
|
|
<DriveFileItem> |
|
|
(id <DriveFileItem>) | (id:<DriveFileItem>) |
|
|
(ids <DriveFileList>) | (ids:<DriveFileList>)
|
|
<DriveFileNameEntity> ::=
|
|
(anyname <DriveFileName>) | (anyname:<DriveFileName>) |
|
|
(anydrivefilename <DriveFileName>) | (anydrivefilename:<DriveFileName>) |
|
|
(name <DriveFileName>) | (name:<DriveFileName>) |
|
|
(drivefilename <DriveFileName>) | (drivefilename:<DriveFileName>) |
|
|
(othername <DriveFileName>) | (othername:<DriveFileName>) |
|
|
(otherdrivefilename <DriveFileName>) | (otherdrivefilename:<DriveFileName>)
|
|
<DriveFileQueryEntity> ::=
|
|
(query <QueryDriveFile>) | (query:<QueryDriveFile>) |
|
|
(fullquery <QueryDriveFile>)
|
|
<DriveFileQueryShortcut> ::=
|
|
all_files |
|
|
all_folders |
|
|
all_forms |
|
|
all_google_files |
|
|
all_non_google_files |
|
|
all_shortcuts |
|
|
all_3p_shortcuts |
|
|
all_items |
|
|
my_commentable_items |
|
|
my_docs |
|
|
my_files |
|
|
my_folders |
|
|
my_forms |
|
|
my_google_files |
|
|
my_non_google_files |
|
|
my_presentations |
|
|
my_publishable_items |
|
|
my_sheets |
|
|
my_shortcuts |
|
|
my_slides |
|
|
my_3p_shortcuts |
|
|
my_items |
|
|
my_top_files |
|
|
my_top_folders |
|
|
my_top_items |
|
|
others_files |
|
|
others_folders |
|
|
others_forms |
|
|
others_google_files |
|
|
others_non_google_files |
|
|
others_shortcuts |
|
|
others_3p_shortcuts |
|
|
others_items |
|
|
writable_files
|
|
|
|
<DriveFileEntityShortcut> ::=
|
|
alldrives |
|
|
mydrive_any |
|
|
mydrive_me |
|
|
mydrive_others |
|
|
onlyteamdrives|onlyshareddrives |
|
|
orphans |
|
|
ownedby_any |
|
|
ownedby_me |
|
|
ownedby_others |
|
|
root | mydrive |
|
|
rootwithorphans|mydrivewithorphans |
|
|
sharedwithme_all |
|
|
sharedwithme_mydrive |
|
|
sharedwithme_notmydrive
|
|
|
|
<DriveFileEntity> ::=
|
|
<DriveFileIDEntity> |
|
|
<DriveFileNameEntity> |
|
|
<DriveFileQueryEntity> |
|
|
<DriveFileQueryShortcut> |
|
|
mydrive | mydriveid |
|
|
root | rootid |
|
|
<SharedDriveIDEntity> [<SharedDriveFileQueryShortcut>] |
|
|
<SharedDriveNameEntity> [<SharedDriveFileQueryShortcut>] |
|
|
<SharedDriveFileNameEntity> |
|
|
<SharedDriveFileQueryEntity> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
|
<DriveFilePermissionEntity> ::=
|
|
<DriveFilePermissionList> |
|
|
<JSONData> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<DriveFilePermissionIDEntity> ::=
|
|
<DriveFilePermissionIDList> |
|
|
<JSONData> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<DriveFileRevisionIDEntity> ::=
|
|
(<DriveFileRevisionID>) | (id[ |:]<DriveFileRevisionID>) (ids[ |:]<DriveFileRevisionIDList>)
|
|
(first|last|allexceptfirst|allexceptlast <Number>)|
|
|
(before|after <Time>) | (range <Time> <Time>)|
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<EmailAddressEntity> ::=
|
|
<EmailAddressList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<FilterIDEntity> ::=
|
|
<FilterIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<EventIDEntity> ::=
|
|
(id|eventid <EventId>) |
|
|
(event|events <EventIdList> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
|
<GroupEntity> ::=
|
|
<GroupList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<GuardianEntity> ::=
|
|
<GuardianList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<GuardianInvitationIDEntity> ::=
|
|
<GuardianInvitationIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<LabelIDEntity> ::=
|
|
<LabelIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<LabelNameEntity> ::=
|
|
<LabelNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<LookerStudioAssetIDEntity> ::=
|
|
<LookerStudioAssetIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<LookerStudioPermissionEntity> ::=
|
|
<LookerStudioPermissionList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<MessageIDEntity> ::=
|
|
<MessageIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<MobileEntity> ::=
|
|
<ResourceIDList> |
|
|
(query:<QueryMobile>) | (query <QueryMobile>)
|
|
<NotesNameEntity> ::=
|
|
<NotesNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<OrgUnitEntity> ::=
|
|
<OrgUnitList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector>
|
|
<OtherContactsResourceNameEntity> ::=
|
|
<OtherContactsResourceNameNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
|
<PeopleResourceNameEntity> ::=
|
|
<PeopleResourceNameList> | <FileSelector> | <CSVFileSelector> | <CSVDataSelector>
|
|
<ProjectIDEntity> ::=
|
|
current | gam | <ProjectID> | (filter <String>) |
|
|
(select <ProjectIDList> | <FileSelector> | <CSVFileSelector>)
|
|
<PrinterIDEntity> ::=
|
|
<PrinterIDList> | <FileSelector> | <CSVFileSelector>
|
|
<RecipientEntity> ::=
|
|
<EmailAddressEntity> | (select <UserTypeEntity>)
|
|
<ResourceEntity> ::=
|
|
<ResourceIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector>
|
|
<SchemaEntity> ::=
|
|
<SchemaNameList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector>
|
|
<SerialNumberEntity> ::=
|
|
<SerialNumberList> | <FileSelector> | <CSVFileSelector>
|
|
<SharedDriveIDEntity> ::=
|
|
<DriveFileItem> |
|
|
(teamdriveid <DriveFileItem>) | (teamdriveid:<DriveFileItem>)
|
|
<SharedDriveNameEntity> ::=
|
|
(teamdrive <SharedDriveName>) | (teamdrive:<SharedDriveName>)
|
|
<SharedDriveEntity> ::=
|
|
<SharedDriveIDEntity> |
|
|
<SharedDriveNameEntity>
|
|
<SharedDriveAdminQueryEntity> ::=
|
|
(teamdriveadminquery <QueryTeamDrive>) | (teamdriveadminquery:<QueryTeamDrive>)
|
|
<SharedDriveEntityAdmin> ::=
|
|
<SharedDriveIDEntity> |
|
|
<SharedDriveNameEntity>|
|
|
<SharedDriveAdminQueryEntity>
|
|
<SharedDriveFileNameEntity> ::=
|
|
(teamdrivefilename <DriveFileName>) | (teamdrivefilename:<DriveFileName>)
|
|
<SharedDriveFileQueryEntity> ::=
|
|
(teamdrivequery <QueryDriveFile>) | (teamdrivequery:<QueryDriveFile>)
|
|
<SharedDriveFileQueryShortcut> ::=
|
|
all_files | all_folders | all_google_files | all_non_google_files | all_items
|
|
<SiteACLScopeEntity> ::=
|
|
<SiteACLScopeList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<SiteEntity> ::=
|
|
<SiteList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<StringEntity> ::=
|
|
<StringList> | <FileSelector> | <CSVFileSelector>
|
|
<StudentGroupEntity> ::=
|
|
<StudentGroupIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector>
|
|
<TagManagerAccountPathEntity> ::=
|
|
<TagManagerAccountPathList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
<TagManagerContainerPathEntity> ::=
|
|
<TagManagerContainerPathList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
<TagManagerWorkspacePathEntity> ::=
|
|
<TagManagerWorkspacePathList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
<TasklistEntity> ::=
|
|
<TasklistIDList> | <TaskListTitleList> | <FileSelector> | <CSVFileSelector>
|
|
<TasklistIDTaskIDEntity> ::=
|
|
<TasklistIDTaskIDList> | <FileSelector> | <CSVFileSelector>
|
|
<ThreadIDEntity> ::=
|
|
<ThreadIDList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
<UserEntity> ::=
|
|
<UserList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
# Meta Commands
|
|
|
|
## Select a section from gam.cfg and process a GAM command using values from that section
|
|
<Select> ::=
|
|
select <Section> [save] [verify [variables <RESearchPattern>]]
|
|
save
|
|
Set section = <Section> in the [DEFAULT] section and write configuration data to gam.cfg
|
|
verify
|
|
Print the variable values for the selected section
|
|
Use `variables <RESearchPattern>` to display variables with names selected by `<RESearchPattern>`
|
|
Values are determined in this order: Selected section, DEFAULT section, Program default
|
|
|
|
## Display all of the sections in gam.cfg and mark the currently selected section with a *.
|
|
showsections
|
|
|
|
## Select an output filter section from gam.cfg and process a GAM command using values from that section
|
|
The only <VariableName>s recognized in this <Section> are: csv_output_header_filter, csv_output_header_drop_filter,
|
|
csv_output_row_filter, csv_output_row_filter_mode, csv_output_row_drop_filter, csv_output_row_drop_filter_mode
|
|
and csv_output_row_limit.
|
|
|
|
<SelectOutputFilter> ::=
|
|
selectfilter|selectoutputfilter <Section>
|
|
|
|
## Select an input filter section from gam.cfg and process a GAM command using values from that section
|
|
The only <VariableName>s recognized in this <Section> are: csv_input_row_filter, csv_input_row_filter_mode,
|
|
csv_input_row_drop_filter, csv_input_row_drop_filter_mode and csv_input_row_limit.
|
|
|
|
<SelectInputFilter> ::=
|
|
selectinputfilter <Section>
|
|
|
|
## Set variables in gam.cfg.
|
|
|
|
<Config> ::=
|
|
config (<VariableName> [=] <Value>)* [save] [verify [variables <RESearchPattern>]]
|
|
<VariableName> [=] <Value>
|
|
Set <VariableName> = <Value> in the current section
|
|
All <VariableNames> except section are allowed.
|
|
The = is optional but must be surrounded by spaces if included.
|
|
save
|
|
Write configuration data to gam.cfg
|
|
verify
|
|
Print the variable values for the current section
|
|
Use `variables <RESearchPattern>` to display variables with names selected by `<RESearchPattern>`.
|
|
Values are determined in this order: Current section, DEFAULT section, Program default
|
|
|
|
## Terminate processing of a CSV or batch file when one of the subprocesses returns a matching return code.
|
|
```
|
|
<Operator> ::= <|<=|>=|>|=|!=
|
|
|
|
<ReturnCodeSelection> ::=
|
|
rc<Operator><Number>|
|
|
rcrange=<Number>/<Number>|
|
|
rcrange!=<Number>/<Number>
|
|
```
|
|
|
|
<MultiProcessExit> :=
|
|
multiprocessexit <ReturnCodeSelection>
|
|
```
|
|
|
|
## File Redirection
|
|
|
|
If the pattern {{Section}} appears in <FileName>, it will be replaced with the name of the current section.
|
|
|
|
For redirect csv, the optional arguments can be specfified in any order but `todrive <ToDriveAttribute>*`
|
|
must be last.
|
|
|
|
<Redirect> ::=
|
|
redirect csv <FileName> [delayopen] multiprocess] [append] [noheader] [charset <Charset>]
|
|
[columndelimiter <Character>] [quotechar <Character>] [noescapechar [<Boolean>]]
|
|
[sortheaders <StringList>] [timestampcolumn <String>] [transpose [<Bopolean>]]
|
|
[todrive <ToDriveAttribute>*] |
|
|
redirect stdout <FileName> [multiprocess] [append] |
|
|
redirect stdout null [multiprocess] |
|
|
redirect stderr <FileName> [multiprocess] [append] |
|
|
redirect stderr null [multiprocess] |
|
|
redirect stderr stdout [multiprocess]
|
|
|
|
<Select> <SelectInputFilter> <SelectOutputFilter> <Config> <Redirect> must come before all other arguments and in this order, ... indicates that additional GAM arguments may appear.
|
|
|
|
gam [<Select>] [<SelectFInputFilter>] [<SelectOutputilter>] [<Config>] [<Redirect>] ...
|
|
|
|
<Select> <SelectInputFilter> <SelectOutputFilter> <Config> <Redirect>] will not be shown in the following command descriptions but can be used with any Gam command.
|
|
|
|
# Check connection to Google
|
|
gam checkconnection
|
|
|
|
# Comment
|
|
gam comment <String>*
|
|
|
|
# Version and Help
|
|
|
|
gam version [check|checkrc|simple|extended] [timeoffset] [location <HostName>]
|
|
gam help
|
|
|
|
# Bulk Processing
|
|
|
|
<BatchContent> ::=
|
|
(<FileName> [charset <Charset>])|
|
|
(- [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>)
|
|
|
|
gam batch <BatchContent> [showcmds [<Boolean>]]
|
|
gam tbatch <BatchContent> [showcmds [<Boolean>]]
|
|
|
|
<CSVLoopContent> ::=
|
|
(((<FileName> [charset <Charset>])|
|
|
(- [charset <Charset>])|
|
|
(gsheet <UserGoogleSheet>)|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>)|
|
|
(gcscsv <StorageBucketObjectName>))
|
|
[charset <Charset>] [delimiter <Character>])
|
|
|
|
gam csv <CSVLoopContent> [warnifnodata]
|
|
[columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>] [fields <FieldNameList>]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)* [showcmds [<Boolean>]]
|
|
[skiprows <Integer>] [maxrows <Integer>]
|
|
gam <GAMArgumentList>
|
|
|
|
gam loop <CSVLoopContent> [warnifnodata]
|
|
[columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>] [fields <FieldNameList>]
|
|
(matchfield|skipfield <FieldName> <RESearchPattern>)* [showcmds [<Boolean>]]
|
|
[skiprows <Integer>] [maxrows <Integer>]
|
|
gam <GAMArgumentList>
|
|
|
|
You can make substitutions in <GAMArgumentList> with values from the CSV file.
|
|
An argument containing exactly ~xxx is replaced by the value of field xxx from the CSV file
|
|
An argument containing instances of ~~xxx~~ has xxx replaced by the value of field xxx from the CSV file
|
|
An argument containing instances of ~~xxx~!~pattern~!~replacement~~ has ~~...~~ replaced by re.sub(pattern, replacement, value of field xxx from the CSV file)
|
|
|
|
Example: gam csv Users.csv gam update user "~primaryEmail" address type work unstructured "~~Street~~, ~~City~~, ~~State~~ ~~ZIP~~" primary note text_plain "~~primaryEmail~!~^(.+)@(.+)$~!~\1 AT \2~~"
|
|
Each user (~primaryEmail, e.g. foo@bar.com) would have their work address updated and a note that shows their email address as foo AT bar.com
|
|
|
|
gam list [todrive <ToDriveAttribute>*] <EntityList> [data <CrOSTypeEntity>|<UserTypeEntity> [delimiter <Character>]]
|
|
gam <CrOSTypeEntity>|<UserTypeEntity> list [todrive <ToDriveAttribute>*] [data <EntityList> [delimiter <Character>]]
|
|
|
|
# Addresses
|
|
|
|
gam print addresses [todrive <ToDriveAttribute>*]
|
|
[domain <DomainName>]
|
|
|
|
# Authorization
|
|
|
|
gam info gcporgid
|
|
|
|
gam create gcpfolder <String>
|
|
gam create gcpfolder [admin <EmailAddress>] folder <String>
|
|
|
|
gam create|add project [<EmailAddress>] [<ProjectID>]
|
|
gam create project [admin <EmailAddress>] [project <ProjectID>]
|
|
[appname <String>] [supportemail <EmailAddress>]
|
|
[projectname <ProjectName>] [parent <String>]
|
|
[saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
|
|
[sadescription <ServiceAccountDescription>]
|
|
[(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)|
|
|
nokey]
|
|
gam use project [<EmailAddress>] [<ProjectID>]
|
|
gam use project [admin <EmailAddress>] [project <ProjectID>]
|
|
[appname <String>] [supportemail <EmailAddress>]
|
|
[saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
|
|
[sadescription <ServiceAccountDescription>]
|
|
[(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)]
|
|
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 info currentprojectid
|
|
|
|
gam create|add svcacct [[admin] <EmailAddress>] [<ProjectIDEntity>]
|
|
[saname <ServiceAccountName>] [sadisplayname <ServiceAccountDisplayName>]
|
|
[sadescription <ServiceAccountDescription>]
|
|
[(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)]
|
|
gam delete svcacct [[admin] <EmailAddress>] [<ProjectIDEntity>]
|
|
(saemail <ServiceAccountEmail>)|(saname <ServiceAccountName>)|(sauniqueid <ServiceAccountUniqueID>)
|
|
gam check svcacct <UserTypeEntity> (scope|scopes <APIScopeURLList>)*
|
|
gam update svcacct <UserTypeEntity> (scope|scopes <APIScopeURLList>)*
|
|
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>]]
|
|
|
|
gam create sakey
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
gam rotate sakey|sakeys retain_existing
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
|
|
gam update sakey
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
gam rotate sakey|sakeys replace_current
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
|
|
gam replace sakeys
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
gam rotate sakey|sakeys retain_none
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
|
|
gam upload sakey [admin <EmailAddress>]
|
|
(algorithm KEY_ALG_RSA_1024|KEY_ALG_RSA_2048)|
|
|
(localkeysize 1024|2048|4096 [validityhours <Number>])|
|
|
(yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>)
|
|
|
|
gam delete sakeys <ServiceAccountKeyList>+ [doit]
|
|
gam show sakeys [all|system|user]
|
|
|
|
gam yubikey resetpvi [yubikey_serialnumber <Number>]
|
|
gam rotate sakey yubikey yubikey_pin yubikey_slot AUTHENTICATION|SIGNATURE yubikey_serialnumber <Number>
|
|
|
|
gam create [gcpserviceaccount|signjwtserviceaccount]
|
|
gam enable apis [auto|manual]
|
|
|
|
gam oauth|oauth2 create|request [<EmailAddress>]
|
|
gam oauth|oauth2 create|request [admin <EmailAddress>] [scopes <APIScopeURLList>]
|
|
gam oauth|oauth2 update [<EmailAddress>]
|
|
gam oauth|oauth2 update [admin <EmailAddress>]
|
|
gam oauth|oauth2 delete|revoke
|
|
gam oauth|oauth2 export [<FileName>]
|
|
gam oauth|oauth2 refresh
|
|
gam oauth|oauth2 info|verify [showsecret] [accesstoken <AccessToken> idtoken <IDToken>] [showdetails]
|
|
|
|
gam <UserTypeEntity> check serviceaccount (scope|scopes <APIScopeURLList>)*
|
|
gam <UserTypeEntity> update serviceaccount (scope|scopes <APIScopeURLList>)*
|
|
|
|
# Administrators
|
|
|
|
gam print privileges [todrive <ToDriveAttribute>*]
|
|
gam show privileges
|
|
|
|
<Privilege> ::= <String>
|
|
<PrivilegeList> ::= "<Privilege>(,<Privilege)*"
|
|
<RoleAssignmentID> ::= <String>
|
|
<RoleItem> ::= id:<String>|uid:<string>|<String>
|
|
|
|
gam create adminrole <String> [description <String>]
|
|
privileges all|all_ou|<PrivilegeList>|(select <FileSelector>|<CSVFileSelector>)|<JSONData>
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]] (addcsvdata <FieldName> <String>)*]
|
|
gam update adminrole <RoleItem> [name <String>] [description <String>]
|
|
[privileges all|all_ou|<PrivilegeList>|(select <FileSelector>|<CSVFileSelector>)|<JSONData>]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]] (addcsvdata <FieldName> <String>)*]
|
|
gam delete adminrole <RoleItem>
|
|
gam info adminrole <RoleItem> [privileges]
|
|
[formatjson]
|
|
gam print adminroles|roles [todrive <ToDriveAttribute>*]
|
|
[role <RoleItem>] [privileges] [oneitemperrow]
|
|
[nosystemroles]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show adminroles|roles
|
|
[role <RoleItem>] [privileges]
|
|
[nosystemroles]
|
|
[formatjson]
|
|
|
|
gam create|add admin <EmailAddress>|<UniqueID> <RoleItem> customer|(org_unit <OrgUnitItem>)
|
|
[condition securitygroup|nonsecuritygroup]
|
|
gam delete admin <RoleAssignmentId>
|
|
|
|
<AdminAssigneeType> ::= group|user|serviceaccount|unknown
|
|
<AdminAssigneeTypeList> ::= "<AdminAssigneeType>(,<AdminAssigneeType>)*"
|
|
|
|
gam print admins [todrive <ToDriveAttribute>*]
|
|
[user|group <EmailAddress>|<UniqueID>] [role <RoleItem>]
|
|
[types <AdminAssigneeTypeList>]
|
|
[recursive] [condition] [privileges] [oneitemperrow]
|
|
gam show admins
|
|
[user|group <EmailAddress>|<UniqueID>] [role <RoleItem>]
|
|
[types <AdminAssigneeTypeList>]
|
|
[recursive] [condition] [privileges]
|
|
|
|
# Alert Center
|
|
|
|
gam show alertsettings
|
|
gam update alertsettings <PubsubTopicName>
|
|
gam clear alertsettings
|
|
|
|
gam delete alert <AlertID>
|
|
gam undelete alert <AlertID>
|
|
gam info alert <AlertID> [formatjson]
|
|
gam show alerts [filter <QueryAlert>] [orderby createtime [ascending|descending]]
|
|
[formatjson]
|
|
gam print alerts [todrive <ToDriveAttribute>*] [filter <QueryAlert>] [orderby createtime [ascending|descending]]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam create alertfeedback <AlertID> not_useful|somewhat_useful|very_useful
|
|
gam show alertfeedback [alert <AlertID>] [filter <QueryAlert>] [orderby createtime [ascending|descending]]
|
|
[formatjson]
|
|
gam print alertfeedback [todrive <ToDriveAttribute>*] [alert <AlertID>] [filter <QueryAlert>] [orderby createtime [ascending|descending]]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Aliases
|
|
|
|
gam create|add alias|aliases <EmailAddressEntity> user|group|target <UniqueID>|<EmailAddress>
|
|
[verifynotinvitable]
|
|
gam update alias|aliases <EmailAddressEntity> user|group|target <UniqueID>|<EmailAddress>
|
|
[notargetverify] [waitafterdelete <Integer>]
|
|
gam delete alias|aliases [user|group|target] <EmailAddressEntity>
|
|
gam remove aliases|nicknames <EmailAddress> user|group <EmailAddressEntity>
|
|
gam <UserTypeEntity> delete alias|aliases
|
|
|
|
gam info alias|aliases <EmailAddressEntity>
|
|
|
|
gam print alias|aliases [todrive <ToDriveAttribute>*]
|
|
([domain|domains <DomainNameEntity>] [(query <QueryUser>)|(queries <QueryUserList>)]
|
|
[limittoou <OrgUnitItem>])
|
|
[user|users <EmailAddressList>] [group|groups <EmailAddressList>]
|
|
[select <UserTypeEntity>]
|
|
[issuspended <Boolean>] [isarchived <Boolean>] [aliasmatchpattern <REMatchPattern>]
|
|
[shownoneditable] [nogroups] [nousers]
|
|
[onerowpertarget] [delimiter <Character>]
|
|
[suppressnoaliasrows]
|
|
(addcsvdata <FieldName> <String>)*
|
|
|
|
gam whatis <EmailItem> [noinfo] [noinivitablecheck]
|
|
|
|
# Analytics Admin
|
|
|
|
gam <UserTypeEntity> print analyticaccounts [todrive <ToDriveAttribute>*]
|
|
[maxresults <Number>] [showdeleted [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show analyticaccounts
|
|
[maxresults <Number>] [showdeleted [<Boolean>]]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print analyticaccountsummaries [todrive <ToDriveAttribute>*]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show analyticaccountsummaries
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print analyticproperties [todrive <ToDriveAttribute>*]
|
|
filter <String>
|
|
[maxresults <Number>] [showdeleted [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show analyticproperties
|
|
filter <String>
|
|
[maxresults <Number>] [showdeleted [<Boolean>]]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print analyticdatastreams [todrive <ToDriveAttribute>*]
|
|
parent <String>
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show analyticdatastreams
|
|
parent <String>
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
# Calendars
|
|
|
|
<CalendarEntity> ::=
|
|
<CalendarList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
<CalendarACLRole> ::= editor|freebusy|freebusyreader|owner|reader|writer|none
|
|
<CalendarACLScope> ::= <EmailAddress>|user:<EmailAdress>|group:<EmailAddress>|domain:<DomainName>|domain|default
|
|
<CalendarACLScopeList> ::= "<CalendarACLScope>(,<CalendarACLScope>)*"
|
|
<CalendarACLScopeEntity> ::=
|
|
<CalendarACLScopeList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
gam calendars <CalendarEntity> create|add acls|calendaracls <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam calendars <CalendarEntity> update acls|calendaracls <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam calendars <CalendarEntity> delete acls|calendaracls [<CalendarACLRole>] <CalendarACLScopeEntity>
|
|
gam calendars <CalendarEntity> info acls|calendaracls <CalendarACLScopeEntity>
|
|
[formatjson]
|
|
|
|
gam calendars <CalendarEntity> show acls|calendaracls
|
|
[noselfowner]
|
|
[formatjson]
|
|
gam calendars <CalendarEntity> print acls|calendaracls [todrive <ToDriveAttribute>*]
|
|
[noselfowner] (addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam calendar <CalendarEntity> create|add <CalendarACLRole> ([user] <EmailAddress>)|(group <EmailAddress>)|(domain [<DomainName>])|default [sendnotifications <Boolean>]
|
|
gam calendar <CalendarEntity> update <CalendarACLRole> ([user] <EmailAddress>)|(group <EmailAddress>)|(domain [<DomainName>])|default [sendnotifications <Boolean>]
|
|
gam calendar <CalendarEntity> delete [<CalendarACLRole>] ([user] <EmailAddress>)|(group <EmailAddress>)|(domain [<DomainName>])|default
|
|
gam calendar <CalendarEntity> showacl
|
|
[noselfowner]
|
|
[formatjson]
|
|
gam calendar <CalendarEntity> printacl [todrive <ToDriveAttribute>*]
|
|
[noselfowner] (addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<AttendeeAttendance> ::= optional|required
|
|
<AttendeeStatus> ::= accepted|declined|needsaction|tentative
|
|
|
|
<EventType> ::=
|
|
birthday|
|
|
default|
|
|
focustime|
|
|
fromgmail|
|
|
outofoffice|
|
|
workinglocation
|
|
<EventTypeList> ::= "<EventType>(,<EventType>)*"
|
|
|
|
<EventSelectProperty> ::=
|
|
(after|starttime|timemin <Time>)|
|
|
(before|endtime|timemax <Time>)|
|
|
(eventtypes <EventTypeList>)|
|
|
(query <QueryCalendar>)|
|
|
(privateextendedproperty <String>)|
|
|
(sharedextendedproperty <Syting>)|
|
|
showdeletedevents|
|
|
showhiddeninvitations|
|
|
singleevents|
|
|
(updatedmin <Time>)
|
|
|
|
<EventMatchProperty> ::=
|
|
(matchfield attendees <EmailAddressEntity>)|
|
|
(matchfield attendeesorganizer <Boolean> <EmailAddressEntity>)|
|
|
(matchfield attendeesonlydomainlist <DomainNameList>)|
|
|
(matchfield attendeesdomainlist <DomainNameList>)|
|
|
(matchfield attendeesnotdomainlist <DomainNameList>)|
|
|
(matchfield attendeespattern <RESearchPattern>)|
|
|
(matchfield attendeesstatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddressEntity>)|
|
|
(matchfield creatoremail <RESearchPattern>)|
|
|
(matchfield creatorname <RESearchPattern>)|
|
|
(matchfield description <RESearchPattern>)|
|
|
(matchfield hangoutlink <RESearchPattern>)|
|
|
(matchfield location <RESearchPattern>)|
|
|
(matchfield organizeremail <RESearchPattern>)|
|
|
(matchfield organizername <RESearchPattern>)|
|
|
(matchfield organizerself <Boolean>)|
|
|
(matchfield status <RESearchPattern>)|
|
|
(matchfield summary <RESearchPattern>)|
|
|
(matchfield transparency <RESearchPattern>)|
|
|
(matchfield visibility <RESearchPattern>)
|
|
|
|
<EventIDEntity> ::=
|
|
(id|eventid <EventId>) |
|
|
(event|events <EventIdList> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
|
|
|
<EventSelectEntity> ::=
|
|
(<EventSelectProperty>+ <EventMatchProperty>*)
|
|
|
|
<EventEntity> ::=
|
|
<EventIDEntity> | <EventSelectEntity>
|
|
|
|
<AttendeeAttendance> ::= optional|required
|
|
<AttendeeStatus> ::= accepted|declined|needsaction|tentative
|
|
|
|
<EventAttribute> ::=
|
|
(allday <Date>)|
|
|
(anyonecanaddself [<Boolean>])|
|
|
(attachment <String> <URL>)|
|
|
(attendee <EmailAddress>)|
|
|
(attendeestatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddress>)|
|
|
available|
|
|
(birthday <Date>)|
|
|
(color <EventColorName>)|
|
|
(colorindex|colorid <EventColorIndex>)|
|
|
(conferencedata meet <MeetID>)|
|
|
(description <String>)|
|
|
(end|endtime (allday <Date>)|<Time>)|
|
|
(guestscaninviteothers <Boolean>)|
|
|
guestscantinviteothers|
|
|
(guestscanmodify <Boolean>)|
|
|
(guestscanseeotherguests <Boolean>)|
|
|
guestscantseeotherguests|
|
|
googlemeet|hangoutsmeet|
|
|
<JSONData>|
|
|
(jsonattendees [charset <Charset>] <String>)|
|
|
(jsonattendees file <FileName> [charset <Charset>])|
|
|
(location <String>)|
|
|
(noreminders|(reminder email|popup <Number>))|
|
|
(optionalattendee <EmailAddress>)|
|
|
(originalstart|originalstarttime (allday <Date>)|<Time>)|
|
|
(privateproperty <PropertyKey> <PropertyValue>)|
|
|
(range <Date> <Date>)|
|
|
(recurrence <RRULE, EXRULE, RDATE and EXDATE line>)|
|
|
(reminder <Number> email|popup)|
|
|
(resource <ResourceID>)|
|
|
(selectattendees [<AttendeeAttendance>] [<AttendeeStatus>] <UserTypeEntity>)|
|
|
(sequence <Integer>)|
|
|
(sharedproperty <PropertyKey> <PropertyValue>)|
|
|
(source <String> <URL>)|
|
|
(start|starttime (allday <Date>)|<Time>)|
|
|
(status confirmed|tentative|cancelled)|
|
|
(summary <String>)|
|
|
tentative|
|
|
(timerange <Time> <Time>)|
|
|
(timezone <TimeZone>)|
|
|
(transparency opaque|transparent)|
|
|
(visibility default|public|private)
|
|
|
|
The following attributes are equivalent:
|
|
available - transparency transparent
|
|
guestscantinviteothers - guestscaninviteothers False
|
|
guestscantseeothers - guestscanseeotherguests False
|
|
tentative - status tentative
|
|
|
|
<EventImportAttribute> ::=
|
|
<EventAttribute>|
|
|
(organizername <String>)|
|
|
(organizeremail <EmailAddress>)
|
|
|
|
<EventUpdateAttribute> ::=
|
|
<EventAttribute>|
|
|
clearattachments|
|
|
clearattendees|
|
|
cleargooglemeet|clearhangoutsmeet|
|
|
(clearprivateproperty <PropertyKey>)|
|
|
clearresources|
|
|
(clearsharedproperty <PropertyKey>)|
|
|
(removeattendee <EmailAddress>)|
|
|
(removeresource <ResourceID>)|
|
|
(replacedescription <REMatchPattern> <RESubstitution>)|
|
|
(selectremoveattendees <UserTypeEntity>)
|
|
|
|
<EventNotificationAttribute> ::=
|
|
notifyattendees|(sendnotifications <Boolean>)|(sendupdates all|enternalonly|none)
|
|
|
|
The following attributes are equivalent:
|
|
notifyattendees - sendupdates all
|
|
sendnotifications false - sendupdates none
|
|
sendnotifications true - sendupdates all
|
|
|
|
gam calendar|calendars <CalendarEntity> create|add event [id <String>] <EventAttribute>+ [<EventNotificationAttribute>]
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam calendar|calendars <CalendarEntity> import event icaluid <iCalUID> <EventImportAttribute>+
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam calendar|calendars <CalendarEntity> update events [<EventEntity>] [replacemode] <EventUpdateAttribute>+ [<EventNotificationAttribute>]
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam calendar|calendars <CalendarEntity> delete events [<EventEntity>]
|
|
# [batchsize <Integer>] [doit] [<EventNotificationAttribute>]
|
|
gam calendar|calendars <CalendarEntity> purge events [<EventEntity>]
|
|
# [batchsize <Integer>] [doit] [<EventNotificationAttribute>]
|
|
gam calendar|calendars <CalendarEntity> wipe events
|
|
gam calendar|calendars <CalendarEntity> move events [<EventEntity>] destination|to <CalendarItem> [<EventNotificationAttribute>]
|
|
gam calendar|calendars <CalendarEntity> empty calendartrash
|
|
|
|
<EventAttachmentsSubfieldName> ::=
|
|
attachments.fileid|
|
|
attachments.fileurl|
|
|
attachments.iconlink|
|
|
attachments.mimetype|
|
|
attachments.title
|
|
|
|
<EventAttendeesSubfieldName> ::=
|
|
attendees.additionalguests|
|
|
attendees.comment|
|
|
attendees.displayname|
|
|
attendees.email|
|
|
attendees.id|
|
|
attendees.optional|
|
|
attendees.organizer|
|
|
attendees.resource|
|
|
attendees.responseStatus|
|
|
attendees.self
|
|
|
|
<EventConferenceDataSubfieldName> ::=
|
|
conferencedata.conferenceid|
|
|
conferencedata.conferencesolution|
|
|
conferencedata.createrequest|
|
|
conferencedata.entrypoints|
|
|
conferencedata.notes|
|
|
conferencedata.signature
|
|
|
|
<EventCreatorSubfieldName> ::=
|
|
creator.displayname|
|
|
creator.email|
|
|
creator.id|
|
|
creator.self
|
|
|
|
<EventFocusTimePropertiesSubfieldName> ::=
|
|
focustime.autodeclinemode|
|
|
focustime.chatstatus|
|
|
focustime.declinemessage
|
|
|
|
<EventOrganizerSubfieldName> ::=
|
|
organizer.displayname|
|
|
organizer.email|
|
|
organizer.id|
|
|
organizer.self
|
|
|
|
<EventOutOfOfficePropertiesSubfieldName> ::=
|
|
outofoffice.autodeclinemode|
|
|
outofoffice.declinemessage
|
|
|
|
<EventWorkingLocationPropertiesSubfieldName> ::=
|
|
workinglocationproperties.homeoffice|
|
|
workinglocationproperties.customlocation|
|
|
workinglocationproperties.officelocation
|
|
|
|
<EventFieldName> ::=
|
|
anyonecanaddself|
|
|
attachments|
|
|
<EventAttachmentsSubfieldName>|
|
|
attendees|
|
|
<EventAttendeesSubfieldName>|
|
|
attendeesomitted|
|
|
colorid|
|
|
conferencedata|
|
|
<EventConferenceDataSubfieldName>|
|
|
created|
|
|
creator|
|
|
<EventCreatorSubfieldName>|
|
|
description|
|
|
end|endtime|
|
|
endtimeunspecified|
|
|
extendedproperties|
|
|
eventtype|
|
|
focustimeproperties|
|
|
<EventFocusTimePropertiesSubfieldName>|
|
|
gadget|
|
|
guestscaninviteothers|
|
|
guestscanmodify|
|
|
guestscanseeotherguests|
|
|
hangoutlink|
|
|
htmllink|
|
|
icaluid|
|
|
id|
|
|
location|
|
|
locked|
|
|
organizer|
|
|
<EventOrganizerSubfieldName>|
|
|
originalstart|originalstarttime|
|
|
outofofficeproperties|
|
|
<EventOutOfOfficePropertiesSubfieldName>|
|
|
privatecopy|
|
|
recurrence|
|
|
recurringeventid|
|
|
reminders|
|
|
sequence|
|
|
source|
|
|
start|starttime|
|
|
status|
|
|
summary|
|
|
transparency|
|
|
updated|
|
|
visibility|
|
|
workinglocationproperties|
|
|
<EventWorkingLocationPropertiesSubfieldName>
|
|
<EventFieldNameList> ::= "<EventFieldName>(,<EventFieldName>)*"
|
|
|
|
<EventDisplayProperty> ::=
|
|
(alwaysincludeemail)|
|
|
(icaluid <String>)|
|
|
(maxattendees <Integer>)|
|
|
(orderby starttime|updated)|
|
|
(timezone <TimeZone>)
|
|
|
|
gam calendar|calendars <CalendarEntity> info events [<EventEntity>] [maxinstances <Number>]
|
|
[fields <EventFieldNameList>] [showdayofweek]
|
|
[formatjson]
|
|
gam calendar|calendars <CalendarEntity> show events [<EventEntity>] <EventDisplayProperty>*
|
|
[fields <EventFieldNameList>] [showdayofweek]
|
|
[countsonly|formatjson]
|
|
gam calendar|calendars <CalendarEntity> print events [<EventEntity>] <EventDisplayProperty>*
|
|
[fields <EventFieldNameList>] [showdayofweek] [attendeeslist]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[eventrowfilter]
|
|
[countsonly|(formatjson [quotechar <Character>])] [todrive <ToDriveAttribute>*]
|
|
|
|
gam calendar <CalendarEntity> addevent <EventAttribute>+ [<EventNotificationAttribute>]
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam calendar <CalendarEntity> updateevent <EventID> [replacemode] <EventUpdateAttribute>+ [<EventNotificationAttribute>]
|
|
gam calendar <CalendarEntity> deleteevent (id|eventid <EventID>)+ [doit] [<EventNotificationAttribute>]
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam calendar <CalendarEntity> moveevent (id|eventid <EventID>)+ destination <CalendarItem> [<EventNotificationAttribute>]
|
|
gam calendar <CalendarEntity> wipe
|
|
gam calendar <CalendarEntity> printevents <EventSelectProperty>* <EventDisplayProperty>*
|
|
[fields <EventFieldNameList>] [showdayofweek]
|
|
[countsonly [eventrowfilter]]
|
|
[formatjson [quotechar <Character>]] [todrive <ToDriveAttribute>*]
|
|
|
|
<CalendarSettingsField> ::=
|
|
autoacceptinvitations|
|
|
conferenceproperties|
|
|
description|
|
|
id|
|
|
location|
|
|
summary|
|
|
timezone
|
|
<CalendarSettingsFieldList> ::= "<CalendarSettingsField>(,<CalendarSettingsField>)*"
|
|
|
|
<CalendarSettings> ::=
|
|
(autoacceptinvitations [<Boolean>])|
|
|
(description <String>)|
|
|
(location <String>)|
|
|
(summary <String>)|
|
|
(timezone <TimeZone>)
|
|
|
|
gam calendar|calendars <CalendarEntity> show settings
|
|
[fields <CalendarSettingsFieldList>]
|
|
[formatjson]
|
|
gam calendar|calendars <CalendarEntity> print settings [todrive <ToDriveAttribute>*]
|
|
[fields <CalendarSettingsFieldList>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam calendar|calendars <CalendarEntity> modify <CalendarSettings>+
|
|
|
|
# Chat Bot
|
|
|
|
<ChatContent> ::=
|
|
(text <String>)|
|
|
(textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>)
|
|
|
|
<ChatMember> ::= spaces/<String>/members/<String>
|
|
<ChatMessage> ::= spaces/<String>/messages/<String>
|
|
<ChatSpace> ::= spaces/<String> | space <String> | space spaces/<String>
|
|
<ChatThread> ::= spaces/<String>/threads/<String>
|
|
|
|
gam setup chat
|
|
|
|
<ChatSpaceFieldName> ::=
|
|
accesssettings|
|
|
admininstalled|
|
|
createtime|
|
|
displayname|
|
|
externaluserallowed|
|
|
importmode|
|
|
lastactivetime|
|
|
membershipcount|
|
|
name|
|
|
permissionsettings|
|
|
singleuserbotdm|
|
|
spacedetails|
|
|
spacehistorystate|
|
|
spacethreadingstate|threaded|
|
|
spacetype|type|
|
|
spaceuri
|
|
<ChatSpaceFieldNameList> ::= "<ChatSpaceFieldName>(,<ChatSpaceFieldName>)*"
|
|
|
|
gam info chatspace <ChatSpace>
|
|
[fields <ChatSpaceFieldNameList>]
|
|
[formatjson]
|
|
gam show chatspaces
|
|
[fields <ChatSpaceFieldNameList>] [showaccessssettings]
|
|
[formatjson]
|
|
gam print chatspaces [todrive <ToDriveAttribute>*]
|
|
[fields <ChatSpaceFieldNameList>] [showaccessssettings]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<ChatMemberFieldName> ::=
|
|
createtime|
|
|
deletetime|
|
|
groupmember|
|
|
member|
|
|
name|
|
|
role|
|
|
state|
|
|
<ChatMemberFieldNameList> ::= "<ChatMemberFieldName>(,<ChatMemberFieldName>)*"
|
|
|
|
gam info chatmember member <ChatMember>
|
|
[fields <ChatMemberFieldNameList>]
|
|
[formatjson]
|
|
gam show chatmembers <ChatSpace>
|
|
[showinvited [<Boolean>]] [showgroups [<Boolean>]] [filter <String>]
|
|
[fields <ChatMemberFieldNameList>]
|
|
[formatjson]
|
|
gam print chatmembers [todrive <ToDriveAttribute>*] <ChatSpace>
|
|
[showinvited [<Boolean>]] [showgroups [<Boolean>]] [filter <String>]
|
|
[fields <ChatMemberFieldNameList>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam create chatmessage <ChatSpace>
|
|
<ChatContent>
|
|
[messageId <ChatMessageID>]
|
|
[(thread <ChatThread>)|(threadkey <String>) [replyoption fail|fallbacktonew]]
|
|
[returnidonly]
|
|
gam update chatmessage name <ChatMessage>
|
|
[<ChatContent>] [clearattachments <String>]
|
|
gam delete chatmessage name <ChatMessage>
|
|
|
|
<ChatMessageFieldName> ::=
|
|
accessorywidgets|
|
|
actionresponse|
|
|
annotations|
|
|
argumenttext|
|
|
attachedgifs|
|
|
attachment|
|
|
cards|
|
|
cardsv2|
|
|
clientassignedmessageid|
|
|
createtime|
|
|
deletetime|
|
|
deletionmetadata|
|
|
emojireactionsummaries|
|
|
fallbacktext|
|
|
formattedtext|
|
|
lastupdatetime|
|
|
matchedurl|
|
|
name|
|
|
privatemessageviewer|
|
|
quotedmessagemetadata|
|
|
sender|
|
|
slashcommand|
|
|
space|
|
|
text|
|
|
thread|
|
|
threadreply
|
|
<ChatMessageFieldNameList> ::= "<ChatMessageFieldName>(,<ChatMessageFieldName>)*"
|
|
|
|
gam info chatmessage name <ChatMessage>
|
|
[fields <ChatMessageFieldNameList>]
|
|
[formatjson]
|
|
|
|
gam info chatevent name <ChatEvent>
|
|
[formatjson]
|
|
|
|
# Chrome Browser Cloud Management
|
|
|
|
<QueryBrowser> ::= <String>
|
|
See: https://support.google.com/chrome/a/answer/9681204#retrieve_all_chrome_devices_for_an_account
|
|
<QueryBrowserList> ::= "<QueryBrowser>(,<QueryBrowser>)*"
|
|
|
|
<BrowserEntity> ::=
|
|
<DeviceIDList> |
|
|
(query:<QueryBrowser>)|(query:orgunitpath:<OrgUnitPath>)|(query <QueryBrowser>) |
|
|
(browserou <OrgUnitItem>) | (browserous <OrgUnitList>) |
|
|
<FileSelector> | <CSVFileSelector>
|
|
|
|
<BrowserAttribute> ::=
|
|
(annotatedassetid|asset|assetid <String>)|
|
|
(annotatedlocation|location <String>)|
|
|
(annotatednotes|notes <String>)|(updatenotes <String>)|
|
|
(annotateduser|user <String>
|
|
|
|
<BrowserFieldName> ::=
|
|
annotatedassetid|asset|assetid|
|
|
annotatedlocation|location|
|
|
annotatednotes|notes|
|
|
annotateduser|user|
|
|
browsers|
|
|
browserversions|
|
|
deviceid|
|
|
extensioncount|
|
|
installedbrowserversion|
|
|
lastactivitytime|
|
|
lastdeviceuser|
|
|
lastdeviceusers|
|
|
lastpolicyfetchtime|
|
|
lastregistrationtime|
|
|
laststatusreporttime|
|
|
machineextensionpolicies|
|
|
machinename|
|
|
machinepolicies|
|
|
orgunitpath|org|orgunit|
|
|
osarchitecture|
|
|
osplatform|
|
|
osplatformversion|
|
|
osversion|
|
|
ou|
|
|
policycount|
|
|
safebrowsingclickthroughcount|
|
|
serialnumber|
|
|
virtualdeviceid
|
|
<BrowserFieldNameList> ::= "<BrowserFieldName>(,<BrowserFieldName>)*"
|
|
|
|
<BrowserOrderByFieldName> ::=
|
|
annotatedassetid|assetassetid|
|
|
annotatedlocation|location|
|
|
annotatednotes|notes|
|
|
annotateduser|user|
|
|
browserversionchannel|
|
|
browserversionsortable|
|
|
deviceid|id|
|
|
enrollmentdate|
|
|
extensioncount|
|
|
lastactivity|
|
|
lastsignedinuser|
|
|
lastsync|
|
|
machinename|
|
|
orgunit|ou|org|
|
|
osversion|
|
|
osversionsortable|
|
|
platformmajorversion|
|
|
policycount
|
|
|
|
gam delete browser <DeviceID>
|
|
gam update browser <BrowserEntity> <BrowserAttibute>+
|
|
gam move browsers ou|org|orgunit <OrgUnitPath>
|
|
((ids <DeviceIDList>) |
|
|
(queries <QueryBrowserList> [querytime<String> <Time>]) |
|
|
(browserou <OrgUnitItem>) | (browserous <OrgUnitList>) |
|
|
<FileSelector> | <CSVFileSelector>)
|
|
[batchsize <Integer>]
|
|
|
|
gam info browser <DeviceID>
|
|
(basic|full|annotated |
|
|
(<BrowserFieldName>* [fields <BrowserFieldNameList>]) |
|
|
(rawfields "<BrowserFieldNameList>"))
|
|
[formatjson]
|
|
gam show browsers
|
|
([ou|org|orgunit|browserou <OrgUnitPath>] [(query <QueryBrowser>)|(queries <QueryBrowserList>))|(select <BrowserEntity>))
|
|
[querytime<String> <Time>]
|
|
[orderby <BrowserOrderByFieldName> [ascending|descending]]
|
|
(basic|full|annotated |
|
|
(<BrowserFieldName>* [fields <BrowserFieldNameList>]) |
|
|
(rawfields "<BrowserFieldNameList>"))
|
|
[formatjson]
|
|
gam print browsers [todrive <ToDriveAttribute>*]
|
|
([ou|org|orgunit|browserou <OrgUnitPath>] [(query <QueryBrowser>)|(queries <QueryBrowserList>))|(select <BrowserEntity>))
|
|
[querytime<String> <Time>]
|
|
[orderby <BrowserOrderByFieldName> [ascending|descending]]
|
|
(basic|full|annotated |
|
|
(<BrowserFieldName>* [fields <BrowserFieldNameList>]) |
|
|
(rawfields "<BrowserFieldNameList>"))
|
|
[sortheaders]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam create browsertoken
|
|
[ou|org|orgunit|browserou <OrgUnitPath>] [expire|expires <Time>]
|
|
[formatjson]
|
|
gam revoke browsertoken <BrowserTokenPermanentID>
|
|
|
|
<BrowserTokenFieldName> ::=
|
|
createtime|
|
|
creatorid|
|
|
customerid|
|
|
expiretime|
|
|
org|
|
|
orgunit|
|
|
orgunitpath|
|
|
ou|
|
|
revoketime|
|
|
revokerid|
|
|
state|
|
|
token|
|
|
tokenpermanentid
|
|
<BrowserTokenFieldNameList> ::= "<BrowserTokenFieldName>(,<BrowserTokenFieldName>)*"
|
|
|
|
gam show browsertokens
|
|
([ou|org|orgunit|browserou <OrgUnitPath>] [(query <QueryBrowserToken>)|(queries <QueryBrowserTokenList>)))
|
|
[querytime<String> <Time>]
|
|
[orderby <BrowserTokenFieldName> [ascending|descending]]
|
|
[allfields] <BrowserTokenFieldName>* [fields <BrowserTokenFieldNameList>]
|
|
[formatjson]
|
|
gam print browsertokens [todrive <ToDriveAttribute>*]
|
|
([ou|org|orgunit|browserou <OrgUnitPath>] [(query <QueryBrowserToken>)|(queries <QueryBrowserTokenList>)))
|
|
[querytime<String> <Time>]
|
|
[orderby <BrowserTokenFieldName> [ascending|descending]]
|
|
[allfields] <BrowserTokenFieldName>* [fields <BrowserTokenFieldNameList>]
|
|
[sortheaders]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# 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]
|
|
|
|
# Chrome Devices Need 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]
|
|
|
|
# Chrome Profile Management
|
|
|
|
<ChromeProfilePermanentID> ::= <String>
|
|
<ChromeProfileName> ::= customers/<CustomerID>/profiles/<ChromeProfilePermanentID> | <ChromeProfilePermanentID>
|
|
<ChromeProfileNameList> ::= "<ChromeProfileName>(,<ChromeProfileName>)*"
|
|
<ChromeProfileCommandName> ::= <ChomeProfileName>/commands/<String>
|
|
<ChromeProfileCommandNameList> ::= "<ChromeProfileCommandName>(,<ChromeProfileCommandName>)*"
|
|
<ChromeProfileNameEntity> ::=
|
|
<ChromeProfileNameList> |
|
|
(select <ChromeProfileNameList>|<FileSelector>|<CSVFileSelector>) |
|
|
(filter <String> (filtertime<String> <Time>)* [orderby <ChromeProfileOrderByFieldName> [ascending|descending]]) |
|
|
(commands <ChromeProfileCommandNameList>|<FileSelector>|<CSVFileSelector>)
|
|
|
|
<ChromeProfileFieldName> ::=
|
|
affiliationstate|
|
|
annotatedlocation|
|
|
annotateduser|
|
|
attestationcredential|
|
|
browserchannel|
|
|
browserversion|
|
|
deviceinfo|
|
|
displayname|
|
|
extensioncount|
|
|
firstenrollmenttime|
|
|
identityprovider|
|
|
lastactivitytime|
|
|
lastpolicyfetchtime|
|
|
lastpolicysynctime|
|
|
laststatusreporttime|
|
|
name|
|
|
osplatformtype|
|
|
osplatformversion|
|
|
osversion|
|
|
policycount|
|
|
profileid|
|
|
profilepermanentid|
|
|
reportingdata|
|
|
useremail|
|
|
userid
|
|
<ChromeProfileFieldNameList> ::= "<ChromeProfileFieldName>(,<ChromeProfileFieldName>)*"
|
|
|
|
<ChromeProfileOrderByFieldName> ::=
|
|
affiliationstate|
|
|
browserchannel|
|
|
browserversion|
|
|
displayname|
|
|
extensioncount|
|
|
firstenrollmenttime|
|
|
identityprovider|
|
|
lastactivitytime|
|
|
lastpolicysynctime|
|
|
laststatusreporttime|
|
|
osplatformtype|
|
|
osversion|
|
|
policycount|
|
|
profileid|
|
|
useremail
|
|
|
|
gam delete chromeprofile <ChromeProfileName>
|
|
|
|
gam info chromeprofile <ChromeProfileName>
|
|
<ChromeProfileFieldName>* [fields <ChromeProfileFieldNameList>]
|
|
gam show chromeprofiles
|
|
[filter <String> (filtertime<String> <Time>)*]
|
|
[orderby <ChromeProfileOrderByFieldName> [ascending|descending]]
|
|
<ChromeProfileFieldName>* [fields <ChromeProfileFieldNameList>]
|
|
[formatjson]
|
|
gam print chromeprofiles [todrive <ToDriveAttribute>*]
|
|
[filter <String> (filtertime<String> <Time>)*]
|
|
[orderby <ChromeProfileOrderByFieldName> [ascending|descending]]
|
|
<ChromeProfileFieldName>* [fields <ChromeProfileFieldNameList>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam create chromeprofilecommand <ChromeProfileNameEntity>
|
|
[clearcache [<Boolean>]] [clearcookies [<Boolean>]]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
|
|
gam info chromeprofilecommand <ChromeProfileCommandName>
|
|
[formatjson]
|
|
|
|
gam show chromeprofilecommands <ChromeProfileNameEntity>
|
|
[formatjson]
|
|
gam print chromeprofilecommands <ChromeProfileNameEntity> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Chrome Device Counts
|
|
|
|
gam show chromedevicecounts
|
|
(mode all|active|perboottype|perreleasechannel)* [date <Date>]
|
|
[formatjson]
|
|
gam print chromedevicecounts [todrive <ToDriveAttribute>*]
|
|
(mode all|active|perboottype|perreleasechannel) [date <Date>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Chrome Versions Counts
|
|
|
|
gam show chromeversions
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[start <Date>] [end <Date>] [recentfirst [<Boolean>]]
|
|
[formatjson]
|
|
gam print chromeversions [todrive <ToDriveAttribute>*]
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[start <Date>] [end <Date>]
|
|
[recentfirst [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Chrome Version History
|
|
|
|
<ChromePlatfornType> ::=
|
|
all|
|
|
android|
|
|
ios|
|
|
lacros|
|
|
linux|
|
|
mac|
|
|
macarm64|
|
|
sebview|
|
|
win|
|
|
win64
|
|
<ChromeChannelType> :==
|
|
beta|
|
|
canary|
|
|
canaryasan|
|
|
dev|
|
|
stable
|
|
<ChromeVersionsOrderByFieldName> ::=
|
|
channel|
|
|
name|
|
|
platform|
|
|
version|
|
|
<ChromeReleasesOrderByFieldName> ::=
|
|
channel|
|
|
endtime|
|
|
fraction|
|
|
name|
|
|
platform|
|
|
starttime|
|
|
version
|
|
|
|
gam show chromehistory platforms
|
|
[formatjson]
|
|
gam print chromehistory platforms [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam show chromehistory channels
|
|
[platform <ChromePlatformType>]
|
|
[formatjson]
|
|
gam print chromehistory channels [todrive <ToDriveAttribute>*]
|
|
[platform <ChromePlatformType>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam show chromehistory versions
|
|
[platform <ChromePlatformType>] [channel <ChromeChannelType>]
|
|
[filter <String>]
|
|
(orderby <ChromeVersionsOrderByFieldName> [ascending|descending])*
|
|
[formatjson]
|
|
gam print chromehistory versions [todrive <ToDriveAttribute>*]
|
|
[platform <ChromePlatformType>] [channel <ChromeChannelType>]
|
|
[filter <String>]
|
|
(orderby <ChromeVersionsOrderByFieldName> [ascending|descending])*
|
|
[formatjson [quotechar <Character>]]
|
|
gam show chromehistory releases
|
|
[platform <ChromePlatformType>] [channel <ChromeChannelType>] [version <String>]
|
|
[filter <String>]
|
|
(orderby <ChromeReleasessOrderByFieldName> [ascending|descending])*
|
|
[formatjson]
|
|
gam print chromehistory releases [todrive <ToDriveAttribute>*]
|
|
[platform <ChromePlatformType>] [channel <ChromeChannelType>] [version <String>]
|
|
[filter <String>]
|
|
(orderby <ChromeReleasessOrderByFieldName> [ascending|descending])*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# ChromeOS Devices
|
|
|
|
<CrOSAction> ::=
|
|
deprovision_different_model_replace|
|
|
deprovision_different_model_replacement|
|
|
deprovision_retiring_device|
|
|
deprovision_same_model_replace|
|
|
deprovision_same_model_replacement|
|
|
deprovision_upgrade_transfer|
|
|
disable|
|
|
reenable|
|
|
pre_provisioned_disable|
|
|
pre_provisioned_reenable
|
|
|
|
gam update cros <CrOSEntity> action <CrOSAction> [acknowledge_device_touch_requirement]
|
|
[actionbatchsize <Integer>] [maxtodeprov <Integer>]
|
|
gam <CrOSTypeEntity> update action <CrOSAction> [acknowledge_device_touch_requirement]
|
|
[actionbatchsize <Integer>] [maxtodeprov <Integer>]
|
|
|
|
<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]
|
|
[csv (addcsvdata <FieldName> <String>)*]
|
|
gam <CrOSTypeEntity> issuecommand command <CrOSCommand>
|
|
[times_to_check_status <Integer>] [doit]
|
|
[csv (addcsvdata <FieldName> <String>)*]
|
|
gam getcommand cros <CrOSEntity> commandid <CommandID>
|
|
[times_to_check_status <Integer>]
|
|
[csv (addcsvdata <FieldName> <String>)*]
|
|
gam <CrOSTypeEntity> getcommand commandid <CommandID>
|
|
[times_to_check_status <Integer>]
|
|
[csv (addcsvdata <FieldName> <String>)*]
|
|
|
|
<CrOSAttribute> ::=
|
|
(asset|assetid|tag <String>)|
|
|
(location <String>)|
|
|
(notes <String>)|(updatenotes <String>)|
|
|
(org|ou <OrgUnitPath>)|
|
|
(user <String>)
|
|
|
|
gam update cros <CrOSEntity> <CrOSAttribute>+ [quickcrosmove [<Boolean>]] [nobatchupdate]
|
|
gam <CrOSTypeEntity> update <CrOSAttribute>+ [quickcrosmove [<Boolean>]] [nobatchupdate]
|
|
|
|
<CrOSFieldName> ::=
|
|
activetimeranges|timeranges|
|
|
annotatedassetid|assetid|asset|
|
|
annotatedlocation|location|
|
|
annotateduser|user|
|
|
autoupdateexpiration|
|
|
autoupdatethrough|
|
|
backlightinfo|
|
|
bootmode|
|
|
chromeostype|
|
|
cpuinfo|
|
|
cpustatusreports|
|
|
deprovisionreason|
|
|
devicefiles|
|
|
deviceid|
|
|
devicelicensetype|
|
|
diskspaceusage|
|
|
diskvolumereports|
|
|
dockmacaddress|
|
|
ethernetmacaddress|
|
|
ethernetmacaddress0|
|
|
extendedsupporteligible|
|
|
extendedsupportstart|
|
|
extendedsupportenabled|
|
|
faninfo|
|
|
firmwareversion|
|
|
firstenrollmenttime|
|
|
lastdeprovisiontimestamp|
|
|
lastenrollmenttime|
|
|
lastknownnetwork|
|
|
lastsync|
|
|
macaddress|
|
|
manufacturedate|
|
|
meid|
|
|
model|
|
|
notes|
|
|
ordernumber|
|
|
orgunitid|
|
|
orgunitpath|org|ou|
|
|
osupdatestatus|
|
|
osversion|
|
|
platformversion|
|
|
recentusers|
|
|
screenshotfiles|
|
|
serialnumber|
|
|
status|
|
|
supportenddate|
|
|
systemramfreereports|
|
|
systemramtotal|
|
|
tpmversioninfo|
|
|
willautorenew
|
|
<CrOSFieldNameList> ::= "<CrOSFieldName>(,<CrOSFieldName>)*"
|
|
|
|
<CrOSListFieldName> ::=
|
|
activetimeranges|timeranges|times|
|
|
cpustatusreports|
|
|
devicefiles|files|
|
|
diskvolumereports|
|
|
lastknownnetwork|
|
|
recentusers|users|
|
|
screenshotfiles|
|
|
systemramfreereports
|
|
<CrOSListFieldNameList> ::= "<CrOSListFieldName>(,<CrOSListFieldName>)*"
|
|
|
|
<CrOSOrderByFieldName> ::=
|
|
lastsync|location|notes|serialnumber|status|supportenddate|user
|
|
|
|
gam info cros <CrOSEntity>
|
|
[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
|
|
[nolists]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSListFieldNameList>]
|
|
[timerangeorder ascending|descending] [showdvrsfp]
|
|
[downloadfile latest|<Time>] [targetfolder <FilePath>]
|
|
[formatjson]
|
|
|
|
gam <CrOSTypeEntity> info
|
|
[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
|
|
[nolists]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSListFieldNameList>]
|
|
[timerangeorder ascending|descending] [showdvrsfp]
|
|
[downloadfile latest|<Time>] [targetfolder <FilePath>]
|
|
[formatjson]
|
|
|
|
Print fields for selected CrOS devices; use these options to select CrOS devices:
|
|
[(query <QueryCrOS>)|(queries <QueryCrOSList>) [querytime<String> <Time>]
|
|
[(limittoou|cros_ou <OrgUnitItem>)|(cros_ou_and_children <OrgUnitItem>)|
|
|
(cros_ous <OrgUnitList>)|(cros_ous_and_children <OrgUnitList>)]]
|
|
If none of these options are chosen, all CrOS devices are selected.
|
|
|
|
gam print cros [todrive <ToDriveAttribute>*]
|
|
[(query <QueryCrOS>)|(queries <QueryCrOSList>) [querytime<String> <Time>]
|
|
[(limittoou|cros_ou <OrgUnitItem>)|(cros_ou_and_children <OrgUnitItem>)|
|
|
(cros_ous <OrgUnitList>)|(cros_ous_and_children <OrgUnitList>)]]
|
|
[orderby <CrOSOrderByFieldName> [ascending|descending]]
|
|
[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
|
|
[nolists|(<CrOSListFieldName>* [onerow])]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSListFieldNameList>]
|
|
[timerangeorder ascending|descending] [showdvrsfp]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[sortheaders]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
Print fields for specified CrOS devices.
|
|
|
|
gam print cros [todrive <ToDriveAttribute>*] select <CrOSTypeEntity>
|
|
[orderby <CrOSOrderByFieldName> [ascending|descending]]
|
|
[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
|
|
[nolists|(<CrOSListFieldName>* [onerow])
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSListFieldNameList>]
|
|
[timerangeorder ascending|descending] [showdvrsfp]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[sortheaders]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
gam <CrOSTypeEntity> print cros [todrive <ToDriveAttribute>*]
|
|
[orderby <CrOSOrderByFieldName> [ascending|descending]]
|
|
[basic|full|allfields] <CrOSFieldName>* [fields <CrOSFieldNameList>]
|
|
[nolists|(<CrOSListFieldName>* [onerow])]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSListFieldNameList>]
|
|
[timerangeorder ascending|descending] [showdvrsfp]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[sortheaders]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
The first column will always be deviceId; the remaining field names will be sorted if allfields, basic, full or sortheaders is specified;
|
|
otherwise, the remaining field names will appear in the order specified.
|
|
|
|
The basic argument outputs these column headers: deviceId,annotatedAssetId,annotatedLocation,annotatedUser,lastSync,notes,serialNumber,status.
|
|
The allfields/full arguments output all column headers including eight headers: activeTimeRanges, cpuStatusReports, deviceFiles, diskVolumeReports,
|
|
lastKnownNetwork, recentUsers, screenshotFiles and systemRamFreeReports that repeat with multiple subvalues each, yielding a large number of columns that make the output hard to process.
|
|
The nolists argument suppresses these six headers; if you want these headers in a more manageable form specify <CrOSListFieldName> values as desired.
|
|
One set of values for all <CrOSListFieldName> fields specified will be output on a separate row with all of the other headers.
|
|
|
|
The listlimit <Number> argument limits the number of repetitions to <Number>; if not specified or <Number> equals zero, there is no limit.
|
|
The start <Date> and end <Date> arguments constrain activeTimeRanges, cpuStatusReports, deviceFiles and systemRamFreeReports to fall within the specified <Dates>.
|
|
|
|
Print no header row and deviceId for specified CrOS devices.
|
|
|
|
gam <CrOSTypeEntity> print
|
|
gam <CrOSTypeEntity> print cros
|
|
|
|
Show count of CrOS devices
|
|
|
|
gam <CrOSTypeEntity> show count
|
|
|
|
Print activity for selected CrOS devices; use these options to select CrOS devices:
|
|
[(query <QueryCrOS>)|(queries <QueryCrOSList>) [querytime<String> <Time>]
|
|
[(limittoou|cros_ou <OrgUnitItem>)|(cros_ou_and_children <OrgUnitItem>)|
|
|
(cros_ous <OrgUnitList>)|(cros_ous_and_children <OrgUnitList>)]]
|
|
If none of these options are chosen, all CrOS devices are selected.
|
|
|
|
gam print crosactivity [todrive <ToDriveAttribute>*]
|
|
[(query <QueryCrOS>)|(queries <QueryCrOSList>) [querytime<String> <Time>]
|
|
[(limittoou|cros_ou <OrgUnitItem>)|(cros_ou_and_children <OrgUnitItem>)|
|
|
(cros_ous <OrgUnitList>)|(cros_ous_and_children <OrgUnitList>)]]
|
|
[orderby <CrOSOrderByFieldName> [ascending|descending]]
|
|
[recentusers] [timeranges] [both] [devicefiles] [all] [oneuserperrow]
|
|
[start <Date>] [end <Date>]
|
|
[listlimit <Number>] [timerangeorder ascending|descending]
|
|
[delimiter <Character>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
Print activity for specified CrOS devices.
|
|
|
|
<CrOSActivityListFieldName> ::=
|
|
activetimeranges|timeranges|times|
|
|
devicefiles|files|
|
|
recentusers|users
|
|
<CrOSActivityListFieldNameList> ::= "<CrOSActivityListFieldName>(,<CrOSActivityListFieldName>)*"
|
|
|
|
gam print crosactivity [todrive <ToDriveAttribute>*] select <CrOSTypeEntity>
|
|
[orderby <CrOSOrderByFieldName> [ascending|descending]]
|
|
[recentusers] [timeranges] [both] [devicefiles] [all] [oneuserperrow]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSActivityListFieldNameList>]
|
|
[timerangeorder ascending|descending]
|
|
[delimiter <Character>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <CrOSTypeEntity> print crosactivity [todrive <ToDriveAttribute>*]
|
|
[orderby <CrOSOrderByFieldName> [ascending|descending]]
|
|
[recentusers] [timeranges] [both] [devicefiles] [all] [oneuserperrow]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSActivityListFieldNameList>]
|
|
[timerangeorder ascending|descending]
|
|
[delimiter <Character>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
The basic column headers are: deviceId,annotatedAssetId,annotatedLocation,serialNumber,orgUnitPath.
|
|
|
|
If recentusers is specified, all of the recent users email addresses, separated by the delimiter <Character>,
|
|
with header recentUsers.email, are output with the basic headers. If oneuserperrow is specified, each recent user
|
|
is output on a separate row with the basic headers.
|
|
|
|
If timeranges is specified, for each time range entry, activeTimeRanges.date, activeTimeRanges.duration and activeTimeRanges.minutes
|
|
are output on a separate row with the basic headers.
|
|
|
|
If devicefiles is specified, for each deviceFile, deviceFiles.type and deviceFiles.createTime
|
|
are output on a separate row with the basic headers.
|
|
|
|
The both option specifies recentusers and timeranges.
|
|
The all option specifies recentusers, timeranges and devicefiles.
|
|
The default is to include recentusers and timeranges.
|
|
|
|
The listlimit <Number> argument limits the number of recent users, time ranges and device files to <Number>; if not specified or <Number> equals zero, there is no limit.
|
|
The start <Date> and end <Date> arguments filter the time ranges and device files.
|
|
Delimiter defaults to gam.cfg/csv_output_field_delimiter.
|
|
|
|
gam get devicefile <CrOSEntity> [select <DeviceFileEntity>] [targetfolder <FilePath>]
|
|
gam <CrOSTypeEntity> get devicefile [select <DeviceFileEntity>] [targetfolder <FilePath>]
|
|
|
|
Print telemetry data for specified CrOS devices.
|
|
|
|
<CrOSTelemetryFieldName> ::=
|
|
audiostatusreport|
|
|
batteryinfo|
|
|
batterystatusreport|
|
|
bootPerformancereport|
|
|
cpuinfo|
|
|
cpustatusreport|
|
|
customer|
|
|
deviceid|
|
|
graphicsinfo|
|
|
graphicsstatusreport|
|
|
memoryinfo|
|
|
memorystatusreport|
|
|
name|
|
|
networkdiagnosticsreport|
|
|
networkinfo|
|
|
networkstatusreport|
|
|
orgunitid|
|
|
osupdatestatus|
|
|
peripheralsreport|
|
|
serialnumber|
|
|
storageinfo|
|
|
storagestatusreport|
|
|
thunderboltinfo
|
|
<CrOSTelemetryFieldNameList> ::= "<CrOSTelemetryFieldName>(,<CrOSTelemetryFieldName>)*"
|
|
|
|
<CrOSTelemetryListFieldName> ::=
|
|
audiostatusreport|
|
|
batteryinfo|
|
|
batterystatusreport|
|
|
bootperformancereport|
|
|
cpuinfo|
|
|
cpustatusreport|
|
|
graphicsstatusreport|
|
|
memorystatusreport|
|
|
networkdiagnosticsreport|
|
|
networkstatusreport|
|
|
osupdatestatus|
|
|
peripheralsreport|
|
|
storagestatusreport|
|
|
thunderboltinfo
|
|
<CrOSTelemetryListFieldNameList> ::= "<CrOSTelemetryListFieldName>(,<CrOSTelemetryLIstFieldName>)*"
|
|
|
|
gam info crostelemetry <SerialNumber>
|
|
<CrOSTelemetryFieldName>* [fields <CrOSTelemetryFieldNameList>]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSTelemetryListFieldNameList>]
|
|
[formatjson]
|
|
gam show crostelemetry
|
|
[(ou|org|orgunit|ou_and_children <OrgUnitItem>)|(cros_sn <SerialNumber>)|(filter <String>)]
|
|
<CrOSTelemetryFieldName>* [fields <CrOSTelemetryFieldNameList>]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[reverselists <CrOSTelemetryListFieldNameList>]
|
|
[formatjson]
|
|
gam print crostelemetry [todrive <ToDriveAttribute>*]
|
|
[(ou|org|orgunit|ou_and_children <OrgUnitItem>)|(cros_sn <SerialNumber>)|(filter <String>)]
|
|
<CrOSTelemetryFieldName>* [fields <CrOSTelemetryFieldNameList>]
|
|
[reverselists <CrOSTelemetryListFieldNameList>]
|
|
[start <Date>] [end <Date>] [listlimit <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Chrome Browser Policies
|
|
|
|
<ChromePolicyImageSchemaName> ::=
|
|
chrome.devices.managedguest.avatar |
|
|
chrome.devices.managedguest.wallpaper |
|
|
chrome.devices.signinwallpaperimage |
|
|
chrome.users.avatar |
|
|
chrome.users.wallpaper
|
|
|
|
gam create chromepolicyimage <ChromePolicyImageSchemaName> <FileName>
|
|
|
|
gam update chromepolicy [convertcrnl]
|
|
(<SchemaName> ((<Field> <Value>)+ | <JSONData>))+
|
|
((ou|orgunit <OrgUnitItem>)|(group <GroupItem>))
|
|
[(printerid <PrinterID>)|(appid <AppID>)]
|
|
gam delete chromepolicy
|
|
(<SchemaName> [<JSONData>])+
|
|
((ou|orgunit <OrgUnitItem>)|(group <GroupItem>))
|
|
[(printerid <PrinterID>)|(appid <AppID>)]
|
|
gam show chromepolicies
|
|
((ou|orgunit <OrgUnitItem> [show all|direct|inherited])|(group <GroupItem>))
|
|
[(printerid <PrinterID>)|(appid <AppID>)]
|
|
(filter <StringList>)* (namespace <NamespaceList>)*
|
|
[show all|direct|inherited]
|
|
[formatjson]
|
|
gam print chromepolicies [todrive <ToDriveAttribute>*]
|
|
((ou|orgunit <OrgUnitItem> [show all|direct|inherited])|(group <GroupItem>))
|
|
[(printerid <PrinterID>)|(appid <AppID>)]
|
|
(filter <StringList>)* (namespace <NamespaceList>)*
|
|
[show all|direct|inherited] [shownopolicy]
|
|
[[formatjson [quotechar <Character>]]
|
|
|
|
<ChromePolicySchemaFieldName> ::=
|
|
accessrestrictions|
|
|
additionaltargetkeynames|
|
|
categorytitle|
|
|
definition|
|
|
fielddescriptions|
|
|
name|
|
|
notices|
|
|
policyapilifecycle|
|
|
policydescription|
|
|
schemaname|
|
|
supporturi|
|
|
validtargetresources
|
|
<ChromePolicySchemaFieldNameList> ::= "<ChromePolicySchemaFieldName>(,<ChromePolicySchemaFieldName>)*"
|
|
|
|
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>]]
|
|
|
|
gam info chromeschema std <SchemaName>
|
|
gam show chromeschemas std
|
|
[filter <String>]
|
|
|
|
gam create chromenetwork
|
|
<OrgUnitItem> <String> <JSONData>
|
|
gam delete chromenetwork
|
|
<OrgUnitItem> <NetworkID>
|
|
|
|
# Chrome Apps/Devices/Versions
|
|
|
|
gam info chromeapp android|chrome|web <AppID>
|
|
[formatjson]
|
|
|
|
gam show chromeapps
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[filter <String>]
|
|
[orderby appname|apptype|installtype|numberofpermissions|totalinstallcount]
|
|
[formatjson]
|
|
gam print chromeapps [todrive <ToDriveAttribute>*]
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[filter <String>]
|
|
[orderby appname|apptype|installtype|numberofpermissions|totalinstallcount]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam show chromeappdevices
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[appid <AppID>] [apptype extension|app|theme|hostedapp|androidapp]
|
|
[filter <String>]
|
|
[orderby deviceid|machine]
|
|
[formatjson]
|
|
gam print chromeappdevices [todrive <ToDriveAttribute>*]
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[appid <AppID>] [apptype extension|app|theme|hostedapp|androidapp]
|
|
[filter <String>]
|
|
[orderby deviceid|machine]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam show chromeversions
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[start <Date>] [end <Date>]
|
|
[formatjson]
|
|
gam print chromeversions [todrive <ToDriveAttribute>*]
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[start <Date>] [end <Date>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam print chromesnvalidity [todrive <ToDriveAttribute>*]
|
|
cros_sn <SerialNumberEntity> [listlimit <Number>]
|
|
[delimiter <Character>]
|
|
|
|
# Classification Labels
|
|
|
|
gam [<UserTypeEntity>] info classificationlabels <ClassificationLabelNameEntity>
|
|
[[basic|full] [languagecode <LanguageCode>]
|
|
[formatjson] [adminaccess|asadmin]
|
|
gam [<UserTypeEntity>] print classificationlabels [todrive <ToDriveAttribute>*]
|
|
[basic|full] [languagecode <LanguageCode>]
|
|
[publishedonly [<Boolean>]] [minimumrole applier|editor|organizer|reader]
|
|
[formatjson [quotechar <Character>]] [adminaccess|asadmin]
|
|
gam [<UserTypeEntity>] show classificationlabels
|
|
[basic|full] [languagecode <LanguageCode>]
|
|
[publishedonly [<Boolean>]] [minimumrole applier|editor|organizer|reader]
|
|
[formatjson] [adminaccess|asadmin]
|
|
`
|
|
gam [<UserTypeEntity>] create classificationlabelpermission <ClassificationLabelNameEntity>
|
|
(user <UserItem>) | (group <GroupItem>) | (audience <String>)
|
|
role applier|editor|organizer|reader
|
|
[formatjson] [adminaccess|asadmin]
|
|
gam [<UserTypeEntity>] delete classificationlabelpermission <ClassificationLabelNameEntity>
|
|
(user <UserItem>) | (group <GroupItem>) | (audience <String>)
|
|
[adminaccess|asadmin]
|
|
gam [<UserTypeEntity>] remove classificationlabelpermission <ClassificationLabelPermissionNameEntity>
|
|
[adminaccess|asadmin]
|
|
|
|
gam [<UserTypeEntity>] print classificationlabelpermissions <ClassificationLabelNameEntity> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]] [adminaccess|asadmin]
|
|
gam [<UserTypeEntity>] show classificationlabelpermissions <ClassificationLabelNameEntity>
|
|
[formatjson] [adminaccess|asadmin]
|
|
|
|
# Context Aware Access
|
|
|
|
<QueryCEL> ::= <String>
|
|
See: https://cloud.google.com/access-context-manager/docs/custom-access-level-spec
|
|
|
|
<CAAAllowedEncryptionStatus> ::=
|
|
encryption_unsupported |
|
|
encrypted |
|
|
unencrypted
|
|
<CAAAllowedEncryptionStatusList> ::= "<CAAAllowedEncryptionStatus>(,<CAAAllowedEncryptionStatus>)"
|
|
|
|
<CAAAllowedDeviceManagementLevel> ::=
|
|
basic |
|
|
advanced|complete |
|
|
none
|
|
<CAAAllowedDeviceManagementLevelList> ::= "<CAAAllowedDeviceManagementLevel>(,<CAAAllowedDeviceManagementLevel>)"
|
|
|
|
<CAACombiningFunction> ::=
|
|
and |
|
|
or
|
|
|
|
<CAAIPSubNetwork> ::=
|
|
<CIDRnetmask>
|
|
<CAAIPSubNetworkList> ::= "<CAAIPSubNetwork>(,<CAAIPSubNetwork>)"
|
|
|
|
<CAAMember> ::=
|
|
user:<EmailAddress> |
|
|
serviceAccount:<EmailAddress>
|
|
<CAAMemberList> ::= "<CAAMember>(,<CAAMember>)"
|
|
|
|
<CAAOsType> ::=
|
|
DESKTOP_MAC |
|
|
DESKTOP_WINDOWS |
|
|
DESKTOP_LINUX |
|
|
DESKTOP_CHROME_OS |
|
|
VERIFIED_DESKTOP_CHROME_OS |
|
|
ANDROID |
|
|
IOS
|
|
|
|
<CAAOsConstraint> ::=
|
|
<CAAOsType> |
|
|
<CAAOsType>:<String>.<String>.<String>
|
|
<CAAOsConstraintList> ::= "<CAAOsConstraint>(,<CAAOsConstraint>)"
|
|
|
|
<CAARegion> ::=
|
|
<Character><Character>
|
|
<CAARegionList> ::= "<CAARegion>(,<CAARegion>)"
|
|
See: https://github.com/taers232c/GAMADV-XTD3/wiki/Context-Aware-Access-Levels#caa-region-codes
|
|
|
|
<CAADevicePolicyAttribute> ::=
|
|
(requirescreenlock <Boolean>) |
|
|
(allowedencryptionstatuses <CAAAllowedEncryptionStatusList>) |
|
|
(osconstraints <CAAOsConstraintList>) |
|
|
(alloweddevicemanagementlevels <CAAAllowedDeviceManagementLevelList>) |
|
|
(requireadminapproval <Boolean>) |
|
|
(requirecorpowned <Boolean>) # See: https://www.iso.org/obp/ui/#search
|
|
|
|
<CAAConditionAttribute> ::=
|
|
(ipsubnetworks <CAAIPSubNetworkList>) |
|
|
(devicepolicy <CAADevicePolicyAttribute> enddevicepolicy) |
|
|
(requiredaccesslevels <StringList>) |
|
|
(negate <Boolean>) |
|
|
(members <CAAMemberList>) |
|
|
(regions <CAARegionList>)
|
|
|
|
<CAABasicAttribute> ::+
|
|
(combiningfunction <CAACombiningFunction>) |
|
|
(condition <CAAConditionAttribute>+ endcondition)
|
|
|
|
gam info gcporgid
|
|
|
|
gam create caalevel <String> [description <String>] (basic <CAABasicAttribute>+)|(custom <QueryCEL>)|<JSONData>
|
|
gam update caalevel <CAALevelName> [description <String>] (basic <CAABasicAttribute>+)|(custom <QueryCEL>)|<JSONData>
|
|
gam delete caalevel <CAALevelName>
|
|
gam show caalevels
|
|
[formatjson]
|
|
gam print caalevels [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Cloud Channel
|
|
|
|
<ChannelCustomerField> ::=
|
|
alternateemail |
|
|
channelpartnerid |
|
|
cloudidentityid |
|
|
cloudidentityinfo |
|
|
createtime |
|
|
domain |
|
|
languagecode |
|
|
name |
|
|
orgdisplayname |
|
|
orgpostaladdress |
|
|
primarycontactinfo |
|
|
updatetime
|
|
<ChannelCustomerFieldList> ::= "<ChannelCustomerField>(,<ChannelCustomerField>)*"
|
|
|
|
gam print channelcustomers [todrive <ToDriveAttribute>*]
|
|
[resellerid <ResellerID>] [filter <String>]
|
|
[fields <ChannelCustomerFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show channelcustomers
|
|
[resellerid <ResellerID>] [filter <String>]
|
|
[fields <ChannelCustomerFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
<ChannelCustomerEntitlementField> ::=
|
|
associationinfo |
|
|
commitmentsettings |
|
|
createtime |
|
|
name |
|
|
offer |
|
|
parameters |
|
|
provisionedservice |
|
|
provisioningstate |
|
|
purchaseorderid |
|
|
suspensionreasons |
|
|
trialsettings |
|
|
updatetime
|
|
<ChannelCustomerEntitlementFieldList> ::= "<ChannelCustomerEntitlementField>(,<ChannelCustomerEntitlementField>)*"
|
|
|
|
gam print channelcustomercentitlements [todrive <ToDriveAttribute>*]
|
|
([resellerid <ResellerID>] [customerid <ChannelCustomerID>])
|
|
(name accounts/<ResellerID>/customers/<ChannelCustomerID>)
|
|
[fields <ChannelCustomerEntitlementsFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show channelcustomerentitlements
|
|
([resellerid <ResellerID>] [customerid <ChannelCustomerID>])|
|
|
(name accounts/<ResellerID>/customers/<ChannelCustomerID>)
|
|
[fields <ChannelCustomerEntitlementsFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
<ChannelCustomerOfferField> ::=
|
|
constraints |
|
|
endtime |
|
|
marketinginfo |
|
|
name |
|
|
parameterdefinitions |
|
|
plan |
|
|
pricebyresources |
|
|
sku |
|
|
starttime
|
|
<ChannelOfferFieldList> ::= "<ChannelOfferField>(,<ChannelOfferField>)*"
|
|
|
|
gam print channeloffers [todrive <ToDriveAttribute>*]
|
|
[resellerid <ResellerID>] [filter <String>] [language <LanguageCode>]
|
|
[fields <ChannelOfferFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show channeloffers
|
|
[resellerid <ResellerID>] [filter <String>] [language <LanguageCode>]
|
|
[fields <ChannelOfferFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
<ChannelProductField> ::=
|
|
marketinginfo |
|
|
name
|
|
<ChannelProductFieldList> ::= "<ChannelProductField>(,<ChannelProductField>)*"
|
|
|
|
gam print channelproducts [todrive <ToDriveAttribute>*]
|
|
[resellerid <ResellerID>] [language <LanguageCode>]
|
|
[fields <ChannelProductFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show channelproducts
|
|
[resellerid <ResellerID>] [language <LanguageCode>]
|
|
[fields <ChannelProductFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
<ChannelSKUField> ::=
|
|
marketinginfo |
|
|
name |
|
|
product
|
|
<ChannelSKUFieldList> ::= "<ChannelSKUField>(,<ChannelSKUField>)*"
|
|
|
|
gam print channelskus [todrive <ToDriveAttribute>*]
|
|
[resellerid <ResellerID>] [language <LanguageCode>] [productid <ProductID>]
|
|
[fields <ChannelSKUFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show channelskus
|
|
[resellerid <ResellerID>] [language <LanguageCode>] [productid <ProductID>]
|
|
[fields <ChannelSKUFieldList>]
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
|
|
# Contacts - Delegation
|
|
|
|
gam <UserTypeEntity> create contactdelegate <UserEntity>
|
|
gam <UserTypeEntity> delete contactdelegate <UserEntity>
|
|
gam <UserTypeEntity> print contactdelegates [todrive <ToDriveAttribute>*] [shownames]
|
|
gam <UserTypeEntity> show contactdelegates [shownames] [csv]
|
|
|
|
# Classroom - Courses
|
|
|
|
<CourseAnnouncementState> ::= draft|published|deleted
|
|
<CourseAnnouncementStateList> ::= all|"<CourseAnnouncementState>(,<CourseAnnouncementState>)*"
|
|
|
|
<CourseSubmissionState> ::= new|created|turned_in|returned|reclaimed_by_student
|
|
<CourseSubmissionStateList> ::= all|"<CourseSubmissionState>(,<CourseSubmissionState>)*"
|
|
|
|
<CourseWorkState> ::= draft|published|deleted
|
|
<CourseWorkStateList> ::= all|"<CourseWorkState>(,<CourseWorkState>)*"
|
|
|
|
<CourseMaterialState> ::= draft|published|deleted
|
|
<CourseMaterialStateList> ::= all|"<CourseMaterialState>(,<CourseMaterialState>)*"
|
|
|
|
<CourseAttribute> ::=
|
|
(description <String>)|
|
|
(descriptionheading|heading <String>)|
|
|
(name <String>)|
|
|
(room <String>)|
|
|
(section <string>)|
|
|
(state|status <CourseState>)|
|
|
(owner|ownerid|teacher <UserItem>)
|
|
|
|
<CourseFieldName> ::=
|
|
aliases|
|
|
alternatelink|
|
|
calendarid|
|
|
coursegroupemail|
|
|
coursematerialsets|
|
|
coursestate|
|
|
creationtime|
|
|
description|
|
|
descriptionheading|heading|
|
|
enrollmentcode|
|
|
gradebooksettings|
|
|
guardiansenabled|
|
|
id|
|
|
name|
|
|
owneremail|
|
|
ownerid|
|
|
ownername|
|
|
room|
|
|
section|
|
|
students|
|
|
teacherfolder|
|
|
teachergroupemail|
|
|
teachers|
|
|
updatetime
|
|
<CourseFieldNameList> ::= "<CourseFieldName>(,<CourseFieldName>)*"
|
|
|
|
gam create|add course [id|alias <CourseAlias>] <CourseAttribute>*
|
|
[copyfrom <CourseID>
|
|
[announcementstates <CourseAnnouncementStateList>]
|
|
[individualstudentannouncements copy|delete|maptoall]
|
|
[materialstates <CourseMaterialStateList>]
|
|
[individualstudentmaterials copy|delete|maptoall]
|
|
[workstates <CourseWorkStateList>]
|
|
[individualstudentcoursework copy|delete|maptoall]
|
|
[removeduedate [<Boolean>]]
|
|
[mapsharemodestudentcopy edit|none|view]
|
|
[individualstudentassignments copy|delete|maptoall]
|
|
[copymaterialsfiles [<Boolean>]]
|
|
[copytopics [<Boolean>]]
|
|
[markdraftaspublished [<Boolean>]]
|
|
[markpublishedasdraft [<Boolean>]]
|
|
[members none|all|students|teachers]]
|
|
[logdrivefileids [<Boolean>]]
|
|
|
|
gam update course <CourseID> <CourseAttribute>+
|
|
[copyfrom <CourseID>
|
|
[announcementstates <CourseAnnouncementStateList>]
|
|
[individualstudentannouncements copy|delete|maptoall]
|
|
[materialstates <CourseMaterialStateList>]
|
|
[individualstudentmaterials copy|delete|maptoall]
|
|
[workstates <CourseWorkStateList>]
|
|
[individualstudentcoursework copy|delete|maptoall]
|
|
[removeduedate [<Boolean>]]
|
|
[mapsharemodestudentcopy edit|none|view]
|
|
[individualstudentassignments copy|delete|maptoall]
|
|
[copymaterialsfiles [<Boolean>]]
|
|
[copytopics [<Boolean>]]
|
|
[markdraftaspublished [<Boolean>]]
|
|
[markpublishedasdraft [<Boolean>]]
|
|
[members none|all|students|teachers]]
|
|
[logdrivefileids [<Boolean>]]
|
|
|
|
gam update courses <CourseEntity> <CourseAttribute>+
|
|
[copyfrom <CourseID>
|
|
[announcementstates <CourseAnnouncementStateList>]
|
|
[individualstudentannouncements copy|delete|maptoall]
|
|
[materialstates <CourseMaterialStateList>]
|
|
[individualstudentmaterials copy|delete|maptoall]
|
|
[workstates <CourseWorkStateList>]
|
|
[individualstudentcoursework copy|delete|maptoall]
|
|
[removeduedate [<Boolean>]]
|
|
[mapsharemodestudentcopy edit|none|view]
|
|
[individualstudentassignments copy|delete|maptoall]
|
|
[copymaterialsfiles [<Boolean>]]
|
|
[copytopics [<Boolean>]]
|
|
[markdraftaspublished [<Boolean>]]
|
|
[markpublishedasdraft [<Boolean>]]
|
|
[members none|all|students|teachers]]
|
|
[logdrivefileids [<Boolean>]]
|
|
|
|
gam delete course <CourseID> [archive|archived]
|
|
gam delete courses <CourseEntity> [archive|archived]
|
|
|
|
gam course <CourseID> create|add alias <CourseAlias>
|
|
gam course <CourseID> delete alias <CourseAlias>
|
|
|
|
<CourseAnnouncementContent> ::=
|
|
(text <String>)|
|
|
(textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>)
|
|
|
|
gam course <CourseID> create announcement
|
|
<CourseAnnouncementContent> [scheduledtime <Time>] [state draft|published]
|
|
gam course <CourseID> remove announcement <CourseAnnouncementID>
|
|
gam course <CourseID> update announcement <CourseAnnouncementID>
|
|
[<CourseAnnouncementContent>] [scheduledtime <Time>] [state published]
|
|
|
|
gam course <CourseID> create|add topic <CourseTopic>
|
|
gam course <CourseID> delete topic <CourseTopicID>
|
|
gam course <CourseID> update topic <CourseTopicID> <CourseTopic>
|
|
|
|
gam course <CourseID> create|add teachers [makefirstteacherowner] <UserItem>
|
|
gam course <CourseID> create|add students <UserItem>
|
|
gam course <CourseID> delete|remove teachers|students [owneraccess] <UserItem>
|
|
gam course <CourseID> clear teachers|students
|
|
gam course <CourseID> sync teachers [addonly|removeonly] [makefirstteacherowner] <UserTypeEntity>
|
|
gam course <CourseID> sync students [addonly|removeonly] <UserTypeEntity>
|
|
|
|
gam courses <CourseEntity> create|add alias <CourseAliasEntity>
|
|
gam courses <CourseEntity> delete alias <CourseAliasEntity>
|
|
|
|
gam courses <CourseEntity> create announcement
|
|
<CourseAnnouncementContent>> [scheduledtime <Time>] [state draft|published]
|
|
gam courses <CourseEntity> remove announcement <CourseAnnouncementIDEntity>
|
|
gam courses <CourseEntity> update announcement <CourseAnnouncementIDEntity>
|
|
[<CourseAnnouncementContent>] [scheduledtime <Time>] [state published]
|
|
|
|
gam courses <CourseEntity> create|add topic <CourseTopicEntity>
|
|
gam courses <CourseEntity> delete topic <CourseTopicIDEntity>
|
|
gam courses <CourseEntity> update topic <CourseTopicIDEntity> <CourseTopic>
|
|
|
|
gam courses <CourseEntity> create|add teachers [makefirstteacherowner] <UserTypeEntity>
|
|
gam courses <CourseEntity> create|add students <UserTypeEntity>
|
|
gam courses <CourseEntity> delete|remove teachers|students [owneraccess] <UserTypeEntity>
|
|
gam courses <CourseEntity> clear teachers|students
|
|
gam courses <CourseEntity> sync teachers [addonly|removeonly] [makefirstteacherowner] <UserTypeEntity>
|
|
gam courses <CourseEntity> sync students [addonly|removeonly] <UserTypeEntity>
|
|
|
|
gam info course <CourseID> [owneraccess]
|
|
[owneremail] [ownername] [alias|aliases] [show all|students|teachers] [countsonly]
|
|
[fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>]
|
|
[formatjson]
|
|
gam info courses <CourseEntity> [owneraccess]
|
|
[owneremail] [ownername] [alias|aliases] [show all|students|teachers] [countsonly]
|
|
[fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>]
|
|
[formatjson]
|
|
gam print courses [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
[owneremail] [owneremailmatchpattern <REMatchPattern>] [ownername]
|
|
[alias|aliases|aliasesincolumns [delimiter <Character>]]
|
|
[show all|students|teachers] [countsonly]
|
|
[timefilter creationtime|updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[fields <CourseFieldNameList>] [skipfields <CourseFieldNameList>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
gam print course-participants [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
[show all|students|teachers]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
gam print course-counts students|teachers [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
[mincount <Integer>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<CourseAnnouncementFieldName> ::=
|
|
alternatelink|
|
|
assigneemode|
|
|
courseid|
|
|
courseannouncementid|
|
|
creationtime|
|
|
creator|creatoruserid|
|
|
id|
|
|
individualstudentsoptions|
|
|
materials|
|
|
scheduledtime|
|
|
state|
|
|
text|
|
|
updatetime
|
|
<CourseAnnouncementFieldNameList> ::= "<CourseAnnouncementFieldName>(,<CourseAnnouncementFieldName>)*"
|
|
|
|
<CourseAnnouncementOrderByFieldName> ::=
|
|
updatetime|
|
|
updatedate
|
|
|
|
<CourseMaterialFieldName> ::=
|
|
alternatelink|
|
|
assigneemode|
|
|
courseid|
|
|
courseworkmaterialid|
|
|
creationtime|
|
|
creator|creatoruserid|
|
|
description|
|
|
id|
|
|
individualstudentsoptions|
|
|
materials|
|
|
scheduledtime|
|
|
state|
|
|
title|
|
|
topicid|
|
|
updatetime|
|
|
workmaterialid
|
|
<CourseMaterialFieldNameList> ::= "<CourseMaterialFieldName>(,<CourseMaterialFieldName>)*"
|
|
|
|
<CourseMaterialOrderByFieldName> ::=
|
|
updatetime|
|
|
updatedate
|
|
|
|
<CourseSubmissionFieldName> ::=
|
|
alternatelink|
|
|
assignedgrade|
|
|
courseid|
|
|
courseworkid|
|
|
courseworktype|
|
|
creationtime|
|
|
draftgrade|
|
|
id|
|
|
late|
|
|
state|
|
|
submissionhistory|
|
|
updatetime|
|
|
userid|
|
|
worktype
|
|
<CourseSubmissionFieldNameList> ::= "<CourseSubmissionFieldName>(,<CourseSubmissionFieldName>)*"
|
|
|
|
<CourseWorkFieldName> ::=
|
|
alternatelink|
|
|
assigneemode|
|
|
courseid|
|
|
courseworkid|
|
|
courseworktype|
|
|
creationtime|
|
|
creator|creatoruserid|
|
|
description|
|
|
duedate|
|
|
duetime|
|
|
id|
|
|
individualstudentsoptions|
|
|
materials|
|
|
maxpoints|
|
|
scheduledtime|
|
|
state|
|
|
submissionmodificationmode|
|
|
title|
|
|
topicid|
|
|
updatetime|
|
|
workid|
|
|
worktype
|
|
<CourseWorkFieldNameList> ::= "<CourseWorkFieldName>(,<CourseWorkFieldName>)*"
|
|
|
|
<CourseWorkOrderByFieldName> ::=
|
|
duedate|
|
|
updatetime|
|
|
updatedate
|
|
|
|
gam print course-announcements [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] states <CourseStateList>])
|
|
(announcementids <CourseAnnouncementIDEntity>)|((announcementstates <CourseAnnouncementStateList>)*
|
|
(orderby <CourseAnnouncementOrderByFieldName> [ascending|descending])*)
|
|
[showcreatoremails|creatoremail] [showcreatornames|creatorname]
|
|
[fields <CourseAnnouncementFieldNameList>]
|
|
[timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[countsonly] [formatjson [quotechar <Character>]]
|
|
gam print course-materials [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] states <CourseStateList>])
|
|
(materialids <CourseMaterialIDEntity>)|((materialstates <CourseMaterialStateList>)*
|
|
(orderby <CourseMaterialOrderByFieldName> [ascending|descending])*)
|
|
[showcreatoremails|creatoremail] [showcreatornames|creatorname] [showtopicnames]
|
|
[fields <CourseMaterialFieldNameList>]
|
|
[timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[oneitemperrow]
|
|
[countsonly] [formatjson [quotechar <Character>]]
|
|
gam print course-submissions [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] states <CourseStateList>])
|
|
(workids <CourseWorkIDEntity>)|((workstates <CourseWorkStateList>)*
|
|
(orderby <CourseWorkOrderByFieldName> [ascending|descending])*)
|
|
(submissionids <CourseSubmissionIDEntity>)|((submissionstates <CourseSubmissionStateList>)*) [late|notlate]
|
|
[fields <CourseSubmissionFieldNameList>]
|
|
[timefilter creationtime|updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[countsonly] [formatjson [quotechar <Character>]]
|
|
gam print course-topics [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] states <CourseStateList>])
|
|
[topicids <CourseTopicIDEntity>]
|
|
[timefilter updatetime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[countsonly] [formatjson [quotechar <Character>]]
|
|
gam print course-works [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] states <CourseStateList>])
|
|
(workids <CourseWorkIDEntity>)|((workstates <CourseWorkStateList>)*
|
|
(orderby <CourseWorkOrderByFieldName> [ascending|descending])*)
|
|
[showcreatoremails|creatoremail] [showcreatornames|creatorname] [showtopicnames]
|
|
[fields <CourseWorkFieldNameList>]
|
|
[showstudentsaslist [<Boolean>]] [delimiter <Character>]
|
|
[timefilter creationtime|updatetime|scheduledtime] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[oneitemperrow]
|
|
[countsonly] [formatjson [quotechar <Character>]]
|
|
|
|
# Classroom - Student Groups
|
|
|
|
gam create course-studentgroups
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
((title <String>)|(select <StringEntity))+
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam update course-studentgroups <CourseID> <StudentGroupID> title <String>
|
|
gam delete course-studentgroups <CourseID> <StudentGroupIDEntity>
|
|
gam clear course-studentgroups
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
gam print course-studentgroups [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam create course-studentgroup-members <CourseID> <StudentGroupID> <UserTypeEntity>
|
|
gam delete course-studentgroup-members <CourseID> <StudentGroupID> <UserTypeEntity>
|
|
gam sync course-studentgroup-members <CourseID> <StudentGroupID> <UserTypeEntity>
|
|
gam clear course-studentgroupmembers <CourseID> <StudentGroupID>
|
|
gam print course-studentgroup-members [todrive <ToDriveAttribute>*]
|
|
(course|class <CourseEntity>)*|([teacher <UserItem>] [student <UserItem>] [states <CourseStateList>])
|
|
[showitemcountonly] [formatjson [quotechar <Character>]]
|
|
|
|
# Classroom - Invitations
|
|
|
|
gam <UserTypeEntity> create classroominvitation courses <CourseEntity> [role owner|student|teacher]
|
|
[adminaccess|asadmin]
|
|
[csv|csvformat] [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> accept classroominvitation (ids <ClassroomInvitationIDEntity>)|([courses <CourseEntity>] [role all|owner|student|teacher])
|
|
gam <UserTypeEntity> delete classroominvitation (ids <ClassroomInvitationIDEntity>)|([courses <CourseEntity>] [role all|owner|student|teacher])
|
|
gam <UserTypeEntity> show classroominvitations [role all|owner|student|teacher]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print classroominvitations [todrive <ToDriveAttribute>*] [role all|owner|student|teacher]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam delete classroominvitation courses <CourseEntity> (ids <ClassroomInvitationIDEntity>)|(role all|owner|student|teacher)
|
|
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>]]
|
|
|
|
# Classroom - Guardians
|
|
|
|
<GuardianInvitationState> ::=
|
|
complete|
|
|
pending
|
|
<GuardianInvitationStateList> ::= "<GuardianInvitationState>(,<GuardianInvitationState>)*"
|
|
|
|
## Selected students, new style
|
|
|
|
gam <UserTypeEntity> create|add guardian|guardianinvitation <GuardianEntity>
|
|
gam <UserTypeEnfity> cancel guardianinvitation|guardianinvitations <GuardianInvitationIDEntity>
|
|
gam <UserTypeEntity> delete guardian|guardians <GuardianEntity> [accepted|invitations|all]
|
|
gam <UserTypeEntity> clear guardian|guardians [accepted|invitations|all]
|
|
gam <UserTypeEntity> sync guardian|guardians <GuardianEntity>
|
|
gam <UserTypeEntity> show guardian|guardians [accepted|invitations|all] [states <GuardianInvitationStateList>] [invitedguardian <EmailAddress>]
|
|
[showstudentemails]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print guardian|guardians [todrive <ToDriveAttribute>*] [accepted|invitations|all] [states <GuardianInvitationStateList>] [invitedguardian <EmailAddress>]
|
|
[showstudentemails]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
## Selected students, old style
|
|
|
|
gam create|add guardian|guardianinvitation <EmailAddress> <StudentItem>
|
|
gam cancel guardianinvitation|guardianinvitations <GuardianInvitationID> <StudentItem>
|
|
gam delete guardian|guardians <GuardianItem> <StudentItem> [accepted|invitations|all]
|
|
gam show guardian|guardians [accepted|invitations|all] [states <GuardianInvitationStateList>] [invitedguardian <EmailAddress>]
|
|
[student <StudentItem>] [<UserTypeEntity>]
|
|
[showstudentemails]
|
|
[formatjson]
|
|
gam print guardian|guardians [todrive <ToDriveAttribute>*] [accepted|invitations|all] [states <GuardianInvitationStateList>] [invitedguardian <EmailAddress>]
|
|
[student <StudentItem>] [<UserTypeEntity>]
|
|
[showstudentemails]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
## All students
|
|
gam print guardian|guardians [todrive <ToDriveAttribute>*] [accepted|invitations|all] [states <GuardianInvitationStateList>] [invitedguardian <EmailAddress>]
|
|
[showstudentemails]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Classroom User Profiles
|
|
|
|
gam <UserTypeEntity> print classroomprofile [todrive <ToDriveAttribute>*]
|
|
gam <UserTypeEntity> show classroomprofile
|
|
|
|
# Customer
|
|
|
|
<CustomerAttribute> ::=
|
|
(primary <DomainName>)|
|
|
(adminsecondaryemail|alternateemail <EmailAddress>)|
|
|
(contact|contactname <String>)|
|
|
(language <LanguageCode>)|
|
|
(phone|phonenumber <String>)|
|
|
(name|organizationname <String>)|
|
|
(address|address1|addressline1 <String>)|
|
|
(address2|addressline2 <String>)|
|
|
(address3|addressline3 <String>)|
|
|
(city|locality <String>)|
|
|
(state|region <String>)|
|
|
(zipcode|postal|postalcode <String>)|
|
|
(country|countrycode <String>)
|
|
|
|
gam update customer <CustomerAttribute>*
|
|
|
|
gam info customer [formatjson]
|
|
|
|
gam info instance [formatjson]
|
|
|
|
gam info customerid
|
|
|
|
gam info gcporgid
|
|
|
|
# Data Transfers
|
|
|
|
gam print|show transferapps
|
|
|
|
<DataTransferService> ::=
|
|
calendar|
|
|
datastudio|lookerstudio|"looker studio"|
|
|
googledrive|gdrive|drive|"drive and docs"
|
|
<DataTransferServiceList> ::= "<DataTransferService>(,<DataTransferService>)*"
|
|
|
|
<OldOwnerID> ::= <UserItem>
|
|
<NewOwnerID> ::= <UserItem>
|
|
|
|
gam create|add datatransfer|transfer <OldOwnerID> <DataTransferServiceList> <NewOwnerID>
|
|
[private|shared|all] [release_resources]
|
|
(<ParameterKey> <ParameterValue>)*
|
|
[wait <Integer> <Integer>]
|
|
gam info datatransfer|transfer <TransferID>
|
|
gam print datatransfers|transfers [todrive <ToDriveAttribute>*]
|
|
[olduser|oldowner <UserItem>] [newuser|newowner <UserItem>]
|
|
[status completed|failed|inprogress] [delimiter <Character>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
gam show datatransfers|transfers
|
|
[olduser|oldowner <UserItem>] [newuser|newowner <UserItem>]
|
|
[status completed|failed|inprogress] [delimiter <Character>]
|
|
|
|
# Domains
|
|
|
|
<DomainAlias> ::= <String>
|
|
|
|
gam create|add domain <DomainName>
|
|
gam update domain <DomainName> primary
|
|
gam delete domain <DomainName>
|
|
|
|
gam info domain [<DomainName>]
|
|
[formatjson]
|
|
gam print domains [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
gam show domains
|
|
[formatjson]
|
|
[showitemcountonly]
|
|
|
|
gam create|add domainalias|aliasdomain <DomainAlias> <DomainName>
|
|
gam delete domainalias|aliasdomain <DomainAlias>
|
|
|
|
gam info domainalias|aliasdomain <DomainAlias>
|
|
[formatjson]
|
|
gam print domainaliases|aliasdomains [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
gam show domainaliases|aliasdomains
|
|
[formatjson]
|
|
[showitemcountonly]
|
|
|
|
# Domain - Contacts and Global Address List
|
|
|
|
<ContactNoteContent> ::=
|
|
<String>|
|
|
(file|textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)
|
|
(gcsdoc <StorageBucketObjectName>)
|
|
|
|
<ContactAttribute> ::=
|
|
(additionalname|middlename <String>)|
|
|
(address clear|(work|home|other|<String> ((formatted|unstructured <String>)|(streetaddress <String>)|(pobox <String>)|
|
|
(neighborhood <String>)|(locality <String>)|(region <String>)|(postalcode <String>)|(country <String>))* notprimary|primary))|
|
|
(billinginfo <String>)|
|
|
(birthday <Date>)|
|
|
(calendar clear|(work|home|free-busy|<String> <URL> notprimary|primary))|
|
|
(directoryserver <String>)|
|
|
(email clear|(work|home|other|<String> <EmailAddress> notprimary|primary))|
|
|
(event clear|(anniversary|other|<String> <Date>))|
|
|
(externalid clear|(account|customer|network|organization|<String> <String>))|
|
|
(familyname|lastname <String>)|
|
|
(gender female|male)|
|
|
(givenname|firstname <String>)|
|
|
(hobby clear|(<String>))|
|
|
(im clear|(work|home|other|<String> aim|gtalk|icq|jabber|msn|net_meeting|qq|skype|yahoo <String> notprimary|primary))|
|
|
(initials <String>)|
|
|
(jot clear|(work|home|other|keywords|<user> <String>))|
|
|
<JSONData>||
|
|
(language <Language>)|
|
|
(location <String>)|
|
|
(maidenname <String>)|
|
|
(mileage <String>)|
|
|
(name <String>)|
|
|
(nickname <String>)|
|
|
(note <ContactNoteContent>)|
|
|
(occupation <String>)|
|
|
(organization clear|(work|other|<String> <String> ((location <String>)|(department <String>)|(title <String>)|(jobdescription <String>)|(symbol <String>))* notprimary|primary))|
|
|
(phone clear|(work|home|other|fax|work_fax|home_fax|other_fax|main|company_main|assistant|mobile|work_mobile|pager|work_pager|car|radio|callback|isdn|telex|tty_tdd|<String> <String> notprimary|primary))|
|
|
(prefix <String>)|
|
|
(priority low|normal|high)
|
|
(relation clear|(spouse|child|mother|father|parent|brother|sister|friend|relative|domestic_partner|manager|assistant|referred_by|partner|<String> <String>))|
|
|
(sensitivity confidential|normal|personal|private)
|
|
(shortname <String>)|
|
|
(subject <String>)|
|
|
(suffix <String>)|
|
|
(userdefinedfield clear|(<String> <String>))|
|
|
(website clear|(app_install_page|blog|ftp|home|home_page|other|profile|reservations|work|<String> <URL> notprimary|primary))
|
|
|
|
<ContactSelection> ::=
|
|
[query <QueryContact>]
|
|
[emailmatchpattern <REMatchPattern> [emailmatchtype work|home|other|<String>]]
|
|
[updated_min <Date>]
|
|
|
|
gam create contact <ContactAttribute>+
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*))| returnidonly]
|
|
gam update contacts <ContactEntity>|<ContactSelection> <ContactAttribute>+
|
|
gam clear contacts <ContactEntity>|<ContactSelection>
|
|
[emailclearpattern <REMatchPattern>] [emailcleartype work|home|other|<String>]
|
|
[delete_cleared_contacts_with_no_emails]
|
|
gam dedup contacts <ContactEntity>|<ContactSelection> [matchType [<Boolean>]]
|
|
gam delete contacts <ContactEntity>|<ContactSelection>
|
|
|
|
gam update contactphotos <ContactEntity>|<ContactSelection>
|
|
[drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>]
|
|
gam get contactphotos <ContactEntity>|<ContactSelection>
|
|
[drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
|
|
gam delete contactphotos <ContactEntity>|<ContactSelection>
|
|
|
|
<ContactFieldName> ::=
|
|
additionalname|middlename|
|
|
address|
|
|
billinginfo|
|
|
birthday|
|
|
calendar|
|
|
directoryserver|
|
|
email|
|
|
event|
|
|
externalid|
|
|
familyname|lastname|
|
|
gender|
|
|
givenname|firstname|
|
|
hobby|
|
|
im|
|
|
initials|
|
|
jot|
|
|
language|
|
|
location|
|
|
maidenname|
|
|
mileage|
|
|
name|
|
|
nickname|
|
|
note|
|
|
occupation|
|
|
organization|
|
|
phone|
|
|
prefix|
|
|
priority|
|
|
relation|
|
|
sensitivity|
|
|
shortname|
|
|
subject|
|
|
suffix|
|
|
updated|
|
|
userdefinedfield|
|
|
website
|
|
<ContactFieldNameList> ::= "<ContactFieldName>(,<ContactFieldName>)*"
|
|
|
|
<ContactOrderByFieldName> ::=
|
|
lastmodified
|
|
|
|
gam info contacts <ContactEntity>
|
|
[basic|full]
|
|
[fields <ContactFieldNameList>]
|
|
[formatjson]
|
|
gam show contacts <ContactSelection>
|
|
[basic|full|countsonly] [showdeleted] [orderby <ContactOrderByFieldName> [ascending|descending]]
|
|
[fields <ContactFieldNameList>]
|
|
[formatjson]
|
|
gam print contacts [todrive <ToDriveAttribute>*] <ContactSelection>
|
|
[basic|full|countsonly] [showdeleted] [orderby <ContactOrderByFieldName> [ascending|descending]]
|
|
[fields <ContactFieldNameList>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Domain - People Contacts and Profiles
|
|
|
|
<PeopleSourceName> ::=
|
|
contact|contacts|
|
|
profile|profiles
|
|
|
|
<PeopleMergeSourceName> ::=
|
|
contact|contacts
|
|
|
|
<PeopleFieldName> ::=
|
|
addresses|
|
|
ageranges|
|
|
biographies|
|
|
birthdays|
|
|
calendarurls|
|
|
clientdata|
|
|
coverphotos|
|
|
emailaddresses|
|
|
events|
|
|
externalids|
|
|
genders|
|
|
imclients|
|
|
interests|
|
|
locales|
|
|
locations|
|
|
memberships|
|
|
metadata|
|
|
misckeywords|
|
|
names|
|
|
nicknames|
|
|
occupations|
|
|
organizations|
|
|
phonenumbers|
|
|
photos|
|
|
relations|
|
|
sipaddresses|
|
|
skills|
|
|
urls|
|
|
updated|updatetime|
|
|
userdefined
|
|
<PeopleFieldNameList> ::= "<PeopleFieldName>(,<PeopleFieldName>)*"
|
|
|
|
gam info domaincontacts|peoplecontacts <PeopleResourceNameEntity>
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[formatjson]
|
|
gam print domaincontacts|peoplecontacts [todrive <ToDriveAttribute>*]
|
|
[sources <PeopleSourceName>]
|
|
[query <String>]
|
|
[mergesources <PeopleMergeSourceName>]
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[coountsonly|(formatjson [quotechar <Character>])]
|
|
gam show domaincontacts|peoplecontacts
|
|
[sources <PeopleSourceName>]
|
|
[query <String>]
|
|
[mergesources <PeopleMergeSourceName>]
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[coountsonly|formatjson]
|
|
|
|
gam info people|peopleprofile <PeopleResourceNameEntity>
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[formatjson]
|
|
gam print people|peopleprofile [todrive <ToDriveAttribute>*]
|
|
[query <String>]
|
|
[mergesources <PeopleMergeSourceName>]
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[coountsonly|(formatjson [quotechar <Character>])]
|
|
gam show people|peopleprofile
|
|
[query <String>]
|
|
[mergesources <PeopleMergeSourceName>]
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[coountsonly|formatjson]
|
|
|
|
# Email Audit Monitor
|
|
|
|
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>
|
|
|
|
# Groups
|
|
|
|
<GroupSettingsAttribute> ::=
|
|
(accesstype public|team|announcementonly|restricted)|
|
|
(allowexternalmembers <Boolean>)|
|
|
(allowwebposting <Boolean>)|
|
|
(archiveonly <Boolean>)|
|
|
(customfootertext <String>)|
|
|
(customreplyto <EmailAddress>)|
|
|
(defaultmessagedenynotificationtext <String>)|
|
|
(defaultsender self|group)|
|
|
(description <String>)|
|
|
(enablecollaborativeinbox|collaborative <Boolean>)|
|
|
(includeinglobaladdresslist|gal <Boolean>)|
|
|
(includecustomfooter <Boolean>)|
|
|
(isarchived <Boolean>)|
|
|
(memberscanpostasthegroup <Boolean>)|
|
|
(messagemoderationlevel moderate_all_messages|moderate_non_members|moderate_new_members|moderate_none)|
|
|
(name <String>)|
|
|
(primarylanguage <Language>)|
|
|
(replyto reply_to_custom|reply_to_sender|reply_to_list|reply_to_owner|reply_to_ignore|reply_to_managers)|
|
|
(sendmessagedenynotification <Boolean>)|
|
|
(spammoderationlevel allow|moderate|silently_moderate|reject)|
|
|
(whocanadd all_members_can_add|all_managers_can_add|all_owners_can_add|none_can_add)|
|
|
(whocanaddexternalmembers only_owners_can_add_external_members|end_users_can_add_external_members)|
|
|
(whocancontactowner anyone_can_contact|all_in_domain_can_contact|all_members_can_contact|all_managers_can_contact|all_owners_can_contact)|
|
|
(whocanjoin anyone_can_join|all_in_domain_can_join|invited_can_join|can_request_to_join)|
|
|
(whocanleavegroup all_members_can_leave|all_managers_can_leave|all_owners_can_leave|none_can_leave)|
|
|
(whocanpostmessage none_can_post|all_managers_can_post|all_members_can_post|all_owners_can_post|all_in_domain_can_post|anyone_can_post)|
|
|
(whocanviewgroup anyone_can_view|all_in_domain_can_view|all_members_can_view|all_managers_can_view|all_owners_can_view)|
|
|
(whocanviewmembership all_in_domain_can_view|all_members_can_view|all_managers_can_view|all_owners_can_view)
|
|
<GroupWhoCanDiscoverGroupDeprecatedAttribute> ::=
|
|
(showingroupdirectory <Boolean>)
|
|
<GroupWhoCanAssistContentDeprecatedAttribute> ::=
|
|
(whocanassigntopics all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanenterfreeformtags all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanhideabuse all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmaketopicssticky all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmarkduplicate all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmarkfavoritereplyonanytopic all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmarknoresponseneeded all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmodifytagsandcategories all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocantaketopics all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanunassigntopic all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanunmarkfavoritereplyonanytopic all_members|owners_and_managers|managers_only|owners_only|none)
|
|
<GroupWhoCanModerateContentDeprecatedAttribute> ::=
|
|
(whocanapprovemessages all_members|owners_and_managers|owners_only|none)|
|
|
(whocandeleteanypost all_members|owners_and_managers|owners_only|none)|
|
|
(whocandeletetopics all_members|owners_and_managers|owners_only|none)|
|
|
(whocanlocktopics all_members|owners_and_managers|owners_only|none)|
|
|
(whocanmovetopicsin all_members|owners_and_managers|owners_only|none)|
|
|
(whocanmovetopicsout all_members|owners_and_managers|owners_only|none)|
|
|
(whocanpostannouncements all_members|owners_and_managers|owners_only|none)
|
|
<GroupWhoCanModerateMembersDeprecatedAttribute> ::=
|
|
(whocanadd all_members_can_add|all_managers_can_add|none_can_add)|
|
|
(whocanapprovemembers all_members_can_approve|all_managers_can_approve|all_owners_can_approve|none_can_approve)|
|
|
(whocanbanusers all_members|owners_and_managers|owners_only|none)|
|
|
(whocaninvite all_members_can_invite|all_managers_can_invite|all_owners_can_invite|none_can_invite)|
|
|
(whocanmodifymembers all_members|owners_and_managers|owners_only|none)
|
|
<GroupDeprecatedAttribute> ::=
|
|
(allowgooglecommunication <Boolean>)|
|
|
(favoriterepliesontop <Boolean>)|
|
|
(maxmessagebytes <ByteCount>)|
|
|
(messagedisplayfont default_font|fixed_width_font)|
|
|
(whocanaddreferences all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmarkfavoritereplyonowntopic all_members|owners_and_managers|managers_only|owners_only|none)
|
|
<GroupAttribute> ::=
|
|
<GroupSettingsAttribute>|
|
|
<JSONData>|
|
|
(whocandiscovergroup all_members_can_discover|all_in_domain_can_discover|anyone_can_discover)|
|
|
(whocanassistcontent all_members|owners_and_managers|managers_only|owners_only|none)|
|
|
(whocanmoderatecontent all_members|owners_and_managers|owners_only|none)|
|
|
(whocanmoderatemembers all_members|owners_and_managers|owners_only|none)|
|
|
<GroupWhoCanDiscoverGroupDeprecatedAttribute>|
|
|
<GroupWhoCanAssistContentDeprecatedAttribute>|
|
|
<GroupWhoCanModerateContentDeprecatedAttribute>|
|
|
<GroupWhoCanModerateMembersDeprecatedAttribute>|
|
|
<GroupDeprecatedAttribute>
|
|
|
|
gam create|add group <EmailAddress>
|
|
[copyfrom <GroupItem>] <GroupAttribute>*
|
|
[verifynotinvitable]
|
|
[recentdeleteretries <Integer>] [recentdeleteretrydelay <Integer>]
|
|
[verifycreationretries <Integer>] [verifycreationinitialdelay <Integer>] [verifycreationretrydelay <Integer>]
|
|
gam update group|groups <GroupEntity> [email <EmailAddress>]
|
|
[updateprimaryemail <RESearchPattern> <RESubstitution>]
|
|
[copyfrom <GroupItem>] <GroupAttribute>*
|
|
[security|makesecuritygroup]
|
|
[admincreated <Boolean>]
|
|
[verifynotinvitable]
|
|
gam update group|groups <GroupEntity> create|add [<GroupRole>]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[[delivery] <DeliverySetting>]
|
|
[preview] [actioncsv]
|
|
<UserItem>|<UserTypeEntity>
|
|
gam update group|groups <GroupEntity> delete|remove [<GroupRole>]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[preview] [actioncsv]
|
|
<UserItem>|<UserTypeEntity>
|
|
gam update group|groups <GroupEntity> sync [<GroupRole>|ignorerole]
|
|
[usersonly|groupsonly] [addonly|removeonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[removedomainnostatusmembers]
|
|
[[delivery] <DeliverySetting>]
|
|
[preview] [actioncsv]
|
|
(additionalmembers [<GroupRole>] <EmailAddressEntity>)*
|
|
<UserItem>|<UserTypeEntity>
|
|
gam update group|groups <GroupEntity> update [<GroupRole>]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[[delivery] <DeliverySetting>]
|
|
[createifnotfound]
|
|
[preview] [actioncsv]
|
|
<UserItem>|<UserTypeEntity>
|
|
gam update group|groups <GroupEntity> clear [member] [manager] [owner]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[emailclearpattern|emailretainpattern <REMatchPattern>]
|
|
[removedomainnostatusmembers]
|
|
[preview] [actioncsv]
|
|
gam delete group|groups <GroupEntity> [noactionifalias]
|
|
|
|
<GroupFieldName> ::=
|
|
admincreated|
|
|
aliases|
|
|
allowexternalmembers|
|
|
allowgooglecommunication|
|
|
allowwebposting|
|
|
archiveonly|
|
|
customfootertext|
|
|
customreplyto|
|
|
customrolesenabledforsettingstobemerged|
|
|
defaultmessagedenynotificationtext|
|
|
description|
|
|
directmemberscount|
|
|
email|
|
|
enablecollaborativeinbox|collaborative|
|
|
favoriterepliesontop|
|
|
id|
|
|
includecustomfooter|
|
|
includeinglobaladdresslist|gal|
|
|
isarchived|
|
|
maxmessagebytes|
|
|
memberscanpostasthegroup|
|
|
messagedisplayfont|
|
|
messagemoderationlevel|
|
|
name|
|
|
primarylanguage|
|
|
replyto|
|
|
sendmessagedenynotification|
|
|
showingroupdirectory|
|
|
spammoderationlevel|
|
|
whocanaddreferences|
|
|
whocanadd|
|
|
whocanaddexternalmembers|
|
|
whocanapprovemessages|
|
|
whocanassigntopics|
|
|
whocanassistcontent|
|
|
whocancontactowner|
|
|
whocandeleteanypost|
|
|
whocandeletetopics|
|
|
whocandiscovergroup|
|
|
whocanenterfreeformtags|
|
|
whocanhideabuse|
|
|
whocaninvite|
|
|
whocanjoin|
|
|
whocanleavegroup|
|
|
whocanlocktopics|
|
|
whocanmaketopicssticky|
|
|
whocanmarkduplicate|
|
|
whocanmarkfavoritereplyonanytopic|
|
|
whocanmarkfavoritereplyonowntopic|
|
|
whocanmarknoresponseneeded|
|
|
whocanmoderatecontent|
|
|
whocanmodifytagsandcategories|
|
|
whocanmovetopicsin|
|
|
whocanmovetopicsout|
|
|
whocanpostannouncements|
|
|
whocanpostmessage|
|
|
whocantaketopics|
|
|
whocanunassigntopic|
|
|
whocanunmarkfavoritereplyonanytopic|
|
|
whocanviewgroup|
|
|
whocanviewmembership
|
|
<GroupFieldNameList> ::= "<GroupFieldName>(,<GroupFieldName>)*"
|
|
|
|
<CIGroupFieldName> ::=
|
|
additionalgroupkeys|
|
|
createtime|
|
|
description|
|
|
displayname|
|
|
dynamicgroupmetadata|
|
|
groupkey|
|
|
labels|
|
|
name|
|
|
parent|
|
|
updatetime
|
|
<CIGroupFieldNameList> ::= "<CIGroupFieldName>(,<CIGroupFieldName>)*"
|
|
|
|
gam info group|groups <GroupEntity>
|
|
[nousers] [quick] [noaliases] [groups]
|
|
[basic] <GroupFieldName>* [fields <GroupFieldNameList>] [nodeprecated]
|
|
[ciallfields|(cifields <CIGroupFieldNameList>)]
|
|
[members] [managers] [owners]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[types <GroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[formatjson]
|
|
gam print groups [todrive <ToDriveAttribute>*]
|
|
[([domain|domains <DomainNameEntity>] ([member|showownedby <EmailItem>]|[(query <QueryGroup>)|(queries <QueryGroupList>)]))|
|
|
(group|group_ns|group_susp <GroupItem>)|
|
|
(select <GroupEntity>)]
|
|
[emailmatchpattern [not] <REMatchPattern>] [namematchpattern [not] <REMatchPattern>]
|
|
[descriptionmatchpattern [not] <REMatchPattern>] (matchsetting [not] <GroupAttribute>)*
|
|
[admincreatedmatch <Boolean>]
|
|
[maxresults <Number>]
|
|
[allfields|([basic] [settings] <GroupFieldName>* [fields <GroupFieldNameList>])]
|
|
[ciallfields|(cifields <CIGroupFieldNameList>)]
|
|
[nodeprecated]
|
|
[roles <GroupRoleList>]
|
|
[members|memberscount] [managers|managerscount] [owners|ownerscount] [totalcount] [countsonly]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[includederivedmembership]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[types <GroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[convertcrnl] [delimiter <Character>] [sortheaders]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
gam print grouptree <GroupEntity> [todrive <ToDriveAttribute>*]
|
|
[showparentsaslist [<Boolean>]] [delimiter <Character>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show grouptree <GroupEntity>
|
|
[formatjson]
|
|
|
|
<MembersFieldName> ::=
|
|
delivery|deliverysettings|
|
|
email|useremail|
|
|
group|groupemail|
|
|
id|
|
|
name|
|
|
role|
|
|
status|
|
|
type
|
|
<MembersFieldNameList> ::= "<MembersFieldName>(,<MembersFieldName>)*"
|
|
|
|
gam <UserTypeEntity> info member|group-members <GroupEntity>
|
|
gam info member|group-members <UserItem>|<UserTypeEntity> <GroupEntity>
|
|
gam print group-members [todrive <ToDriveAttribute>*]
|
|
[([domain|domains <DomainNameEntity>] ([member|showownedby <EmailItem>]|[(query <QueryGroup>)|(queries <QueryGroupList>)]))|
|
|
(group|group_ns|group_susp <GroupItem>)|
|
|
(select <GroupEntity>)]
|
|
[emailmatchpattern [not] <REMatchPattern>] [namematchpattern [not] <REMatchPattern>]
|
|
[descriptionmatchpattern [not] <REMatchPattern>]
|
|
[admincreatedmatch <Boolean>]
|
|
[roles <GroupRoleList>] [members] [managers] [owners]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[showallowexternal [<Boolean>]] [verifyallowexternal [<Boolean>]]
|
|
[membernames] [showdeliverysettings]
|
|
<MembersFieldName>* [fields <MembersFieldNameList>]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[types <GroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[userfields <UserFieldNameList>]
|
|
[allschemas|(schemas|custom|customschemas <SchemaNameList>)]
|
|
[(recursive [noduplicates])|includederivedmembership] [nogroupemail]
|
|
[peoplelookup|(peoplelookupuser <EmailAddress>)]
|
|
[unknownname <String>] [cachememberinfo [Boolean]]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show group-members
|
|
[([domain|domains <DomainNameEntity>] ([member|showownedby <EmailItem>]|[(query <QueryGroup>)|(queries <QueryGroupList>)]))|
|
|
(group|group_ns|group_susp <GroupItem>)|
|
|
(select <GroupEntity>)]
|
|
[emailmatchpattern [not] <REMatchPattern>] [namematchpattern [not] <REMatchPattern>]
|
|
[descriptionmatchpattern [not] <REMatchPattern>]
|
|
[admincreatedmatch <Boolean>]
|
|
[roles <GroupRoleList>] [members] [managers] [owners] [depth <Number>]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[types <GroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[includederivedmembership]
|
|
|
|
# Cloud Identity Groups
|
|
|
|
<CBCMBrowser> ::= id:cbcm-browser.<DeviceId>
|
|
<ChromeOSDevice> ::= id:chrome-os-device.<DeviceId>
|
|
<BrowserDeviceList> ::= "(<CBCMBrowser>|<ChromeOSDevice>)(,(<CBCMBrowser>|<ChromeOSDevice>))*"
|
|
|
|
<CIGroupFieldsName> ::=
|
|
additionalgroupkeys|
|
|
createtime|
|
|
description|
|
|
displayname|
|
|
dynamicgroupmetadata|
|
|
groupkey|
|
|
labels|
|
|
name|
|
|
parent|
|
|
updatetime
|
|
<CIGroupFieldNameList> ::= "<CIGroupFieldName>(,<CIGroupFieldName>)*"
|
|
|
|
gam create cigroup <EmailAddress>
|
|
[copyfrom <GroupItem>] <GroupAttribute>*
|
|
[makeowner] [alias|aliases <CIGroupAliasList>]
|
|
[security|makesecuritygroup] [locked]
|
|
[dynamic <QueryDynamicGroup>]
|
|
gam update cigroup <GroupEntity> [copyfrom <GroupItem>] <GroupAttribute>
|
|
[updateprimaryemail <RESearchPattern> <RESubstitution>]
|
|
[security|makesecuritygroup|
|
|
dynamicsecurity|makedynamicsecuritygroup|
|
|
lockedsecurity|makelockedsecuritygroup]
|
|
[locked|unlocked]
|
|
[dynamic <QueryDynamicGroup>]
|
|
[memberrestrictions <QueryMemberRestrictions>]
|
|
gam update cigroups <GroupEntity> create|add [<GroupRole>]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[expire|expires <Time>] [preview] [actioncsv]
|
|
<UserTypeEntity>|<BrowserDeviceList>
|
|
gam update cigroups <GroupEntity> delete|remove [<GroupRole>]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[preview] [actioncsv]
|
|
<UserTypeEntity>|<BrowserDeviceList>
|
|
gam update cigroups <GroupEntity> sync [<GroupRole>|ignorerole]
|
|
[usersonly|groupsonly] [addonly|removeonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[expire|expires <Time>] [preview] [actioncsv]
|
|
<UserTypeEntity>
|
|
gam update cigroups <GroupEntity> update [<GroupRole>]
|
|
[usersonly|groupsonly]
|
|
[notsuspended|suspended] [notarchived|archived]
|
|
[expire|expires <Time>] [preview] [actioncsv]
|
|
<UserTypeEntity>
|
|
gam update cigroups <GroupEntity> clear [member] [manager] [owner]
|
|
[usersonly|groupsonly]
|
|
[emailclearpattern|emailretainpattern <REMatchPattern>]
|
|
[preview] [actioncsv]
|
|
gam delete cigroups <GroupEntity>
|
|
|
|
gam info cigroups <GroupEntity>
|
|
[nousers|membertree] [quick] [noaliases] [nojoindate] [showupdatedate]
|
|
[nosecurity|nosecuritysettings]
|
|
[allfields|<CIGroupFieldName>*|(fields <CIGroupFieldNameList>)]
|
|
[roles <GroupRoleList>] [members] [managers] [owners]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[types <CIGroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[formatjson]
|
|
gam print cigroups [todrive <ToDriveAttribute>*]
|
|
[(cimember|ciowner <UserItem>)|(select <GroupEntity>)|(query <String>)]
|
|
[showownedby <UserItem>]
|
|
[emailmatchpattern [not] <REMatchPattern>] [namematchpattern [not] <REMatchPattern>]
|
|
[descriptionmatchpattern [not] <REMatchPattern>]
|
|
[basic|allfields|(<CIGroupFieldName>* [fields <CIGroupFieldNameList>])]
|
|
[roles <GroupRoleList>] [memberrestrictions]
|
|
[members|memberscount] [managers|managerscount] [owners|ownerscount] [totalcount] [countsonly]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[types <CIGroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[convertcrnl] [delimiter <Character>]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
<CIGroupMembersFieldName> ::=
|
|
createtime
|
|
email|useremail|
|
|
expiretime|
|
|
memberkey|
|
|
name|
|
|
role|
|
|
type|
|
|
updatetime
|
|
|
|
<CIGroupMembersFieldNameList> ::= "<CIGroupMembersFieldName>(,<CIGroupMembersFieldName>)*"
|
|
|
|
gam <UserTypeEntity> info cimember <GroupEntity>
|
|
gam info cimember <UserTypeEntity> <GroupEntity>
|
|
gam print cigroup-members [todrive <ToDriveAttribute>*]
|
|
[(cimember|ciowner <UserItem>)|(cigroup <GroupItem>)|(select <GroupEntity>)]
|
|
[showownedby <UserItem>]
|
|
[emailmatchpattern [not] <REMatchPattern>] [namematchpattern [not] <REMatchPattern>]
|
|
[descriptionmatchpattern [not] <REMatchPattern>]
|
|
[roles <GroupRoleList>] [members] [managers] [owners]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[showallowexternal [<Boolean>]] [verifyallowexternal [<Boolean>]]
|
|
[types <CIGroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
<CIGroupMembersFieldName>* [fields <CIGroupMembersFieldNameList>]
|
|
[minimal|basic|full]
|
|
[(recursive [noduplicates]) | includederivedmembership] [nogroupemail]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show cigroup-members
|
|
[(cimember|ciowner <UserItem>)|(cigroup <GroupItem>)|(select <GroupEntity>)]
|
|
[showownedby <UserItem>]
|
|
[emailmatchpattern [not] <REMatchPattern>] [namematchpattern [not] <REMatchPattern>]
|
|
[descriptionmatchpattern [not] <REMatchPattern>]
|
|
[roles <GroupRoleList>] [members] [managers] [owners]
|
|
[internal] [internaldomains all|primary|<DomainNameList>] [external]
|
|
[types <CIGroupMemberTypeList>]
|
|
[memberemaildisplaypattern|memberemailskippattern <REMatchPattern>]
|
|
[minimal|basic|full]
|
|
[(depth <Number>) | includederivedmembership]
|
|
|
|
# Cloud Identity Devices
|
|
|
|
<DeviceID> ::= devices/<String>
|
|
<DeviceIDList> ::= "<DeviceID>(,<DeviceID>)*"
|
|
<DeviceEntity> ::=
|
|
<DeviceIDList> | devicesn <String> |
|
|
(query:<QueryDevice>)|(query <QueryDevice>)
|
|
<DeviceType> ::= android|chrome_os|google_sync|ios|linux|mac_os|windows
|
|
<DeviceUserID> ::= devices/<String>/deviceUsers/<String>
|
|
<DeviceFieldName> ::=
|
|
androidspecificattributes|
|
|
assettag|
|
|
basebandversion|
|
|
bootloaderversion|
|
|
brand|
|
|
buildnumber|
|
|
compromisedstate|
|
|
createtime|
|
|
deviceid|
|
|
devicetype|
|
|
enableddeveloperoptions|
|
|
enabledusbdebugging|
|
|
endpointverificationspecificattributes|
|
|
encryptionstate|
|
|
hostname|
|
|
imei|
|
|
kernelversion|
|
|
lastsynctime|
|
|
managementstate|
|
|
manufacturer|
|
|
meid|
|
|
model|
|
|
name|
|
|
networkoperator|
|
|
osversion|
|
|
otheraccounts|
|
|
ownertype|
|
|
releaseversion|
|
|
securitypatchtime|
|
|
serialnumber|
|
|
unifieddeviceid|
|
|
wifimacaddresses
|
|
<DeviceFieldNameList> ::= "<DeviceFieldName>(,<DeviceFieldName>)*"
|
|
|
|
<DeviceUserFieldName> ::=
|
|
compromisedstate|
|
|
createtime|
|
|
firstsynctime|
|
|
languagecode|
|
|
lastsynctime|
|
|
managementstate|
|
|
name|
|
|
passwordstate|
|
|
useragent|
|
|
useremail
|
|
<DeviceUserFieldNameList> ::= "<DeviceUserFieldName>(,<DeviceUserFieldName>)*"
|
|
|
|
<DeviceOrderbyFieldName> ::=
|
|
createtime|devicetype|lastsynctime|model|osversion|serialnumber
|
|
|
|
<DeviceAction> ::=
|
|
cancelwipe|
|
|
wipe
|
|
|
|
gam create device serialnumber <String> devicetype <DeviceType> [assettag <String>]
|
|
gam delete device <DeviceEntity> [doit]
|
|
gam update device <DeviceEntity> action <DeviceAction> [removeresetlock] [doit]
|
|
gam cancelwipe device <DeviceEntity> [doit]
|
|
gam wipe device <DeviceEntity> [removeresetlock] [doit]
|
|
|
|
gam sync devices
|
|
<CSVFileSelector>
|
|
[(query <QueryDevice>)|(queries <QueryDeviceList>) (querytime<String> <Time>)*]
|
|
(devicetype_column <String>)|(static_devicetype <DeviceType>)
|
|
(serialnumber_column <String>)
|
|
[assettag_column <String>]
|
|
[unassigned_missing_action delete|wipe|donothing]
|
|
[assigned_missing_action delete|wipe|donothing]
|
|
[preview]
|
|
|
|
gam info device <DeviceEntity>
|
|
<DeviceFieldName>* [fields <DeviceFieldNameList>] [userfields <DeviceUserFieldNameList>]
|
|
[nodeviceusers]
|
|
[formatjson]
|
|
gam print devices [todrive <ToDriveAttribute>*]
|
|
[(query <QueryDevice>)|(queries <QueryDeviceList>) (querytime<String> <Time>)*]
|
|
<DeviceFieldName>* [fields <DeviceFieldNameList>] [userfields <DeviceUserFieldNameList>]
|
|
[orderby <DeviceOrderByFieldName> [ascending|descending]]
|
|
[all|company|personal|nocompanydevices|nopersonaldevices]
|
|
[nodeviceusers|oneuserperrow]
|
|
[clientstates]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
<DeviceUserAction> ::=
|
|
approve|
|
|
block|
|
|
cancelwipe|
|
|
wipe
|
|
|
|
gam delete deviceuser <DeviceUserEntity> [doit]
|
|
gam update deviceuser <DeviceUserEntity> action <DeviceUserAction> [doit]
|
|
gam approve deviceuser <DeviceUserEntity> [doit]
|
|
gam block deviceuser <DeviceUserEntity> [doit]
|
|
gam cancelwipe deviceuser <DeviceUserEntity> [doit]
|
|
gam wipe deviceuser <DeviceUserEntity> [doit]
|
|
|
|
gam info deviceuser <DeviceUserEntity>
|
|
<DeviceUserFieldName>* [fields <DeviceUserFieldNameList>]
|
|
[formatjson]
|
|
gam print deviceusers [todrive <ToDriveAttribute>*]
|
|
[select <DeviceID>]
|
|
[(query <QueryDevice>)|(queries <QueryDeviceList>) (querytime<String> <Time>)*]
|
|
<DeviceUserFieldName>* [fields <DeviceUserFieldNameList>]
|
|
[orderby <DeviceOrderByFieldName> [ascending|descending]]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
gam info deviceuserstate <DeviceUserEntity> [clientid <String>]
|
|
gam update deviceuserstate <DeviceUserEntity> [clientid <String>]
|
|
[customid <String>] [assettags clear|<AssetTagList>]
|
|
[compliantstate|compliancestate compliant|noncompliant] [managedstate clear|managed|unmanaged]
|
|
[healthscore very_poor|poor|neutral|good|very_good] [scorereason clear|<String>]
|
|
(customvalue clear|(bool|boolean <String> <Boolean>)|(number <String> <Integer>)|(string <String> <String>))*
|
|
|
|
# Cloud Identity Policies
|
|
|
|
gam info policies <CIPolicyNameEntity>
|
|
[nowarnings] [noappnames] [noidmappimg]
|
|
[formatjson]
|
|
gam print policies [todrive <ToDriveAttribute>*]
|
|
[filter <String>] [nowarnings] [noappnames] [noidmappimg]
|
|
[group <REMatchPattern>] [ou|org|orgunit <REMatchPattern>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show policies
|
|
[filter <String>] [nowarnings] [noappnames] [noidmappimg]
|
|
[group <REMatchPattern>] [ou|org|orgunit <REMatchPattern>]
|
|
[formatjson]
|
|
|
|
# Inbound SSO
|
|
|
|
<SSOProfileDisplayName> ::= <String>
|
|
<SSOProfileName> ::= id:inboundSamlSsoProfiles/<String>
|
|
<SSOProfileItem> ::= <SSOProfileDisplayName>|<SSOProfileName>
|
|
<SSOProfileItemList> ::= "<SSOProfileItem>(,<SSOProfileItem>)*"
|
|
|
|
gam create inboundssoprofile [saml|oidc] [name <SSOProfileDisplayName>]
|
|
[entityid <String>] [loginurl <URL>] [logouturl <URL>] [changepasswordurl <URL>]
|
|
[returnnameonly]
|
|
gam update inboundssoprofile [saml|oidc] <SSOProfileItem>
|
|
[entityid <String>] [loginurl <URL>] [logouturl <URL>] [changepasswordurl <URL>]
|
|
[returnnameonly]
|
|
gam delete inboundssoprofile [saml|oidc] <SSOProfileItem>
|
|
|
|
gam info inboundssoprofile [all|saml|oidc] <SSOProfileItem>
|
|
[formatjson]
|
|
gam show inboundssoprofiles [all|saml|oidc]
|
|
[formatjson]
|
|
gam print inboundssoprofiles [all|saml|oidc] [todrive <ToDriveAttribute>*]
|
|
[[formatjson [quotechar <Character>]]
|
|
|
|
<SSOCredentialsName> ::= [id:]inboundSamlSsoProfiles/<String>/idpCredentials/<String>
|
|
|
|
gam create inboundssocredential profile <SSOProfileItem>
|
|
(pemfile <FileName>)|(generatekey [keysize 1024|2048|4096]) [replaceolddest]
|
|
gam delete inboundssocredential <SSOCredentialsName>
|
|
|
|
gam info inboundssocredential <SSOCredentialsName>
|
|
[formatjson]
|
|
gam show inboundssocredentials [profile|profiles <SSOProfileItemList>]
|
|
[formatjson]
|
|
gam print inboundssocredentials [profile|profiles <SSOProfileItemList>]
|
|
[[formatjson [quotechar <Character>]]
|
|
|
|
<SSOAssignmentName> ::= [id:]inboundSsoAssignments/<String>
|
|
<SSOAssignmentSelector> ::=
|
|
<SSOAssignmentName> |
|
|
groups/<String> |
|
|
group:<EmailAddress> |
|
|
orgunits/<String> |
|
|
orgunit:<OrgUnitPath>
|
|
|
|
gam create inboundssoassignment
|
|
(group <GroupItem> rank <Number>)|(ou|org|orgunit <OrgUnitItem>)
|
|
(mode sso_off)|(mode saml_sso profile <SSOProfileItem>)|(mode oidc_sso profile <SSOProfileName>}|(mode domain_wide_saml_if_enabled)
|
|
[neverredirect]
|
|
gam update inboundssoassignment <SSOAssignmentName>
|
|
[(group <GroupItem> rank <Number>)|(ou|org|orgunit <OrgUnitItem>)]
|
|
(mode sso_off)|(mode saml_sso profile <SSOProfileItem>)|(mode oidc_sso profile <SSOProfileName>}|(mode domain_wide_saml_if_enabled)
|
|
[neverredirect]
|
|
gam delete inboundssoassignment <SSOAssignmentSelector>
|
|
|
|
gam info inboundssoassignment <SSOAssignmentSelector>
|
|
[formatjson]
|
|
gam show inboundssoassignments
|
|
[formatjson]
|
|
gam print inboundssoassignments [todrive <ToDriveAttribute>*]
|
|
[[formatjson [quotechar <Character>]]
|
|
|
|
# Licenses
|
|
|
|
gam print licenses [todrive <ToDriveAttribute>*]
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)|allskus|gsuite]
|
|
[maxresults <Integer>] [countsonly]
|
|
gam show licenses
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)|allskus|gsuite]
|
|
[maxresults <Integer>]
|
|
|
|
# Mobile Devices
|
|
|
|
<MobileAction> ::=
|
|
admin_remote_wipe|wipe|
|
|
admin_account_wipe|accountwipe|wipeaccount|
|
|
approve|
|
|
block|
|
|
cancel_remote_wipe_then_activate|
|
|
cancel_remote_wipe_then_block
|
|
|
|
gam update mobile <MobileEntity> action <MobileAction>
|
|
[doit] [matchusers <UserTypeEntity>]
|
|
gam delete mobile <MobileEntity>
|
|
[doit] [matchusers <UserTypeEntity>]
|
|
|
|
<MobileFieldName> ::=
|
|
adbstatus|
|
|
applications|
|
|
basebandversion|
|
|
bootloaderversion|
|
|
brand|
|
|
buildnumber|
|
|
defaultlanguage|
|
|
developeroptionsstatus|
|
|
devicecompromisedstatus|
|
|
deviceid|
|
|
devicepasswordstatus|
|
|
email|
|
|
encryptionstatus|
|
|
firstsync|
|
|
hardware|
|
|
hardwareid|
|
|
imei|
|
|
kernelversion|
|
|
lastsync|
|
|
managedaccountisonownerprofile|
|
|
manufacturer|
|
|
meid|
|
|
model|
|
|
name|
|
|
networkoperator|
|
|
os|
|
|
otheraccountsinfo|
|
|
privilege|
|
|
releaseversion|
|
|
resourceid|
|
|
securitypatchlevel|
|
|
serialnumber|
|
|
status|
|
|
supportsworkprofile|
|
|
type|
|
|
unknownsourcesstatus|
|
|
useragent|
|
|
wifimacaddress
|
|
|
|
<MobileFieldNameList> ::= "<MobileFieldName>(,<MobileFieldName>)*"
|
|
|
|
<MobileOrderByFieldName> ::=
|
|
deviceid|email|lastsync|model|name|os|status|type
|
|
|
|
gam info mobile <MobileEntity>
|
|
[basic|full|allfields] <MobileFieldName>* [fields <MobileFieldNameList>]
|
|
[formatjson]
|
|
gam print mobile [todrive <ToDriveAttribute>*]
|
|
[(query <QueryMobile>)|(queries <QueryMobileList>) (querytime<String> <Time>)*]
|
|
[orderby <MobileOrderByFieldName> [ascending|descending]]
|
|
[basic|full|allfields] <MobileFieldName>* [fields <MobileFieldNameList>]
|
|
[delimiter <Character>] [appslimit <Number>] [oneappperrow] [listlimit <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
# Organizational Units
|
|
|
|
<OrgUnitFieldName> ::=
|
|
description|
|
|
id|orgunitid|
|
|
name|
|
|
parentid|parentorgunitid|
|
|
parent|parentorgunitpath|
|
|
path|orgunitpath
|
|
<OrgUnitFieldNameList> ::= "<OrgUnitFieldName>(,<OrgUnitFieldName>)*"
|
|
|
|
gam create|add org|ou <OrgUnitPath> [description <String>] [parent <OrgUnitItem>] [buildpath]
|
|
gam update org|ou <OrgUnitItem> [name <String>] [description <String>] [parent <OrgUnitItem>]
|
|
gam update org|ou <OrgUnitItem> add|move <CrOSTypeEntity> [quickcrosmove [<Boolean>]]
|
|
gam update org|ou <OrgUnitItem> add|move <UserTypeEntity>
|
|
gam update org|ou <OrgUnitItem> sync <CrOSTypeEntity> [removetoou <OrgUnitItem>] [quickcrosmove [<Boolean>]]
|
|
gam update org|ou <OrgUnitItem> sync <UserTypeEntity> [removetoou <OrgUnitItem>]
|
|
gam delete org|ou <OrgUnitItem>
|
|
|
|
gam update orgs|ous <OrgUnitEntity> [name <String>] [description <String>] [parent <OrgUnitItem>]
|
|
gam update orgs|ous <OrgUnitEntity> add|move <CrOSTypeEntity> [quickcrosmove [<Boolean>]]
|
|
gam update orgs|ous <OrgUnitEntity> add|move <UserTypeEntity>
|
|
gam update orgs|ous <OrgUnitEntity> sync <CrOSTypeEntity> [removetoou <OrgUnitItem>] [quickcrosmove [<Boolean>]]
|
|
gam update orgs|ous <OrgUnitEntity> sync <UserTypeEntity> [removetoou <OrgUnitItem>]
|
|
gam delete orgs|ous <OrgUnitEntity>
|
|
|
|
gam info org|ou <OrgUnitItem>
|
|
[nousers | ([notarchived|archived] [notsuspended|suspended])] [children|child]
|
|
gam info orgs|ous <OrgUnitEntity>
|
|
[nousers | ([notarchived|archived] [notsuspended|suspended])] [children|child]
|
|
|
|
<OrgUnitSelector> ::=
|
|
cros_ou | cros_ou_and_children|
|
|
ou | ou_ns | ou_susp|
|
|
ou_and_children | ou_and_children_ns | ou_and_children_susp
|
|
|
|
gam print orgs|ous [todrive <ToDriveAttribute>*]
|
|
[fromparent <OrgUnitItem>] [showparent [<Boolean>]] [toplevelonly]
|
|
[parentselector <OrgUnitSelector> childselector <OrgUnitSelector>]
|
|
[allfields|<OrgUnitFieldName>*|(fields <OrgUnitFieldNameList>)] [convertcrnl] [batchsuborgs [<Boolean>]]
|
|
[mincroscount <Number>] [maxcroscount <Number>]
|
|
[minusercount <Number>] [maxusercount <Number>]
|
|
[showitemcountonly]
|
|
gam show orgtree [fromparent <OrgUnitItem>] [batchsuborgs [<Boolean>]]
|
|
|
|
<OrgUnitCheckName> ::=
|
|
browsers|
|
|
devices|
|
|
shareddrives|
|
|
subous|
|
|
users
|
|
<OrgUnitCheckNameList> ::= "<OrgUnitCheckName>(,<OrgUnitCheckName>)*"
|
|
|
|
gam check ou|org <OrgUnitItem> [todrive <ToDriveAttribute>*]
|
|
[<OrgUnitCheckName>*|(fields <OrgUnitCheckNameList>)]
|
|
[filename <FileName>] [movetoou <OrgUnitItem>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Printers
|
|
|
|
<PrinterAttribute> ::=
|
|
(description <String>)|
|
|
(displayname <String>)|
|
|
<JSONData>|
|
|
(makeandmodel <String>)|
|
|
(ou|org|orgunit <OrgUnitItem>)|
|
|
(uri <String>)|
|
|
(driverless [<Boolean>])
|
|
|
|
<PrinterFieldName> ::=
|
|
auxiliarymessages|
|
|
createtime|
|
|
description|
|
|
displayname|
|
|
id|
|
|
makeandmodel|
|
|
name|
|
|
ou|org|orgunit|orgunitid|
|
|
uri|
|
|
usedriverlessconfig|
|
|
<PrinterFieldNameList> ::= "<PrinterFieldName>(,<PrinterFieldName>)*"
|
|
|
|
gam create printer <PrinterAttribute>+ [nodetails|returnidonly]
|
|
gam update printer <PrinterID> <PrinterAttribute>+ [nodetails|returnidonly]
|
|
gam delete printer
|
|
<PrinterIDList>|
|
|
<FileSelector>|
|
|
<CSVFileSelector>
|
|
gam info printer <PrinterID>
|
|
[fields <PrinterFieldNameList>]
|
|
[formatjson]
|
|
gam show printers
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[filter <String>] [showinherited [<Boolean>]
|
|
[fields <PrinterFieldNameList>]
|
|
[formatjson]
|
|
gam print printers [todrive <ToDriveAttribute>*]
|
|
[(ou <OrgUnitItem>)|(ou_and_children <OrgUnitItem>)|
|
|
(ous <OrgUnitList>)|(ous_and_children <OrgUnitList>)]
|
|
[filter <String>] [showinherited [<Boolean>]
|
|
[fields <PrinterFieldNameList>] [[formatjson [quotechar <Character>]]
|
|
|
|
gam show printermodels
|
|
[filter <String>]
|
|
[formatjson]
|
|
gam print printermodels [todrive <ToDriveAttribute>*]
|
|
[filter <String>]
|
|
[[formatjson [quotechar <Character>]]
|
|
|
|
# Reports
|
|
|
|
gam report usageparameters customer|user [todrive <ToDriveAttribute>*]
|
|
gam report usage user [todrive <ToDriveAttribute>*]
|
|
[(user all|<UserItem>)|(orgunit|org|ou <OrgUnitPath> [showorgunit])|(select <UserTypeEntity>)]
|
|
[([start|startdate <Date>] [end|enddate <Date>])|(range <Date> <Date>)|
|
|
thismonth|(previousmonths <Integer>)]
|
|
[skipdates <Date>[:<Date>](,<Date>[:<Date>])*] [skipdaysofweek <DayOfWeek>(,<DayOfWeek>)*]
|
|
[fields|parameters <String>]
|
|
[convertmbtogb]
|
|
gam report usage customer [todrive <ToDriveAttribute>*]
|
|
[([start|startdate <Date>] [end|enddate <Date>])|(range <Date> <Date>)|
|
|
thismonth|(previousmonths <Integer>)]
|
|
[skipdates <Date>[:<Date>](,<Date>[:<Date>])*] [skipdaysofweek <DayOfWeek>(,<DayOfWeek>)*]
|
|
[fields|parameters <String>]
|
|
[convertmbtogb]
|
|
|
|
<ActivityApplicationName> ::=
|
|
accessevaluation|
|
|
accesstransparency|access|
|
|
admin|
|
|
admindataaction|
|
|
assignments|
|
|
calendar|calendars|
|
|
chat|
|
|
chrome|
|
|
classroom|
|
|
cloudsearch|
|
|
contacts|
|
|
contextawareaccess|
|
|
datamigration|
|
|
datastudio|
|
|
directorysync|
|
|
drive|doc|docs|
|
|
gcp|cloud|
|
|
geminiinworkspaceapps|gemini|geminiforworkspace|
|
|
gmail|
|
|
gplus|currents|google+|
|
|
graduation|
|
|
groups|group|
|
|
groupsenterprise|enterprisegroups|
|
|
jamboard|
|
|
keep|
|
|
ldap|
|
|
login|logins|
|
|
meet|hangoutsmeet|
|
|
meethardware|
|
|
mobile|devices|
|
|
profile|
|
|
rules|
|
|
saml|
|
|
takeout|
|
|
tasks|
|
|
token|tokens|oauthtoken|
|
|
useraccounts|
|
|
vault
|
|
|
|
gam report <ActivityApplicationName> [todrive <ToDriveAttribute>*]
|
|
[(user all|<UserItem>)|(orgunit|org|ou <OrgUnitPath> [showorgunit])|(select <UserTypeEntity>)]
|
|
[userisactor]
|
|
[([start <Time>] [end <Time>])|(range <Time> <Time>)|
|
|
yesterday|today|thismonth|(previousmonths <Integer>)]
|
|
[filter <String> (filtertime<String> <Time>)*]
|
|
[event|events <EventNameList>] [ip <String>]
|
|
[gmaileventtypes <NumberRangeList>]
|
|
[groupidfilter <String>] [resourcedetailsfilter <String>]
|
|
[networkinfofilter <String>] [statusfilter <String>]
|
|
[applicationinfofilter <String>] [includesensitivedata]
|
|
[notimesort]
|
|
[maxactivities <Number>] [maxevents <Number>] [maxresults <Number>]
|
|
[countsonly [bydate|summary] [eventrowfilter]]
|
|
(addcsvdata <FieldName> <String>)* [shownoactivities]
|
|
|
|
<CustomerServiceName> ::=
|
|
accounts|
|
|
app_maker|
|
|
apps_scripts|
|
|
calendar|
|
|
chat|
|
|
classroom|
|
|
cros|
|
|
device_management|
|
|
docs|
|
|
drive|
|
|
gmail|
|
|
gplus|
|
|
meet|
|
|
sites
|
|
<CustomerServiceNameList> ::= "<CustomerServiceName>(,<CustomerServiceName>)*"
|
|
|
|
gam report customers|customer|domain [todrive <ToDriveAttribute>*]
|
|
[(date <Date>)|(range <Date> <Date>)|
|
|
yesterday|today|thismonth|(previousmonths <Integer>)]
|
|
[(nodatechange | limitdatechanges <Integer>) | (fulldatarequired all|<CustomerServiceNameList>)]
|
|
[(fields|parameters <String>)|(services <CustomerServiceNameList>)] [noauthorizedapps]
|
|
[convertmbtogb]
|
|
(addcsvdata <FieldName> <String>)*
|
|
|
|
<UserServiceName> ::=
|
|
accounts|
|
|
chat|
|
|
classroom|
|
|
docs|
|
|
drive|
|
|
gmail|
|
|
gplus
|
|
<UserServiceNameList> ::= "<UserServiceName>(,<UserServiceName>)*"
|
|
|
|
gam report users|user [todrive <ToDriveAttribute>*]
|
|
[(user all|<UserItem>)|(orgunit|org|ou <OrgUnitPath> [showorgunit])|(select <UserTypeEntity>)]
|
|
[allverifyuser <UserItem>]
|
|
[(date <Date>)|(range <Date> <Date>)|
|
|
yesterday|today|thismonth|(previousmonths <Integer>)]
|
|
[(nodatechange | limitdatechanges <Integer>) | (fulldatarequired all|<UserServiceNameList>)]
|
|
[filter <String> (filtertime<String> <Time>)*]
|
|
[(fields|parameters <String>)|(services <UserServiceNameList>)]
|
|
[aggregatebydate|aggregatebyuser [Boolean]]
|
|
[maxresults <Number>]
|
|
[convertmbtogb]
|
|
(addcsvdata <FieldName> <String>)*
|
|
|
|
# Reseller
|
|
|
|
<ResoldCustomerAttribute> ::=
|
|
(email|alternateemail <EmailAddress>)|
|
|
(contact|contactname <String>)|
|
|
(phone|phonenumber <String>)|
|
|
(name|organizationname <String>)|
|
|
(address|address1|addressline1 <String>)|
|
|
(address2|addressline2 <String>)|
|
|
(address3|addressline3 <String>)|
|
|
(city|locality <String>)|
|
|
(state|region <String>)|
|
|
(zipcode|postal|postalcode <String>)|
|
|
(country|countrycode <String>)
|
|
|
|
gam create|add resoldcustomer <CustomerDomain> (customer_auth_token <String>) <ResoldCustomerAttribute>+
|
|
gam update resoldcustomer <CustomerID> <ResoldCustomerAttribues>+
|
|
gam info resoldcustomer <CustomerID> [formatjson]
|
|
|
|
gam create|add resoldsubscription <CustomerID> (sku <SKUID>)
|
|
(plan annual_monthly_pay|annual_yearly_pay|flexible|trial|free) (seats <Number>)
|
|
[customer_auth_token <String>] [deal <String>] [purchaseorderid <String>]
|
|
gam update resoldsubscription <CustomerID> <SKUID>
|
|
activate|suspend|startpaidservice|
|
|
(renewal auto_renew_monthly_pay|auto_renew_yearly_pay|cancel|renew_current_users_monthly_pay|renew_current_users_yearly_pay|switch_to_pay_as_you_go)|
|
|
(seats <Number>)|
|
|
(plan annual_monthly_pay|annual_yearly_pay|flexible|trial [deal <String>] [purchaseorderid <String>] [seats <Number>])
|
|
gam delete resoldsubscription <CustomerID> <SKUID> cancel|downgrade|transfer_to_direct
|
|
gam info resoldsubscription <CustomerID> <SKUID>
|
|
[formatjson]
|
|
gam show resoldsubscriptions
|
|
[customerid <CustomerID>] [customer_auth_token <String>] [customer_prefix <String>]
|
|
[maxresults <Number>]
|
|
[formatjson]
|
|
gam print resoldsubscriptions [todrive <ToDriveAttribute>*]
|
|
[customerid <CustomerID>] [customer_auth_token <String>] [customer_prefix <String>]
|
|
[maxresults <Number>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Resource Calendars
|
|
|
|
<BuildingFieldName> ::=
|
|
address|
|
|
buildingid|
|
|
buildingname|
|
|
coordinates|
|
|
description|
|
|
floors|
|
|
floornames|
|
|
id|
|
|
name
|
|
<BuildingFieldNameList> ::= "<BuildingFieldName>(,<BuildingFieldName>)*"
|
|
|
|
<BuildingAttribute> ::=
|
|
(address|addresslines <String>)|
|
|
(city|locality <String>)|
|
|
(country|regioncode <String>)|
|
|
(description <String>)|
|
|
(floors <FloorNameList>)|
|
|
(id <String>)|
|
|
(language|languageCode <Language>)|
|
|
(latitude <Float>)|
|
|
(longitude <Float>)|
|
|
(name <String>)
|
|
(state|administrativearea <String>)|
|
|
(sublocality <String>)|
|
|
(zipcode|postalcode <String>)
|
|
|
|
<ResourceAttribute> ::=
|
|
(autoacceptinvitations [<Boolean>])|
|
|
(addfeatures <FeatureNameList>)|
|
|
(buildingid <BuildingID>)|
|
|
(capacity <Number>)|
|
|
(category other|room|conference_room|category_unknown|unknown)|
|
|
(description <String>)|
|
|
(features <FeatureNameList>)|
|
|
(floor <FloorName>)|
|
|
(floorsection <String>)|
|
|
(name <String>)|
|
|
(removefeatures <FeatureNameList>)|
|
|
(type <String>)|
|
|
(uservisibledescription <String>)
|
|
|
|
<ResourceFieldName> ::=
|
|
acls|
|
|
autoacceptinvitations|
|
|
buildingid|
|
|
calendar|
|
|
capacity|
|
|
category|
|
|
description|
|
|
email|
|
|
featureinstances|
|
|
features|
|
|
floor|
|
|
floorsection|
|
|
generatedresourcename|
|
|
id|
|
|
name|
|
|
resourcecategory|
|
|
resourcedescription|
|
|
resourceemail|
|
|
resourceid|
|
|
resourcename|
|
|
resourcetype|
|
|
type|
|
|
uservisibledescription
|
|
<ResourceFieldNameList> ::= "<ResourceFieldName>(,<ResourceFieldName>)*"
|
|
|
|
gam create|add building <Name> <BuildingAttribute>*
|
|
gam update building <BuildIngID> <BuildingAttribute>*
|
|
gam delete building <BuildingID>
|
|
gam info building <BuildingID>
|
|
[formatjson]
|
|
gam show buildings
|
|
[allfields|<BuildingFieldName>*|(fields <BuildingFieldNameList>)]
|
|
[formatjson]
|
|
gam print buildings [todrive <ToDriveAttribute>*]
|
|
[allfields|<BuildingFieldName>*|(fields <BuildingFieldNameList>)]
|
|
[delimiter <Character>] [formatjson [quotechar <Character>]]
|
|
|
|
gam create|add feature name <Name>
|
|
gam update feature <Name> name <Name>
|
|
gam delete feature <Name>
|
|
gam show features
|
|
gam print features [todrive <ToDriveAttribute>*]
|
|
|
|
gam create|add resource <ResourceID> <Name> <ResourceAttribute>*
|
|
gam update resource <ResourceID> <ResourceAttribute>*
|
|
gam delete resource <ResourceID>
|
|
gam info resource <ResourceID>
|
|
[acls] [noselfowner] [calendar]
|
|
[formatjson]
|
|
|
|
gam update resources <ResourceEntity> <ResourceAttribute>*
|
|
gam delete resources <ResourceEntity>
|
|
gam info resources <ResourceEntity>
|
|
[acls] [noselfowner] [calendar]
|
|
[formatjson]
|
|
|
|
gam show resources [allfields|<ResourceFieldName>*|(fields <ResourceFieldNameList>)]
|
|
[query <String>]
|
|
[acls] [noselfowner] [calendar] [convertcrnl]
|
|
[formatjson]
|
|
gam print resources [todrive <ToDriveAttribute>*] [allfields|<ResourceFieldName>*|(fields <ResourceFieldNameList>)]
|
|
[query <String>]
|
|
[acls] [noselfowner] [calendar] [convertcrnl]
|
|
[formatjson [quotechar <Character>]]
|
|
[showitemcountonly]
|
|
|
|
<CalendarACLRole> ::= editor|freebusy|freebusyreader|owner|reader|writer|none
|
|
<CalendarACLScope> ::= <EmailAddress>|user:<EmailAdress>|group:<EmailAddress>|domain:<DomainName>|domain|default
|
|
<CalendarACLScopeList> ::= "<CalendarACLScope>(,<CalendarACLScope>)*"
|
|
<CalendarACLScopeEntity> ::= <CalendarACLScopeList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
gam resource <ResourceID> create|add acls|calendaracls <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam resource <ResourceID> update acls|calendaracls <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam resource <ResourceID> delete acls|calendaracls [<CalendarACLRole>] <CalendarACLScopeEntity>
|
|
gam resource <ResourceID> info acls|calendaracls <CalendarACLScopeEntity> [formatjson]
|
|
|
|
gam resource <ResourceID> show acls|calendaracls
|
|
[noselfowner]
|
|
[formatjson]
|
|
gam resource <ResourceID> print acls|calendaracls [todrive <ToDriveAttribute>*]
|
|
[noselfowner] (addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam resources <ResourceEntity> create|add acls|calendaracls <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam resources <ResourceEntity> update acls|calendaracls <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam resources <ResourceEntity> delete acls|calendaracls [<CalendarACLRole>] <CalendarACLScopeEntity>
|
|
gam resources <ResourceEntity> info acls|calendaracls <CalendarACLScopeEntity> [formatjson]
|
|
|
|
gam resources <ResourceEntity> show acls|calendaracls
|
|
[noselfowner]
|
|
[formatjson]
|
|
gam resources <ResourceEntity> print acls|calendaracls [todrive <ToDriveAttribute>*]
|
|
[noselfowner] (addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Schemas
|
|
|
|
<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 delete schema <SchemaName>
|
|
gam info schema <SchemaName>
|
|
|
|
gam update schemas <SchemaEntity> [displayname <String>] <SchemaFieldDefinition>* (deletefield <FieldName>)*
|
|
gam delete schemas <SchemaEntity>
|
|
|
|
gam info schemas <SchemaEntity>
|
|
gam show schema|schemas
|
|
gam print schema|schemas [todrive <ToDriveAttribute>*]
|
|
|
|
# Send Email
|
|
|
|
<MessageContent> ::=
|
|
(message|textmessage|htmlmessage <String>)|
|
|
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)|
|
|
|
|
gam sendemail [recipient|to] <RecipientEntity>
|
|
[from <EmailAddress>] [mailbox <EmailAddress>] [replyto <EmailAddress>]
|
|
[cc <RecipientEntity>] [bcc <RecipientEntity>] [singlemessage]
|
|
[subject <String>] [<MessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <String>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <String>)*
|
|
(attach <FileName> [charset <Charset>])*
|
|
(embedimage <FileName> <String>)*
|
|
[newuser <EmailAddress> firstname|givenname <String> lastname|familyname <string> password <Password>]
|
|
(<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*
|
|
[threadid <String>]
|
|
gam <UserTypeEntity> sendemail recipient|to <RecipientEntity>
|
|
[replyto <EmailAddress>]
|
|
[cc <RecipientEntity>] [bcc <RecipientEntity>] [singlemessage]
|
|
[subject <String>] [<MessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <String>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <String>)*
|
|
(attach <FileName> [charset <Charset>])*
|
|
(embedimage <FileName> <String>)*
|
|
[newuser <EmailAddress> firstname|givenname <String> lastname|familyname <string> password <Password>]
|
|
(<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*
|
|
[threadid <String>]
|
|
gam <UserTypeEntity> sendemail from <EmailAddress>
|
|
[replyto <EmailAddress>]
|
|
[cc <RecipientEntity>] [bcc <RecipientEntity>] [singlemessage]
|
|
[subject <String>] [<MessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <String>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <String>)*
|
|
(attach <FileName> [charset <Charset>])*
|
|
(embedimage <FileName> <String>)*
|
|
[newuser <EmailAddress> firstname|givenname <String> lastname|familyname <string> password <Password>]
|
|
(<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*
|
|
[threadid <String>]
|
|
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>)*
|
|
|
|
# Shared Drives - Administrator
|
|
|
|
<SharedDriveFieldName> ::=
|
|
backgroundimagefile|
|
|
backgroundimagelink|
|
|
capabilities|
|
|
colorrgb|
|
|
createdtime|
|
|
id|
|
|
name|
|
|
restrictions|
|
|
themeid
|
|
<SharedDriveFieldNameList> ::= "<SharedDriveFieldName>(,<SharedDriveFieldName>)*"
|
|
|
|
<SharedDriveRestrictionsSubfieldName> ::=
|
|
adminmanagedrestrictions|
|
|
allowcontentmanagerstosharefolders|
|
|
copyrequireswriterpermission|
|
|
domainusersonly|
|
|
downloadrestrictedforreaders|downloadrestrictions.restrictedforreaders|
|
|
downloadrestrictedforwriters|downloadrestrictions.restrictedforwriters|
|
|
drivemembersonly|teammembersonly|
|
|
sharingfoldersrequiresorganizerpermission
|
|
|
|
Each pair of restrictions below are equivalent:
|
|
|
|
allowcontentmanagerstosharefolders true
|
|
sharingfoldersrequiresorganizerpermission false
|
|
|
|
allowcontentmanagerstosharefolders false
|
|
sharingfoldersrequiresorganizerpermission true
|
|
|
|
In these commands, the Google administrator named in oauth2.txt is used.
|
|
|
|
gam show shareddrivethemes
|
|
gam create shareddrive <Name>
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
([restrictions.]<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
|
[errorretries <Integer>] [updateinitialdelay <Integer>] [updateretrydelay <Integer>]
|
|
[movetoorgunitdelay <Integer>]
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
|
gam update shareddrive <SharedDriveEntity> [name <Name>]
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
(<SharedDriveRestrictionsFieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
|
gam delete shareddrive <SharedDriveEntity>
|
|
[adminaccess|asadmin] [allowitemdeletion]
|
|
gam hide shareddrive <SharedDriveEntity>
|
|
gam unhide shareddrive <SharedDriveEntity>
|
|
gam info shareddrive <SharedDriveEntity>
|
|
[fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
gam show shareddriveinfo <SharedDriveEntity>
|
|
[fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
gam print shareddrives [todrive <ToDriveAttribute>*]
|
|
[teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
[fields <SharedDriveFieldNameList>] [noorgunits [<Boolean>]]
|
|
[showwebviewlink text|hyperlink]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show shareddrives
|
|
[teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
[fields <SharedDriveFieldNameList>] [noorgunits [<Boolean>]]
|
|
[showwebviewlink text|hyperlink]
|
|
[formatjson] [noorgunits [<Boolean>]]
|
|
|
|
gam print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
|
[(shareddriveadminquery|query <QuerySharedDrive>) |
|
|
(shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
|
[orgunit|org|ou <OrgUnitPath>]
|
|
[matchname <REMatchPattern>]
|
|
[domainlist <DomainList>]
|
|
[includetypes <OrganizerTypeList>]
|
|
[oneorganizer [<Boolean>]]
|
|
[shownorganizerdrives [false|true|only]]
|
|
[includefileorganizers [<Boolean>]]
|
|
[delimiter <Character>]
|
|
gam print oushareddrives [todrive <ToDriveAttribute>*]
|
|
[ou|org|orgunit <OrgUnitPath>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show oushareddrives
|
|
[ou|org|orgunit <OrgUnitPath>]
|
|
[formatjson]
|
|
|
|
In these commands, you specify an administrator and then indicate that you want domain administrator access with the adminaccess option.
|
|
|
|
gam <UserTypeEntity> create shareddrive <Name> adminaccess
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
([restrictions.]<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
|
[errorretries <Integer>] [updateinitialdelay <Integer>] [updateretrydelay <Integer>]
|
|
[movetoorgunitdelay <Integer>]
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
|
gam <UserTypeEntity> update shareddrive <SharedDriveEntity> adminaccess [name <Name>]
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
(<SharedDriveRestrictionsFieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
|
gam <UserTypeEntity> delete shareddrive <SharedDriveEntity>
|
|
adminaccess [allowitemdeletion]
|
|
gam <UserTypeEntity> info shareddrive <SharedDriveEntity>
|
|
adminaccess [fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show shareddriveinfo <SharedDriveEntity>
|
|
adminaccess [fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print shareddrives [todrive <ToDriveAttribute>*]
|
|
adminaccess [teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
(role|roles <SharedDriveACLRoleList>)*
|
|
[fields <SharedDriveFieldNameList>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show shareddrives
|
|
adminaccess [teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
(role|roles <SharedDriveACLRoleList>)*
|
|
[fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
|
|
In these commands, you specify a user, administrator access is not used.
|
|
|
|
gam <UserTypeEntity> create shareddrive <Name>
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
([restrictions.]<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
|
[errorretries <Integer>] [updateinitialdelay <Integer>] [updateretrydelay <Integer>]
|
|
[movetoorgunitdelay <Integer>]
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
|
gam <UserTypeEntity> update shareddrive <SharedDriveEntity> [name <Name>]
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
(<SharedDriveRestrictionsFieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>] [ou|org|orgunit <OrgUnitItem>]
|
|
gam <UserTypeEntity> delete shareddrive <SharedDriveEntity>
|
|
[allowitemdeletion]
|
|
gam <UserTypeEntity> info shareddrive <SharedDriveEntity>
|
|
[fields <SharedDriveFieldNameList>]
|
|
[guiroles [<Boolean>]] [formatjson]
|
|
gam <UserTypeEntity> show shareddriveinfo <SharedDriveEntity>
|
|
[fields <SharedDriveFieldNameList>]
|
|
[guiroles [<Boolean>]] [formatjson]
|
|
gam <UserTypeEntity> print shareddrives [todrive <ToDriveAttribute>*]
|
|
[teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
(role|roles <SharedDriveACLRoleList>)*
|
|
[fields <SharedDriveFieldNameList>]
|
|
[showwebviewlink text|hyperlink]
|
|
[guiroles [<Boolean>]] [formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show shareddrives
|
|
[teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
(role|roles <SharedDriveACLRoleList>)*
|
|
[fields <SharedDriveFieldNameList>]
|
|
[showwebviewlink text|hyperlink]
|
|
[guiroles [<Boolean>]] [formatjson]
|
|
|
|
<PermissionMatch> ::=
|
|
pm|permissionmatch [not]
|
|
[type|nottype <DriveFileACLType>] [role|notrole <DriveFileACLRole>]
|
|
[typelist|nottypelist <DriveFileACLTypeList>] [rolelist|notrolelist <DriveFileACLRoleList>]
|
|
[allowfilediscovery|withlink <Boolean>]
|
|
[emailaddress <RegularExpression>] [emailaddressList <EmailAddressList>]
|
|
[permissionidlist <PermissionIDList>
|
|
[name|displayname <String>]
|
|
[domain|notdomain <RegularExpression>] [domainlist|notdomainlist <DomainNameList>]
|
|
[expirationstart <Time>] [expirationend <Time>]
|
|
[deleted <Boolean>] [inherited <Boolean>] [permtype member|file]
|
|
em|endmatch
|
|
<PermissionMatchMode> ::=
|
|
pmm|permissionmatchmode or|and
|
|
<PermissionMatchAction> ::=
|
|
pma|permissionmatchaction process|skip
|
|
|
|
These commands are used to manage the ACLs on the Team Drives themselves, not the files/folders on the Team Drives.
|
|
|
|
<DrivePermissionsFieldName> ::=
|
|
additionalroles|
|
|
allowfilediscovery|
|
|
basicpermissions|
|
|
deleted|
|
|
displayname|
|
|
domain|
|
|
emailaddress|
|
|
expirationdate|
|
|
expirationtime|
|
|
id|
|
|
name|
|
|
pendingowner|
|
|
permissiondetails|
|
|
photolink|
|
|
role|
|
|
type|
|
|
view|
|
|
withlink
|
|
<DrivePermissionsFieldNameList> ::= "<DrivePermissionsFieldName>(,<DrivePermissionsFieldName>)*"
|
|
|
|
In these commands, the Google administrator named in oauth2.txt is used.
|
|
|
|
gam create|add drivefileacl <SharedDriveEntityAdmin>
|
|
anyone|(user <UserItem>)|(group <GroupItem>)|(domain <DomainName>)
|
|
(role <DriveFileACLRole>) [withlink|(allowfilediscovery|discoverable [<Boolean>])]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
[expiration <Time>] [sendemail|sendnotification] [emailmessage <String>]
|
|
[showtitles] [nodetails|(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]])]
|
|
gam update drivefileacl <SharedDriveEntityAdmin> <DriveFilePermissionIDorEmail>
|
|
(role <DriveFileACLRole>) [expires|expiration <Time>] [removeexpiration [<Boolean>]]
|
|
[showtitles] [nodetails|(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]])]
|
|
gam delete drivefileacl <SharedDriveEntityAdmin> <DriveFilePermissionIDorEmail>
|
|
[showtitles]
|
|
gam info drivefileacl <SharedDriveEntityAdmin> <DriveFilePermissionIDorEmail>
|
|
[showtitles]
|
|
[formatjson]
|
|
gam show drivefileacls <SharedDriveEntityAdmin>
|
|
(role|roles <DriveFileACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[includepermissionsforview published]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[showtitles|(addtitle <String>)]]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[formatjson]
|
|
gam print drivefileacls <SharedDriveEntityAdmin> [todrive <ToDriveAttribute>*]
|
|
(role|roles <DriveFileACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[includepermissionsforview published]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[showtitles|(addtitle <String>)]]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[formatjson [quotechar <Character>]]
|
|
gam create|add permissions <SharedDriveEntityAdmin> <DriveFilePermissionEntity>
|
|
[expires|expiration <Time>] [sendemail|sendnotification] [emailmessage <String>]
|
|
<PermissionMatch>* [<PermissionMatchAction>]
|
|
gam delete permissions <SharedDriveEntityAdmin> <DriveFilePermissionIDEntity>
|
|
<PermissionMatch>* [<PermissionMatchAction>]
|
|
|
|
In these commands, you specify an administrator and then indicate that you want domain administrator access with the adminaccess option.
|
|
|
|
gam <UserTypeEntity> create|add drivefileacl <SharedDriveEntityAdmin>
|
|
anyone|(user <UserItem>)|(group <GroupItem>)|(domain <DomainName>)
|
|
(role <DriveFileACLRole>) [withlink|(allowfilediscovery|discoverable [<Boolean>])]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
[movetonewownersroot [<Boolean>]]
|
|
[expiration <Time>] [sendemail|sendnotification] [emailmessage <String>]
|
|
[showtitles] [nodetails|(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]])]
|
|
adminaccess
|
|
gam <UserTypeEntity> update drivefileacl <SharedDriveEntityAdmin> <DriveFilePermissionIDorEmail>
|
|
(role <DriveFileACLRole>) [expires|expiration <Time>] [removeexpiration [<Boolean>]]
|
|
[showtitles] [nodetails|(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]])]
|
|
adminaccess
|
|
gam <UserTypeEntity> delete drivefileacl <SharedDriveEntityAdmin> <DriveFilePermissionIDorEmail>
|
|
[showtitles] adminaccess
|
|
gam <UserTypeEntity> info drivefileacl <SharedDriveEntityAdmin> <DriveFilePermissionIDorEmail> adminaccess
|
|
[showtitles]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show drivefileacls <SharedDriveEntityAdmin> adminaccess
|
|
(role|roles <DriveFileACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[includepermissionsforview published]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[showtitles|(addtitle <String>)]]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[formatjson]
|
|
gam <UserTypeEntity> print drivefileacls <SharedDriveEntityAdmin> [todrive <ToDriveAttribute>*] adminaccess
|
|
(role|roles <DriveFileACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[includepermissionsforview published]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[showtitles|(addtitle <String>)]]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> create|add permissions <SharedDriveEntityAdmin> <DriveFilePermissionEntity>
|
|
[expires|expiration <Time>] [sendemail|sendnotification] [emailmessage <String>] adminaccess
|
|
<PermissionMatch>* [<PermissionMatchAction>]
|
|
gam <UserTypeEntity> delete permissions <SharedDriveEntityAdmin> <DriveFilePermissionIDEntity> adminaccess
|
|
<PermissionMatch>* [<PermissionMatchAction>]
|
|
|
|
In these commands, the Google administrator named in oauth2.txt is used.
|
|
|
|
gam copy shareddriveacls <SharedDriveEntity> to <SharedDriveEntity>
|
|
[adminaccess|asadmin]
|
|
[showpermissionsmessages [<Boolean>]]
|
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
|
(mappermissionsemail <EmailAddress> <EmailAddress>)* [mappermissionsemailfile <CSVFileInput> endcsv]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
gam sync shareddriveacls <SharedDriveEntity> with <SharedDriveEntity>
|
|
[adminaccess|asadmin]
|
|
[showpermissionsmessages [<Boolean>]]
|
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
|
(mappermissionsemail <EmailAddress> <EmailAddress>)* [mappermissionsemailfile <CSVFileInput> endcsv]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
|
|
gam print shareddriveacls [todrive <ToDriveAttribute>*]
|
|
[teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
gam show shareddriveacls
|
|
[teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
In these commands, you specify an administrator and then indicate that you want domain administrator access with the adminaccess option.
|
|
|
|
gam <UserTypeEntity> copy shareddriveacls <SharedDriveEntity> to <SharedDriveEntity>
|
|
[adminaccess|asadmin]
|
|
[showpermissionsmessages [<Boolean>]]
|
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
|
(mappermissionsemail <EmailAddress> <EmailAddress>)* [mappermissionsemailfile <CSVFileInput> endcsv]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
gam <UserTypeEntity> sync shareddriveacls <SharedDriveEntity> with <SharedDriveEntity>
|
|
[adminaccess|asadmin]
|
|
[showpermissionsmessages [<Boolean>]]
|
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
|
(mappermissionsemail <EmailAddress> <EmailAddress>)* [mappermissionsemailfile <CSVFileInput> endcsv]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
|
|
gam <UserTypeEntity> print shareddriveacls [todrive <ToDriveAttribute>*]
|
|
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[shownopermissionsdrives false|true|only]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show shareddriveacls
|
|
[adminaccess|asadmin] [teamdriveadminquery|query <QueryTeamDrive>]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
[user|group <EmailAddress> [checkgroups]] (role|roles <SharedDriveACLRoleList>)*
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[oneitemperrow] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
[shownopermissionsdrives false|true|only]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Tag Replace
|
|
<AddressSubfieldName> ::=
|
|
country|
|
|
countrycode|
|
|
customtype|
|
|
extendedaddress|
|
|
formatted|
|
|
locality|
|
|
pobox|
|
|
postalcode|
|
|
primary|
|
|
region|
|
|
streetaddress|
|
|
type
|
|
<EmailSubfieldName> ::=
|
|
domain|
|
|
primaryemail|
|
|
username
|
|
<ExternalIdSubfieldName> ::=
|
|
customtype|
|
|
type|
|
|
value
|
|
<GenderSubfieldName> ::=
|
|
addressmeas|
|
|
customgender|
|
|
type
|
|
<IMSubfieldName> ::=
|
|
customtype|
|
|
type|
|
|
value
|
|
<KeywordSubfieldName> ::=
|
|
customtype|
|
|
type|
|
|
value
|
|
<LocationSubfieldName> ::=
|
|
area|
|
|
buildingid|
|
|
buildingname|
|
|
customtype|
|
|
deskcode|
|
|
floorname|
|
|
floorsection|
|
|
type
|
|
<NameSubfieldName> ::=
|
|
familyname|
|
|
fullname|
|
|
givenname
|
|
<OrganizationSubfieldName> ::=
|
|
costcenter|
|
|
customtype|
|
|
department|
|
|
description|
|
|
domain|
|
|
fulltimeequivalent|
|
|
location|
|
|
name|
|
|
primary|
|
|
symbol|
|
|
title|
|
|
type
|
|
<OtherEmailSubfieldName> ::=
|
|
address|
|
|
customtype|
|
|
primary|
|
|
type
|
|
<PhoneSubfieldName> ::=
|
|
customtype|
|
|
primary|
|
|
type|
|
|
value
|
|
<PosixSubfieldName> ::=
|
|
accountid|
|
|
gecos|
|
|
gid|
|
|
homedirectory|
|
|
operatingsystemtype|
|
|
primary|
|
|
shell|
|
|
systemid|
|
|
uid|
|
|
username
|
|
<RelationSubfieldName> ::=
|
|
customtype|
|
|
type|
|
|
value
|
|
<SSHkeysSubfieldName> ::=
|
|
expirationtimeusec|
|
|
fingerprint|
|
|
key
|
|
<WebsiteSubfieldName> ::=
|
|
customtype|
|
|
primary|
|
|
type|
|
|
value
|
|
<UserReplacementFieldSubfield> ::=
|
|
address.<AddressSubfieldName>|
|
|
email.<EmailSubfieldName>|
|
|
externalid.<ExternalIdSubfieldName>|
|
|
gender.<GenderSubfieldName>|
|
|
im.<IMSubfieldName>|
|
|
keyword.<KeywordSubfieldName>|
|
|
location.<LocationSubfieldName>|
|
|
name.<NameSubfieldName>|
|
|
organization.<OrganizationSubfieldName>|
|
|
otheremail.<OtherEmailSubfieldName>|
|
|
phone.<PhoneSubfieldName>|
|
|
posix.<PosixSubfieldName>|
|
|
relation.<RelationSubfieldName>|
|
|
sshkeys.<SSHkeysSubfieldName>|
|
|
website.<WebsiteSubfieldName>|
|
|
<UserReplacementFieldSubfieldMatchSubfield> ::=
|
|
address.<AddressSubfieldName>.<AddressSubfieldName>.<String>|
|
|
externalid.<ExternalIdSubfieldName>.<ExternalIdSubfieldName>.<String>|
|
|
im.<IMSubfieldName>.<IMSubfieldName>.<String>|
|
|
keyword.<KeywordSubfieldName>.<KeywordSubfieldName>.<String>|
|
|
location.<LocationSubfieldName>.<LocationSubfieldName>.<String>|
|
|
organization.<OrganizationSubfieldName>.<OrganizationSubfieldName>.<String>|
|
|
otheremail.<OtherEmailSubfieldName>.<OtherEmailSubfieldName>.<String>|
|
|
phone.<PhoneSubfieldName>.<PhoneSubfieldName>.<String>|
|
|
posix.<PosixSubfieldName>.<PosixSubfieldName>.<String>|
|
|
relation.<RelationSubfieldName>.<RelationSubfieldName>.<String>|
|
|
sshkeys.<SSHkeysSubfieldName>.<SSHkeysSubfieldName>.<String>|
|
|
website.<WebsiteSubfieldName>.<WebsiteSubfieldName>.<String>
|
|
<UserReplacementField> ::=
|
|
photourl
|
|
<Tag> ::= <String>
|
|
<UserReplacement> ::=
|
|
(field:<UserReplacementField>)|
|
|
(field:<UserReplacementFieldSubfield>)|
|
|
(field:<UserReplacementFieldSubfieldMatchSubfield>)|
|
|
(schema:<SchemaNameField>)|
|
|
<String>
|
|
|
|
# Vault/Takeout
|
|
|
|
gam create|add vaultmatter|matter [name <String>] [description <string>]
|
|
[collaborator|collaborators <EmailItemList>] [sendemails <Boolean>] [ccme <Boolean>]
|
|
[showdetails|returnidonly]
|
|
gam update vaultmatter|matter <MatterItem> [name <String>] [description <string>]
|
|
[addcollaborator|addcollaborators <EmailItemList>] [removecollaborator|removecollaborators <EmailItemList>]
|
|
gam update vaultmatter|matter <MatterItem> action close|reopen|delete|undelete
|
|
gam close vaultmatter|matter <MatterItem>
|
|
gam reopen vaultmatter|matter <MatterItem>
|
|
gam delete vaultmatter|matter <MatterItem>
|
|
gam undelete vaultmatter|matter <MatterItem>
|
|
|
|
<VaultMatterFieldName> ::=
|
|
description|
|
|
matterid|
|
|
matterpermissions|
|
|
name|
|
|
state
|
|
<VaultMatterFieldNameList> ::= "<VaultMatterFieldName>(,<VaultMatterFieldName>)*"
|
|
|
|
gam info vaultmatter|matter <MatterItem> [basic|full]
|
|
[basic|full|(fields <VaultMatterFieldNameList>)]
|
|
[formatjson]
|
|
gam print vaultmatters|matters [todrive <ToDriveAttribute>*] [matterstate <MatterStateList>]
|
|
[basic|full|(fields <VaultMatterFieldNameList>)]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show vaultmatters|matters [matterstate <MatterStateList>]
|
|
[basic|full|(fields <VaultMatterFieldNameList>)]
|
|
[formatjson]
|
|
|
|
gam print vaultcounts [todrive <ToDriveAttributes>*]
|
|
matter <MatterItem> <QueryItem>
|
|
[wait <Integer>]
|
|
gam print vaultcounts [todrive <ToDriveAttributes>*]
|
|
matter <MatterItem>
|
|
corpus mail|groups
|
|
[scope [all_data|held_data|unprocessed_data]]
|
|
[(accounts <EmailAddressEntity>) | (orgunit|org|ou <OrgUnitPath>) | everyone]
|
|
[terms <String>] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>] [timezone <TimeZone>]
|
|
[excludedrafts <Boolean>]
|
|
[<JSONData>]
|
|
[wait <Integer>]
|
|
[include_suspended_zeros [<Boolean>]]
|
|
gam print vaultcounts [todrive <ToDriveAttributes>*]
|
|
matter <MatterItem> operation <String> [wait <Integer>]
|
|
|
|
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]
|
|
|
|
gam create vaultexport|export matter <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)*
|
|
[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]
|
|
gam delete vaultexport|export <ExportItem> matter <MatterItem>
|
|
gam delete vaultexport|export <MatterItem> <ExportItem>
|
|
gam download vaultexport|export <ExportItem> matter <MatterItem>
|
|
[targetfolder <FilePath>] [targetname <FileName>] [noverify] [noextract] [ziptostdout]
|
|
[bucketmatchpattern <REMatchPattern>] [objectmatchpattern <REMatchPattern>]
|
|
[downloadattempts <Integer>] [retryinterval <Integer>]
|
|
gam download vaultexport|export <MatterItem> <ExportItem>
|
|
[targetfolder <FilePath>] [targetname <FileName>] [noverify] [noextract] [ziptostdout]
|
|
[bucketmatchpattern <REMatchPattern>] [objectmatchpattern <REMatchPattern>]
|
|
[downloadattempts <Integer>] [retryinterval <Integer>]
|
|
gam copy vaultexport|export <ExportItem> matter <MatterItem>
|
|
[targetbucket <String>] [targetprefix <String>]
|
|
[bucketmatchpattern <REMatchPattern>] [objectmatchpattern <REMatchPattern>]
|
|
[copyattempts <Integer>] [retryinterval <Integer>]
|
|
gam copy vaultexport|export <MatterItem> <ExportItem>
|
|
[targetbucket <String>] [targetprefix <String>]
|
|
[bucketmatchpattern <REMatchPattern>] [objectmatchpattern <REMatchPattern>]
|
|
[copyattempts <Integer>] [retryinterval <Integer>]
|
|
|
|
<VaultExportFieldName> ::=
|
|
cloudstoragesink|
|
|
createtime|
|
|
exportoptions|
|
|
id|
|
|
matterid|
|
|
name|
|
|
query|
|
|
requester|
|
|
requester.displayname|
|
|
requester.email|
|
|
stats|
|
|
stats.exportedArtifactCount|
|
|
stats.sizeinbytes|
|
|
stats.totalartifactcount|
|
|
status
|
|
<VaultExportFieldNameList> ::= "<VaultExportFieldName>(,<VaultExportFieldName>)*"
|
|
|
|
gam info vaultexport|export <ExportItem> matter <MatterItem>
|
|
[fields <VaultExportFieldNameList>] [shownames]
|
|
[formatjson]
|
|
gam info vaultexport|export <MatterItem> <ExportItem>
|
|
[fields <VaultExportFieldNameList>] [shownames]
|
|
[formatjson]
|
|
gam print vaultexports|exports [todrive <ToDriveAttribute>*]
|
|
[matters <MatterItemList>] [exportstatus <ExportStatusList>]
|
|
[fields <VaultExportFieldNameList>] [shownames]
|
|
[formatjson [quotechar <Character>]]
|
|
[oneitemperrow]
|
|
gam show vaultexports|exports
|
|
[matters <MatterItemList>] [exportstatus <ExportStatusList>]
|
|
[fields <VaultExportFieldNameList>] [shownames]
|
|
[formatjson]
|
|
|
|
gam create vaulthold|hold matter <MatterItem> [name <String>]
|
|
vaultquery <QueryItem>
|
|
[showdetails|returnidonly]
|
|
gam create vaulthold|hold matter <MatterItem> [name <String>] corpus calendar|drive|mail|groups|hangouts_chat|voice
|
|
[(accounts|groups|users <EmailItemList>) | (orgunit|org|ou <OrgUnit>)]
|
|
[query <QueryVaultCorpus>]
|
|
[terms <String>] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[includerooms <Boolean>] (covereddata calllogs|textmessages|voicemails)*
|
|
[includeshareddrives <Boolean>]
|
|
[showdetails|returnidonly]
|
|
gam update vaulthold|hold <HoldItem> matter <MatterItem>
|
|
[([addaccounts|addgroups|addusers <EmailItemList>] [removeaccounts|removegroups|removeusers <EmailItemList>]) | (orgunit|org|ou <OrgUnit>)]
|
|
[query <QueryVaultCorpus>]
|
|
[terms <String>] [start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>]
|
|
[includerooms <Boolean>] (covereddata calllogs|textmessages|voicemails)*
|
|
[includeshareddrives <Boolean>]
|
|
[showdetails]
|
|
gam delete vaulthold|hold <HoldItem> matter <MatterItem>
|
|
gam delete vaulthold|hold <MatterItem> <HoldItem>
|
|
|
|
<VaultHoldFieldName> ::=
|
|
accounts|
|
|
accounts.acountid|
|
|
accounts.email|
|
|
accounts.firstname|
|
|
accounts.holdtime|
|
|
accounts.lastname|
|
|
corpus|
|
|
holdid|
|
|
name|
|
|
orgunit|
|
|
orgunit.holdtime|
|
|
orgunit.orgunitid|
|
|
query|
|
|
updatetime
|
|
<VaultHoldFieldNameList> ::= "<VaultHoldFieldName>(,<VaultHoldFieldName>)*"
|
|
|
|
gam info vaulthold|hold <HoldItem> matter <MatterItem>
|
|
[fields <VaultHoldFieldNameList>] [shownames]
|
|
[formatjson]
|
|
gam info vaulthold|hold <MatterItem> <HoldItem>
|
|
[fields <VaultHoldFieldNameList>] [shownames]
|
|
[formatjson]
|
|
gam print vaultholds|holds [todrive <ToDriveAttribute>*] [matters <MatterItemList>]
|
|
[fields <VaultHoldFieldNameList>] [shownames]
|
|
[formatjson [quotechar <Character>]]
|
|
[oneitemperrow]
|
|
gam show vaultholds|holds [matters <MatterItemList>]
|
|
[fields <VaultHoldFieldNameList>] [shownames]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print vaultholds|holds [todrive <ToDriveAttribute>*]
|
|
gam <UserTypeEntity> show vaultholds|holds
|
|
|
|
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)*
|
|
[<JSONData>]
|
|
[shownames]
|
|
[showdetails|returnidonly|formatjson]
|
|
|
|
gam copy vaultquery <MatterItem> <QueryItem> [targetmatter <MatterItem>] [name <String>]
|
|
[shownames]
|
|
[showdetails|returnidonly|formatjson]
|
|
|
|
gam delete vaultquery <QueryItem> matter <MatterItem>
|
|
gam delete vaultquery <MatterItem> <QueryItem>
|
|
|
|
<VaultQueryFieldName> ::=
|
|
createtime |
|
|
displayname |
|
|
matterid |
|
|
name |
|
|
query |
|
|
queryid |
|
|
savedqueryid
|
|
<VaultQueryFieldNameList> ::= "<VaultQueryFieldName>(,<VaultQueryFieldName>)*"
|
|
|
|
gam info vaultquery <QueryItem> matter <MatterItem>
|
|
[fields <VaultQueryFieldNameList>] [shownames]
|
|
[formatjson]
|
|
gam info vaultquery <MatterItem> <QueryItem>
|
|
[fields <VaultQueryFieldNameList>] [shownames]
|
|
[formatjson]
|
|
gam print vaultqueries [todrive <ToDriveAttribute>*] [matters <MatterItemList>]
|
|
[fields <VaultQueryFieldNameList>] [shownames]
|
|
[formatjson [quotechar <Character>]]
|
|
gam show vaultqueries [matters <MatterItemList>]
|
|
[fields <VaultQueryFieldNameList>] [shownames]
|
|
[formatjson]
|
|
|
|
gam download storagebucket <TakeoutBucketName>
|
|
[targetfolder <FilePath>]
|
|
gam copy storagebucket sourcebucket <StorageBucketName> targetbucket <StorageBucketName>
|
|
[sourceprefix <String>] [targetprefix <String>]
|
|
|
|
gam download storagefile <StorageBucketObjectName>
|
|
[targetfolder <FilePath>] [overwrite [<Boolean>]] [nogcspath [<Boolean>]]
|
|
|
|
# Users
|
|
|
|
<UserFieldName> ::=
|
|
addresses|address|
|
|
agreedtoterms|agreed2terms|
|
|
aliases|
|
|
archived|
|
|
changepasswordatnextlogin|changepassword|
|
|
creationtime|
|
|
customerid|
|
|
deletiontime|
|
|
displayname|
|
|
email|emails|otheremail|otheremails|
|
|
employeeid|
|
|
externalids|externalid|
|
|
familyname|lastname|
|
|
fullname|
|
|
gender|
|
|
givenname|firstname|
|
|
guestaccountinfo|
|
|
id|
|
|
ims|im|
|
|
includeinglobaladdresslist|gal|
|
|
ipwhitelisted|
|
|
isdelegatedadmin|admin|isadmin|
|
|
isenforcedin2sv|is2svenforced|
|
|
isenrolledin2sv|is2svenrolled|
|
|
isguestuser|
|
|
ismailboxsetup|
|
|
keyword|keywords|
|
|
language|languages|
|
|
lastlogintime|
|
|
locations|location|
|
|
manager|
|
|
name|
|
|
noneditablealiases|aliases|nicknames|
|
|
notes|note|
|
|
organizations|organization|
|
|
orgunitpath|org|ou|
|
|
phones|phone|
|
|
posixaccounts|posix|
|
|
primaryemail|username|
|
|
recoveryemail|
|
|
recoveryphone|
|
|
relations|relation|
|
|
sshpublickeys|ssh|sshkeys|
|
|
suspended|
|
|
thumbnailphotourl|photo|photourl|
|
|
websites|website
|
|
<UserFieldNameList> ::= "<UserFieldName>(,<UserFieldName>)*"
|
|
|
|
<UserOrderByFieldName> ::=
|
|
familyname|lastname|givenname|firstname|email
|
|
|
|
<UserNoteContent> ::=
|
|
<String>|
|
|
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)
|
|
|
|
<UserBasicAttribute> ::=
|
|
(archive|archived <Boolean>)|
|
|
(changepassword|changepasswordatnextlogin <Boolean>)|
|
|
(base64-md5|base64-sha1|crypt|sha|sha1|sha-1|md5|nohash)|
|
|
(customerid <String>)|
|
|
(displayname <String>)|
|
|
(email|primaryemail|username <EmailAddress>)|
|
|
(firstname|givenname <String>)|
|
|
(gal|includeinglobaladdresslist <Boolean>)|
|
|
(gender clear|(female|male|unknown|(other <String>) [addressmeas <String>]))|
|
|
(ipwhitelisted <Boolean>)|
|
|
(language clear|<LanguageList>)|
|
|
(lastname|familyname <String>)|
|
|
(note clear|([text_html|text_plain] <UserNoteContent))|
|
|
(ou|org|orgunitpath <OrgUnitPath>|<OrgUnitID>|root)
|
|
(password (random [<Integer>])|(uniquerandom [<Integer>])|
|
|
blocklogin|
|
|
prompt|uniqueprompt|
|
|
<Password>)|
|
|
(recoveryemail <EmailAddress>)|
|
|
(recoveryphone <string>)|
|
|
(suspend|suspended <Boolean>)|
|
|
(<SchemaNameField> [scalarnonempty|
|
|
[multivalued|multivalue|value|multinonempty [type home|other|work|(custom <String>)]]]
|
|
<String>)
|
|
|
|
<UserMultiAttribute> ::=
|
|
(address type home|other|work|(custom <String>)
|
|
[unstructured|formatted <String>]
|
|
[pobox <String>] [extendedaddress <String>] [streetaddress <String>]
|
|
[locality <String>] [region <String>] [postalcode <String>]
|
|
[country <String>] [countrycode <String>]
|
|
notprimary|primary)|
|
|
(employeeid <String>)|
|
|
(externalid account|customer|login_id|network|organization|(custom <String>)|<String> <String>)|
|
|
(im type home|other|work|(custom <String>)
|
|
protocol aim|gtalk|icq|jabber|msn|net_meeting|qq|
|
|
skype|yahoo|(custom_protocol <String>) <String>
|
|
notprimary|primary)|
|
|
(keyword mission|occupation|outlook|(custom <string>) <String>)|
|
|
(location [type default|desk|<String>] area <String>
|
|
[building|buildingid <String>] [floor|floorname <String>]
|
|
[section|floorsection <String>] [desk|deskcode <String>] endlocation)|
|
|
(manager <String>)|
|
|
(organization [type domain_only|school|unknown|work] [customtype <String>]
|
|
[name <String>] [title <String>] [department <String>]
|
|
[symbol <String>] [costcenter <String>] [location <String>]
|
|
[description <String>] [domain <String>]
|
|
[fulltimeequivalent <Integer>]
|
|
notprimary|primary)|
|
|
(otheremail home|other|work|<String> <String>)|
|
|
(phone [type assistant|callback|car|company_main|grand_central|home|
|
|
home_fax|isdn|main|mobile|other|other_fax|pager|radio|telex|tty_tdd|
|
|
work|work_fax|work_mobile|work_pager|(custom <String>)]
|
|
[value <String>]
|
|
notprimary|primary)|
|
|
(posix username <String> uid <Integer> gid <Integer> [system|systemid <String>]
|
|
[home|homedirectory <String>] [shell <String>]
|
|
[gecos <String>] [os|operatingSystemType linux|unspecified|windows]
|
|
[primary <Boolean>] endposix)|
|
|
(relation admin_assistant|assistant|brother|child|domestic_partner|
|
|
dotted-line_manager|exec_assistant|father|friend|manager|mother|
|
|
parent|partner|referred_by|relative|sister|spouse|<String> <String>)|
|
|
(sshkeys key <String> [expires <Integer>] endssh)|
|
|
(website app_install_page|blog|ftp|home|home_page|other|
|
|
profile|reservations|resume|work|<String> <URL>
|
|
notprimary|primary)
|
|
|
|
<UserClearAttribute> ::=
|
|
(address clear)|
|
|
(externalid clear)|
|
|
(im clear)|
|
|
(keyword clear)|
|
|
(location clear)|
|
|
(organization clear)|
|
|
(otheremail clear)|
|
|
(phone clear)|
|
|
(posix clear)|
|
|
(relation clear)|
|
|
(sshkeys clear)|
|
|
(website clear)
|
|
|
|
<UserAttribute> ::=
|
|
<JSONData>|
|
|
<UserBasicAttribute>|
|
|
<UserMultiAttribute>|
|
|
<UserClearAttribute>
|
|
|
|
<UserMultiAttributeFilterName> ::=
|
|
address|addresses|
|
|
externalid|externalids|
|
|
im|ims|
|
|
keyword|keywords|
|
|
location|locations|
|
|
orgainzation|organizations|
|
|
otheremail|otheremails|
|
|
phone|phones|
|
|
relation|relations|
|
|
website|websites
|
|
|
|
gam create|add user <EmailAddress> [ignorenullpassword] <UserAttribute>*
|
|
[verifynotinvitable|alwaysevict]
|
|
(groups [<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)*
|
|
[alias|aliases <EmailAddressList>]
|
|
[license <SKUIDList> [product|productid <ProductID>]]
|
|
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
|
[subject <String>]
|
|
[notifypassword <String>]
|
|
[from <EmailAaddress>] [mailbox <EmailAaddress>]
|
|
[replyto <EmailAaddress>]
|
|
[<NotifyMessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
]
|
|
[logpassword <FileName>]
|
|
[addnumericsuffixonduplicate <Number>]
|
|
|
|
gam <UserTypeEntity> waitformailbox [retries <Number>]
|
|
|
|
gam update user <UserItem> [ignorenullpassword] <UserAttribute>*
|
|
[verifynotinvitable|alwaysevict] [noactionifalias]
|
|
[updateprimaryemail <RESearchPattern> <RESubstitution>]
|
|
[updateoufromgroup <FileName> [charset <Charset>]
|
|
[columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[fields <FieldNameList>] [keyfield <FieldName>] [datafield <FieldName>]]
|
|
[immutableous <OrgUnitEntity>]|
|
|
[clearschema <SchemaName>|<SchemaNameField>]
|
|
[createifnotfound] [notfoundpassword (random [<Integer>])|blocklogin|<Password>]
|
|
(groups [<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)*
|
|
[alias|aliases <EmailAddressList>]
|
|
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
|
[subject <String>]
|
|
[notifypassword <String>]
|
|
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
|
[replyto <EmailAddress>]
|
|
[<NotifyMessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
]
|
|
[notifyonupdate [<Boolean>]] [setchangepasswordoncreate [<Boolean>]]
|
|
[logpassword <FileName>]
|
|
gam delete user <UserItem> [noactionifalias]
|
|
gam undelete user <UserItem> [ou|org|orgunit <OrgUnitPath>]
|
|
gam check suspended <UserItem>
|
|
gam suspend user <UserItem> [noactionifalias]
|
|
gam unsuspend user <UserItem> [noactionifalias]
|
|
gam info user [<UserItem>]
|
|
[quick]
|
|
[noaliases|aliases]
|
|
[nobuildingnames|buildingnames]
|
|
[nogroups|groups|grouptree|cigrouptree]
|
|
[nolicenses|nolicences|licenses|licences]
|
|
[noschemas|allschemas|(schemas|custom|customschemas <SchemaNameList>)]
|
|
[userview] <UserFieldName>* [fields <UserFieldNameList>]
|
|
(filtermultiattrtype <UserMultiAttributeFilterName> <String>)*
|
|
(filtermultiattrcustom <UserMultiAttributeFilterName> <String>)*
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)]
|
|
[formatjson]
|
|
|
|
gam update users <UserTypeEntity> [ignorenullpassword] <UserAttribute>*
|
|
[verifynotinvitable|alwaysevict] [noactionifalias]
|
|
[updateprimaryemail <RESearchPattern> <RESubstitution>]
|
|
[updateoufromgroup <FileName> [charset <Charset>]
|
|
[columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[fields <FieldNameList>] [keyfield <FieldName>] [datafield <FieldName>]]
|
|
[clearschema <SchemaName>|<SchemaNameField>]
|
|
[createifnotfound] [notfoundpassword (random [<Integer>])|blocklogin|<Password>]
|
|
(groups [<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)*
|
|
[alias|aliases <EmailAddressList>]
|
|
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
|
[subject <String>]
|
|
[notifypassword <String>]
|
|
[from <EmailAddress>] [mailbox <EmailAddress>]
|
|
[replyto <EmailAaddress>]
|
|
[<NotifyMessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
]
|
|
[notifyonupdate [<Boolean>]] [setchangepasswordoncreate [<Boolean>]]
|
|
[logpassword <FileName>]
|
|
gam delete users <UserTypeEntity> [noactionifalias]
|
|
gam undelete users <UserEntity> [ou|org|orgunit <OrgUnitPath>]
|
|
gam suspend users <UserTypeEntity> [noactionifalias]
|
|
gam unsuspend users <UserTypeEntity> [noactionifalias]
|
|
gam info users <UserTypeEntity>
|
|
[quick]
|
|
[noaliases|aliases]
|
|
[nobuildingnames|buildingnames]
|
|
[nogroups|groups|grouptree|cigrouptree]
|
|
[nolicenses|nolicences|licenses|licences]
|
|
[noschemas|allschemas|(schemas|custom|customschemas <SchemaNameList>)]
|
|
[userview] <UserFieldName>* [fields <UserFieldNameList>]
|
|
(filtermultiattrtype <UserMultiAttributeFilterName> <String>)*
|
|
(filtermultiattrcustom <UserMultiAttributeFilterName> <String>)*
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> update users [ignorenullpassword] <UserAttribute>*
|
|
[verifynotinvitable|alwaysevict] [noactionifalias]
|
|
[updateprimaryemail <RESearchPattern> <RESubstitution>]
|
|
[updateoufromgroup <FileName> [charset <Charset>]
|
|
[columndelimiter <Character>] [noescapechar <Boolean>] [quotechar <Character>]
|
|
[fields <FieldNameList>] [keyfield <FieldName>] [datafield <FieldName>]]
|
|
[clearschema <SchemaName>|<SchemaNameField>]
|
|
[createifnotfound] [notfoundpassword (random [<Integer>])|blocklogin|<Password>]
|
|
(groups [<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)*
|
|
[alias|aliases <EmailAddressList>]
|
|
[[notify <EmailAddressList>] [notifyrecoveryemail]
|
|
[subject <String>]
|
|
[notifypassword <String>]
|
|
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
|
[replyto <EmailAddress>]
|
|
[<NotifyMessageContent>] [html [<Boolean>]]
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
]
|
|
[notifyonupdate [<Boolean>]] [setchangepasswordoncreate [<Boolean>]]
|
|
[logpassword <FileName>]
|
|
gam <UserTypeEntity> delete users [noactionifalias]
|
|
gam <UserEntity> undelete users [ou|org|orgunit <OrgUnitPath>]
|
|
gam <UserTypeEntity> suspend users [noactionifalias]
|
|
gam <UserTypeEntity> unsuspend users [noactionifalias]
|
|
gam <UserTypeEntity> info users
|
|
[quick]
|
|
[noaliases|aliases]
|
|
[nobuildingnames|buildingnames]
|
|
[nogroups|groups|grouptree|cigrouptree]
|
|
[nolicenses|nolicences|licenses|licences]
|
|
[noschemas|allschemas|(schemas|custom|customschemas <SchemaNameList>)]
|
|
[userview] <UserFieldName>* [fields <UserFieldNameList>]
|
|
(filtermultiattrtype <UserMultiAttributeFilterName> <String>)*
|
|
(filtermultiattrcustom <UserMultiAttributeFilterName> <String>)*
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)]
|
|
[formatjson]
|
|
|
|
Print fields for selected users; use these options to select users:
|
|
([domain <DomainName>] [(query <QueryUser>)|(queries <QueryUserList>)]
|
|
[limittoou <OrgUnitItem>] [deleted_only|only_deleted] [notsuspended|suspended])
|
|
If none of these options are chosen, all users are selected.
|
|
|
|
gam print users [todrive <ToDriveAttribute>*]
|
|
([domain|domains <DomainNameEntity>] [(query <QueryUser>)|(queries <QueryUserList>)]
|
|
[limittoou <OrgUnitItem>] [deleted_only|only_deleted])
|
|
[orderby <UserOrderByFieldName> [ascending|descending]]
|
|
[groups|groupsincolumns]
|
|
[license|licenses|licence|licences|licensebyuser|licensesbyuser|licencebyuser|licencesbyuser]
|
|
[onelicenseperrow|onelicenceperrow]
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)]
|
|
[schemas|custom|customschemas all|<SchemaNameList>]
|
|
[emailpart|emailparts|username]
|
|
[userview] [basic|full|allfields|(<UserFieldName>*|fields <UserFieldNameList>)]
|
|
(filtermultiattrtype <UserMultiAttributeFilterName> <String>)*
|
|
(filtermultiattrcustom <UserMultiAttributeFilterName> <String>)*
|
|
[delimiter <Character>] [sortheaders [<Boolean>]] [scalarsfirst [<Boolean>]]
|
|
[formatjson [quotechar <Character>]] [quoteplusphonenumbers]
|
|
[issuspended <Boolean>] [isarchived <Boolean>] [aliasmatchpattern <REMatchPattern>]
|
|
[showvalidcolumn] (addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[showitemcountonly]
|
|
|
|
Print fields for specified users.
|
|
|
|
gam print users [todrive <ToDriveAttribute>*] select <UserTypeEntity>
|
|
[orderby <UserOrderByFieldName> [ascending|descending]]
|
|
[groups|groupsincolumns]
|
|
[license|licenses|licence|licences|licensebyuser|licensesbyuser|licencebyuser|licencesbyuser]
|
|
[onelicenseperrow|onelicenceperrow]
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)]
|
|
[schemas|custom|customschemas all|<SchemaNameList>]
|
|
[emailpart|emailparts|username]
|
|
[userview] [basic|full|allfields|(<UserFieldName>*|fields <UserFieldNameList>)]
|
|
(filtermultiattrtype <UserMultiAttributeFilterName> <String>)*
|
|
(filtermultiattrcustom <UserMultiAttributeFilterName> <String>)*
|
|
[delimiter <Character>] [sortheaders [<Boolean>]] [scalarsfirst [<Boolean>]]
|
|
[formatjson [quotechar <Character>]] [quoteplusphonenumbers]
|
|
[issuspended <Boolean>] [isarchived <Boolean>] [aliasmatchpattern <REMatchPattern>]
|
|
[showvalidcolumn] (addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[showitemcountonly]
|
|
|
|
gam <UserTypeEntity> print users [todrive <ToDriveAttribute>*]
|
|
[orderby <UserOrderByFieldName> [ascending|descending]]
|
|
[groups|groupsincolumns]
|
|
[license|licenses|licence|licences|licensebyuser|licensesbyuser|licencebyuser|licencesbyuser]
|
|
[onelicenseperrow|onelicenceperrow]
|
|
[(products|product <ProductIDList>)|(skus|sku <SKUIDList>)]
|
|
[schemas|custom|customschemas all|<SchemaNameList>]
|
|
[emailpart|emailparts|username]
|
|
[userview] [basic|full|allfields|(<UserFieldName>*|fields <UserFieldNameList>)]
|
|
(filtermultiattrtype <UserMultiAttributeFilterName> <String>)*
|
|
(filtermultiattrcustom <UserMultiAttributeFilterName> <String>)*
|
|
[delimiter <Character>] [sortheaders [<Boolean>]] [scalarsfirst [<Boolean>]]
|
|
[formatjson [quotechar <Character>]] [quoteplusphonenumbers]
|
|
[issuspended <Boolean>] [isarchived <Boolean>] [aliasmatchpattern <REMatchPattern>]
|
|
[showvalidcolumn] (addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[showitemcountonly]
|
|
|
|
The first column will always be primaryEmail; the remaining field names will be sorted if allfields, basic, full or sortheaders is specified;
|
|
otherwise, the remaining field names will appear in the order specified.
|
|
|
|
Print no header row and primaryEmail for specified users.
|
|
|
|
gam <UserTypeEntity> print
|
|
gam <UserTypeEntity> print users
|
|
|
|
Print user domain counts for selected users; use these options to select users:
|
|
([domain|domains <DomainNameEntity>] [(query <QueryUser>)|(queries <QueryUserList>)]
|
|
[limittoou <OrgUnitItem>] [deleted_only|only_deleted])
|
|
If none of these options are chosen, all users are selected.
|
|
|
|
gam print users [todrive <ToDriveAttribute>*]
|
|
([domain|domains <DomainNameEntity>] [(query <QueryUser>)|(queries <QueryUserList>)]
|
|
[limittoou <OrgUnitItem>] [deleted_only|only_deleted])
|
|
[formatjson [quotechar <Character>]] [countsonly|countonly]
|
|
[issuspended <Boolean>] [isarchived <Boolean>]
|
|
|
|
Print user domain counts for specified users.
|
|
|
|
gam print users [todrive <ToDriveAttribute>*] select <UserTypeEntity>
|
|
[formatjson [quotechar <Character>]] [countsonly|countonly]
|
|
|
|
gam <UserTypeEntity> print users [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]] [countsonly|countonly]
|
|
[issuspended <Boolean>]
|
|
|
|
Print user counts by OrgUnits
|
|
|
|
gam print usercountsbyorgunit [todrive <ToDriveAttribute>*]
|
|
[domain <String>]
|
|
|
|
Print lists of users
|
|
|
|
gam <UserTypeEntity> print userlist [todrive <ToDriveAttribute>*]
|
|
[title <String>]
|
|
[delimiter <Character>] [formatjson] [quotechar <Character>]
|
|
|
|
Show count of users
|
|
|
|
gam <UserTypeEntity> show count
|
|
|
|
# Users - Application Specific Passwords/backup Codes
|
|
|
|
gam <UserTypeEntity> delete asps|applicationspecificpasswords all|<ASPIDList>
|
|
gam <UserTypeEntity> show asps|applicationspecificpasswords
|
|
gam <UserTypeEntity> print asps|applicationspecificpasswords [todrive <ToDriveAttribute>*]
|
|
[oneitemperrow]
|
|
|
|
gam <UserTypeEntity> update backupcodes|verificationcodes
|
|
gam <UserTypeEntity> delete backupcodes|verificationcodes
|
|
gam <UserTypeEntity> show backupcodes|verificationcodes
|
|
gam <UserTypeEntity> print backupcodes|verificationcodes [todrive <ToDriveAttribute>*]
|
|
[delimiter <Character>] [countsonly]
|
|
|
|
# Users - Business Profile Accounts
|
|
|
|
gam <UserTypeEntity> show businessprofileaccounts
|
|
[type locationgroup|organization|personal|usergroup]
|
|
gam <UserTypeEntity> print businessprofileaccounts [todrive <ToDriveAttribute>*]
|
|
[type locationgroup|organization|personal|usergroup]
|
|
|
|
# Users - Calendars
|
|
|
|
<CalendarACLRole> ::= editor|freebusy|freebusyreader|owner|reader|writer
|
|
|
|
<CalendarSelectProperty> ::=
|
|
(minaccessrole <CalendarACLRole>)|
|
|
showdeleted|
|
|
showhidden
|
|
|
|
<UserCalendarAddEntity> ::=
|
|
<EmailAddress>|
|
|
<UniqueID>|
|
|
(courses <CourseIDList>)|
|
|
((courses_with_teacher <UserItem>)|my_courses_as_teacher [coursestates <CourseStateList>])|
|
|
((courses_with_student <UserItem>)|my_courses_as_student [coursestates <CourseStateList>])|
|
|
(resource <ResourceID>)|
|
|
(resources <ResourceIDList>)|
|
|
((calendars <CalendarList>) | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>)
|
|
|
|
<UserCalendarEntity> ::=
|
|
allcalendars|
|
|
primary|
|
|
<EmailAddress>|
|
|
<UniqueID>|
|
|
(courses <CourseIDList>)|
|
|
((courses_with_teacher <UserItem>)|my_courses_as_teacher [coursestates <CourseStateList>])|
|
|
((courses_with_student <UserItem>)|my_courses_as_student [coursestates <CourseStateList>])|
|
|
(coursestates <CourseStateList>)|
|
|
(resource <ResourceID>)|
|
|
(resources <ResourceIDList>)|
|
|
((calendars <CalendarList>) | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>)|
|
|
<CalendarSelectProperty>*
|
|
|
|
<CalendarACLScope> ::=
|
|
<EmailAddress>|user:<EmailAddress>|group:<EmailAddress>|domain:<DomainName>|domain|default
|
|
<CalendarACLScopeList> ::=
|
|
<CalendarACLScope>(,<CalendarACLScope>)*
|
|
<CalendarACLScopeEntity> ::=
|
|
<CalendarACLScopeList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
<CalendarEmailNotificatonEventType> ::=
|
|
eventcreation|eventchange|eventcancellation|eventresponse|agenda
|
|
<CalendarEmailNotificatonEventTypeList> ::=
|
|
"<CalendarEmailNotificatonEventType>(,<CalendarEmailNotificatonEventType>)*"
|
|
|
|
<CalendarAttribute> ::=
|
|
(backgroundcolor <ColorValue>)|
|
|
(color <CalendarColorName>)|
|
|
(colorindex|colorid <CalendarColorIndex>)|
|
|
(foregroundcolor <ColorValue>)|
|
|
(hidden <Boolean>)|
|
|
(notification clear|(email <CalendarEmailNotificatonEventTypeList>))|
|
|
(reminder clear|(email|pop <Number>)|(<Number> email|pop))|
|
|
(selected <Boolean>)|
|
|
(summary <String>)
|
|
|
|
<CalendarSettings> ::=
|
|
(autoacceptinvitations [<Boolean>])|
|
|
(description <String>)|
|
|
(location <String>)|
|
|
(summary <String>)|
|
|
(timezone <TimeZone>)
|
|
|
|
Manage a users list of calendars
|
|
|
|
gam <UserTypeEntity> add calendars <UserCalendarAddEntity> <CalendarAttribute>*
|
|
gam <UserTypeEntity> update calendars <UserCalendarEntity> <CalendarAttribute>+
|
|
gam <UserTypeEntity> delete calendars <UserCalendarEntity>
|
|
|
|
<CalendarListField> ::=
|
|
accessrole|
|
|
backgroundcolor|
|
|
colorid|
|
|
conferenceproperties|
|
|
defaultreminders|
|
|
deleted|
|
|
description|
|
|
foregroundcolor|
|
|
hidden|
|
|
id|
|
|
location|
|
|
notificationsettings|
|
|
primary|
|
|
selected|
|
|
summary|
|
|
summaryoverride|
|
|
timezone
|
|
<CalendarListFieldList> ::= "<CalendarListField>(,<CalendarListField>)*"
|
|
|
|
Display a users list of calendars
|
|
|
|
gam <UserTypeEntity> info calendars <UserCalendarEntity>
|
|
[fields <CalendarListFieldList>] [permissions]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show calendars
|
|
[primary] <CalendarSelectProperty>* [noprimary] [nogroups] [noresources] [nosystem] [nousers]
|
|
[fields <CalendarListFieldList>] [permissions]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print calendars [todrive <ToDriveAttribute>*]
|
|
[primary] <CalendarSelectProperty>* [noprimary] [nogroups] [noresources] [nosystem] [nousers]
|
|
[fields <CalendarListFieldList>] [permissions] [oneitemperrow]
|
|
[formatjson] [delimiter <Character>] [quotechar <Character>]
|
|
|
|
Display a users calendar settings
|
|
|
|
<UserCalendarSettingsField> ::=
|
|
autoaddhangouts|
|
|
datefieldorder|
|
|
defaulteventlength|
|
|
format24hourtime|
|
|
hideinvitations|
|
|
hideinvitationssetting|
|
|
hideweekends|
|
|
locale|
|
|
remindonrespondedeventsonly|
|
|
showdeclinedevents|
|
|
timezone|
|
|
usekeyboardshortcuts|
|
|
weekstart
|
|
<UserCalendarSettingsFieldList> ::= "<UserCalendarSettingsField>(,<UserCalendarSettingsField>)*"
|
|
|
|
gam <UserTypeEntity> show calsettings
|
|
[fields <UserCalendarSettingsFieldList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print calsettings [todrive <ToDriveAttribute>*]
|
|
[fields <UserCalendarSettingsFieldList>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
Create, modify and remove calendars for a user
|
|
|
|
gam <UserTypeEntity> create calendar <CalendarSettings>+
|
|
gam <UserTypeEntity> modify calendars <UserCalendarEntity> <CalendarSettings>+
|
|
gam <UserTypeEntity> remove calendars <UserCalendarEntity>
|
|
|
|
Manage access to any calendar a user owns
|
|
|
|
gam <UserTypeEntity> create|add calendaracls <UserCalendarEntity> <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam <UserTypeEntity> update calendaracls <UserCalendarEntity> <CalendarACLRole> <CalendarACLScopeEntity> [sendnotifications <Boolean>]
|
|
gam <UserTypeEntity> delete calendaracls <UserCalendarEntity> <CalendarACLRole>] <CalendarACLScopeEntity>
|
|
|
|
gam <UserTypeEntity> info calendaracls <UserCalendarEntity> <CalendarACLScopeEntity>
|
|
[formatjson]
|
|
gam <UserTypeEntity> show calendaracls <UserCalendarEntity>
|
|
[noselfowner]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print calendaracls <UserCalendarEntity> [todrive <ToDriveAttribute>*]
|
|
[noselfowner] (addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
Transfer ownership of a selection of a users secondary calendars to another user
|
|
|
|
gam <UserTypeEntity> transfer calendars|seccals <UserItem> [<UserCalendarEntity>]
|
|
[keepuser | (retainrole <CalendarACLRole>)] [sendnotifications <Boolean>] [noretentionmessages]
|
|
<CalendarSettings>* [append description|location|summary] [noupdatemessages]
|
|
[deletefromoldowner] [addtonewowner <CalendarAttribute>*] [nolistmessages]
|
|
|
|
<AttendeeAttendance> ::= optional|required
|
|
<AttendeeStatus> ::= accepted|declined|needsaction|tentative
|
|
|
|
<EventType> ::=
|
|
birthday|
|
|
default|
|
|
focustime|
|
|
outofoffice|
|
|
workinglocation
|
|
<EventTypeList> ::= "<EventType>(,<EventType>)*"
|
|
|
|
<EventSelectProperty> ::=
|
|
(after|starttime|timemin <Time>)|
|
|
(before|endtime|timemax <Time>)|
|
|
(eventtypes <EventTypeList>)|
|
|
(query <QueryCalendar>)|
|
|
(privateextendedproperty <String>)|
|
|
(sharedextendedproperty <String>)|
|
|
showdeletedevents|
|
|
showhiddeninvitations|
|
|
singleevents|
|
|
(updatedmin <Time>)
|
|
|
|
<EventMatchProperty> ::=
|
|
(matchfield attendees <EmailAddressEntity>)|
|
|
(matchfield attendeespattern <RESearchPattern>)|
|
|
(matchfield attendeesstatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddressEntity>)|
|
|
(matchfield creatoremail <RESearchPattern>)|
|
|
(matchfield creatorname <RESearchPattern>)|
|
|
(matchfield description <RESearchPattern>)|
|
|
(matchfield hangoutlink <RESearchPattern>)|
|
|
(matchfield location <RESearchPattern>)|
|
|
(matchfield organizeremail <RESearchPattern>)|
|
|
(matchfield organizername <RESearchPattern>)|
|
|
(matchfield status <RESearchPattern>)|
|
|
(matchfield summary <RESearchPattern>)|
|
|
(matchfield transparency <RESearchPattern>)|
|
|
(matchfield visibility <RESearchPattern>)
|
|
|
|
<EventIDEntity> ::=
|
|
(id|eventid <EventId>) |
|
|
(event|events <EventIdList> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
|
|
|
<EventSelectEntity> ::=
|
|
(<EventSelectProperty>+ <EventMatchProperty>*)
|
|
|
|
<EventEntity> ::=
|
|
<EventIDEntity> | <EventSelectEntity>
|
|
|
|
<AttendeeAttendance> ::= optional|required
|
|
<AttendeeStatus> ::= accepted|declined|needsaction|tentative
|
|
|
|
<EventAttribute> ::=
|
|
(allday <Date>)|
|
|
(anyonecanaddself [<Boolean>])|
|
|
(attachment <String> <URL>)|
|
|
(attendee <EmailAddress>)|
|
|
(attendeestatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddress>)|
|
|
available|
|
|
(birthday <Date>)|
|
|
(color <EventColorName>)|
|
|
(colorindex|colorid <EventColorIndex>)|
|
|
(conferencedata meet <MeetID>)|
|
|
(description <String>)|
|
|
(end|endtime (allday <Date>)|<Time>)|
|
|
(guestscaninviteothers <Boolean>)|
|
|
guestscantinviteothers|
|
|
(guestscanmodify <Boolean>)|
|
|
(guestscanseeotherguests <Boolean>)|
|
|
guestscantseeotherguests|
|
|
googlemeet|hangoutsmeet|
|
|
<JSONData>|
|
|
(jsonattendees [charset <Charset>] <String>)|
|
|
(jsonattendees file <FileName> [charset <Charset>])|
|
|
(location <String>)|
|
|
(noreminders|(reminder email|popup <Number>))|
|
|
(optionalattendee <EmailAddress>)|
|
|
(originalstart|originalstarttime (allday <Date>)|<Time>)|
|
|
(privateproperty <PropertyKey> <PropertyValue>)|
|
|
(range <Date> <Date>)|
|
|
(recurrence <RRULE, EXRULE, RDATE and EXDATE line>)|
|
|
(reminder <Number> email|popup)|
|
|
(resource <ResourceID>)|
|
|
(selectattendees [<AttendeeAttendance>] [<AttendeeStatus>] <UserTypeEntity>)|
|
|
(sequence <Integer>)|
|
|
(sharedproperty <PropertyKey> <PropertyValue>)|
|
|
(source <String> <URL>)|
|
|
(start|starttime (allday <Date>)|<Time>)|
|
|
(status confirmed|tentative|cancelled)|
|
|
(summary <String>)|
|
|
tentative|
|
|
(timerange <Time> <Time>)|
|
|
(timezone <TimeZone>)|
|
|
(transparency opaque|transparent)|
|
|
(visibility default|public|private)
|
|
|
|
The following attributes are equivalent:
|
|
available - transparency transparent
|
|
guestscantinviteothers - guestscaninviteothers False
|
|
guestscantseeothers - guestscanseeotherguests False
|
|
tentative - status tentative
|
|
|
|
<EventImportAttribute> ::=
|
|
<EventAttribute>|
|
|
(organizername <String>)|
|
|
(organizeremail <EmailAddress>)
|
|
|
|
<EventUpdateAttribute> ::=
|
|
<EventAttribute>|
|
|
clearattachments|
|
|
clearattendees|
|
|
cleargooglemeet|clearhangoutsmeet|
|
|
(clearprivateproperty <PropertyKey>)|
|
|
clearresources|
|
|
(clearsharedproperty <PropertyKey>)|
|
|
(removeattendee <EmailAddress>)|
|
|
(removeresource <ResourceID>)|
|
|
(replacedescription <REMatchPattern> <RESubstitution>)|
|
|
(selectremoveattendees <UserTypeEntity>)
|
|
|
|
<EventNotificationAttribute> ::=
|
|
notifyattendees|(sendnotifications <Boolean>)|(sendupdates all|enternalonly|none)
|
|
|
|
The following attributes are equivalent:
|
|
notifyattendees - sendupdates all
|
|
sendnotifications false - sendupdates none
|
|
sendnotifications true - sendupdates all
|
|
|
|
Add update and delete events in any calendar for which a user has access
|
|
|
|
gam <UserTypeEntity> create|add event <UserCalendarEntity> [id <String>] <EventAttribute>+ [<EventNotificationAttribute>]
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam <UserTypeEntity> import event <UserCalendarEntity> icaluid <iCalUID> <EventImportAttribute>+
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam <UserTypeEntity> update events <UserCalendarEntity> [<EventEntity>] [replacemode] <EventUpdateAttribute>+ [<EventNotificationAttribute>]
|
|
[showdayofweek]
|
|
[csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]]]
|
|
gam <UserTypeEntity> delete events <UserCalendarEntity> [<EventEntity>]
|
|
# [batchsize <Integer>] [doit] [<EventNotificationAttribute>]
|
|
gam <UserTypeEntity> purge events <UserCalendarEntity> [<EventEntity>]
|
|
# [batchsize <Integer>] [doit] [<EventNotificationAttribute>]
|
|
gam <UserTypeEntity> wipe events <UserCalendarEntity>
|
|
gam <UserTypeEntity> move events <UserCalendarEntity> [<EventEntity>] destination|to <CalendarItem> [<EventNotificationAttribute>]
|
|
gam <UserTypeEntity> empty calendartrash <UserCalendarEntity>
|
|
|
|
<EventDisplayProperty> ::=
|
|
(alwaysincludeemail)|
|
|
(icaluid <String>)|
|
|
(maxattendees <Integer>)|
|
|
(orderby starttime|updated)|
|
|
(timezone <TimeZone>)
|
|
|
|
gam <UserTypeEntity> info events <UserCalendarEntity> [<EventEntity>] [maxinstances <Number>]
|
|
[fields <EventFieldNameList>] [showdayofweek]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show events <UserCalendarEntity> [<EventEntity>] <EventDisplayProperty>*
|
|
[fields <EventFieldNameList>] [showdayofweek]
|
|
[countsonly|formatjson]
|
|
gam <UserTypeEntity> print events <UserCalendarEntity> [<EventEntity>] <EventDisplayProperty>*
|
|
[fields <EventFieldNameList>] [showdayofweek] [attendeeslist]
|
|
[eventrowfilter]]
|
|
[countsonly|(formatjson [quotechar <Character>])] [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> update calattendees <UserCalendarEntity> <EventEntity> [anyorganizer]
|
|
[<EventNotificationAttribute>] [splitupdate] [dryrun|doit]
|
|
(csv|csvfile <CSVFileInput> endcsv)
|
|
(delete <EmailAddress>)*
|
|
(deleteentity <EmailAddressEntity>)*
|
|
(add <EmailAddress>)*
|
|
(addentity <EmailAddressEntity>)*
|
|
(addstatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddress>)*
|
|
(addentitystatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddressEntity>)*
|
|
(replace <EmailAddress> <EmailAddress>)*
|
|
(replacestatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddress> <EmailAddress>)*
|
|
(updatestatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddress>)*
|
|
(updateentitystatus [<AttendeeAttendance>] [<AttendeeStatus>] <EmailAddressEntity>)*
|
|
|
|
Manage/Display Status Events
|
|
|
|
gam <UserTypeEntity> create focustime
|
|
[chatstatus available|donotdisturb]
|
|
[declinemode none|all|new]
|
|
[declinemessage <String>]
|
|
[summary <String>]
|
|
((date yyyy-mm-dd)|
|
|
(range yyyy-mm-dd yyyy-mm-dd)|
|
|
(daily yyyy-mm-dd N)|
|
|
(weekly yyyy-mm-dd N)|
|
|
(timerange <Time> <Time> (recurrence <RRULE, EXRULE, RDATE and EXDATE line>)*))+
|
|
[timezone <String>]
|
|
(noreminders|(reminder email|popup <Number>)+)
|
|
|
|
gam <UserTypeEntity> create outofoffice
|
|
[declinemode none|all|new]
|
|
[declinemessage <String>]
|
|
[summary <String>]
|
|
((date yyyy-mm-dd)|
|
|
(range yyyy-mm-dd yyyy-mm-dd)|
|
|
(daily yyyy-mm-dd N)|
|
|
(weekly yyyy-mm-dd N)|
|
|
(timerange <Time> <Time>) (recurrence <RRULE, EXRULE, RDATE and EXDATE line>)*)+
|
|
[timezone <String>]
|
|
(noreminders|(reminder email|popup <Number>)+)
|
|
|
|
gam <UserTypeEntity> create workinglocation
|
|
(home|
|
|
(custom <String>)|
|
|
(office <String> [building|buildingid <String>] [floor|floorname <String>]
|
|
[section|floorsection <String>] [desk|deskcode <String>]))
|
|
((date yyyy-mm-dd)|
|
|
(range yyyy-mm-dd yyyy-mm-dd)|
|
|
(daily yyyy-mm-dd N)|
|
|
(weekly yyyy-mm-dd N)|
|
|
(timerange <Time> <Time>) (recurrence <RRULE, EXRULE, RDATE and EXDATE line>)*)+
|
|
[timezone <String>]
|
|
(noreminders|(reminder email|popup <Number>)+)
|
|
|
|
gam <UserTypeEntity> delete focustime|outofoffice|workinglocation
|
|
((date yyyy-mm-dd)|
|
|
(range yyyy-mm-dd yyyy-mm-dd)|
|
|
(daily yyyy-mm-dd N)|
|
|
(weekly yyyy-mm-dd N)|
|
|
(timerange <Time> <Time>))+
|
|
|
|
gam <UserTypeEntity> show focustime|outofoffice|workinglocation
|
|
((date yyyy-mm-dd)|
|
|
(range yyyy-mm-dd yyyy-mm-dd)|
|
|
(daily yyyy-mm-dd N)|
|
|
(weekly yyyy-mm-dd N)|
|
|
(timerange <Time> <Time>))+
|
|
[showdayofweek]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print focustime|outofoffice|workinglocation
|
|
((date yyyy-mm-dd)|
|
|
(range yyyy-mm-dd yyyy-mm-dd)|
|
|
(daily yyyy-mm-dd N)|
|
|
(weekly yyyy-mm-dd N)|
|
|
(timerange <Time> <Time>))+
|
|
[showdayofweek]
|
|
[formatjson [quotechar <Character>]] [todrive <ToDriveAttribute>*]
|
|
|
|
# Users - Chat
|
|
|
|
<ChatContent> ::=
|
|
(text <String>)|
|
|
(textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>)
|
|
|
|
<ChatMember> ::= spaces/<String>/members/<String>
|
|
<ChatMemberList> ::= "<ChatMember>(,<ChatMember>)*"
|
|
<ChatMessage> ::= spaces/<String>/messages/<String>
|
|
<ChatSpace> ::= spaces/<String> | <String>
|
|
<ChatThread> ::= spaces/<String>/threads/<String>
|
|
<ChatSpaceType> ::=
|
|
space|
|
|
groupchat|
|
|
directmessage
|
|
<ChatSpaceTypeList> ::= "<ChatSpaceType>(,<ChatSpaceType>)*"
|
|
<ChatMessageID> ::= client-<String>
|
|
<String> must contain only lowercase letters, numbers, and hyphens up to 56 characters in length.
|
|
|
|
gam <UserTypeEntity> create chatspace
|
|
[type <ChatSpaceType>] [announcement|collaboration]
|
|
[restricted|(audience <String>)]
|
|
[externalusersrallowed <Boolean>]
|
|
[members <UserTypeEntity>]
|
|
[displayname <String>]
|
|
[description <String>] [guidelines <String>]
|
|
[history <Boolean>]
|
|
[<ChatContent>]
|
|
[(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]] (addcsvdata <FieldName> <String>)*) | formatjson | returnidonly]
|
|
|
|
gam <UserTypeEntity> update chatspace <ChatSpace>
|
|
[restricted|(audience <String>)]|
|
|
([displayname <String>]
|
|
[type space]
|
|
[description <String>] [guidelines|rules <String>]
|
|
[history <Boolean>])
|
|
[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]
|
|
[formatjson]
|
|
gam <UserTypeEntity> delete chatspace <ChatSpace>
|
|
|
|
gam <UserItem> update chatspace asadmin <ChatSpace>
|
|
[restricted|(audience <String>)]|
|
|
([displayname <String>]
|
|
[type space]
|
|
[description <String>] [guidelines|rules <String>]
|
|
[history <Boolean>])
|
|
[formatjson]
|
|
gam <UserItem> delete chatspace asadmin <ChatSpace>
|
|
|
|
<ChatSpaceFieldName> ::=
|
|
accesssettings|
|
|
admininstalled|
|
|
createtime|
|
|
displayname|
|
|
externaluserallowed|
|
|
importmode|
|
|
lastactivetime|
|
|
membershipcount|
|
|
name|
|
|
singleuserbotdm|
|
|
spacedetails|
|
|
spacehistorystate|
|
|
spacethreadingstate|threaded|
|
|
spacetype|type|
|
|
spaceuri
|
|
<ChatSpaceFieldNameList> ::= "<ChatSpaceFieldName>(,<ChatSpaceFieldName>)*"
|
|
|
|
gam <UserTypeEntity> info chatspace <ChatSpace>
|
|
[fields <ChatSpaceFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> info chatspacedm <UserItem>
|
|
[fields <ChatSpaceFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show chatspaces
|
|
[types <ChatSpaceTypeList>]
|
|
[fields <ChatSpaceFieldNameList>] [showaccessssettings]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatspaces [todrive <ToDriveAttribute>*]
|
|
[types <ChatSpaceTypeList>]
|
|
[fields <ChatSpaceFieldNameList>] [showaccessssettings]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserItem> info chatspace asadmin <ChatSpace>
|
|
[fields <ChatSpaceFieldNameList>]
|
|
[formatjson]
|
|
gam <UserItem> show chatspaces asadmin
|
|
[query <String>] [querytime<String> <Time>]
|
|
[orderby <ChatSpaceAdminOrderByFieldName> [ascending|descending]]
|
|
[fields <ChatSpaceFieldNameList>] [showaccessssettings]
|
|
[formatjson]
|
|
gam <UserItem> print chatspaces asadmin [todrive <ToDriveAttribute>*]
|
|
[query <String>] [querytime<String> <Time>]
|
|
[orderby <ChatSpaceAdminOrderByFieldName> [ascending|descending]]
|
|
[fields <ChatSpaceFieldNameList>] [showaccessssettings]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> create chatsection
|
|
displayname <String>
|
|
[formatjson|returnidonly]
|
|
gam <UserTypeEntity> update chatsection <ChatSection>
|
|
[displayname <String>]
|
|
[(sortorder <Integer>)|(position start|end)]
|
|
[formatjson]
|
|
gam <UserTypeEntity> delete chatsection <ChatSection>
|
|
gam <UserTypeEntity> show chatsections
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatsections [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> move chatsectionitem <ChatSectionItem> to <ChatSection>
|
|
gam <UserTypeEntity> show chatsectionitems <ChatSection>
|
|
[space <ChatSpace>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatsectionitems <ChatSection> [todrive <ToDriveAttribute>*]
|
|
[space <ChatSpace>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> create chatmember <ChatSpace>
|
|
[type human|bot] [role member|manager|owner]
|
|
(user <UserItem>)* (members <UserTypeEntity>)*
|
|
(group <GroupItem>)* (groups <GroupEntity>)*
|
|
[formatjson|returnidonly]
|
|
gam <UserTypeEntity> delete chatmember <ChatSpace>
|
|
((user <UserItem>)|(members <UserTypeEntity>)|
|
|
(group <GroupItem>)|(groups <GroupEntity>))+
|
|
`gam <UserTypeEntity> remove chatmember members <ChatMemberList>
|
|
gam <UserTypeEntity> update chatmember <ChatSpace>
|
|
role member|manager|owner
|
|
((user <UserItem>)|(members <UserTypeEntity>))+
|
|
gam <UserTypeEntity> modify chatmember
|
|
role member|manager|owner
|
|
members <ChatMemberList>
|
|
gam <UserTypeEntity> sync chatmembers <ChatSpace>
|
|
[role member|manager|owner] [type human|bot]
|
|
[addonly|removeonly]
|
|
[preview [actioncsv]]
|
|
(users <UserTypeEntity>)* (groups <GroupEntity>)*
|
|
|
|
gam <UserItem> create chatmember asadmin <ChatSpace>
|
|
[type human|bot] [role member|manager|owner]
|
|
(user <UserItem>)* (members <UserTypeEntity>)*
|
|
(group <GroupItem>)* (groups <GroupEntity>)*
|
|
[formatjson|returnidonly]
|
|
gam <UserItem> remove chatmember asadmin members <ChatMemberList>
|
|
gam <UserItem> delete chatmember asadmin <ChatSpace>
|
|
((user <UserItem>)|(members <UserTypeEntity>)|
|
|
(group <GroupItem>)|(groups <GroupEntity>))+
|
|
gam <UserItem> update chatmember asadmin <ChatSpace>
|
|
role member|manager|owner
|
|
((user <UserItem>)|(members <UserTypeEntity>))+
|
|
gam <UserItem> modify chatmember asadmin
|
|
role member|manager|owner
|
|
members <ChatMemberList>
|
|
gam <UserItem> sync chatmembers asadmin <ChatSpace>
|
|
[role member|manager|owner`] [type human|bot]
|
|
[addonly|removeonly]
|
|
[preview [actioncsv]]
|
|
(users <UserTypeEntity>)* (groups <GroupEntity>)*
|
|
|
|
<ChatMemberFieldName> ::=
|
|
createtime|
|
|
deletetime|
|
|
groupmember|
|
|
member|
|
|
name|
|
|
role|
|
|
state|
|
|
<ChatMemberFieldNameList> ::= "<ChatMemberFieldName>(,<ChatMemberFieldName>)*"
|
|
|
|
gam <UserTypeEntity> info chatmember
|
|
members <ChatMemberList>
|
|
[fields <ChatMemberFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show chatmembers
|
|
<ChatSpace>* [types <ChatSpaceTypeList>]
|
|
[showinvited [<Boolean>]] [showgroups [<Boolean>]] [filter <String>]
|
|
[fields <ChatMemberFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatmembers [todrive <ToDriveAttribute>*]
|
|
<ChatSpace>* [types <ChatSpaceTypeList>]
|
|
[showinvited [<Boolean>]] [showgroups [<Boolean>]] [filter <String>]
|
|
[fields <ChatMemberFieldNameList>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserItem> info chatmember asadmin
|
|
members <ChatMemberList>
|
|
[fields <ChatMemberFieldNameList>]
|
|
[formatjson]
|
|
gam <UserItem> show chatmembers asadmin
|
|
<ChatSpace>* [query <String>] [querytime<String> <Time>]
|
|
[orderby <ChatSpaceAdminOrderByFieldName> [ascending|descending]]
|
|
[showinvited [<Boolean>]] [showgroups [<Boolean>]] [filter <String>]
|
|
[fields <ChatMemberFieldNameList>]
|
|
[formatjson]
|
|
gam <UserItem> print chatmembers asadmin [todrive <ToDriveAttribute>*]
|
|
<ChatSpace>* [query <String>] [querytime<String> <Time>]
|
|
[orderby <ChatSpaceAdminOrderByFieldName> [ascending|descending]]
|
|
[showinvited [<Boolean>]] [showgroups [<Boolean>]] [filter <String>]
|
|
[fields <ChatMemberFieldNameList>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> create chatmessage <ChatSpace>
|
|
<ChatContent>
|
|
[messageId <ChatMessageID>] [(thread <ChatThread>)|(threadkey <String>)]
|
|
[replyoption fail|fallback]
|
|
[returnidonly]
|
|
gam <UserTypeEntity> update chatmessage name <ChatMessage>
|
|
[<ChatContent>] [clearattachments <String>]
|
|
gam <UserTypeEntity> delete chatmessage name <ChatMessage>
|
|
|
|
<ChatMessageFieldName> ::=
|
|
accessorywidgets|
|
|
actionresponse|
|
|
annotations|
|
|
argumenttext|
|
|
attachedgifs|
|
|
attachment|
|
|
cards|
|
|
cardsv2|
|
|
clientassignedmessageid|
|
|
createtime|
|
|
deletetime|
|
|
deletionmetadata|
|
|
emojireactionsummaries|
|
|
fallbacktext|
|
|
formattedtext|
|
|
lastupdatetime|
|
|
matchedurl|
|
|
name|
|
|
privatemessageviewer|
|
|
quotedmessagemetadata|
|
|
sender|
|
|
slashcommand|
|
|
space|
|
|
text|
|
|
thread|
|
|
threadreply
|
|
<ChatMessageFieldNameList> ::= "<ChatMessageFieldName>(,<ChatMessageFieldName>)*"
|
|
|
|
gam <UserTypeEntity> info chatmessage name <ChatMessage>
|
|
[fields <ChatMessageFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show chatmessages
|
|
<ChatSpace>+
|
|
[showdeleted [<Boolean>]] [filter <String>]
|
|
[fields <ChatMessageFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatmessages [todrive <ToDriveAttribute>*]
|
|
<ChatSpace>+
|
|
[showdeleted [<Boolean>]] [filter <String>]
|
|
[fields <ChatMessageFieldNameList>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> info chatevent name <ChatEvent>
|
|
[formatjson]
|
|
gam <UserTypeEntity> show chatevents
|
|
<ChatSpace>+
|
|
filter <String>
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatevents [todrive <ToDriveAttribute>*]
|
|
<ChatSpace>+
|
|
filter <String>
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<ChatEmojiName> ::= :[0-9a-z_-]+:
|
|
<ChatEmoji> ::= emojiname <ChatEmojiName> | customemojis/<String>
|
|
|
|
gam <UserTypeEntity> create chatemoji <ChatEmojiName>
|
|
([drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>])
|
|
[formatjson]
|
|
gam <UserTypeEntity> delete chatemoji <ChatEmoji>
|
|
gam <UserTypeEntity> info chatemoji <ChatEmoji>
|
|
[formatjson]
|
|
gam <UserTypeEntity> show chatemojis
|
|
[showcreatedby any|me|others]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print chatemojis [todrive <ToDriveAttribute>*]
|
|
[showcreatedby any|me|others]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Users - Drive
|
|
|
|
<DriveFileOrderByFieldName> ::=
|
|
createddate|createdtime|
|
|
folder|
|
|
lastviewedbyme|lastviewedbymedate|lastviewedbymetime|lastviewedbyuser|
|
|
modifiedbyme|modifiedbymedate|modifiedbymetime|modifiedbyuser|
|
|
modifieddate|modifiedtime|
|
|
name|
|
|
name_natural|
|
|
quotabytesused|quotaused|
|
|
recency|
|
|
sharedwithmedate|sharedwithmetime|
|
|
starred|
|
|
title|
|
|
title_natural|
|
|
viewedbymedate|viewedbymetime
|
|
|
|
<DriveFileIDEntity> ::=
|
|
<DriveFileItem> |
|
|
(id <DriveFileItem>) | (id:<DriveFileItem>) |
|
|
(ids <DriveFileList>) | (ids:<DriveFileList>)
|
|
<DriveFileNameEntity> ::=
|
|
(anyname <DriveFileName>) | (anyname:<DriveFileName>) |
|
|
(anydrivefilename <DriveFileName>) | (anydrivefilename:<DriveFileName>) |
|
|
(name <DriveFileName>) | (name:<DriveFileName>) |
|
|
(drivefilename <DriveFileName>) | (drivefilename:<DriveFileName>) |
|
|
(othername <DriveFileName>) | (othername:<DriveFileName>) |
|
|
(otherdrivefilename <DriveFileName>) | (otherdrivefilename:<DriveFileName>)
|
|
<DriveFileQueryEntity> ::=
|
|
(query <QueryDriveFile>) | (query:<QueryDriveFile>) |
|
|
(fullquery <QueryDriveFile>)
|
|
<DriveFileEntity> ::=
|
|
<DriveFileIDEntity> |
|
|
<DriveFileNameEntity> |
|
|
<DriveFileQueryEntity> |
|
|
<DriveFileQueryShortcut> |
|
|
mydrive | mydriveid |
|
|
root | rootid |
|
|
<SharedDriveIDEntity> [<SharedDriveFileQueryShortcut>] |
|
|
<SharedDriveNameEntity> [<SharedDriveFileQueryShortcut>] |
|
|
<SharedDriveFileNameEntity> |
|
|
<SharedDriveFileQueryEntity> |
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
|
|
|
<DriveFileAttribute> ::=
|
|
(contentrestrictions (readonly false)|(readonly true [reason <String>]) [ownerrestricted [<Boolean>]])|
|
|
(copyrequireswriterpermission [<Boolean>])|
|
|
(description <String>)|
|
|
(folderColorRgb <ColorValue>)|
|
|
(indexabletext <String>)|
|
|
(inheritedpermissionsdisabled [<Boolean>])|
|
|
(itemdownloadrestriction restrictedforreaders|restrictedforwriters [<Boolean>])|
|
|
(keeprevisionforever|pinned)|
|
|
(lastviewedbyme <Time>)|
|
|
(mimetype <MimeType>)|
|
|
(ocrlanguage <Language>)|
|
|
(preservefiletimes [<Boolean>])|
|
|
(privateproperty <PropertyKey> <PropertyValue>)|
|
|
(publicproperty <PropertyKey> <PropertyValue>)|
|
|
(property <PropertyKey> <PropertyValue> [private|public])|
|
|
(restricted|restrict [<Boolean>])|
|
|
(securityupdate [<Boolean>])|
|
|
(shortcut <DriveFileID>)|
|
|
(starred|star [<Boolean>])|
|
|
(trashed|trash [<Boolean>])|
|
|
(viewed|view [<Boolean>])|
|
|
(viewerscancopycontent [<Boolean>])|
|
|
(writerscanshare|writerscantshare [<Boolean>])
|
|
|
|
<DriveFileParentAttribute> ::=
|
|
(parentid <DriveFolderID>)|
|
|
(parentname <DriveFolderName>)|
|
|
(anyownerparentname <DriveFolderName>)|
|
|
(teamdriveparentid <DriveFolderID>)|
|
|
(teamdriveparent <SharedDriveName>)|
|
|
(teamdriveparentid <SharedDriveID> teamdriveparentname <DriveFolderName>)|
|
|
(teamdriveparent <SharedDriveName> teamdriveparentname <DriveFolderName>)
|
|
|
|
<DriveFileCreateAttribute> ::=
|
|
<DriveFileAttribute>|
|
|
<DriveFileParentAttribute>|
|
|
(createddate|createdtime <Time>)|
|
|
(modifieddate|modifiedtime <Time>)|
|
|
ignoredefaultvisibility|
|
|
usecontentasindexabletext
|
|
|
|
gam <UserTypeEntity> create|add drivefile
|
|
[(localfile <FileName>|-)|(url <URL>)]
|
|
[(drivefilename|newfilename <DriveFileName>) | (replacefilename <REMatchPattern> <RESubstitution>)*]
|
|
[stripnameprefix <String>] [noduplicate]
|
|
[timestamp [<Boolean>]] [timeformat <DateTimeFormat>]
|
|
<DriveFileCreateAttribute>*
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> currenttime|<String>)*) |
|
|
(returnidonly|returnlinkonly|returneditlinkonly|showdetails)]
|
|
|
|
<DriveFileUpdateAttribute> ::=
|
|
<DriveFileAttribute>|
|
|
<DriveFileParentAttribute>|
|
|
(modifieddate|modifiedtime <Time>)|
|
|
usecontentasindexabletext|
|
|
((addparents <DriveFolderIDList>)|
|
|
(addparentname <DriveFolderName>)|
|
|
(addanyownerparentname <DriveFolderName>))|
|
|
((removeparents <DriveFolderIDList>)|
|
|
(removeparentname <DriveFolderName>)|
|
|
(removeanyownerparentname <DriveFolderName>))
|
|
|
|
gam <UserTypeEntity> update drivefile <DriveFileEntity> [copy] [returnidonly|returnlinkonly]
|
|
[(localfile <FileName>|-)|(url <URL>)]
|
|
[retainname | (newfilename <DriveFileName>) | (replacefilename <REMatchPattern> <RESubstitution>)*]
|
|
[stripnameprefix <String>]
|
|
[timestamp [<Boolean>]] [timeformat <DateTimeFormat>]
|
|
<DriveFileUpdateAttribute>*
|
|
[(gsheet|csvsheet <SheetEntity> [clearfilter])|(addsheet <String>)]
|
|
[charset <Charset>] [columndelimiter <Character>]
|
|
|
|
<DriveFileCopyAttribute> ::=
|
|
(contentrestrictions (readonly false)|(readonly true [reason <String>]) [ownerrestricted [<Boolean>]])|
|
|
(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>])
|
|
|
|
gam <UserTypeEntity> copy drivefile <DriveFileEntity>
|
|
[newfilename <DriveFileName>] (replacefilename <REMatchPattern> <RESubstitution>)*
|
|
[stripnameprefix <String>]
|
|
[excludetrashed]
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) |
|
|
(returnidonly|returnlinkonly)]
|
|
[summary [<Boolean>]] [showpermissionmessages [<Boolean>]]
|
|
[<DriveFileParentAttribute>]
|
|
[mergewithparent [<Boolean>]] [recursive [depth <Number>]]
|
|
<DriveFileCopyAttribute>*
|
|
[skipids <DriveFileEntity>]
|
|
[copysubfiles [<Boolean>]] [filenamematchpattern <REMatchPattern>]
|
|
[filemimetype [not] <MimeTypeList>] [filemimetype category <MimeTypeNameList>]
|
|
[([start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>])|(range <Date>|<Time> <Date>|<Time>)]|
|
|
[copysubfilesownedby
|
|
any|me|others|
|
|
users <EmailAddressList>|
|
|
notusers <EmailAddressList>|
|
|
regex <REMatchPattern>|
|
|
notregex <REMatchPattern>]
|
|
[copysubfolders [<Boolean>]] [foldernamematchpattern <REMatchPattern>]
|
|
[copysubshortcuts [<Boolean>]] [shortcutnamematchpattern <REMatchPattern>]
|
|
[duplicatefiles overwriteolder|overwriteall|duplicatename|uniquename|skip]
|
|
[duplicatefolders merge|duplicatename|uniquename|skip]
|
|
[copiedshortcutspointtocopiedfiles [<Boolean>]]
|
|
[copyfilepermissions [<Boolean>]]
|
|
[copyfileinheritedpermissions [<Boolean>]
|
|
[copyfilenoninheritedpermissions [<Boolean>]
|
|
[copyfolderpermissions [<Boolean>]]
|
|
[copymergewithparentfolderpermissions [<Boolean>]]
|
|
[copymergedtopfolderpermissions [<Boolean>]]
|
|
[copytopfolderpermissions [<Boolean>]]
|
|
[copytopfolderiheritedpermissions [<Boolean>]]
|
|
[copytopfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders]
|
|
[copymergedsubfolderpermissions [<Boolean>]]
|
|
[copysubfolderpermissions [<Boolean>]]
|
|
[copysubfolderinheritedpermissions [<Boolean>]]
|
|
[copysubfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders]
|
|
[copypermissionroles <DriveFileACLRoleList>]
|
|
[copypermissiontypes <DriveFileACLTypeList>]
|
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
|
(mappermissionsemail <EmailAddress> <EmailAddress>)* [mappermissionsemailfile <CSVFileInput> endcsv]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
[copysheetprotectedranges [<Boolean>]]
|
|
[copysheetprotectedrangesinheritedpermissions [<Boolean>]]
|
|
[copysheetprotectedrangesnoninheritedpermissions [<Boolean>]]
|
|
[sendemailifrequired [<Boolean>]]
|
|
[suppressnotselectedmessages [<Boolean>]]
|
|
[verifyorganizer [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> move drivefile <DriveFileEntity> [newfilename <DriveFileName>]
|
|
[summary [<Boolean>]] [showpermissionmessages [<Boolean>]]
|
|
[<DriveFileParentAttribute>]
|
|
[mergewithparent|mergewithparentretain [<Boolean>]]
|
|
[createshortcutsfornonmovablefiles [<Boolean>]]
|
|
[duplicatefiles overwriteolder|overwriteall|duplicatename|uniquename|skip]
|
|
[duplicatefolders merge|duplicatename|uniquename|skip]
|
|
[copyfolderpermissions [<Boolean>]]
|
|
[copymergewithparentfolderpermissions [<Boolean>]]
|
|
[copymergedtopfolderpermissions [<Boolean>]]
|
|
[copytopfolderpermissions [<Boolean>]]
|
|
[copytopfolderiheritedpermissions [<Boolean>]]
|
|
[copytopfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders]
|
|
[copymergedsubfolderpermissions [<Boolean>]]
|
|
[copysubfolderpermissions [<Boolean>]]
|
|
[copysubfolderinheritedpermissions [<Boolean>]]
|
|
[copysubfoldernoniheritedpermissions never|always|syncallfolders|syncupdatedfolders]
|
|
[excludepermissionsfromdomains|includepermissionsfromdomains <DomainNameList>]
|
|
(mappermissionsemail <EmailAddress> <EmailAddress>)* [mappermissionsemailfile <CSVFileInput> endcsv]
|
|
(mappermissionsdomain <DomainName> <DomainName>)*
|
|
[retainsourcefolders [<Boolean>]]
|
|
[sendemailifrequired [<Boolean>]]
|
|
[verifyorganizer [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> get document <DriveFileEntity>
|
|
[viewmode default|suggestions_inline|preview_suggestions_accepted|preview_without_suggestions]
|
|
[targetfolder <FilePath>] [targetname <FileName>]
|
|
[donotfollowshortcuts [<Boolean>]] [overwrite [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> update docuument <DriveFileEntity>
|
|
((json [charset <Charset>] <SpreadsheetJSONUpdateRequest>) |
|
|
(json file <FileName> [charset <Charset>]))
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> get drivefile <DriveFileEntity> [revision <DriveFileRevisionID>]
|
|
[(format <FileFormatList>)|(gsheet|csvsheet <SheetEntity>)] [exportsheetaspdf <String>]
|
|
[targetfolder <FilePath>] [targetname <FileName>|-]
|
|
[donotfollowshortcuts [<Boolean>]] [overwrite [<Boolean>]] [showprogress [<Boolean>]]
|
|
[acknowledgeabuse [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> delete drivefile <DriveFileEntity> [purge|untrash|trash] [shortcutandtarget [<Boolean>]]
|
|
gam <UserTypeEntity> purge drivefile <DriveFileEntity> [shortcutandtarget [<Boolean>]]
|
|
gam <UserTypeEntity> trash drivefile <DriveFileEntity> [shortcutandtarget [<Boolean>]]
|
|
gam <UserTypeEntity> untrash drivefile <DriveFileEntity> [shortcutandtarget [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> info drivefile <DriveFileEntity>
|
|
[returnidonly]
|
|
[filepath|fullpath] [folderpathonly|parentpathonly [<Boolean>]] [pathdelimiter <Character>]
|
|
[allfields|<DriveFieldName>*|(fields <DriveFieldNameList>)]
|
|
[includepermissionsforview published]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[showdrivename] [showshareddrivepermissions]
|
|
[(showlabels details|ids)|(includelabels <ClassificationLabelIDList>)]
|
|
[showparentsidsaslist] [followshortcuts [<Boolean>]]
|
|
[stripcrsfromname]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> create|add drivefolderpath
|
|
[pathdelimiter <Character>]
|
|
((fullpath <DriveFolderPath>) |
|
|
(path <DriveFolderPath> [<DriveFileParentAttribute>]) |
|
|
(list <DriveFolderNameList> [<DriveFileParentAttribute>]))
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) |
|
|
returnidonly]
|
|
|
|
gam <UserTypeEntity> create|add drivefileshortcut <DriveFileEntity> [shortcutname <String>]
|
|
[<DriveFileParentAttribute>|convertparents]
|
|
[(csv [todrive <ToDriveAttribute>*]) | returnidonly]
|
|
|
|
gam <UserTypeEntity> check drivefileshortcut <DriveFileEntity>
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
|
|
<DriveFileACLRole> ::=
|
|
commenter|
|
|
contentmanager|fileorganizer|
|
|
contributor|editor|writer|
|
|
manager|organizer|owner|
|
|
reader|viewer
|
|
<DriveFilePermission> ::=
|
|
anyone;<DriveFileACLRole>|
|
|
anyonewithlink;<DriveFileACLRole>|
|
|
domain:<DomainName>;<DriveFileACLRole>|
|
|
domainwithlink:<DomainName>;<DriveFileACLRole>|
|
|
group:<EmailAddress>;<DriveFileACLRole>|
|
|
user:<EmailAddress>;<DriveFileACLRole>
|
|
<DriveFilePermissionID> ::= anyone|anyonewithlink|id:<String>
|
|
<DriveFilePermissionIDorEmail> ::= <DriveFilePermissionID>|<EmailAddress>
|
|
<DriveFilePermissionList> ::= "<DriveFilePermission>(,<DriveFilePermission>)*"
|
|
<DriveFilePermissionIDList> ::= "<DriveFilePermissionID>(,<DriveFilePermissionID>)*"
|
|
|
|
<DriveFilePermissionEntity> ::=
|
|
<DriveFilePermissionList> |
|
|
<JSONData>|
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVSubkeySelector> | <CSVDataSelector>)
|
|
<DriveFilePermissionIDEntity> ::=
|
|
<DriveFilePermissionIDList> |
|
|
<JSONData>|
|
|
<FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
<DrivePermissionsFieldName> ::=
|
|
additionalroles|
|
|
allowfilediscovery|
|
|
basicpermissions|
|
|
deleted|
|
|
displayname|
|
|
domain|
|
|
emailaddress|
|
|
expirationdate|
|
|
expirationtime|
|
|
id|
|
|
name|
|
|
pendingowner|
|
|
permissiondetails|
|
|
photolink|
|
|
role|
|
|
type|
|
|
view|
|
|
withlink
|
|
<DrivePermissionsFieldNameList> ::= "<DrivePermissionsFieldName>(,<DrivePermissionsFieldName>)*"
|
|
|
|
gam <UserTypeEntity> create|add drivefileacl <DriveFileEntity> [adminaccess|asadmin]
|
|
anyone|(user <UserItem>)|(group <GroupItem>)|(domain <DomainName>) (role <DriveFileACLRole>)
|
|
[withlink|(allowfilediscovery|discoverable [<Boolean>])] [expiration <Time>]
|
|
[moveToNewOwnersRoot [<Boolean>]]
|
|
[sendemail|sendnotification] [emailmessage <String>]
|
|
[updatesheetprotectedranges [<Boolean>]]
|
|
[showtitles] [nodetails|(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]])]
|
|
gam <UserTypeEntity> update drivefileacl <DriveFileEntity> <DriveFilePermissionIDorEmail>
|
|
(role <DriveFileACLRole>) [expires|expiration <Time>] [removeexpiration [<Boolean>]]
|
|
[updatesheetprotectedranges [<Boolean>]]
|
|
[showtitles] [nodetails|(csv [todrive <ToDriveAttribute>*] [formatjson [quotechar <Character>]])]
|
|
gam <UserTypeEntity> delete drivefileacl <DriveFileEntity> <DriveFilePermissionIDorEmail>
|
|
[updatesheetprotectedranges [<Boolean>]]
|
|
[showtitles]
|
|
gam <UserTypeEntity> info drivefileacl <DriveFileEntity> <DriveFilePermissionIDorEmail>
|
|
[showtitles]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show drivefileacls <DriveFileEntity>
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[includepermissionsforview published]
|
|
[showtitles] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[formatjson]
|
|
gam <UserTypeEntity> print drivefileacls <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
<PermissionMatch>* [<PermissionMatchAction>] [pmselect]
|
|
[includepermissionsforview published]
|
|
[oneitemperrow] [showtitles] [<DrivePermissionsFieldName>*|(fields <DrivePermissionsFieldNameList>)]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> create|add permissions <DriveFileEntity> <DriveFilePermissionEntity>
|
|
[expires|expiration <Time>] [sendemail|sendnotification] [emailmessage <String>]
|
|
[movetonewownersroot [<Boolean>]]
|
|
<PermissionMatch>* [<PermissionMatchAction>]
|
|
gam <UserTypeEntity> delete permissions <DriveFileEntity> <DriveFilePermissionIDEntity>
|
|
<PermissionMatch>* [<PermissionMatchAction>]
|
|
|
|
gam <UserTypeEntity> process filedrivelabels <DriveFileEntity>
|
|
(addlabel <ClassificationLabelIDList>)*
|
|
(deletelabel <ClassificationLabelIDList>)*
|
|
(addlabelfield <ClassificationLabelID> <ClassificationLabelFieldID>
|
|
(text <String>)|selection <ClassificationLabelSelectionIDList>)|
|
|
(integer <Number>)|(date <Date>)|(user <EmailAddressList>))*
|
|
(deletelabelfield <ClassificationLabelID> <ClassificationLabelFieldID>)*
|
|
[nodetails]
|
|
|
|
gam show ownership <DriveFileID>|(drivefilename <DriveFileName>)
|
|
[formatjson]
|
|
gam print ownership <DriveFileID>|(drivefilename <DriveFileName>) [todrive <ToDriveAttribute>*]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<CommentsAuthorSubfieldName> ::=
|
|
author.displayname|
|
|
author.emailaddress|
|
|
author.me|
|
|
author.permissionid|
|
|
author.photolink
|
|
|
|
<CommentsRepliesSubfieldName> ::=
|
|
reply.action|
|
|
reply.author|
|
|
reply.author.<CommentsAuthorSubfieldName>|
|
|
reply.content|
|
|
reply.createddate|createdtime|
|
|
reply.deleted|
|
|
reply.htmlcontent|
|
|
reply.id|
|
|
reply.modifieddate|modifiedtime
|
|
|
|
<CommentsFieldName> ::=
|
|
action|
|
|
author|
|
|
content|
|
|
<CommentsAuthorSubfieldName>|
|
|
<CommentsRepliesSubfieldName>|
|
|
createddate|createdtime|
|
|
deleted|
|
|
htmlcontent|
|
|
id|
|
|
modifieddate|modifiedtime|
|
|
quotedfilecontent|
|
|
reply|replies|
|
|
resolved
|
|
<CommentsFieldNameList> ::= "<CommentsFieldName>(,<CommentsFieldName>)*"
|
|
|
|
gam <UserTypeEntity> show filecomments <DriveFileEntity>
|
|
[showdeleted] [start <Date>|<Time>]
|
|
[fields <CommentsFieldNameList>] [showphotolinks]
|
|
[countsonly|positivecountsonly]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print filecomments <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
[showdeleted] [start <Date>|<Time>]
|
|
[fields <CommentsFieldNameList>] [showphotolinks]
|
|
[countsonly|positivecountsonly]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<RevisionsFieldName> ::=
|
|
filesize|
|
|
id|
|
|
keepforever|
|
|
lastmodifyinguser|
|
|
lastmodifyingusername|
|
|
md5checksum|
|
|
mimetype|
|
|
modifieddate|
|
|
modifiedtime|
|
|
originalfilename|
|
|
pinned|
|
|
publishauto|
|
|
published|
|
|
publishedoutsidedomain|
|
|
size
|
|
<RevisionsFieldNameList> ::= "<RevisionsFieldName>(,<RevisionsFieldName>)*"
|
|
|
|
gam <UserTypeEntity> delete filerevisions <DriveFileEntity> select <DriveFileRevisionIDEntity>
|
|
[previewdelete] [showtitles] [doit] [max_to_delete <Number>]
|
|
gam <UserTypeEntity> update filerevisions <DriveFileEntity> select <DriveFileRevisionIDEntity>
|
|
[published [<Boolean>]] [publishauto [<Boolean>]] [publishedoutsidedomain [<Boolean>]]
|
|
[previewupdate] [showtitles] [doit] [max_to_update <Number>]
|
|
|
|
gam <UserTypeEntity> show filerevisions <DriveFileEntity>
|
|
[select <DriveFileRevisionIDEntity>]
|
|
[previewdelete] [showtitles]
|
|
[<RevisionsFieldName>*|(fields <RevisionsFieldNameList>)]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[stripcrsfromname]
|
|
gam <UserTypeEntity> print filerevisions <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
[select <DriveFileRevisionIDEntity>]
|
|
[previewdelete] [showtitles] [oneitemperrow]
|
|
[<RevisionsFieldName>*|(fields <RevisionsFieldNameList>)]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[stripcrsfromname]
|
|
|
|
gam <UserTypeEntity> transfer ownership <DriveFileEntity> <UserItem>
|
|
[<DriveFileParentAttribute>] [includetrashed] [norecursion [<Boolean>]]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[preview] [filepath] [pathdelimiter <Character>] [buildtree]
|
|
[todrive <ToDriveAttribute>*]
|
|
gam <UserTypeEntity> claim ownership <DriveFileEntity>
|
|
[<DriveFileParentAttribute>] [includetrashed]
|
|
[skipids <DriveFileEntity>] [onlyusers|skipusers <UserTypeEntity>] [subdomains <DomainNameEntity>]
|
|
[restricted [<Boolean>]] [writerscanshare|writerscantshare [<Boolean>]]
|
|
[keepuser | (retainrole commenter|reader|writer|editor|fileorganizer|none)] [noretentionmessages]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[preview] [filepath] [pathdelimiter <Character>] [buildtree]
|
|
[todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> transfer drive <UserItem> [select <DriveFileEntity>]
|
|
[(targetfolderid <DriveFolderID>)|(targetfoldername <DriveFolderName>)]
|
|
[targetuserfoldername <DriveFolderName>] [targetuserorphansfoldername <DriveFolderName>]
|
|
[mergewithtarget [<Boolean>]]
|
|
[skipids <DriveFileEntity>]
|
|
[keepuser | (retainrole reader|commenter|writer|editor|fileorganizer|none)] [noretentionmessages]
|
|
[nonowner_retainrole reader|commenter|writer|editor|fileorganizer|current|none]
|
|
[nonowner_targetrole reader|commenter|writer|editor|fileorganizer|current|none|source]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[preview] [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> collect orphans
|
|
[(targetuserfoldername <DriveFolderName>)|(targetuserfolderid <DriveFolderID>)]
|
|
[useshortcuts [<Boolean>]]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[preview [todrive <ToDriveAttribute>*]]
|
|
|
|
<DriveCapabilitiesSubfieldName> ::=
|
|
capabilities.canacceptownership|
|
|
capabilities.canaddchildren|
|
|
capabilities.canaddfolderfromanotherdrive|
|
|
capabilities.canaddmydriveparent|
|
|
capabilities.canchangecopyrequireswriterpermission|
|
|
capabilities.canchangecopyrequireswriterpermissionrestriction|
|
|
capabilities.canchangedomainusersonlyrestriction|
|
|
capabilities.canchangedownloadrestriction|
|
|
capabilities.canchangedrivebackground|
|
|
capabilities.canchangedrivemembersonlyrestriction|
|
|
capabilities.canchangesecurityupdateenabled|
|
|
capabilities.canchangesharingfoldersrequiresorganizerpermissionrestriction|
|
|
capabilities.canchangeviewerscancopycontent|
|
|
capabilities.cancomment|
|
|
capabilities.cancopy|
|
|
capabilities.candelete|
|
|
capabilities.candeletechildren|
|
|
capabilities.candeletedrive|
|
|
capabilities.candisableinheritedpermissions|
|
|
capabilities.candownload|
|
|
capabilities.canedit|
|
|
capabilities.canenableinheritedpermissions|
|
|
capabilities.canlistchildren|
|
|
capabilities.canmanagemembers|
|
|
capabilities.canmodifycontent|
|
|
capabilities.canmodifycontentrestriction|
|
|
capabilities.canmodifyeditorcontentrestriction|
|
|
capabilities.canmodifylabels|
|
|
capabilities.canmodifyownercontentrestriction|
|
|
capabilities.canmovechildrenoutofdrive|
|
|
capabilities.canmovechildrenoutofteamdrive|
|
|
capabilities.canmovechildrenwithindrive|
|
|
capabilities.canmovechildrenwithinteamdrive|
|
|
capabilities.canmoveitemintodrive|
|
|
capabilities.canmoveitemintoteamdrive|
|
|
capabilities.canmoveitemoutofdrive|
|
|
capabilities.canmoveitemoutofteamdrive|
|
|
capabilities.canmoveitemwithindrive|
|
|
capabilities.canmoveitemwithinteamdrive|
|
|
capabilities.canmoveteamdriveitem|
|
|
capabilities.canreaddrive|
|
|
capabilities.canreadlabels|
|
|
capabilities.canreadrevisions|
|
|
capabilities.canreadteamdrive|
|
|
capabilities.canremovechildren|
|
|
capabilities.canremovecontentrestriction|
|
|
capabilities.canremovemydriveparent|
|
|
capabilities.canrename|
|
|
capabilities.canrenamedrive|
|
|
capabilities.canresetdriverestrictions|
|
|
capabilities.canshare|
|
|
capabilities.cantrash|
|
|
capabilities.cantrashchildren|
|
|
capabilities.canuntrash
|
|
|
|
<DriveContentRestrictionsSubfieldName> ::=
|
|
contentrestrictions.ownerrestricted|
|
|
contentrestrictions.readonly|
|
|
contentrestrictions.reason|
|
|
contentrestrictions.restrictinguser|
|
|
contentrestrictions.restrictiontime|
|
|
contentrestrictions.type
|
|
|
|
<DriveDownloadRestrictionsSubfieldName> ::=
|
|
downloadrestrictions.itemdownloadrestriction|
|
|
downloadrestrictions.effectivedownloadrestrictionwithcontext
|
|
|
|
<ClassificationLabelInfoSubfieldName> ::=
|
|
labels.id| # modifiedByMe
|
|
labels.revisionid| # copyRequiresWriterPermission
|
|
labels.fields # viewedByMe
|
|
|
|
<ClassificationLabelsSubfieldName> ::=
|
|
labels.modified| # modifiedByMe
|
|
labels.restricted| # copyRequiresWriterPermission
|
|
labels.starred| # starred
|
|
labels.trashed| # trashed
|
|
labels.viewed # viewedByMe
|
|
|
|
<DriveOwnersSubfieldName> ::=
|
|
owners.displayname|
|
|
owners.emailaddress|
|
|
owners.isauthenticateduser|
|
|
owners.me|
|
|
owners.permissionid|
|
|
owners.photolink|
|
|
owners.picture
|
|
|
|
<DriveParentsSubfieldName> ::=
|
|
parents.id|
|
|
parents.isroot
|
|
|
|
<DrivePermissionsSubfieldName> ::=
|
|
permissions.additionalroles|
|
|
permissions.allowfilediscovery|
|
|
permissions.deleted|
|
|
permissions.permissiondetails|
|
|
permissions.displayname|
|
|
permissions.domain|
|
|
permissions.emailaddress|
|
|
permissions.expirationdate|
|
|
permissions.expirationtime|
|
|
permissions.id|
|
|
permissions.name|
|
|
permissions.photolink|
|
|
permissions.role|
|
|
permissions.type|
|
|
permissions.withlink
|
|
|
|
<DriveLastModifyingUserSubfieldName> ::=
|
|
lastmodifyinguser.displayname|
|
|
lastmodifyinguser.emailaddress|
|
|
lastmodifyinguser.isauthenticateduser|
|
|
lastmodifyinguser.me|
|
|
lastmodifyinguser.name|
|
|
lastmodifyinguser.permissionid|
|
|
lastmodifyinguser.photolink|
|
|
lastmodifyinguser.picture
|
|
|
|
<DriveSharingUserSubfieldName> ::=
|
|
sharinguser.displayname|
|
|
sharinguser.emailaddress|
|
|
sharinguser.isauthenticateduser|
|
|
sharinguser.me|
|
|
sharinguser.name|
|
|
sharinguser.permissionid|
|
|
sharinguser.photolink|
|
|
sharinguser.picture
|
|
|
|
<DriveTrashingUserSubfieldName> ::=
|
|
trashinguser.displayname|
|
|
trashinguser.emailaddress|
|
|
trashinguser.isauthenticateduser|
|
|
trashinguser.me|
|
|
trashinguser.name|
|
|
trashinguser.permissionid|
|
|
trashinguser.photolink|
|
|
trashinguser.picture
|
|
|
|
<DriveShortcutDetailsSubfieldName> ::=
|
|
shortcutdetails.targetid|
|
|
shortcutdetails.targetmimetype
|
|
shortcutdetails.resourcekey
|
|
|
|
<DriveFieldName> ::=
|
|
alternatelink|
|
|
appdatacontents|
|
|
appproperties|
|
|
basicpermissions|
|
|
cancomment|
|
|
canreadrevisions|
|
|
capabilities|
|
|
<DriveCapabilitiesSubfieldName>|
|
|
contenthints|
|
|
contentrestrictions|
|
|
<DriveContentRestrictionsSubfieldName>|
|
|
copyable|
|
|
copyrequireswriterpermission|
|
|
createddate|createdtime|
|
|
description|
|
|
downloadrestictions|
|
|
<DriveDownloadRestrictionsSubfieldName>|
|
|
driveid|
|
|
drivename|
|
|
editable|
|
|
explicitlytrashed|
|
|
exportlinks|
|
|
fileextension|
|
|
filesize|
|
|
foldercolorrgb|
|
|
fullfileextension|
|
|
hasaugmentedpermissions|
|
|
hasthumbnail|
|
|
headrevisionid|
|
|
iconlink|
|
|
id|
|
|
imagemediametadata|
|
|
inheritedpermissionsdisabled|
|
|
isappauthorized|
|
|
labelinfo|
|
|
<ClassificationLabelInfoSubfieldName>|
|
|
labels|
|
|
<ClassificationLabelsSubfieldName>|
|
|
lastmodifyinguser|
|
|
<DriveLastModifyingUserSubfieldName>|
|
|
lastmodifyingusername|
|
|
lastviewedbyme|lastviewedbymedate|lastviewedbymetime|lastviewedbyuser|
|
|
linksharemetadata|
|
|
md5|md5checksum|md5sum|
|
|
mime|mimetype|
|
|
modifiedbyme|modifiedbymedate|modifiedbymetime|modifiedbyuser|
|
|
modifieddate|modifiedtime|
|
|
name|
|
|
originalfilename|
|
|
ownedbyme|
|
|
ownernames|
|
|
owners|
|
|
<DriveOwnersSubfieldName>|
|
|
parents|
|
|
<DriveParentsSubfieldName>|
|
|
permissionids|
|
|
permissiondetails|
|
|
permissions|
|
|
<DrivePermissionsSubfieldName>|
|
|
properties|
|
|
quotabytesused|quotaused|
|
|
resourcekey|
|
|
restricted|
|
|
shareable|
|
|
shared|
|
|
sharedwithmedate|sharedwithmetime|
|
|
sharinguser|
|
|
<DriveSharingUserSubfieldName>|
|
|
shortcutdetails|
|
|
<DriveShortcutDetailsSubfieldName>|
|
|
sha1checksum|
|
|
sha256checksum|
|
|
size|
|
|
spaces|
|
|
starred|
|
|
teamdriveid|
|
|
teamdrivename|
|
|
thumbnaillink|
|
|
thumbnailversion|
|
|
title|
|
|
trashed|
|
|
trasheddate|trashedtime|
|
|
trashinguser|
|
|
<DriveTrashingUserSubfieldName>|
|
|
userpermission|
|
|
version|
|
|
videomediametadata|
|
|
viewed|
|
|
viewedbymedate|viewedbymetime|
|
|
viewerscancopycontent|
|
|
webcontentlink|
|
|
webviewlink|
|
|
writerscanshare
|
|
<DriveFieldNameList> ::= "<DriveFieldName>(,<DriveFieldName>)*"
|
|
|
|
gam <UserTypeEntity> show fileinfo <DriveFileEntity>
|
|
[returnidonly]
|
|
[filepath|fullpath] [folderpathonly|parentpathonly [<Boolean>]] [pathdelimiter <Character>]
|
|
[allfields|<DriveFieldName>*|(fields <DriveFieldNameList>)]
|
|
[includepermissionsforview published]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[showdrivename] [showshareddrivepermissions]
|
|
[(showlabels details|ids)|(includelabels <ClassificationLabelIDList>)]
|
|
[showparentsidsaslist] [followshortcuts [<Boolean>]]
|
|
[stripcrsfromname]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> show filepath <DriveFileEntity>
|
|
[returnpathonly]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[stripcrsfromname]
|
|
[fullpath] [folderpathonly|parentpathonly [<Boolean>]] [pathdelimiter <Character>]
|
|
[followshortcuts [<Boolean>]]
|
|
gam <UserTypeEntity> print filepath <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])*
|
|
[stripcrsfromname] [oneitemperrow]
|
|
[fullpath] [folderpathonly|parentpathonly [<Boolean>]] [pathdelimiter <Character>]
|
|
[followshortcuts [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> print filecounts [todrive <ToDriveAttribute>*]
|
|
[((query <QueryDriveFile>) | (fullquery <QueryDriveFile>) | <DriveFileQueryShortcut>)
|
|
(querytime<String> <Time>)*]
|
|
[continueoninvalidquery [<Boolean>]]
|
|
[corpora <CorporaAttribute>]
|
|
[select <SharedDriveEntity>]
|
|
[anyowner|(showownedby any|me|others)]
|
|
[showmimetype [not] <MimeTypeList>] [showmimetype category <MimeTypeNameList>]
|
|
[sizefield quotabytesused|size] [minimumfilesize <Integer>] [maximumfilesize <Integer>]
|
|
[filenamematchpattern <REMatchPattern>]
|
|
<PermissionMatch>* [<PermissionMatchMode>] [<PermissionMatchAction>]
|
|
[excludetrashed]
|
|
[showsize] [showsizeunits] [showmimetypesize]
|
|
[showlastmodification] [pathdelimiter <Character>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[summary none|only|plus] [summaryuser <String>]
|
|
gam <UserTypeEntity> show filecounts
|
|
[((query <QueryDriveFile>) | (fullquery <QueryDriveFile>) | <DriveFileQueryShortcut>)
|
|
(querytime<String> <Time>)*]
|
|
[continueoninvalidquery [<Boolean>]]
|
|
[corpora <CorporaAttribute>]
|
|
[select <SharedDriveEntity>]
|
|
[anyowner|(showownedby any|me|others)]
|
|
[showmimetype [not] <MimeTypeList>] [showmimetype category <MimeTypeNameList>]
|
|
[sizefield quotabytesused|size] [minimumfilesize <Integer>] [maximumfilesize <Integer>]
|
|
[filenamematchpattern <REMatchPattern>]
|
|
<PermissionMatch>* [<PermissionMatchMode>] [<PermissionMatchAction>]
|
|
[excludetrashed]
|
|
[showsize] [showsizeunits] [showmimetypesize]
|
|
[showlastmodification] [pathdelimiter <Character>]
|
|
[summary none|only|plus] [summaryuser <String>]
|
|
|
|
gam <UserTypeEntity> print filesharecounts [todrive <ToDriveAttribute>*]
|
|
[excludetrashed]
|
|
[internaldomains all|primary|<DomainNameList>]
|
|
[summary none|only|plus] [summaryuser <String>]
|
|
gam <UserTypeEntity> show filesharecounts
|
|
[excludetrashed]
|
|
[internaldomains all|primary|<DomainNameList>]
|
|
[summary none|only|plus] [summaryuser <String>]
|
|
|
|
<FileTreeFieldName> ::=
|
|
explicitlytrashed|
|
|
filesize|
|
|
id|
|
|
mimetype|
|
|
owners|
|
|
parents|
|
|
size|
|
|
trashed|
|
|
webviewlink
|
|
<FileTreeFieldNameList> ::= "<FileTreeFieldName>(,<FileTreeFieldName>)*"
|
|
|
|
gam <UserTypeEntity> print filetree [todrive <ToDriveAttribute>*]
|
|
[select <DriveFileEntity> [selectsubquery <QueryDriveFile>]
|
|
[depth <Number>]]
|
|
[anyowner|(showownedby any|me|others)]
|
|
[showmimetype [not] <MimeTypeList>] [showmimetype category <MimeTypeNameList>]
|
|
[sizefield quotabytesused|size] [minimumfilesize <Integer>] [maximumfilesize <Integer>]
|
|
[filenamematchpattern <REMatchPattern>]
|
|
<PermissionMatch>* [<PermissionMatchMode>] [<PermissionMatchAction>]
|
|
[excludetrashed]
|
|
[fields <FileTreeFieldNameList>]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])* [delimiter <Character>]
|
|
[noindent] [stripcrsfromname]
|
|
gam <UserTypeEntity> show filetree
|
|
[select <DriveFileEntity> [selectsubquery <QueryDriveFile>]
|
|
[depth <Number>]]
|
|
[anyowner|(showownedby any|me|others)]
|
|
[showmimetype [not] <MimeTypeList>] [showmimetype category <MimeTypeNameList>]
|
|
[sizefield quotabytesused|size] [minimumfilesize <Integer>] [maximumfilesize <Integer>]
|
|
[filenamematchpattern <REMatchPattern>]
|
|
<PermissionMatch>* [<PermissionMatchMode>] [<PermissionMatchAction>]
|
|
[excludetrashed]
|
|
[fields <FileTreeFieldNameList>]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])* [delimiter <Character>]
|
|
[stripcrsfromname]
|
|
|
|
gam <UserTypeEntity> print fileparenttree <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
[stripcrsfromname]
|
|
|
|
gam <UserTypeEntity> print filelist [todrive <ToDriveAttribute>*]
|
|
[((query <QueryDriveFile>) | (fullquery <QueryDriveFile>) | <DriveFileQueryShortcut>)
|
|
(querytime<String> <Time>)*]
|
|
[continueoninvalidquery [<Boolean>]]
|
|
[choose <DriveFileNameEntity>|<DriveFileEntityShortcut>]
|
|
[corpora <CorporaAttribute>]
|
|
[select <DriveFileEntity> [selectsubquery <QueryDriveFile>]
|
|
[(norecursion [<Boolean>])|(depth <Number>)] [showparent]]
|
|
[anyowner|(showownedby any|me|others)]
|
|
[showmimetype [not] <MimeTypeList>] [showmimetype category <MimeTypeNameList>] [mimetypeinquery [<Boolean>]]
|
|
[sizefield quotabytesused|size] [minimumfilesize <Integer>] [maximumfilesize <Integer>]
|
|
[filenamematchpattern <REMatchPattern>]
|
|
<PermissionMatch>* [<PermissionMatchMode>] [<PermissionMatchAction>] [pmfilter] [oneitemperrow]
|
|
[includepermissionsforview published]
|
|
[excludetrashed]
|
|
[maxfiles <Integer>] [nodataheaders <String>]
|
|
[countsonly [summary none|only|plus] [summaryuser <String>]
|
|
[showsource] [showsize] [showsizeunits] [showmimetypesize]]
|
|
[countsrowfilter]
|
|
[filepath|fullpath [folderpathonly|parentpathonly [<Boolean>]] [pathdelimiter <Character>] [addpathstojson] [showdepth]] [buildtree]
|
|
[allfields|<DriveFieldName>*|(fields <DriveFieldNameList>)]
|
|
[showdrivename] [showshareddrivepermissions]
|
|
[(showlabels details|ids)|(includelabels <ClassificationLabelIDList>)]
|
|
[showparentsidsaslist] [showpermissionslast]
|
|
(orderby <DriveFileOrderByFieldName> [ascending|descending])* [delimiter <Character>]
|
|
[stripcrsfromname]
|
|
(addcsvdata <FieldName> <String>)* [includecsvdatainjson [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> print diskusage <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
[anyowner|(showownedby any|me|others)]
|
|
[sizefield quotabytesused|size]
|
|
[pathdelimiter <Character>] [excludetrashed] [stripcrsfromname]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[noprogress] [show all|summary|summaryandtrash]
|
|
|
|
<DriveActivityAction> ::=
|
|
comment|
|
|
create|
|
|
delete|trash|
|
|
dlpchange|
|
|
edit|
|
|
emptytrash|
|
|
move|
|
|
permissionchange|
|
|
reference|
|
|
rename|
|
|
restore|untrash|
|
|
settingschange|
|
|
upload
|
|
<DriveActivityActionList> ::= "<DriveActivityAction>(,<DriveActivityAction>)*"
|
|
|
|
gam <UserTypeEntity> print driveactivity [todrive <ToDriveAttribute>*]
|
|
[(fileid <DriveFileID>) | (folderid <DriveFolderID>) |
|
|
(drivefilename <DriveFileName>) | (drivefoldername <DriveFolderName>) | (query <QueryDriveFile>)]
|
|
[([start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>])|(range <Date>|<Time> <Date>)|<Time>|
|
|
yesterday|today|thismonth|(previousmonths <Integer>)]
|
|
[action|actions [not] <DriveActivityActionList>] [maxactivities <Number>]
|
|
[consolidationstrategy legacy|none]
|
|
[idmapfile <CSVFileInput> endcsv]
|
|
[stripcrsfromname] [formatjson [quotechar <Character>]]
|
|
|
|
<DriveSettingsFieldName> ::=
|
|
appinstalled|
|
|
drivethemes|
|
|
exportformats|
|
|
foldercolorpalette|
|
|
importformats|
|
|
largestchangeid|
|
|
limit|
|
|
maximportsizes|
|
|
maxuploadsize|
|
|
name|
|
|
permissionid|
|
|
rootfolderid|
|
|
usage|
|
|
usageindrive|
|
|
usageindrivetrash
|
|
<DriveSettingsFieldNameList> ::= "<DriveSettingsFieldName>(,<DriveSettingsFieldName>)*"
|
|
|
|
gam <UserTypeEntity> print drivelastmodification [todrive <ToDriveAttribute>*]
|
|
[select <SharedDriveEntity>]
|
|
[pathdelimiter <Character>]
|
|
(addcsvdata <FieldName> <String>)*
|
|
gam <UserTypeEntity> show drivelastmodification
|
|
[select <SharedDriveEntity>]
|
|
[pathdelimiter <Character>]
|
|
|
|
gam <UserTypeEntity> print drivesettings [todrive <ToDriveAttribute>*]
|
|
[allfields|<DriveSettingsFieldName>*|(fields <DriveSettingsFieldNameList>)]
|
|
[delimiter <Character>] [showusagebytes]
|
|
gam <UserTypeEntity> show drivesettings
|
|
[allfields|<DriveSettingsFieldName>*|(fields <DriveSettingsFieldNameList>)]
|
|
[delimiter <Character>] [showusagebytes]
|
|
|
|
gam <UserTypeEntity> print emptydrivefolders [todrive <ToDriveAttribute>*]
|
|
[select <DriveFileEntity>]
|
|
[pathdelimiter <Character>]
|
|
gam <UserTypeEntity> delete emptydrivefolders
|
|
[select <DriveFileEntity>]
|
|
[<SharedDriveEntity>]
|
|
[pathdelimiter <Character>]
|
|
gam <UserTypeEntity> delete emptydrivefolders [<SharedDriveEntity>]
|
|
|
|
gam <UserTypeEntity> empty drivetrash [<SharedDriveEntity>]
|
|
|
|
# Users - Deprovision
|
|
|
|
gam <UserTypeEntity> deprovision|deprov [popimap] [signout] [turnoff2sv]
|
|
|
|
# Users - Gmail - Delegates
|
|
|
|
gam <UserTypeEntity> delegate to [convertalias] <UserEntity>
|
|
[notify [<Boolean>]
|
|
[subject <String>]
|
|
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
|
[replyto <EmailAaddress>]
|
|
[<NotifyMessageContent>] [html [<Boolean>]]
|
|
]
|
|
gam <UserTypeEntity> create|add delegate|delegates [convertalias] <UserEntity>
|
|
[notify [<Boolean>]
|
|
[subject <String>]
|
|
[from <EmailAaddress>] [mailbox <EmailAddress>]
|
|
[replyto <EmailAaddress>]
|
|
[<NotifyMessageContent>] [html [<Boolean>]]
|
|
]
|
|
gam <UserTypeEntity> delete delegate|delegates [convertalias] <UserEntity>
|
|
gam <UserTypeEntity> update delegate|delegates [convertalias] [<UserEntity>]
|
|
gam <UserTypeEntity> show delegates|delegate [shownames] [csv]
|
|
gam <UserTypeEntity> print delegates|delegate [todrive <ToDriveAttribute>*] [shownames]
|
|
|
|
# Users - Gmail - Filters
|
|
|
|
<GmailCategory> ::=
|
|
forums|
|
|
personal|
|
|
promotions|
|
|
social|
|
|
updates
|
|
|
|
<FilterCriteria> ::=
|
|
excludechats|
|
|
(from <String>)|
|
|
(haswords|query <List>)|
|
|
(musthaveattachment|hasattachment)|
|
|
(nowords|negatedquery <List>)|
|
|
(size larger|smaller <ByteCount>)|
|
|
(subject <String>)|
|
|
(to <String>)
|
|
|
|
<FilterAction> ::=
|
|
archive|
|
|
(category <GmailCategory>)|
|
|
(forward <EmailAddress>)|
|
|
(important|notimportant)|
|
|
(label <LabelName>)|
|
|
markread|
|
|
neverspam|
|
|
star|
|
|
trash
|
|
|
|
gam <UserTypeEntity> [create|add] filter
|
|
(<FilterCriteria>+ <FilterAction>+) | <JSONData>
|
|
[buildpath [<Boolean>]]
|
|
gam <UserTypeEntity> delete filters <FilterIDEntity>
|
|
|
|
gam <UserTypeEntity> info filters <FilterIDEntity> [labelidsonly] [formatjson]
|
|
gam <UserTypeEntity> show filters [labelidsonly] [formatjson]
|
|
gam <UserTypeEntity> print filters [labelidsonly] [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Users - Forms
|
|
|
|
gam <UserTypeEntity> create form
|
|
title <String> [description <String>] [isquiz [<Boolean>]] [<JSONData>]
|
|
[ispublished [<Boolean>] isacceptingresponses [<Boolean>]]
|
|
[drivefilename <DriveFileName>] [<DriveFileParentAttribute>]
|
|
[(csv [todrive <ToDriveAttribute>*]) | returnidonly]
|
|
gam <UserTypeEntity> update form <DriveFileEntity>
|
|
[title <String>] [description <String>] [isquiz [<Boolean>]] [<JSONData>]
|
|
[ispublished [<Boolean>] isacceptingresponses [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> print forms <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show forms <DriveFileEntity>
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print formresponses <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
(addcsvdata <FieldName> <String>)*
|
|
[filter <String> (filtertime<String> <Time>)*]
|
|
[countsonly|(formatjson [quotechar <Character>])]
|
|
gam <UserTypeEntity> show formresponses <DriveFileEntity>
|
|
[filter <String> (filtertime<String> <Time>)*]
|
|
[countsonly|formatjson]
|
|
|
|
# Users - Gmail - Forwarding
|
|
|
|
gam <UserTypeEntity> create|add forwardingaddress|forwardingaddresses <EmailAddressEntity>
|
|
gam <UserTypeEntity> delete forwardingaddress|forwardingaddresses <EmailAddressEntity>
|
|
|
|
gam <UserTypeEntity> show forwardingaddress|forwardingaddresses
|
|
gam <UserTypeEntity> info forwardingaddress|forwardingaddresses <EmailAddressEntity>
|
|
gam <UserTypeEntity> print forwardingaddress|forwardingaddresses [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> forward <FalseValues>
|
|
gam <UserTypeEntity> forward <TrueValues> keep|leaveininbox|archive|delete|trash|markread <EmailAddress>
|
|
gam <UserTypeEntity> show forward|forwards
|
|
gam <UserTypeEntity> print forward|forwards [enabledonly] [todrive <ToDriveAttribute>*]
|
|
|
|
# Users - Gmail - Labels/Messages
|
|
|
|
gam <UserTypeEntity> [create|add] label|labels <String>
|
|
[messagelistvisibility hide|show] [labellistvisibility hide|show|showifunread]
|
|
[backgroundcolor "<LabelColorHex>|<LabelBackgroundColorHex>|custom:<ColorHex>"]
|
|
[textcolor "<LabelColorHex>|<LabelTextColorHex>|custom:<ColorHex>"]
|
|
[buildpath [<Boolean>]]
|
|
gam <UserTypeEntity> create labellist <LabelNameEntity>
|
|
[messagelistvisibility hide|show] [labellistvisibility hide|show|showifunread]
|
|
[backgroundcolor "<LabelColorHex>|<LabelBackgroundColorHex>|custom:<ColorHex>"]
|
|
[textcolor "<LabelColorHex>|<LabelTextColorHex>|custom:<ColorHex>"]
|
|
[buildpath [<Boolean>]]
|
|
gam <UserTypeEntity> update labelid <LabelID> [name <String>]
|
|
[messagelistvisibility hide|show] [labellistvisibility hide|show|showifunread]
|
|
[backgroundcolor "<LabelColorHex>|<LabelBackgroundColorHex>|custom:<ColorHex>"]
|
|
[textcolor "<LabelColorHex>|<LabelTextColorHex>|custom:<ColorHex>"]
|
|
gam <UserTypeEntity> update labelsettings <LabelName> [name <String>]
|
|
[messagelistvisibility hide|show] [labellistvisibility hide|show|showifunread]
|
|
[backgroundcolor "<LabelColorHex>|<LabelBackgroundColorHex>|custom:<ColorHex>"]
|
|
[textcolor "<LabelColorHex>|<LabelTextColorHex>|custom:<ColorHex>"]
|
|
gam <UserTypeEntity> update label|labels [search <REMatchPattern>] [replace <LabelReplacement>] [merge [keepoldlabel]]
|
|
gam <UserTypeEntity> delete label|labels <LabelName>|regex:<REMatchPattern>|--ALL_LABELS--
|
|
gam <UserTypeEntity> delete labellist <LabelNameEntity>
|
|
gam <UserTypeEntity> delete labelid <LabelID>
|
|
gam <UserTypeEntity> delete labelidlist <LabelIDEntity>
|
|
|
|
gam <UserTypeEntity> show labels|label
|
|
[onlyuser|useronly [<Boolean>]] [showcounts [<Boolean>]]
|
|
[nested [<Boolean>]] [display allfields|basename|fullname]
|
|
[labellist <LabelNameEntity>]
|
|
gam <UserTypeEntity> print labels|label [todrive <ToDriveAttribute>*]
|
|
[onlyuser|useronly [<Boolean>]] [showcounts [<Boolean>]]
|
|
[labellist <LabelNameEntity>]
|
|
|
|
<SMTPDateHeader> ::=
|
|
date|
|
|
delivery-date|
|
|
expires|
|
|
expiry-date|
|
|
latest-delivery-time|
|
|
reply-by|
|
|
resent-date
|
|
<SMTPHeader> ::=
|
|
accept-language|
|
|
alternate-recipient|
|
|
autoforwarded|
|
|
autosubmitted|
|
|
bcc|
|
|
cc|
|
|
comments|
|
|
content-alternative|
|
|
content-base|
|
|
content-description|
|
|
content-disposition|
|
|
content-duration|
|
|
content-id|
|
|
content-identifier|
|
|
content-language|
|
|
content-location|
|
|
content-md5|
|
|
content-return|
|
|
content-transfer-encoding|
|
|
content-type|
|
|
content-features|
|
|
conversion|
|
|
conversion-with-loss|
|
|
dl-expansion-history|
|
|
deferred-delivery|
|
|
delivered-to|
|
|
discarded-x400-ipms-extensions|
|
|
discarded-x400-mts-extensions|
|
|
disclose-recipients|
|
|
disposition-notification-options|
|
|
disposition-notification-to|
|
|
encoding|
|
|
encrypted|
|
|
from|
|
|
generate-delivery-report|
|
|
importance|
|
|
in-reply-to|
|
|
incomplete-copy|
|
|
keywords|
|
|
language|
|
|
list-archive|
|
|
list-help|
|
|
list-id|
|
|
list-owner|
|
|
list-post|
|
|
list-subscribe|
|
|
list-unsubscribe|
|
|
mime-version|
|
|
message-context|
|
|
message-id|
|
|
message-type|
|
|
obsoletes|
|
|
original-encoded-information-types|
|
|
original-message-id|
|
|
originator-return-address|
|
|
pics-label|
|
|
prevent-nondelivery-report|
|
|
priority|
|
|
received|
|
|
references|
|
|
reply-to|
|
|
resent-bcc|
|
|
resent-cc|
|
|
resent-from|
|
|
resent-message-id|
|
|
resent-reply-to|
|
|
resent-sender|
|
|
resent-to|
|
|
return-path|
|
|
sender|
|
|
sensitivity|
|
|
subject|
|
|
supersedes|
|
|
to|
|
|
x400-content-identifier|
|
|
x400-content-return|
|
|
x400-content-type|
|
|
x400-mts-identifier|
|
|
x400-originator|
|
|
x400-received|
|
|
x400-recipients|
|
|
x400-trace
|
|
<SMTPHeaderList> ::= "<SMTPDateHeader>|<SMTPHeader>(,<SMTPDateHeader>|<SMTPHeader>)*"
|
|
|
|
<MessageContent> ::=
|
|
(message|textmessage|htmlmessage <String>)|
|
|
(file|textfile|htmlfile <FileName> [charset <Charset>])|
|
|
(gdoc|ghtml <UserGoogleDoc>)|
|
|
(gcsdoc|gcshtml <StorageBucketObjectName>)|
|
|
(emlfile <FileName> [charset <Charset>])
|
|
|
|
gam <UserTypeEntity> draft message
|
|
<MessageContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
(<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*
|
|
(attach <FileName> [charset <Charset>])*
|
|
(embedimage <FileName> <String>)*
|
|
gam <UserTypeEntity> import message
|
|
<MessageContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
(<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*
|
|
(addlabel <LabelName>)* [labels <LabelNameList>]
|
|
(attach <FileName> [charset <Charset>])*
|
|
(embedimage <FileName> <String>)*
|
|
[deleted [<Boolean>]] [checkspam|nevermarkspam [<Boolean>]] [processforcalendar [<Boolean>]]
|
|
gam <UserTypeEntity> insert message
|
|
<MessageContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
(<SMTPDateHeader> <Time>)* (<SMTPHeader> <String>)* (header <String> <String>)*
|
|
(addlabel <LabelName>)* [labels <LabelNameList>]
|
|
(attach <FileName> [charset <Charset>])*
|
|
(embedimage <FileName> <String>)*
|
|
[deleted [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> archive messages <GroupItem>
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_archive <Number>])|(ids <MessageIDEntity>)
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
gam <UserTypeEntity> delete messages|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_delete <Number>])|(ids <MessageIDEntity>)
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
gam <UserTypeEntity> modify messages|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_modify <Number>])|(ids <MessageIDEntity>)
|
|
((addlabel <LabelName>)|(removelabel <LabelName>))+
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
gam <UserTypeEntity> spam messages|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_spam <Number>])|(ids <MessageIDEntity>)
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
gam <UserTypeEntity> trash messages|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_trash <Number>])|(ids <MessageIDEntity>)
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
gam <UserTypeEntity> untrash messages|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_untrash <Number>])|(ids <MessageIDEntity>)
|
|
[csv [todrive <ToDriveAttribute>*]]
|
|
|
|
gam <UserTypeEntity> export message|messages
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_export <Number>])|(ids <MessageIDEntity>)
|
|
[targetfolder <FilePath>] [targetname <FileName>] [overwrite [<Boolean>]]
|
|
gam <UserTypeEntity> export thread|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_export <Number>])|(ids <ThreadIDEntity>)
|
|
[targetfolder <FilePath>] [targetname <FileName>] [overwrite [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> forward message|messages [recipient|to] <RecipientEntity>
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [doit] [max_to_forward <Number>])|(ids <MessageIDEntity>)
|
|
[subject <String>] [addorigfieldstosubject [<Boolean>]] [altcharset <String>]
|
|
gam <UserTypeEntity> forward thread|thtreads [recipient|to] <RecipientEntity>
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])+
|
|
[labelids <LabelIDList>]
|
|
quick|notquick] [doit] [max_to_forward <Number>])|(ids <ThreadIDEntity>)
|
|
[subject <String>] [addorigfieldstosubject [<Boolean>]] [altcharset <String>]
|
|
|
|
gam <UserTypeEntity> show messages|threads
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])*
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [max_to_show <Number>] [includespamtrash])|(ids <MessageIDEntity>)
|
|
[labelmatchpattern <REMatchPattern>] [sendermatchpattern <REMatchPattern>]
|
|
[countsonly|positivecountsonly]
|
|
[headers all|<SMTPHeaderList>] [dateheaderformat iso|rfc2822|<String>] [dateheaderconverttimezone [<Boolean>]]
|
|
[showlabels] [useronly] [delimiter <Character>] [showbody] [showhtml] [showdate] [showsize] [showsnippet]
|
|
[maxmessagesperthread <Number>]
|
|
[[attachmentnamepattern <REMatchPattern>]
|
|
[showattachments [noshowtextplain]]
|
|
[saveattachments [targetfolder <FilePath>] [overwrite [<Boolean>]]]
|
|
[uploadattachments [<DriveFileParentAttribute>]]]
|
|
gam <UserTypeEntity> print messages|threads [todrive <ToDriveAttribute>*]
|
|
(((query <QueryGmail> [querytime<String> <Date>]*) (matchlabel <LabelName>) [or|and])*
|
|
[labelids <LabelIDList>]
|
|
[quick|notquick] [max_to_print <Number>] [includespamtrash])|(ids <MessageIDEntity>)
|
|
[labelmatchpattern <REMatchPattern>] [sendermatchpattern <REMatchPattern>]
|
|
[countsonly|positivecountsonly]
|
|
[headers all|<SMTPHeaderList>] [dateheaderformat iso|rfc2822|<String> [dateheaderconverttimezone [<Boolean>]]]
|
|
[showlabels] [useronly] [delimiter <Character>] [showbody] [showhtml] [showdate] [showsize] [showsnippet]
|
|
[maxmessagesperthread <Number>]
|
|
[convertcrnl] [delimiter <Character>]
|
|
[[attachmentnamepattern <REMatchPattern>]
|
|
[showattachments [noshowtextplain]]]
|
|
(addcsvdata <FieldName> <String>)*
|
|
|
|
# Users - Gmail - Profile
|
|
|
|
gam <UserTypeEntity> show gmailprofile
|
|
gam <UserTypeEntity> print gmailprofile [todrive <ToDriveAttribute>*]
|
|
|
|
# Users - Gmail - Send As/Signature/Vacation
|
|
|
|
gam <UserTypeEntity> [create|add] sendas <EmailAddress> [name] <String>
|
|
[<SendAsContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*]
|
|
[html [<Boolean>]] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
|
|
[smtpmsa.host <SMTPHostName> smtpmsa.port 25|465|587
|
|
smtpmsa.username <UserName> smtpmsa.password <Password>
|
|
[smtpmsa.securitymode none|ssl|starttls]]
|
|
gam <UserTypeEntity> update sendas <EmailAddress> [name <String>]
|
|
[<SendAsContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*]
|
|
[html [<Boolean>]] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
|
|
gam <UserTypeEntity> delete sendas <EmailAddressEntity>
|
|
gam <UserTypeEntity> info sendas <EmailAddressEntity> [compact|format|html]
|
|
gam <UserTypeEntity> show sendas [compact|format|html]
|
|
[primary|default] [verifyonly]
|
|
gam <UserTypeEntity> print sendas [compact]
|
|
[primary|default] [verifyonly] [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> signature|sig
|
|
<SignatureContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*
|
|
[html [<Boolean>]] [replyto <EmailAddress>] [default] [treatasalias <Boolean>]
|
|
[name <String>]
|
|
[primary]
|
|
gam <UserTypeEntity> show signature|sig [compact|format|html|template]
|
|
[primary|default] [verifyonly]
|
|
gam <UserTypeEntity> print signature [compact]
|
|
[primary|default] [verifyonly] [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> vacation [<Boolean>] [subject <String>]
|
|
[<VacationMessageContent>
|
|
(replace <Tag> <UserReplacement>)*
|
|
(replaceregex <RESearchPattern> <RESubstitution> <Tag> <UserReplacement>)*]
|
|
[html [<Boolean>]] [contactsonly [<Boolean>]] [domainonly [<Boolean>]]
|
|
[start|startdate <Date>|Started] [end|enddate <Date>|NotSpecified]
|
|
gam <UserTypeEntity> show vacation [compact|format|html] [enabledonly]
|
|
gam <UserTypeEntity> print vacation [compact] [enabledonly] [todrive <ToDriveAttribute>*]
|
|
|
|
# Users - Gmail - S/MIME
|
|
|
|
gam <UserTypeEntity> create|add smime file <FileName> [password <Password>]
|
|
[sendas|sendasemail <EmailAddress>] [default]
|
|
gam <UserTypeEntity> update smime default
|
|
[id <S/MIMEID>] [sendas|sendasemail <EmailAddress>]
|
|
gam <UserTypeEntity> delete smime
|
|
[id <S/MIMEID>] [sendas|sendasemail <EmailAddress>]
|
|
gam <UserTypeEntity> show smimes
|
|
[primary|default|(sendas|sendasemail <EmailAddress>)]
|
|
gam <UserTypeEntity> print smimes [todrive <ToDriveAttribute>*]
|
|
[primary|default|(sendas|sendasemail <EmailAddress>)]
|
|
|
|
# Users - Gmail Client Side Encryption
|
|
|
|
gam <UserTypeEntity> create cseidentity
|
|
(primarykeypairid <KeyPairID>) | (signingkeypairid <KeyPairID> encryptionkeypairid <KeyPairID>)
|
|
[kpemail <EmailAddress>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> update cseidentity
|
|
(primarykeypairid <KeyPairID>) | (signingkeypairid <KeyPairID> encryptionkeypairid <KeyPairID>)
|
|
[kpemail <EmailAddress>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> delete cseidentity [kpemail <EmailAddress>]
|
|
|
|
gam <UserTypeEntity> info cseidentity [kpemail <EmailAddress>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show cseidentities
|
|
[formatjson]
|
|
gam <UserTypeEntity> print cseidentities [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> create csekeypair
|
|
[incertdir <FilePath>] [inkeydir <FilePath>]
|
|
[addidentity [<Boolean>]] [kpemail <EmailAddress>]
|
|
[showpem] [showkaclsdata] [formatjson|returnidonly]
|
|
gam <UserTypeEntity> disable csekeypair <KeyPairID>
|
|
[showpem] [showkaclsdata] [formatjson]
|
|
gam <UserTypeEntity> enable csekeypair <KeyPairID>
|
|
[showpem] [showkaclsdata] [formatjson]
|
|
gam <UserTypeEntity> obliterate csekeypair <KeyPairID>
|
|
|
|
gam <UserTypeEntity> info csekeypair <KeyPairID>
|
|
[showpem] [showkaclsdata] [formatjson]
|
|
gam <UserTypeEntity> show csekeypairs
|
|
[showpem] [showkaclsdata] [formatjson]
|
|
gam <UserTypeEntity> print csekeypairs [todrive <ToDriveAttribute>*]
|
|
[showpem] [showkaclsdata] [formatjson [quotechar <Character>]]
|
|
|
|
# Users - Gmail - Settings
|
|
|
|
gam <UserTypeEntity> imap|imap4 <Boolean>
|
|
[noautoexpunge] [expungebehavior archive|deleteforever|trash]
|
|
[maxfoldersize 0|1000|2000|5000|10000]
|
|
gam <UserTypeEntity> show imap|imap4
|
|
gam <UserTypeEntity> print imap|imap4 [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> pop|pop3 <Boolean>
|
|
[for allmail|newmail|mailfromnowon|fromnowon]
|
|
[action keep|leaveininbox|archive|delete|trash|markread]
|
|
gam <UserTypeEntity> show pop|pop3
|
|
gam <UserTypeEntity> print pop|pop3 [todrive <ToDriveAttribute>*]
|
|
|
|
gam <UserTypeEntity> language <Language>
|
|
gam <UserTypeEntity> show language
|
|
gam <UserTypeEntity> print language [todrive <ToDriveAttribute>*]
|
|
|
|
# Users - Groups
|
|
|
|
gam <UserTypeEntity> add group|groups
|
|
([<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)+
|
|
gam <UserTypeEntity> delete group|groups
|
|
[(domain <DomainName>)|(customerid <CustomerID>)|
|
|
(emailmatchpattern [not] <REMatchPattern>)|<GroupEntity>]
|
|
gam <UserTypeEntity> update group|groups
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]) [<GroupRole>] [[delivery] <DeliverySetting>]
|
|
([<GroupRole>] [[delivery] <DeliverySetting>] [<GroupEntity>])*
|
|
gam <UserTypeEntity> sync group|groups
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]
|
|
[<GroupRole>] [[delivery] <DeliverySetting>] <GroupEntity>)*
|
|
gam <UserTypeEntity> check group|groups
|
|
[roles <GroupRoleList>] [includederivedmembership] [csv] <GroupEntity>
|
|
gam <UserTypeEntity> print groups [todrive <ToDriveAttribute>*]
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]
|
|
[roles <GroupRoleList>] [countsonly|totalonly|nodetails]
|
|
gam <UserTypeEntity> show groups
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]
|
|
[roles <GroupRoleList>] [countsonly|totalonly|nodetails]
|
|
gam <UserTypeEntity> print grouptree [todrive <ToDriveAttribute>*]
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]
|
|
[roles <GroupRoleList>]
|
|
[showparentsaslist [<Boolean>]] [delimiter <Character>]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show grouptree
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]
|
|
[roles <GroupRoleList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print groupslist [todrive <ToDriveAttribute>*]
|
|
[(domain <DomainName>)|(customerid <CustomerID>)]
|
|
[delimiter <Character>] [quotechar <Character>]
|
|
|
|
# Users - Invitations
|
|
|
|
gam send userinvitation <EmailAddress>
|
|
gam cancel userinvitation <EmailAddress>
|
|
gam info userinvitation <EmailAddress> [formatjson]
|
|
gam show userinvitations
|
|
[state notyetsent|invited|accepted|declined]
|
|
[orderby email|updatetime [ascending|descending]]
|
|
[formatjson]
|
|
gam print userinvitations [todrive <ToDriveAttribute>*]
|
|
[[state notyetsent|invited|accepted|declined]
|
|
[orderby email|updatetime [ascending|descending]]
|
|
[[formatjson [quotechar <Character>]]
|
|
gam check isinvitable|userinvitation <EmailAddress>
|
|
gam <UserTypeEntity> check isinvitable [todrive <ToDriveAttribute>*]
|
|
|
|
# Users - Keep Notes
|
|
|
|
<KeepNoteContent> ::=
|
|
(text <String>)|
|
|
(textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)|
|
|
(gcsdoc <StorageBucketObjectName>)|
|
|
<JSONData>
|
|
|
|
gam <UserTypeEntity> create note [title <String>]
|
|
[missingtextvalue <String>]
|
|
<KeepNoteContent>
|
|
[copyacls [copyowneraswriter]]
|
|
[compact|formatjson|nodetails]
|
|
|
|
gam <UserTypeEntity> delete note <NoteNameEntity>
|
|
|
|
<NotesField> ::=
|
|
attachments|
|
|
body|
|
|
createtime|
|
|
name|
|
|
permissions|
|
|
title|
|
|
trashed|
|
|
trashtime|
|
|
updatetime
|
|
<NotesFieldList> ::= "<NotesField>(,<NotesField>)*"
|
|
|
|
gam <UserTypeEntity> info note <NotesNameEntity>
|
|
[fields <NotesFieldList>]
|
|
[compact|formatjson]
|
|
|
|
gam <UserTypeEntity> show notes
|
|
[fields <NotesFieldList>] [filter <String>]
|
|
[role owner|writer]
|
|
[countsonly]
|
|
[compact|formatjson]
|
|
gam <UserTypeEntity> print notes [todrive <ToDriveAttribute>*]
|
|
[fields <NotesFieldList>] [filter <String>]
|
|
[role owner|writer]
|
|
[countsonly]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> get noteattachments <NotesNameEntity>
|
|
[targetfolder <FilePath>] [targetname <FileName>] [overwrite [<Boolean>]]
|
|
[<DriveFileParentAttribute>]
|
|
|
|
gam <UserTypeEntity> create noteacl <NotesNameEntity>
|
|
(user|group <EmailAddress>)+
|
|
<JSONData>
|
|
[nodetails]
|
|
gam <UserTypeEntity> delete noteacl <NotesNameEntity>
|
|
(user|group <EmailAddress>)+
|
|
<JSONData>
|
|
|
|
# Users - Licenses
|
|
|
|
gam <UserTypeEntity> create|add license <SKUIDList> [product|productid <ProductID>] [preview] [actioncsv]
|
|
gam <UserTypeEntity> update license <NewSKUID> [product|productid <ProductID>] [from] <OldSKUID>
|
|
[preview|archive] [actioncsv]
|
|
gam <UserTypeEntity> delete license <SKUIDList> [product|productid <ProductID>] [preview] [actioncsv]
|
|
gam <UserTypeEntity> sync license <SKUIDList> [product|productid <ProductID>] [addonly|removeonly] [allskus|onesku] [preview] [actioncsv]
|
|
|
|
# Users - Looker Studuo
|
|
|
|
<LookerStudioPermission> ::=
|
|
user:<EmailAddress>|
|
|
group:<EmailAddress>|
|
|
domain:<DomainName>|
|
|
serviceAccount:<EmailAddress>
|
|
<LookerStudioPermissionList> ::= "<LookerStudioPermission>(,<LookerStudioPermission>)*"
|
|
<LookerStudioPermissionEntity> ::=
|
|
<LookerStudioPermissionList> | <FileSelector> | <CSVFileSelector> | <CSVkmdSelector> | <CSVDataSelector>
|
|
|
|
stam <UserTypeEntity> print lookerstudioassets [todrive <ToDriveAttribute>*]
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]
|
|
[orderby title [ascending|descending]]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
[stripcrsfromtitle]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show lookerstudioassets
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]
|
|
[orderby title [ascending|descending]]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
[stripcrsfromtitle]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> add lookerstudiopermissions
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]
|
|
[orderby title [ascending|descending]]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
(role editor|viewer <LookerStudioPermissionEntity>)+
|
|
[nodetails]
|
|
gam <UserTypeEntity> delete lookerstudiopermissions
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
(role any <LookerStudioPermissionEntity>)+
|
|
[nodetails]
|
|
gam <UserTypeEntity> update lookerstudiopermissions
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]
|
|
[orderby title [ascending|descending]]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
(role editor|viewer <LookerStudioPermissionEntity>)+
|
|
[nodetails]
|
|
|
|
gam <UserTypeEntity> print lookerstudiopermissions [todrive <ToDriveAttribute>*]
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]
|
|
[orderby title [ascending|descending]]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
[role editor|owner|viewer]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show lookerstudiopermissions
|
|
[([assettype report|datasource|all] [title <String>]
|
|
[owner <Emailddress>] [includetrashed]
|
|
[orderby title [ascending|descending]]) |
|
|
(assetids <LookerStudioAssetIDEntity>)]
|
|
[role editor|owner|viewer]
|
|
[formatjson]
|
|
|
|
# Users - Meet
|
|
|
|
<MeetConferenceName> ::= conferenceRecords/<String>
|
|
<MeetSpaceName> ::= spaces/<String> | <String>
|
|
<MeetSpaceOptions> ::=
|
|
accesstype open|trusted|restricted |
|
|
entrypointaccess all|creatorapponly |
|
|
moderation <Boolean> |
|
|
chatrestriction hostsonly|norestriction |
|
|
reactionrestriction hostsonly|norestriction |
|
|
presentrestriction hostsonly|norestriction |
|
|
defaultjoinasviewer <Boolean> |
|
|
recording <Boolean> |
|
|
transcription <Boolean> |
|
|
smartnotes <Boolean>
|
|
|
|
gam <UserTypeEntity> create meetspace
|
|
<MeetSpaceOptions>*
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> update meetspace <MeetSpaceName>
|
|
<MeetSpaceOptions>*
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> info meetspace <MeetSpaceName>
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> end meetconference <MeetSpaceName>
|
|
|
|
gam <UserItem> show meetconferences
|
|
[space <MeetSpaceName>] [code <String>]
|
|
[andquery|orquery <String>] [querytime<String> <Time>]
|
|
[formatjson]
|
|
gam <UserItem> print meetconferences [todrive <ToDriveAttribute>*]
|
|
[andquery|orquery <String>] [querytime<String> <Time>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserItem> show meetparticipants <MeetConferenceName>
|
|
[query <String>] [querytime<String> <Time>]
|
|
[formatjson]
|
|
gam <UserItem> print meetparticipants <MeetConferenceName> [todrive <ToDriveAttribute>*]
|
|
[query <String>] [querytime<String> <Time>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserItem> show meetrecordings <MeetConferenceName>
|
|
[formatjson]
|
|
gam <UserItem> print meetrecordings <MeetConferenceName> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserItem> show meettranscripts <MeetConferenceName>
|
|
[formatjson]
|
|
gam <UserItem> print meettranscripts <MeetConferenceName> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Users - Contacts and Profiles
|
|
|
|
<BiographyContent> ::=
|
|
<String>|
|
|
(file|textfile <FileName> [charset <Charset>])|
|
|
(gdoc <UserGoogleDoc>)
|
|
|
|
<PeopleContactAttribute> ::=
|
|
(additionalname|middlename <String>)|
|
|
(address clear|(work|home|other|<String> ((formatted|unstructured <String>)|(streetaddress <String>)|(pobox <String>)|
|
|
(neighborhood <String>)|(locality <String>)|(region <String>)|(postalcode <String>)|(country <String>))* notprimary|primary))|
|
|
(billinginfo <String>)|
|
|
(biography|biographies <BiographyContent)|
|
|
(birthday <Date>)|
|
|
(calendar clear|(work|home|free-busy|<String> <URL> notprimary|primary))|
|
|
(clientdata <String> <String>)|
|
|
(directoryserver <String>)|
|
|
(email clear|(work|home|other|<String> <EmailAddress> notprimary|primary))|
|
|
(event clear|(anniversary|other|<String> <Date>))|
|
|
(externalid clear|(account|customer|network|organization|<String> <String>))|
|
|
(familyname|lastname <String>)|
|
|
(fileas <String>)|
|
|
(gender female|male)|
|
|
(givenname|firstname <String>)|
|
|
(im clear|(work|home|other|<String> aim|gtalk|icq|jabber|msn|net_meeting|qq|skype|yahoo <String> notprimary|primary))|
|
|
(interests clear|<String>)|
|
|
(initials <String>)|
|
|
(jot clear|(work|home|other|keywords|<user> <String>))|
|
|
<JSONData>||
|
|
(language <Language>)|
|
|
(locale clear|<Language>)|
|
|
(location clear|<String>)|
|
|
(maidenname <String>)|
|
|
(mileage <String>)|
|
|
(name <String>)|
|
|
(nickname <String>)|
|
|
(note <NoteContent>)|
|
|
(occupation clear|<String>)|
|
|
(organization clear|(work|other|<String> <String> ((location <String>)|(department <String>)|(title <String>)|(jobdescription <String>)|(symbol <String>))* notprimary|primary))|
|
|
(phone clear|(work|home|other|fax|work_fax|home_fax|other_fax|main|company_main|assistant|mobile|work_mobile|pager|work_pager|car|radio|callback|isdn|telex|tty_tdd|<String> <String> notprimary|primary))|
|
|
(prefix <String>)|
|
|
(priority low|normal|high)
|
|
(relation clear|(spouse|child|mother|father|parent|brother|sister|friend|relative|domestic_partner|manager|assistant|referred_by|partner|<String> <String>))|
|
|
(sensitivity confidential|normal|personal|private)
|
|
(shortname <String>)|
|
|
(skills clear|<String>)|
|
|
(subject <String>)|
|
|
(suffix <String>)|
|
|
(userdefinedfield clear|(<String> <String>))|
|
|
(url|website clear|(app_install_page|blog|ftp|home|home_page|other|profile|reservations|work|<String> <URL> notprimary|primary))
|
|
|
|
<PeopleUserContactSelection> ::=
|
|
[(selectcontactgroup <PeopleContactGroupItem>)|
|
|
[query <QueryContact>]]
|
|
[emailmatchpattern <REMatchPattern> [emailmatchtype work|home|other|<String>]]
|
|
|
|
gam <UserTypeEntity> create contact
|
|
[<PeopleContactAttribute>+]
|
|
(contactgroup <ContactGroupItem>)*
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*))| returnidonly]
|
|
gam <UserTypeEntity> update contacts
|
|
<PeopleResourceNameEntity>|(<PeopleUserContactSelection> endquery)
|
|
[<PeopleContactAttribute>+]
|
|
(contactgroup <ContactGroupItem>)*|((addcontactgroup <ContactGroupItem>)* (removecontactgroup <ContactGroupItem>)*)
|
|
gam <UserTypeEntity> delete contacts
|
|
<PeopleResourceNameEntity>|<PeopleUserContactSelection>
|
|
|
|
gam <UserTypeEntity> clear contacts
|
|
<PeopleResourceNameEntity>|<PeopleUserContactSelection>
|
|
[emailclearpattern <REMatchPattern>] [emailcleartype work|home|other|<String>]
|
|
[delete_cleared_contacts_with_no_emails]
|
|
|
|
gam <UserTypeEntity> dedup contacts
|
|
[<PeopleResourceNameEntity>|<PeopleUserContactSelection>]
|
|
[matchType [<Boolean>]]
|
|
|
|
gam <UserTypeEntity> replacedomain contacts
|
|
[<PeopleResourceNameEntity>|<PeopleUserContactSelection>]
|
|
(domain <OldDomainName> <NewDomainName>)+
|
|
|
|
gam <UserTypeEntity> update contactphotos
|
|
<PeopleResourceNameEntity>|<PeopleUserContactSelection>
|
|
[drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>]
|
|
gam <UserTypeEntity> get contactphotos
|
|
<PeopleResourceNameEntity>|<PeopleUserContactSelection>
|
|
[drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
|
|
gam <UserTypeEntity> delete contactphotos
|
|
<PeopleResourceNameEntity>|<PeopleUserContactSelection>
|
|
|
|
gam <UserTypeEntity> info contacts
|
|
<PeopleResourceNameEntity>
|
|
[allfields|(fields <PeopleFieldNameList>)] [showgroups] [showmetadata]
|
|
[formatjson]
|
|
|
|
<PeoplePrintShowUserContactSelection> ::=
|
|
[(selectcontactgroup <PeopleContactGroupItem>)|(filtercontactgroup <PeopleContactGroupItem>)|
|
|
([query <QueryContact>] [selectmaincontacts|selectothercontacts])]
|
|
[emailmatchpattern <REMatchPattern> [emailmatchtype work|home|other|<String>]]
|
|
|
|
gam <UserTypeEntity> show contacts
|
|
<PeoplePrintShowUserContactSelection>
|
|
[orderby firstname|lastname|(lastmodified ascending)|(lastnodified descending)
|
|
[allfields|(fields <PeopleFieldNameList>)] [showgroups] [showmetadata]
|
|
[countsonly|formatjson]
|
|
gam <UserTypeEntity> print contacts [todrive <ToDriveAttribute>*]
|
|
<PeoplePrintShowUserContactSelection>
|
|
[orderby firstname|lastname|(lastmodified ascending)|(lastnodified descending)
|
|
[allfields|(fields <PeopleFieldNameList>)] [[showgroups|showgroupnameslist] showmetadata]
|
|
[countsonly|(formatjson [quotechar <Character>])]
|
|
|
|
<OtherContactsFieldName> ::=
|
|
emailaddresses|
|
|
metadata|
|
|
names|
|
|
phonenumbers|
|
|
photos
|
|
<OtherContactsFieldNameList> ::= "<OtherContactsFieldName>(,<OtherContactsFieldName>)*"
|
|
|
|
<OtherContactsSelection> ::=
|
|
[query <QueryContact>]
|
|
[emailmatchpattern <REMatchPattern> [emailmatchtype work|home|other|<String>]]
|
|
|
|
gam <UserTypeEntity> copy othercontacts
|
|
<OtherContactsResourceNameEntity>|<OtherContactsSelection>
|
|
gam <UserTypeEntity> move othercontacts
|
|
<OtherContactsResourceNameEntity>|<OtherContactsSelection>
|
|
gam <UserTypeEntity> update othercontacts
|
|
<OtherContactsResourceNameEntity>|<OtherContactsSelection>
|
|
[<PeopleContactAttribute>+]
|
|
(contactgroup <ContactGroupItem>)*
|
|
gam <UserTypeEntity> delete othercontacts
|
|
<OtherContactsResourceNameEntity>|<OtherContactsSelection>
|
|
|
|
gam <UserTypeEntity> show othercontacts
|
|
[<OtherContactsSelection>]
|
|
[countsonly|allfields|(fields <OtherContactsFieldNameList>)] [showmetadata]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print othercontacts [todrive <ToDriveAttribute>*]
|
|
[<OtherContactsSelection>]
|
|
[countsonly|allfields|(fields <OtherContactsFieldNameList>)] [showmetadata]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<PeopleContactGroupAttribute> ::=
|
|
(clientdata <String> <String>)|
|
|
<JSONData>|
|
|
name <String>
|
|
|
|
<PeopleContactGroupField> ::=
|
|
clientdata|
|
|
grouptype|
|
|
membercount|
|
|
metadata|
|
|
name
|
|
<PeopleContactGroupFieldList> ::= "<PeopleContactGroupField>(,<PeopleContactGroupField>)*"
|
|
|
|
gam <UserTypeEntity> create contactgroup <PeopleContactGroupAttribute>+
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*))| returnidonly]
|
|
gam <UserTypeEntity> update contactgroup <PeopleContactGroupItem> <PeopleContactGroupAttribute>+
|
|
gam <UserTypeEntity> delete contactgroups <PeopleContactGroupEntity>
|
|
|
|
gam <UserTypeEntity> info contactgroups <PeopleContactGroupEntity>
|
|
[allfields|(fields <PeopleContactGroupFieldList>)] [showmetadata]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show contactgroups
|
|
[allfields|(fields <PeopleContactGroupFieldList>)] [showmetadata]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print contactgroups [todrive <ToDriveAttribute>*]
|
|
[allfields|(fields <PeopleContactGroupFieldList>)] [showmetadata]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
<PeopleFieldName> ::=
|
|
addresses|
|
|
ageranges|
|
|
biographies|
|
|
birthdays|
|
|
calendarurls|
|
|
clientdata|
|
|
coverphotos|
|
|
emailaddresses|
|
|
events|
|
|
externalids|
|
|
genders|
|
|
imclients|
|
|
interests|
|
|
locales|
|
|
locations|
|
|
memberships|
|
|
metadata|
|
|
misckeywords|
|
|
names|
|
|
nicknames|
|
|
occupations|
|
|
organizations|
|
|
phonenumbers|
|
|
photos|
|
|
relations|
|
|
sipaddresses|
|
|
skills|
|
|
urls|
|
|
updated|updatetime|
|
|
userdefined
|
|
<PeopleFieldNameList> ::= "<PeopleFieldName>(,<PeopleFieldName>)*"
|
|
|
|
<PeopleProfileSourceName> ::=
|
|
account|accounts|
|
|
domain|domains|
|
|
profile|profiles
|
|
<PeopleProfileSourceNameList> ::= "<PeopleProfileSourceName>(,<PeopleProfileSourceName>)*"
|
|
|
|
gam <UserTypeEntity> show peopleprofile
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[sources <PeopleProfileSourceNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print peopleprofile [todrive <ToDriveAttribute>*]
|
|
[allfields|(fields <PeopleFieldNameList>)] [showmetadata]
|
|
[sources <PeopleProfileSourceNameList>]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Users - Photo
|
|
|
|
gam <UserTypeEntity> update photo
|
|
([<FileNamePattern>] |
|
|
([drivedir|(sourcefolder <FilePath>)] [filename <FileNamePattern>]) |
|
|
(gphoto <EmailAddress> <DriveFileIDEntity>|<DriveFileNameEntity>))
|
|
gam <UserTypeEntity> delete photo
|
|
gam <UserTypeEntity> get photo [drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
|
|
[noshow] [nofile]
|
|
gam <UserTypeEntity> get profilephoto [drivedir|(targetfolder <FilePath>)] [filename <FileNamePattern>]
|
|
[noshow] [nofile] [returnurlonly] [nodefault] [size <Integer>]
|
|
|
|
# Users - Profile
|
|
|
|
gam <UserTypeEntity> profile share|shared|unshare|unshared
|
|
|
|
gam <UserTypeEntity> show profile
|
|
|
|
# Users - Tag Manager
|
|
|
|
<TagManagerAccountID> ::= <String>
|
|
<TagManagerAccountPath> ::= accounts/<TagManagerAccountID>
|
|
<TagManagerAccountPathList> ::= "<TagManagerAccountPath>(,<TagManagerAccountPath>)*"
|
|
<TagManagerAccountPathEntity> ::=
|
|
<TagManagerAccountPathList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
|
|
<TagManagerContainerID> ::= <String>
|
|
<TagManagerContainerPath> ::= accounts/<TagManagerAccountID>/containers/<TagManagerContainerID>
|
|
<TagManagerContainerPathList> ::= "<TagManagerContainerPath>(,<TagManagerContainerPath>)*"
|
|
<TagManagerContainerPathEntity> ::=
|
|
<TagManagerContainerPathList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
|
|
<TagManagerWorkspaceID> ::= <String>
|
|
<TagManagerWorkspacePath> ::= accounts/<TagManagerAccountID>/containers/<TagManagerContainerID>/workspaces/<TagManagerWorkspaceID>
|
|
<TagManagerWorkspacePathList> ::= "<TagManagerWorkspacePath>(,<TagManagerWorkspacePath>)*"
|
|
<TagManagerWorkspacePathEntity> ::=
|
|
<TagManagerWorkspacePathList> |
|
|
(select <FileSelector>|<CSVFileSelector>) |
|
|
|
|
<TagManagerTagID> ::= <String>
|
|
<TagManagerTagPath> ::= accounts/<TagManagerAccountID>/containers/<TagManagerContainerID>/workspaces/<TagManagerWorkspaceID>/tags/<TagManagerTagID>
|
|
|
|
gam <UserTypeEntity> show tagmanageraccounts
|
|
[includegoogletags [<Boolean>]]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print tagmanagerccounts [todrive <ToDriveAttribute>*]
|
|
[includegoogletags [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> show tagmanagercontainers <TagManagerAccountPathEntity>
|
|
[formatjson]
|
|
gam <UserTypeEntity> print tagmanagercontainers <TagManagerAccountPathEntity> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> show tagmanagerworkspaces <TagManagerContainerPathEntity>
|
|
[formatjson]
|
|
gam <UserTypeEntity> print tagmanagerworkspaces <TagManagerContainerPathEntity> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> show tagmanagertags <TagManagerWorkspacePathEntity>
|
|
[formatjson]
|
|
gam <UserTypeEntity> print tagmanagertags <TagManagerWorkspacePathEntity> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
gam <UserTypeEntity> show tagmanagerpermissions <TagManagerAccountPathEntity>
|
|
[formatjson]
|
|
gam <UserTypeEntity> print tagmanagerpermissions <TagManagerAccountPathEntity> [todrive <ToDriveAttribute>*]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Users - Tasks
|
|
|
|
<TaskAttribute> ::=
|
|
(title <String>)|
|
|
(notes <String>)|
|
|
(status needsaction|completed)|
|
|
(due <Time>)
|
|
|
|
gam <UserTypeEntity> create task <TasklistEntity>
|
|
<TaskAttribute>* [parent <TaskID>] [previous <TaskID>]
|
|
[compact|formatjson|returnidonly]
|
|
gam <UserTypeEntity> update task <TasklistIDTaskIDEntity>
|
|
<TaskAttribute>*
|
|
[compact|formatjson]
|
|
gam <UserTypeEntity> delete task <TasklistIDTaskIDEntity>
|
|
gam <UserTypeEntity> move task <TasklistIDTaskIDEntity>
|
|
[parent <TaskID>] [previous <TaskID>]
|
|
[compact|formatjson]
|
|
|
|
gam <UserTypeEntity> info task <TasklistIDTaskIDEntity>
|
|
[compact|formatjson]
|
|
gam <UserTypeEntity> show tasks [tasklists <TasklistEntity>]
|
|
[completedmin <Time>] [completedmax <Time>]
|
|
[duemin <Time>] [duemax <Time>]
|
|
[updatedmin <Time>]
|
|
[showcompleted [<Boolean>]] [showdeleted [<Boolean>]] [showhidden [<Boolean>]] [showall]
|
|
[orderby completed|due|updated]
|
|
[countsonly|compact|formatjson]
|
|
gam <UserTypeEntity> print tasks [tasklists <TasklistEntity>] [todrive <ToDriveAttribute>*]
|
|
[completedmin <Time>] [completedmax <Time>]
|
|
[duemin <Time>] [duemax <Time>]
|
|
[updatedmin <Time>]
|
|
[showcompleted [<Boolean>]] [showdeleted [<Boolean>]] [showhidden [<Boolean>]] [showall]
|
|
[orderby completed|due|updated]
|
|
[countsonly | (formatjson [quotechar <Character>])]
|
|
|
|
<TasklistAttribute> ::=
|
|
(title <String>)
|
|
|
|
gam <UserTypeEntity> create tasklist
|
|
<TasklistAttribute>*
|
|
[returnidonly] [formatjson]
|
|
gam <UserTypeEntity> update tasklist <TasklistEntity>
|
|
<TasklistAttribute>*
|
|
[formatjson]
|
|
gam <UserTypeEntity> delete tasklist <TasklistEntity>
|
|
gam <UserTypeEntity> clear tasklist <TasklistEntity>
|
|
|
|
gam <UserTypeEntity> info tasklist <TasklistEntity>
|
|
[formatjson]
|
|
gam <UserTypeEntity> show tasklists
|
|
[countsonly|formatjson]
|
|
gam <UserTypeEntity> print tasklists [todrive <ToDriveAttribute>*]
|
|
[countsonly|(formatjson [quotechar <Character>])]
|
|
|
|
# Users - Shared Drives
|
|
|
|
<SharedDriveRestrictionsSubfieldName> ::=
|
|
adminmanagedrestrictions|
|
|
allowcontentmanagerstosharefolders|
|
|
copyrequireswriterpermission|
|
|
domainusersonly|
|
|
downloadrestrictedforreaders|downloadrestrictions.restrictedforreaders|
|
|
downloadrestrictedforwriters|downloadrestrictions.restrictedforwriters|
|
|
drivemembersonly|teammembersonly|
|
|
sharingfoldersrequiresorganizerpermission
|
|
|
|
Each pair of restrictions below are equivalent:
|
|
|
|
allowcontentmanagerstosharefolders true
|
|
sharingfoldersrequiresorganizerpermission false
|
|
|
|
allowcontentmanagerstosharefolders false
|
|
sharingfoldersrequiresorganizerpermission true
|
|
|
|
gam <UserTypeEntity> show shareddrivethemes
|
|
gam <UserTypeEntity> create shareddrive <Name>
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
([restrictions.]<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>]
|
|
[errorretries <Integer>] [updateinitialdelay <Integer>] [updateretrydelay <Integer>]
|
|
[(csv [todrive <ToDriveAttribute>*] (addcsvdata <FieldName> <String>)*) | returnidonly]
|
|
gam <UserTypeEntity> update shareddrive <SharedDriveEntity> [name <Name>]
|
|
[(theme|themeid <String>) | ([customtheme <DriveFileID> <Float> <Float> <Float>] [color <ColorValue>])]
|
|
([restrictions.]<SharedDriveRestrictionsSubfieldName> <Boolean>)*
|
|
[hide|hidden <Boolean>]
|
|
gam <UserTypeEntity> delete shareddrive <SharedDriveEntity>
|
|
[allowitemdeletion]
|
|
gam <UserTypeEntity> hide shareddrive <SharedDriveEntity>
|
|
gam <UserTypeEntity> unhide shareddrive <SharedDriveEntity>
|
|
gam <UserTypeEntity> info shareddrive <SharedDriveEntity> [fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> show shareddriveinfo <SharedDriveEntity> [fields <SharedDriveFieldNameList>]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print shareddrives [todrive <ToDriveAttribute>*]
|
|
[adminaccess|asadmin [teamdriveadminquery|query <QueryTeamDrive>]]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
(role|roles <SharedDriveACLRoleList>)*
|
|
[fields <SharedDriveFieldNameList>] [noorgunits [<Boolean>]]
|
|
[formatjson [quotechar <Character>]]
|
|
gam <UserTypeEntity> show shareddrives
|
|
[adminaccess|asadmin [teamdriveadminquery|query <QueryTeamDrive>]]
|
|
[matchname <REMatchPattern>] [orgunit|org|ou <OrgUnitPath>]
|
|
(role|roles <SharedDriveACLRoleList>)*
|
|
[fields <SharedDriveFieldNameList>] [noorgunits [<Boolean>]]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print shareddriveorganizers [todrive <ToDriveAttribute>*]
|
|
[adminaccess|asadmin]
|
|
[(shareddriveadminquery|query <QuerySharedDrive>) |
|
|
(shareddrives|teamdrives (<SharedDriveIDList>|(select <FileSelector>|<CSVFileSelector>)))]
|
|
[orgunit|org|ou <OrgUnitPath>]
|
|
[matchname <REMatchPattern>]
|
|
[domainlist <DomainList>]
|
|
[includetypes <OrganizerTypeList>]
|
|
[oneorganizer [<Boolean>]]
|
|
[shownorganizerdrives [false|true|only]]
|
|
[includefileorganizers [<Boolean>]]
|
|
[delimiter <Character>]
|
|
|
|
# Users - Force Signout and Turn Off 2-Step Verification
|
|
|
|
gam <UserTypeEntity> signout
|
|
gam <UserTypeEntity> turnoff2sv
|
|
|
|
# Users - Spreadsheets
|
|
|
|
See: https://developers.google.com/sheets/api/reference/rest/
|
|
The following right-hand side characters are literal: {}[],'":
|
|
The following right-hand side characters are part of the meta-syntax: <>()*|
|
|
<SpreadsheetJSONCreateRequest> ::=
|
|
'{"properties": {<SpreadsheetProperties>}, "sheets": [{<Sheet>}(,{<Sheet>})*],
|
|
"namedRanges": [{<NamedRange>}(,{<NamedRange>})*],
|
|
"developerMetadata": [{<DeveloperMetadata>}(,{<DeveloperMetadata>})]}'
|
|
<SpreadsheetJSONUpdateRequest> ::=
|
|
'{"requests": [{<Request>}(,{<Request>})], "includeSpreadsheetInResponse": true|false,
|
|
"responseRanges": ["<SpreadsheetRange>"(,"<SpreadsheetRange>")],
|
|
"responseIncludeGridData": true|false}
|
|
<SpreadsheetField> ::=
|
|
developermetadata|
|
|
namedranges|
|
|
properties|
|
|
sheets|
|
|
spreadsheetid|
|
|
spreadsheeturl
|
|
<SpreadsheetFieldList> ::= "<SpreadsheetField>(,<SpreadsheetField>)*"
|
|
<SpreadsheetSheetsField> ::=
|
|
bandedranges|
|
|
basicfilter|
|
|
charts|
|
|
columngroups|
|
|
conditionalformats|
|
|
data|
|
|
developermetadata|
|
|
filterviews|
|
|
merges|
|
|
properties|
|
|
protectedranges|
|
|
rowgroups|
|
|
slicers
|
|
<SpreadsheetSheetsFieldList> ::= "<SpreadsheetSheetsField>(,<SpreadsheetSheetsField>)*"
|
|
<SpreadsheetRange> ::= <String>
|
|
<SpreadsheetRangeList> ::= "'<SpreadsheetRange>'(,'<SpreadsheetRange>')*"
|
|
<SpreadsheetValue> ::= "<String>"|<Number>|true|false
|
|
<SpreadsheetValueList> ::= "<SpreadsheetValue>(,<SpreadsheetValue>)*"
|
|
<SpreadsheetJSONRangeValues> ::=
|
|
'{"range": <SpreadsheetRange>, "values": [<SpreadsheetValueList>(,<SpreadsheetValueList>)*],
|
|
"majorDimension": "ROWS|COLUMNS"}'
|
|
<SpreadsheetJSONRangeValuesList> ::=
|
|
'[<SpreadsheetJSONRangeValues>(,<SpreadsheetJSONRangeValues>)*]'
|
|
|
|
See: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/create
|
|
See: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets/batchUpdate
|
|
|
|
gam <UserTypeEntity> create|add sheet
|
|
((json [charset <Charset>] <SpreadsheetJSONCreateRequest>) |
|
|
(json file <FileName> [charset <Charset>]))
|
|
[<DriveFileParentAttribute>]
|
|
[formatjson] [returnidonly]
|
|
gam <UserTypeEntity> update sheet <DriveFileEntity>
|
|
((json [charset <Charset>] <SpreadsheetJSONUpdateRequest>) |
|
|
(json file <FileName> [charset <Charset>]))
|
|
[formatjson]
|
|
gam <UserTypeEntity> info|show sheet <DriveFileEntity>
|
|
[fields <SpreadsheetFieldList>] [sheetsfields <SpreadsheetSheetsFieldList>]
|
|
(range <SpreadsheetRange>)* (rangelist <SpreadsheetRangeList>)*
|
|
[includegriddata [<Boolean>]] [shownames]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print sheet <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
[fields <SpreadsheetFieldList>] [sheetsfields <SpreadsheetSheetsFieldList>]
|
|
(range <SpreadsheetRange>)* (rangelist <SpreadsheetRangeList>)*
|
|
[includegriddata [<Boolean>]] [shownames]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
See: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values#ValueRange
|
|
See: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/append
|
|
See: https://developers.google.com/sheets/api/reference/rest/v4/spreadsheets.values/batchUpdate
|
|
|
|
gam <UserTypeEntity> append sheetrange <DriveFileEntity>
|
|
((json [charset <Charset>] <SpreadsheetJSONRangeValues>|<SpreadsheetJSONRangeValuesList>) |
|
|
(json file <FileName> [charset <Charset>]))
|
|
[overwrite|insertrows]
|
|
[raw|userentered] [formula|formattedvalue|unformattedvalue] [serialnumber|formattedstring]
|
|
[includevaluesinresponse [<Boolean>]]
|
|
[formatjson]
|
|
gam <UserTypeEntity> update sheetrange <DriveFileEntity>
|
|
((json [charset <Charset>] <SpreadsheetJSONRangeValues>|<SpreadsheetJSONRangeValuesList>)+
|
|
(json file <FileName> [charset <Charset>])+)
|
|
[raw|userentered] [formula|formattedvalue|unformattedvalue] [serialnumber|formattedstring]
|
|
[includevaluesinresponse [<Boolean>]]
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> clear sheetrange <DriveFileEntity>
|
|
(range <SpreadsheetRange>)+ (rangelist <SpreadsheetRangeList>)*
|
|
[formatjson]
|
|
|
|
gam <UserTypeEntity> print sheetrange <DriveFileEntity> [todrive <ToDriveAttribute>*]
|
|
(range <SpreadsheetRange>)* (rangelist <SpreadsheetRangeList>)*
|
|
[rows|columns] [formula|formattedvalue|unformattedvalue] [serialnumber|formattedstring]
|
|
[formatjson [quotechar <Character>] [valuerangesonly [<Boolean>]]]
|
|
gam <UserTypeEntity> show sheetrange <DriveFileEntity>
|
|
(range <SpreadsheetRange>)* (rangelist <SpreadsheetRangeList>)*
|
|
[rows|columns] [formula|formattedvalue|unformattedvalue] [serialnumber|formattedstring]
|
|
[formatjson [valuerangesonly [<Boolean>]]]
|
|
|
|
# Users - Tokens
|
|
|
|
gam <UserTypeEntity> delete tokens clientid <ClientID>
|
|
|
|
gam info gcporgid
|
|
|
|
gam <UserTypeEntity> print tokens|token [todrive <ToDriveAttribute>*] [clientid <ClientID>]
|
|
[usertokencounts|(aggregateusersby|orderby clientid|id|appname|displaytext)]
|
|
[delimiter <Character>] [gcpdetails]
|
|
gam <UserTypeEntity> show tokens|token|3lo|oauth [clientid <ClientID>]
|
|
[usertokencounts|(aggregateusersby|orderby clientid|id|appname|displaytext)]
|
|
[delimiter <Character>] [gcpdetails]
|
|
gam print tokens|token [todrive <ToDriveAttribute>*] [clientid <ClientID>]
|
|
[usertokencounts|(aggregateusersby|orderby clientid|id|appname|displaytext)]
|
|
[delimiter <Character>] [gcpdetails]
|
|
[<UserTypeEntity>]
|
|
gam show tokens|token [clientid <ClientID>]
|
|
[usertokencounts|(aggregateusersby|orderby clientid|id|appname|displaytext)]
|
|
[delimiter <Character>] [gcpdetails]
|
|
[<UserTypeEntity>]
|
|
|
|
# Users - YouTube
|
|
|
|
<YouTubeChannelID> ::= <String>
|
|
<YouTubeChannelIDList> ::= "<YouTubeChannelID>(,<YouTubeChannelID>)*"
|
|
|
|
<YouTubeChannelFieldName> ::=
|
|
brandingsettings|
|
|
contentdetails|
|
|
contentownerdetails|
|
|
id|
|
|
localizations|
|
|
snippet|
|
|
statistics|
|
|
status|
|
|
topicdetails
|
|
<YouTubeChannelFieldNameList> ::= "<YouTubeChannelFieldName>(,<YouTubeChannelFieldName>)*"
|
|
|
|
gam <UserTypeEntity> show youtubechannels
|
|
(mine|
|
|
(ids|channels <YouTubeChannelIDList>)|
|
|
(forusername <String>)|
|
|
(managedbyme <String>))
|
|
[languagecode <BCP47LanguageCode>]
|
|
[allfields|(fields <YouTubeChannelFieldNameList>)]
|
|
[formatjson]
|
|
gam <UserTypeEntity> print youtubechannels [todrive <ToDriveAttribute>*]
|
|
(mine|
|
|
(ids|channels <YouTubeChannelIDList>)|
|
|
(forusername <String>)|
|
|
(managedbyme <String>))
|
|
[languagecode <BCP47LanguageCode>]
|
|
[allfields|(fields <YouTubeChannelFieldNameList>)]
|
|
[formatjson [quotechar <Character>]]
|
|
|
|
# Verifications
|
|
|
|
gam create|add verify|verification <DomainName>
|
|
gam update verify|verification <DomainName> cname|txt|text|site|file
|
|
gam info verify|verification
|
|
|
|
# Web Resourses and Sites
|
|
|
|
gam <UserTypeEntity> show webresources
|
|
gam <UserTypeEntity> print webresources [todrive <ToDriveAttribute>*]
|
|
gam <UserTypeEntity> show webmastersites
|
|
gam <UserTypeEntity> print webmastersites [todrive <ToDriveAttribute>*]
|
|
```
|