batch
Batch updates Domain Shared Contacts using a CSV file as input
Synopsis
Implements the API documented at https://developers.google.com/admin-sdk/domain-shared-contacts
gsm sharedContacts update batch [flags]
Options
--additionalName int Additional name of the person, eg. middle name.
--additionalName_ALL string Same as additionalName but value is applied to all lines in the CSV file
--batchThreads int Specify the number of threads that should be used for batch commands (overrides value in config file. Max 16)
--delimiter string Delimiter to use for CSV columns. Must be exactly one character. Default is ';'
--email int Email.
Must be in the form of "address=user@domain.com;displayName=Some Name;primary=[true|false];label=[Work|Home]".
Can be used multiple time (although "primary" may only be used once
--email_ALL strings Same as email but value is applied to all lines in the CSV file
--extendedProperty int Extended Properties
Must be in the form of "name=Some Name;Value=Some Value;Realm=Some Realm"
--extendedProperty_ALL strings Same as extendedProperty but value is applied to all lines in the CSV file
--familyName int Person's family name.
--familyName_ALL string Same as familyName but value is applied to all lines in the CSV file
--fullName int Unstructured representation of the name.
--fullName_ALL string Same as fullName but value is applied to all lines in the CSV file
--givenName int Person's given name.
--givenName_ALL string Same as givenName but value is applied to all lines in the CSV file
-h, --help help for batch
--im int IM addresses.
Must be in the form of "protocol=http://schemas.google.com/g/2005#GOOGLE_TALK;address=some@address.com;primary=[true|false]label=[Work|Home|Mobile]".
Can be used multiple time (although "primary" may only be used once
--im_ALL strings Same as im but value is applied to all lines in the CSV file
--json int Output as JSON"
--json_ALL Same as json but value is applied to all lines in the CSV file
--namePrefix int Honorific prefix, eg. 'Mr' or 'Mrs'.
--namePrefix_ALL string Same as namePrefix but value is applied to all lines in the CSV file
--nameSuffix int Honorific suffix, eg. 'san' or 'III'.
--nameSuffix_ALL string Same as nameSuffix but value is applied to all lines in the CSV file
--organization int Organization of the contact.
Must be in the form of "orgName=Some Company;orgDepartment=Some Department;orgTitle=Some Title;orgJobDescription=Some Description;orgSymbol=Some Symbol"
--organization_ALL strings Same as organization but value is applied to all lines in the CSV file
--path string Path of the import file (CSV)
--phoneNumber int Phone number.
Must be in the form of "phoneNumber=+1 212 213181;primary=[true|false]label=[Work|Home|Mobile]".
Can be used multiple time (although "primary" may only be used once
--phoneNumber_ALL strings Same as phoneNumber but value is applied to all lines in the CSV file
--skipHeader Whether to skip the first row (header)
--structuredPostalAddress int Structed Postal Address
Must be in the form of "mailClass=...;label=...;usage=...;primary=[true|false];agent=...;housename=...;street=...;pobox=...neighborhood=...;city=...;subregion=...;region=...;postcode=...;country=...;formattedAddress=..."
--structuredPostalAddress_ALL strings Same as structuredPostalAddress but value is applied to all lines in the CSV file
--url int URL of the Shared Contact (Retrieve with "list" and look for "id").
MUST BE https://!
Options inherited from parent commands
--compressOutput By default, GSM outputs "pretty" (indented) objects. By setting this flag, GSM's output will be compressed. This may or may not improve performance in scripts.
--config string config file (default is $HOME/.config/gsm/.gsm.yaml)
--delay int This delay (plus a random jitter between 0 and 50) will be applied after every command to avoid reaching quota and rate limits. Set to 0 to disable.
--dwdSubject string Specify a subject used for DWD impersonation (overrides value in config file)
--log string Set the path of the log file. Default is either ~/gsm.log or defined in your config file
--maxElapsedTime int This is the maximum total time that will be spent retrying a request in minutes. (default 15)
--maxRetryInterval int This is the maximum interval that will be used between retry attempts in seconds. (default 320)
--redirectPort int This is the TCP port on which GSM will create web server if you authenticate with a user account for the first time. This is necessary for the OAuth flow. See https://developers.google.com/identity/protocols/oauth2/native-app#redirect-uri_loopback (default 8081)
--retryOn ints Specify the HTTP error code(s) that GSM should retry on. Note that GSM will always retry on HTTP 403 errors that indicate a quota / rate limit error
--streamOutput Setting this flag will cause GSM to output slice values to stdout one by one, instead of one large object
SEE ALSO
- gsm sharedContacts update - Update a shared contact