mirror of
https://github.com/GAM-team/GAM.git
synced 2026-06-03 22:01:39 +00:00
chat message searching, user attributes, license cleanup 4ba9385c
This commit is contained in:
Ross Scroggs
@@ -10,6 +10,30 @@ Add the `-s` option to the end of the above commands to suppress creating the `g
|
||||
|
||||
See [Downloads-Installs-GAM7](https://github.com/GAM-team/GAM/wiki/Downloads-Installs) for Windows or other options, including manual installation
|
||||
|
||||
### 7.44.00
|
||||
|
||||
Added support for User data `archivalTime` and `suspensionTime` that is available
|
||||
when fields `archived` and `suspended` are requested in `gam info user` and `gam print users`.
|
||||
|
||||
Added the following options to `gam <UserTypeEntity> show chatmessages` to simplify specifying a filter.
|
||||
```
|
||||
start|starttime <Date>|<Time>
|
||||
end|endtime <Date>|<Time>
|
||||
range <Date>|<Time> <Date>|<Time>
|
||||
thread <ChatThread>
|
||||
```
|
||||
|
||||
Added commands to search for and display chat messages.
|
||||
* See: https://github.com/GAM-team/GAM/wiki/Users-Chat#display-chat-messages-by-searching
|
||||
|
||||
These commands are in Developer Preview; to use them you must have these values set in `gam.cfg`.
|
||||
```
|
||||
developer_preview_apis = chat
|
||||
developer_preview_api_key = <DeveloperPreviewKey>
|
||||
```
|
||||
|
||||
Upgraded to Python 3.14.5.
|
||||
|
||||
### 7.43.10
|
||||
|
||||
Updated `gam <UserTypeEntity> forward message|thread [recipient|to] <RecipientEntity>` to not forward messages
|
||||
|
||||
@@ -251,9 +251,9 @@ writes the credentials into the file oauth2.txt.
|
||||
```
|
||||
gamteam@server:/Users/gamteam$ rm -f /Users/gamteam/GAMConfig/oauth2.txt
|
||||
gamteam@server:/Users/gamteam$ gam version
|
||||
GAM 7.43.10 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.44.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.4 64-bit final
|
||||
Python 3.14.5 64-bit final
|
||||
macOS Tahoe 26.5 arm64
|
||||
Path: /Users/gamteam/bin/gam7
|
||||
Config File: /Users/gamteam/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
@@ -1034,9 +1034,9 @@ writes the credentials into the file oauth2.txt.
|
||||
```
|
||||
C:\>del C:\GAMConfig\oauth2.txt
|
||||
C:\>gam version
|
||||
GAM 7.43.10 - https://github.com/GAM-team/GAM - pythonsource
|
||||
GAM 7.44.00 - https://github.com/GAM-team/GAM - pythonsource
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.4 64-bit final
|
||||
Python 3.14.5 64-bit final
|
||||
Windows 11 10.0.26200 AMD64
|
||||
Path: C:\GAM7
|
||||
Config File: C:\GAMConfig\gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
|
||||
@@ -50,7 +50,7 @@
|
||||
| Assured Controls | 1010390001 | assuredcontrols |
|
||||
| Assured Controls Plus | 1010390002 | assuredcontrolsplus |
|
||||
| Chrome Enterprise Premium | 1010400001 | cep | chromeenterprisepremium |
|
||||
| Cloud Identity | 1010010001 | cloudidentity |
|
||||
| Cloud Identity Free | 1010010001 | cloudidentity |
|
||||
| Cloud Identity Premium | 1010050001 | cloudidentitypremium |
|
||||
| Cloud Search | 1010350001 | cloudsearch |
|
||||
| Colab Pro | 1010500001 | colabpro |
|
||||
@@ -163,7 +163,7 @@
|
||||
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 |
|
||||
cloudidentityfree| cloudidentity | identity | 1010010001 | Cloud Identity Free |
|
||||
cloudidentitypremium | identitypremium | 1010050001 | Cloud Identity Premium |
|
||||
cloudsearch | 1010350001 | Cloud Search |
|
||||
colabpro | 1010500001 | Colab Pro |
|
||||
|
||||
@@ -16,6 +16,7 @@
|
||||
- [Display Chat Members](#display-chat-members)
|
||||
- [Manage Chat Messages](#manage-chat-messages)
|
||||
- [Display Chat Messages](#display-chat-messages)
|
||||
- [Display Chat Messages by Searching](#display-chat-messages-by-searching)
|
||||
- [Display Chat Events](#display-chat-events)
|
||||
- [Manage Chat Emojis](#manage-chat-emojis)
|
||||
- [Display Chat Emojis](#display-chat-emojis)
|
||||
@@ -65,6 +66,7 @@ Google requires that you have a Chat Bot configured in order to use the Chat API
|
||||
* [Chat API - Custom Emojis](https://developers.google.com/workspace/chat/api/reference/rest/v1/customEmojis)
|
||||
* [Chat API - Members](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.members/list)
|
||||
* [Chat API - Messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/list)
|
||||
* [Chat API - Search Messages](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/search)
|
||||
* [Chat API - Events](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.spaceEvents/list)
|
||||
* [Chat API - User Sections](https://developers.google.com/workspace/chat/api/reference/rest/v1/users.sections)
|
||||
* [Apps in Google Chat](https://support.google.com/chat/answer/7655820)
|
||||
@@ -908,7 +910,7 @@ gam user user@domain.com delete chatmessage name spaces/AAAADi-pvqc/messages/PKJ
|
||||
```
|
||||
|
||||
## Display Chat Messages
|
||||
Display a specific Chat message.
|
||||
Display a specific chat message.
|
||||
|
||||
```
|
||||
gam <UserTypeEntity> info chatmessage name <ChatMessage>
|
||||
@@ -923,12 +925,15 @@ By default, Gam displays the information as an indented list of keys and values.
|
||||
gam user user@domain.com info chatmessage name spaces/AAAADi-pvqc/messages/PKJrx90ooIU.PKJrx90ooIU
|
||||
```
|
||||
|
||||
### Display information about all chat messages in a chat space
|
||||
### Display information about chat messages in a chat space
|
||||
```
|
||||
gam <UserTypeEntity> show chatmessages
|
||||
<ChatSpace>+
|
||||
[showdeleted [<Boolean>]] [filter <String>]
|
||||
[showdeleted [<Boolean>]]
|
||||
[([start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>])|(range <Date>|<Time> <Date>|<Time>)]
|
||||
[thread <ChatThread>])
|
||||
[fields <ChatMessageFieldNameList>]
|
||||
[orderby createtime [ascending|descending]]
|
||||
[formatjson]
|
||||
```
|
||||
By default, Gam displays the information as an indented list of keys and values.
|
||||
@@ -937,8 +942,11 @@ By default, Gam displays the information as an indented list of keys and values.
|
||||
```
|
||||
gam <UserTypeEntity> print chatmessages [todrive <ToDriveAttribute>*]
|
||||
<ChatSpace>+
|
||||
[showdeleted [<Boolean>]] [filter <String>]
|
||||
[showdeleted [<Boolean>]]
|
||||
[([start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>])|(range <Date>|<Time> <Date>|<Time>)]
|
||||
[thread <ChatThread>])
|
||||
[fields <ChatMessageFieldNameList>]
|
||||
[orderby createtime [ascending|descending]]
|
||||
[formatjson [quotechar <Character>]]
|
||||
```
|
||||
By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,
|
||||
@@ -952,38 +960,73 @@ The `quotechar <Character>` option allows you to choose an alternate quote chara
|
||||
|
||||
By default, deleted messages are not displayed; use `showdeleted` to also display deleted messages.
|
||||
|
||||
Use `filter <String>` to filter messages by `createTime` and `thread.name`.
|
||||
To filter messages by the time they were created:
|
||||
* `start|starttime <Date>|<Time>` - Display messages created on or after the `<Date>|<Time>`
|
||||
* `end|endtime <Date>|<Time>` - Display messages created before the `<Date>|<Time>`
|
||||
* `range <Date>|<Time> <Date>|<Time>` - Display messages created on or after the first `<Date>|<Time>` and before the second `<Date>|<Time>`
|
||||
|
||||
To filter messages by the date they were created, specify the createTime with a timestamp in RFC-3339 format and double quotation marks. For example, "2023-04-21T11:30:00-04:00".
|
||||
* Use the greater than operator `>` to list messages that were created after a timestamp.
|
||||
* Use the less than operator `<` to list messages that were created before a timestamp.
|
||||
* To filter messages within a time interval, use the AND operator between two timestamps.
|
||||
* To filter by thread, specify the thread.name, formatted as spaces/{space}/threads/{thread}. You can only specify one thread.name per query.
|
||||
* To filter by both thread and date, use the AND operator in your query.
|
||||
Use `thread <String>` to filter messages by their thread name, e.g., `spaces/AAAAAAAAAAA/threads/123`.
|
||||
|
||||
For example, the following queries are valid on Linux/MacOS:
|
||||
## Display Chat Messages by Searching
|
||||
These commands are in Developer Preview; to use them you must have these values set in `gam.cfg`.
|
||||
```
|
||||
filter 'createTime > "2012-04-21T11:30:00-04:00"'
|
||||
filter 'createTime > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123'
|
||||
filter 'createTime > "2012-04-21T11:30:00+00:00" AND createTime < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123'
|
||||
filter 'thread.name = spaces/AAAAAAAAAAA/threads/123'
|
||||
developer_preview_apis = chat
|
||||
developer_preview_api_key = <DeveloperPreviewKey>
|
||||
```
|
||||
See the following for search option details:
|
||||
https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces.messages/search
|
||||
|
||||
For example, the following queries are valid on Windows Command Prompt:
|
||||
```
|
||||
filter "createTime > \"2012-04-21T11:30:00-04:00\""
|
||||
filter "createTime > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123"
|
||||
filter "createTime > \"2012-04-21T11:30:00+00:00\" AND createTime < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123"
|
||||
filter "thread.name = spaces/AAAAAAAAAAA/threads/123"
|
||||
```
|
||||
You must specify `keywords <StringList>`; messages that match any word in `<StringList>` are displayed.
|
||||
|
||||
For example, the following queries are valid on Windows PowerShell:
|
||||
By default, all spaces the user has access to are searched; use the following options to limit the search.
|
||||
* `<ChatSpace>*` - Specific chat spaces
|
||||
* `displaynames [all|any] <StringList>` - Spaces with display names with partial matches of `all|any` of the words in `<StringList>`
|
||||
|
||||
Use the following to limit the search to messages with specific characteristics.
|
||||
* `senders <EmailAddressEntity>` - Messages with any sender in `<EmailAddressEntity>`
|
||||
* `usermentions [all|any] <EmailAddressEntity>` - Messages with mentions af `all|any` users in `<EmailAddressEntity>`
|
||||
* `start|starttime <Date>|<Time>` - Messages created on or after the `<Date>|<Time>`
|
||||
* `end|endtime <Date>|<Time>` - Messages created before the `<Date>|<Time>`
|
||||
* `range <Date>|<Time> <Date>|<Time>` - Messages created on or after the first `<Date>|<Time>` and before the second `<Date>|<Time>`
|
||||
* `hasattachment` - Messages with at least one attachment
|
||||
```
|
||||
filter 'createTime > \"2012-04-21T11:30:00-04:00\"'
|
||||
filter 'createTime > \"2012-04-21T11:30:00-04:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123"'
|
||||
filter 'createTime > \"2012-04-21T11:30:00+00:00\" AND createTime < \"2013-01-01T00:00:00+00:00\" AND thread.name = spaces/AAAAAAAAAAA/threads/123'
|
||||
filter 'thread.name = spaces/AAAAAAAAAAA/threads/123'
|
||||
gam <UserTypeEntity> show chatsearchmessages
|
||||
keywords <StringList>
|
||||
<ChatSpace>*
|
||||
[displaynames [all|any] <StringList>]
|
||||
[senders <EmailAddressEntity>]*
|
||||
[usermentions [all|any] <EmailAddressEntity>]*
|
||||
[([start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>])|(range <Date>|<Time> <Date>|<Time>)]
|
||||
[hasattachment]
|
||||
[fields <ChatMessageFieldNameList>]
|
||||
[orderby createtime|relevance]
|
||||
[formatjson]
|
||||
```
|
||||
By default, Gam displays the information as an indented list of keys and values.
|
||||
* `formatjson` - Display the fields in JSON format.
|
||||
|
||||
```
|
||||
gam <UserTypeEntity> print chatsearchmessages [todrive <ToDriveAttribute>*]
|
||||
keywords <StringList>
|
||||
<ChatSpace>*
|
||||
[displaynames [all|any] <StringList>]
|
||||
[senders <EmailAddressEntity>]*
|
||||
[usermentions [all|any] <EmailAddressEntity>]*
|
||||
[([start|starttime <Date>|<Time>] [end|endtime <Date>|<Time>])|(range <Date>|<Time> <Date>|<Time>)]
|
||||
[hasattachment]
|
||||
[fields <ChatMessageFieldNameList>]
|
||||
[orderby createtime|relevance]
|
||||
[formatjson [quotechar <Character>]]
|
||||
```
|
||||
By default, Gam displays the information as columns of fields; the following option causes the output to be in JSON format,
|
||||
* `formatjson` - Display the fields in JSON format.
|
||||
|
||||
By default, when writing CSV files, Gam uses a quote character of double quote `"`. The quote character is used to enclose columns that contain
|
||||
the quote character itself, the column delimiter (comma by default) and new-line characters. Any quote characters within the column are doubled.
|
||||
When using the `formatjson` option, double quotes are used extensively in the data resulting in hard to read/process output.
|
||||
The `quotechar <Character>` option allows you to choose an alternate quote character, single quote for instance, that makes for readable/processable output.
|
||||
`quotechar` defaults to `gam.cfg/csv_output_quote_char`. When uploading CSV files to Google, double quote `"` should be used.
|
||||
|
||||
|
||||
## Display Chat Events
|
||||
Display a specific Chat event.
|
||||
|
||||
@@ -3,9 +3,9 @@
|
||||
Print the current version of Gam with details
|
||||
```
|
||||
gam version
|
||||
GAM 7.43.10 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.44.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.4 64-bit final
|
||||
Python 3.14.5 64-bit final
|
||||
macOS Tahoe 26.5 arm64
|
||||
Path: /Users/gamteam/bin/gam7
|
||||
Config File: /Users/gamteam/GamConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
@@ -15,9 +15,9 @@ Time: 2026-02-15T07:51:00-08:00
|
||||
Print the current version of Gam with details and time offset information
|
||||
```
|
||||
gam version timeoffset
|
||||
GAM 7.43.10 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.44.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.4 64-bit final
|
||||
Python 3.14.5 64-bit final
|
||||
macOS Tahoe 26.5 arm64
|
||||
Path: /Users/gamteam/bin/gam7
|
||||
Config File: /Users/admin/GAMConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
@@ -27,9 +27,9 @@ Your system time differs from www.googleapis.com by less than 1 second
|
||||
Print the current version of Gam with extended details and SSL information
|
||||
```
|
||||
gam version extended
|
||||
GAM 7.43.10 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM 7.44.00 - https://github.com/GAM-team/GAM - pyinstaller
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.4 64-bit final
|
||||
Python 3.14.5 64-bit final
|
||||
macOS Tahoe 26.5 arm64
|
||||
Path: /Users/gamteam/bin/gam7
|
||||
Config File: /Users/gamteam/GamConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
@@ -68,7 +68,7 @@ MacOS High Sierra 10.13.6 x86_64
|
||||
Path: /Users/gamteam/bin/gam7
|
||||
Version Check:
|
||||
Current: 5.35.08
|
||||
Latest: 7.43.10
|
||||
Latest: 7.44.00
|
||||
echo $?
|
||||
1
|
||||
```
|
||||
@@ -76,7 +76,7 @@ echo $?
|
||||
Print the current version number without details
|
||||
```
|
||||
gam version simple
|
||||
7.43.10
|
||||
7.44.00
|
||||
```
|
||||
In Linux/MacOS you can do:
|
||||
```
|
||||
@@ -86,9 +86,9 @@ echo $VER
|
||||
Print the current version of Gam and address of this Wiki
|
||||
```
|
||||
gam help
|
||||
GAM 7.43.10 - https://github.com/GAM-team/GAM
|
||||
GAM 7.44.00 - https://github.com/GAM-team/GAM
|
||||
GAM Team <google-apps-manager@googlegroups.com>
|
||||
Python 3.14.4 64-bit final
|
||||
Python 3.14.5 64-bit final
|
||||
macOS Tahoe 26.5 arm64
|
||||
Path: /Users/gamteam/bin/gam7
|
||||
Config File: /Users/gamteam/GamConfig/gam.cfg, Section: DEFAULT, customer_id: my_customer, domain: domain.com
|
||||
|
||||
Reference in New Issue
Block a user