View Source GoogleApi.Chat.V1.Api.Spaces (google_api_chat v0.41.6)
API calls for all endpoints tagged Spaces
.
Summary
Functions
Completes the import process for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see Authorize Google Chat apps to import data.
Creates a space. Can be used to create a named space, or a group chat in Import mode
. For an example, see Create a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication When authenticating as an app, the space.customer
field must be set in the request. Space membership upon creation depends on whether the space is created in Import mode
: Import mode: No members are created. All other modes: The calling user is added as a member. This is: The app itself when using app authentication. The human user when using user authentication. If you receive the error message ALREADY_EXISTS
when creating a space, try a different displayName
. An existing space within the Google Workspace organization might already use this display name.
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND
error. For an example, see Find a direct message. With app authentication, returns the direct message space between the specified user and the calling Chat app. With user authentication, returns the direct message space between the specified user and the authenticated user. // Supports the following types of authentication: - App authentication - User authentication
Returns details about a space. For an example, see Get details about a space. Supports the following types of authentication: - App authentication - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Supports the following types of authentication: - App authentication - User authentication To list all named spaces by Google Workspace organization, use the spaces.search()
method using Workspace administrator privileges instead.
Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request. For example usage, see: - Invite or add a user to a space. - Invite or add a Google Group to a space. - Add the Chat app to a space.
Deletes a membership. For an example, see Remove a user or a Google Chat app from a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership. Supports the following types of authentication: - App authentication - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Supports the following types of authentication: - App authentication - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Updates a membership. For an example, see Update a user's membership in a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Gets the metadata of a message attachment. The attachment data is fetched using the media API. For an example, see Get metadata about a message attachment. Requires app authentication.
Creates a message in a Google Chat space. For an example, see Send a message. The create()
method requires either user authentication or app authentication. Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (text
), cards (cardsV2
), and accessory widgets (accessoryWidgets
). The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (
text
). The maximum message size, including the message contents, is 32,000 bytes. For webhook requests, the response doesn't contain the full message. The response only populates the
name
and thread.name
fields in addition to the information that was in the request.
Deletes a message. For an example, see Delete a message. Supports the following types of authentication: - App authentication - User authentication When using app authentication, requests can only delete messages created by the calling Chat app.
Returns details about a message. For an example, see Get details about a message. Supports the following types of authentication: - App authentication - User authentication Note: Might return a message from a blocked member or space.
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, {}
. For an example, see List messages. Requires user authentication.
Updates a message. There's a difference between the patch
and update
methods. The patch
method uses a patch
request while the update
method uses a put
request. We recommend using the patch
method. For an example, see Update a message. Supports the following types of authentication: - App authentication - User authentication When using app authentication, requests can only update messages created by the calling Chat app.
Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see Add a reaction to a message. Requires user authentication.
Deletes a reaction to a message. Only unicode emojis are supported. For an example, see Delete a reaction. Requires user authentication.
Lists reactions to a message. For an example, see List reactions for a message. Requires user authentication.
Updates a message. There's a difference between the patch
and update
methods. The patch
method uses a patch
request while the update
method uses a put
request. We recommend using the patch
method. For an example, see Update a message. Supports the following types of authentication: - App authentication - User authentication When using app authentication, requests can only update messages created by the calling Chat app.
Updates a space. For an example, see Update a space. If you're updating the displayName
field and receive the error message ALREADY_EXISTS
, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires user authentication with administrator privileges. In the request, set use_admin_access
to true
.
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriate membership.member.name
. To add a human user, use users/{user}
, where {user}
can be the email address for the user. For users in the same Workspace organization {user}
can also be the id
for the person from the People API, or the id
for the user in the Directory API. For example, if the People API Person profile ID for user@example.com
is 123456789
, you can add the user to the space by setting the membership.member.name
to users/user@example.com
or users/123456789
. To specify the Google groups to add, add memberships with the appropriate membership.group_member.name
. To add or invite a Google group, use groups/{group}
, where {group}
is the id
for the group from the Cloud Identity Groups API. For example, you can use Cloud Identity Groups lookup API to retrieve the ID 123456789
for group email group@example.com
, then you can add the group to the space by setting the membership.group_member.name
to groups/123456789
. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set Space.singleUserBotDm
to true
and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or add a user or app to a space. If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message ALREADY_EXISTS
when setting up a space, try a different displayName
. An existing space within the Google Workspace organization might already use this display name. Requires user authentication.
Returns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Message
resource in the event payload. Note: The permissionSettings
field is not returned in the Space object of the Space event data for this request. Requires user authentication. To get an event, the authenticated user must be a member of the space. For an example, see Get details about an event from a Google Chat space.
Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership
resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership
resource. Requires user authentication. To list events, the authenticated user must be a member of the space. For an example, see List events from a Google Chat space.
Functions
@spec chat_spaces_complete_import( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.CompleteImportSpaceResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Completes the import process for the specified space and makes it visible to users. Requires app authentication and domain-wide delegation. For more information, see Authorize Google Chat apps to import data.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the import mode space. Format:spaces/{space}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Chat.V1.Model.CompleteImportSpaceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.CompleteImportSpaceResponse{}}
on success -
{:error, info}
on failure
@spec chat_spaces_create(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Space.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a space. Can be used to create a named space, or a group chat in Import mode
. For an example, see Create a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication When authenticating as an app, the space.customer
field must be set in the request. Space membership upon creation depends on whether the space is created in Import mode
: Import mode: No members are created. All other modes: The calling user is added as a member. This is: The app itself when using app authentication. The human user when using user authentication. If you receive the error message ALREADY_EXISTS
when creating a space, try a different displayName
. An existing space within the Google Workspace organization might already use this display name.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:requestId
(type:String.t
) - Optional. A unique identifier for this request. A random UUID is recommended. Specifying an existing request ID returns the space created with that ID instead of creating a new space. Specifying an existing request ID from the same Chat app with a different authenticated user returns an error. -
:body
(type:GoogleApi.Chat.V1.Model.Space.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Space{}}
on success -
{:error, info}
on failure
@spec chat_spaces_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a named space. Always performs a cascading delete, which means that the space's child resources—like messages posted in the space and memberships in the space—are also deleted. For an example, see Delete a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the space to delete. Format:spaces/{space}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.delete
OAuth 2.0 scope.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec chat_spaces_find_direct_message(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Space.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns the existing direct message with the specified user. If no direct message space is found, returns a 404 NOT_FOUND
error. For an example, see Find a direct message. With app authentication, returns the direct message space between the specified user and the calling Chat app. With user authentication, returns the direct message space between the specified user and the authenticated user. // Supports the following types of authentication: - App authentication - User authentication
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:name
(type:String.t
) - Required. Resource name of the user to find direct message with. Format:users/{user}
, where{user}
is either theid
for the person from the People API, or theid
for the user in the Directory API. For example, if the People API profile ID is123456789
, you can find a direct message with that person by usingusers/123456789
as thename
. When authenticated as a user, you can use the email as an alias for{user}
. For example,users/example@gmail.com
whereexample@gmail.com
is the email of the Google Chat user.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Space{}}
on success -
{:error, info}
on failure
@spec chat_spaces_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Space.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns details about a space. For an example, see Get details about a space. Supports the following types of authentication: - App authentication - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the space, in the formspaces/{space}
. Format:spaces/{space}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.spaces
orchat.admin.spaces.readonly
OAuth 2.0 scopes.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Space{}}
on success -
{:error, info}
on failure
@spec chat_spaces_list(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.ListSpacesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists spaces the caller is a member of. Group chats and DMs aren't listed until the first message is sent. For an example, see List spaces. Supports the following types of authentication: - App authentication - User authentication To list all named spaces by Google Workspace organization, use the spaces.search()
method using Workspace administrator privileges instead.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. A query filter. You can filter spaces by the space type (space_type
). To filter by space type, you must specify valid enum value, such asSPACE
orGROUP_CHAT
(thespace_type
can't beSPACE_TYPE_UNSPECIFIED
). To query for multiple space types, use theOR
operator. For example, the following queries are valid:space_type = "SPACE" spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error. -
:pageSize
(type:integer()
) - Optional. The maximum number of spaces to return. The service might return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return anINVALID_ARGUMENT
error. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previous list spaces call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value may lead to unexpected results.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.ListSpacesResponse{}}
on success -
{:error, info}
on failure
@spec chat_spaces_members_create(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Membership.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a membership for the calling Chat app, a user, or a Google Group. Creating memberships for other Chat apps isn't supported. When creating a membership, if the specified member has their auto-accept policy turned off, then they're invited, and must accept the space invitation before joining. Otherwise, creating a membership adds the member directly to the specified space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request. For example usage, see: - Invite or add a user to a space. - Invite or add a Google Group to a space. - Add the Chat app to a space.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the space for which to create the membership. Format: spaces/{space} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.memberships
OAuth 2.0 scope. Creating app memberships or creating memberships for users outside the administrator's Google Workspace organization isn't supported using admin access. -
:body
(type:GoogleApi.Chat.V1.Model.Membership.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Membership{}}
on success -
{:error, info}
on failure
@spec chat_spaces_members_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Membership.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a membership. For an example, see Remove a user or a Google Chat app from a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the membership to delete. Chat apps can delete human users' or their own memberships. Chat apps can't delete other apps' memberships. When deleting a human membership, requires thechat.memberships
scope andspaces/{space}/members/{member}
format. You can use the email as an alias for{member}
. For example,spaces/{space}/members/example@gmail.com
whereexample@gmail.com
is the email of the Google Chat user. When deleting an app membership, requires thechat.memberships.app
scope andspaces/{space}/members/app
format. Format:spaces/{space}/members/{member}
orspaces/{space}/members/app
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.memberships
OAuth 2.0 scope. Deleting app memberships in a space isn't supported using admin access.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Membership{}}
on success -
{:error, info}
on failure
@spec chat_spaces_members_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Membership.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns details about a membership. For an example, see Get details about a user's or Google Chat app's membership. Supports the following types of authentication: - App authentication - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the membership to retrieve. To get the app's own membership by using user authentication, you can optionally usespaces/{space}/members/app
. Format:spaces/{space}/members/{member}
orspaces/{space}/members/app
You can use the user's email as an alias for{member}
. For example,spaces/{space}/members/example@gmail.com
whereexample@gmail.com
is the email of the Google Chat user. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.memberships
orchat.admin.memberships.readonly
OAuth 2.0 scopes. Getting app memberships in a space isn't supported when using admin access.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Membership{}}
on success -
{:error, info}
on failure
@spec chat_spaces_members_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.ListMembershipsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists memberships in a space. For an example, see List users and Google Chat apps in a space. Listing memberships with app authentication lists memberships in spaces that the Chat app has access to, but excludes Chat app memberships, including its own. Listing memberships with User authentication lists memberships in spaces that the authenticated user has access to. Supports the following types of authentication: - App authentication - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the space for which to fetch a membership list. Format: spaces/{space} -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. A query filter. You can filter memberships by a member's role (role
) and type (member.type
). To filter by role, setrole
toROLE_MEMBER
orROLE_MANAGER
. To filter by type, setmember.type
toHUMAN
orBOT
. You can also filter formember.type
using the!=
operator. To filter by both role and type, use theAND
operator. To filter by either role or type, use theOR
operator. Eithermember.type = "HUMAN"
ormember.type != "BOT"
is required whenuse_admin_access
is set to true. Other member type filters will be rejected. For example, the following queries are valid:role = "ROLE_MANAGER" OR role = "ROLE_MEMBER" member.type = "HUMAN" AND role = "ROLE_MANAGER" member.type != "BOT"
The following queries are invalid:member.type = "HUMAN" AND member.type = "BOT" role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error. -
:pageSize
(type:integer()
) - Optional. The maximum number of memberships to return. The service might return fewer than this value. If unspecified, at most 100 memberships are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return anINVALID_ARGUMENT
error. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previous call to list memberships. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. -
:showGroups
(type:boolean()
) - Optional. Whentrue
, also returns memberships associated with a Google Group, in addition to other types of memberships. If a filter is set, Google Group memberships that don't match the filter criteria aren't returned. -
:showInvited
(type:boolean()
) - Optional. Whentrue
, also returns memberships associated with invited members, in addition to other types of memberships. If a filter is set, invited memberships that don't match the filter criteria aren't returned. Currently requires user authentication. -
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires either thechat.admin.memberships.readonly
orchat.admin.memberships
OAuth 2.0 scope. Listing app memberships in a space isn't supported when using admin access.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.ListMembershipsResponse{}}
on success -
{:error, info}
on failure
@spec chat_spaces_members_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Membership.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a membership. For an example, see Update a user's membership in a space. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. Resource name of the membership, assigned by the server. Format:spaces/{space}/members/{member}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The field paths to update. Separate multiple values with commas or use*
to update all field paths. Currently supported field paths: -role
-
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.memberships
OAuth 2.0 scope. -
:body
(type:GoogleApi.Chat.V1.Model.Membership.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Membership{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_attachments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.Attachment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the metadata of a message attachment. The attachment data is fetched using the media API. For an example, see Get metadata about a message attachment. Requires app authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the attachment, in the formspaces/{space}/messages/{message}/attachments/{attachment}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Attachment{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a message in a Google Chat space. For an example, see Send a message. The create()
method requires either user authentication or app authentication. Chat attributes the message sender differently depending on the type of authentication that you use in your request. The following image shows how Chat attributes a message when you use app authentication. Chat displays the Chat app as the message sender. The content of the message can contain text (text
), cards (cardsV2
), and accessory widgets (accessoryWidgets
). The following image shows how Chat attributes a message when you use user authentication. Chat displays the user as the message sender and attributes the Chat app to the message by displaying its name. The content of message can only contain text (
text
). The maximum message size, including the message contents, is 32,000 bytes. For webhook requests, the response doesn't contain the full message. The response only populates the
name
and thread.name
fields in addition to the information that was in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the space in which to create a message. Format:spaces/{space}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:messageId
(type:String.t
) - Optional. A custom ID for a message. Lets Chat apps get, update, or delete a message without needing to store the system-assigned ID in the message's resource name (represented in the messagename
field). The value for this field must meet the following requirements: Begins withclient-
. For example,client-custom-name
is a valid custom ID, butcustom-name
is not. Contains up to 63 characters and only lowercase letters, numbers, and hyphens. * Is unique within a space. A Chat app can't use the same custom ID for different messages. For details, see Name a message. -
:messageReplyOption
(type:String.t
) - Optional. Specifies whether a message starts a thread or replies to one. Only supported in named spaces. When responding to user interactions, this field is ignored. For interactions within a thread, the reply is created in the same thread. Otherwise, the reply is created as a new thread. -
:requestId
(type:String.t
) - Optional. A unique request ID for this message. Specifying an existing request ID returns the message created with that ID instead of creating a new message. -
:threadKey
(type:String.t
) - Optional. Deprecated: Use thread.thread_key instead. ID for the thread. Supports up to 4000 characters. To start or add to a thread, create a message and specify athreadKey
or the thread.name. For example usage, see Start or reply to a message thread. -
:body
(type:GoogleApi.Chat.V1.Model.Message.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Message{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a message. For an example, see Delete a message. Supports the following types of authentication: - App authentication - User authentication When using app authentication, requests can only delete messages created by the calling Chat app.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the message. Format:spaces/{space}/messages/{message}
If you've set a custom ID for your message, you can use the value from theclientAssignedMessageId
field for{message}
. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:force
(type:boolean()
) - Optional. Whentrue
, deleting a message also deletes its threaded replies. Whenfalse
, if a message has threaded replies, deletion fails. Only applies when authenticating as a user. Has no effect when [authenticating as a Chat app] (https://developers.google.com/workspace/chat/authenticate-authorize-chat-app).
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_get(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns details about a message. For an example, see Get details about a message. Supports the following types of authentication: - App authentication - User authentication Note: Might return a message from a blocked member or space.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the message. Format:spaces/{space}/messages/{message}
If you've set a custom ID for your message, you can use the value from theclientAssignedMessageId
field for{message}
. For details, see [Name a message] (https://developers.google.com/workspace/chat/create-messages#name_a_created_message). -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Message{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_list(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.ListMessagesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists messages in a space that the caller is a member of, including messages from blocked members and spaces. If you list messages from a space with no messages, the response is an empty object. When using a REST/HTTP interface, the response contains an empty JSON object, {}
. For an example, see List messages. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The resource name of the space to list messages from. Format:spaces/{space}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. A query filter. You can filter messages by date (create_time
) and thread (thread.name
). To filter messages by the date they were created, specify thecreate_time
with a timestamp in RFC-3339 format and double quotation marks. For example,"2023-04-21T11:30:00-04:00"
. You can use the greater than operator>
to list messages that were created after a timestamp, or the less than operator<
to list messages that were created before a timestamp. To filter messages within a time interval, use theAND
operator between two timestamps. To filter by thread, specify thethread.name
, formatted asspaces/{space}/threads/{thread}
. You can only specify onethread.name
per query. To filter by both thread and date, use theAND
operator in your query. For example, the following queries are valid:create_time > "2012-04-21T11:30:00-04:00" create_time > "2012-04-21T11:30:00-04:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 create_time > "2012-04-21T11:30:00+00:00" AND create_time < "2013-01-01T00:00:00+00:00" AND thread.name = spaces/AAAAAAAAAAA/threads/123 thread.name = spaces/AAAAAAAAAAA/threads/123
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error. -
:orderBy
(type:String.t
) - Optional. How the list of messages is ordered. Specify a value to order by an ordering operation. Valid ordering operation values are as follows: -ASC
for ascending. -DESC
for descending. The default ordering iscreate_time ASC
. -
:pageSize
(type:integer()
) - Optional. The maximum number of messages returned. The service might return fewer messages than this value. If unspecified, at most 25 are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. Negative values return anINVALID_ARGUMENT
error. -
:pageToken
(type:String.t
) - Optional. A page token received from a previous list messages call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. -
:showDeleted
(type:boolean()
) - Optional. Whether to include deleted messages. Deleted messages include deleted time and metadata about their deletion, but message content is unavailable.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.ListMessagesResponse{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a message. There's a difference between the patch
and update
methods. The patch
method uses a patch
request while the update
method uses a put
request. We recommend using the patch
method. For an example, see Update a message. Supports the following types of authentication: - App authentication - User authentication When using app authentication, requests can only update messages created by the calling Chat app.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. Resource name of the message. Format:spaces/{space}/messages/{message}
Where{space}
is the ID of the space where the message is posted and{message}
is a system-assigned ID for the message. For example,spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB
. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing{message}
with the value from theclientAssignedMessageId
field. For example,spaces/AAAAAAAAAAA/messages/client-custom-name
. For details, see Name a message. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - Optional. Iftrue
and the message isn't found, a new message is created andupdateMask
is ignored. The specified message ID must be client-assigned or the request fails. -
:updateMask
(type:String.t
) - Required. The field paths to update. Separate multiple values with commas or use*
to update all field paths. Currently supported field paths: -text
-attachment
-cards
(Requires app authentication.) -cards_v2
(Requires app authentication.) -accessory_widgets
(Requires app authentication.) -
:body
(type:GoogleApi.Chat.V1.Model.Message.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Message{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_reactions_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.Reaction.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a reaction and adds it to a message. Only unicode emojis are supported. For an example, see Add a reaction to a message. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The message where the reaction is created. Format:spaces/{space}/messages/{message}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Chat.V1.Model.Reaction.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Reaction{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_reactions_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.Empty.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes a reaction to a message. Only unicode emojis are supported. For an example, see Delete a reaction. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Name of the reaction to delete. Format:spaces/{space}/messages/{message}/reactions/{reaction}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Empty{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_reactions_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.ListReactionsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists reactions to a message. For an example, see List reactions for a message. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The message users reacted to. Format:spaces/{space}/messages/{message}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Optional. A query filter. You can filter reactions by emoji (eitheremoji.unicode
oremoji.custom_emoji.uid
) and user (user.name
). To filter reactions for multiple emojis or users, join similar fields with theOR
operator, such asemoji.unicode = "🙂" OR emoji.unicode = "👍"
anduser.name = "users/AAAAAA" OR user.name = "users/BBBBBB"
. To filter reactions by emoji and user, use theAND
operator, such asemoji.unicode = "🙂" AND user.name = "users/AAAAAA"
. If your query uses bothAND
andOR
, group them with parentheses. For example, the following queries are valid:user.name = "users/{user}" emoji.unicode = "🙂" emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR emoji.unicode = "👍" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" AND user.name = "users/{user}" (emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}") AND user.name = "users/{user}"
The following queries are invalid:emoji.unicode = "🙂" AND emoji.unicode = "👍" emoji.unicode = "🙂" AND emoji.custom_emoji.uid = "{uid}" emoji.unicode = "🙂" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" OR user.name = "users/{user}" emoji.unicode = "🙂" OR emoji.custom_emoji.uid = "{uid}" AND user.name = "users/{user}"
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error. -
:pageSize
(type:integer()
) - Optional. The maximum number of reactions returned. The service can return fewer reactions than this value. If unspecified, the default value is 25. The maximum value is 200; values above 200 are changed to 200. -
:pageToken
(type:String.t
) - Optional. (If resuming from a previous query.) A page token received from a previous list reactions call. Provide this to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.ListReactionsResponse{}}
on success -
{:error, info}
on failure
@spec chat_spaces_messages_update( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.Message.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a message. There's a difference between the patch
and update
methods. The patch
method uses a patch
request while the update
method uses a put
request. We recommend using the patch
method. For an example, see Update a message. Supports the following types of authentication: - App authentication - User authentication When using app authentication, requests can only update messages created by the calling Chat app.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. Resource name of the message. Format:spaces/{space}/messages/{message}
Where{space}
is the ID of the space where the message is posted and{message}
is a system-assigned ID for the message. For example,spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB
. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing{message}
with the value from theclientAssignedMessageId
field. For example,spaces/AAAAAAAAAAA/messages/client-custom-name
. For details, see Name a message. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:allowMissing
(type:boolean()
) - Optional. Iftrue
and the message isn't found, a new message is created andupdateMask
is ignored. The specified message ID must be client-assigned or the request fails. -
:updateMask
(type:String.t
) - Required. The field paths to update. Separate multiple values with commas or use*
to update all field paths. Currently supported field paths: -text
-attachment
-cards
(Requires app authentication.) -cards_v2
(Requires app authentication.) -accessory_widgets
(Requires app authentication.) -
:body
(type:GoogleApi.Chat.V1.Model.Message.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Message{}}
on success -
{:error, info}
on failure
@spec chat_spaces_patch(Tesla.Env.client(), String.t(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Space.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a space. For an example, see Update a space. If you're updating the displayName
field and receive the error message ALREADY_EXISTS
, try a different display name.. An existing space within the Google Workspace organization might already use this display name. Supports the following types of authentication: - App authentication with administrator approval in Developer Preview - User authentication You can authenticate and authorize this method with administrator privileges by setting the use_admin_access
field in the request.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Identifier. Resource name of the space. Format:spaces/{space}
Where{space}
represents the system-assigned ID for the space. You can obtain the space ID by calling thespaces.list()
method or from the space URL. For example, if the space URL ishttps://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA
, the space ID isAAAAAAAAA
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:updateMask
(type:String.t
) - Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space:space_details
: Updates the space's description. Supports up to 150 characters.display_name
: Only supports updating the display name for spaces wherespaceType
field isSPACE
. If you receive the error messageALREADY_EXISTS
, try a different value. An existing space within the Google Workspace organization might already use this display name.space_type
: Only supports changing aGROUP_CHAT
space type toSPACE
. Includedisplay_name
together withspace_type
in the update mask and ensure that the specified space has a non-empty display name and theSPACE
space type. Including thespace_type
mask and theSPACE
type in the specified space when updating the display name is optional if the existing space already has theSPACE
type. Trying to update the space type in other ways results in an invalid argument error.space_type
is not supported withuseAdminAccess
.space_history_state
: Updates space history settings by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request.space_history_state
is not supported withuseAdminAccess
.access_settings.audience
: Updates the access setting of who can discover the space, join the space, and preview the messages in named space wherespaceType
field isSPACE
. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in import mode. To learn more, see Make a space discoverable to specific users.access_settings.audience
is not supported withuseAdminAccess
.permission_settings
: Supports changing the permission settings of a space. When updating permission settings, you can only specifypermissionSettings
field masks; you cannot update other field masks at the same time.permissionSettings
is not supported withuseAdminAccess
. The supported field masks include: -permission_settings.manageMembersAndGroups
-permission_settings.modifySpaceDetails
-permission_settings.toggleHistory
-permission_settings.useAtMentionAll
-permission_settings.manageApps
-permission_settings.manageWebhooks
-permission_settings.replyMessages
-
:useAdminAccess
(type:boolean()
) - Optional. Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires thechat.admin.spaces
OAuth 2.0 scope. SomeFieldMask
values are not supported using admin access. For details, see the description ofupdate_mask
. -
:body
(type:GoogleApi.Chat.V1.Model.Space.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Space{}}
on success -
{:error, info}
on failure
@spec chat_spaces_search(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.SearchSpacesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns a list of spaces in a Google Workspace organization based on an administrator's search. Requires user authentication with administrator privileges. In the request, set use_admin_access
to true
.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:orderBy
(type:String.t
) - Optional. How the list of spaces is ordered. Supported attributes to order by are: -membership_count.joined_direct_human_user_count
— Denotes the count of human users that have directly joined a space. -last_active_time
— Denotes the time when last eligible item is added to any topic of this space. -create_time
— Denotes the time of the space creation. Valid ordering operation values are: -ASC
for ascending. Default value. -DESC
for descending. The supported syntax are: -membership_count.joined_direct_human_user_count DESC
-membership_count.joined_direct_human_user_count ASC
-last_active_time DESC
-last_active_time ASC
-create_time DESC
-create_time ASC
-
:pageSize
(type:integer()
) - The maximum number of spaces to return. The service may return fewer than this value. If unspecified, at most 100 spaces are returned. The maximum value is 1000. If you use a value more than 1000, it's automatically changed to 1000. -
:pageToken
(type:String.t
) - A token, received from the previous search spaces call. Provide this parameter to retrieve the subsequent page. When paginating, all other parameters provided should match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results. -
:query
(type:String.t
) - Required. A search query. You can search by using the following parameters: -create_time
-customer
-display_name
-external_user_allowed
-last_active_time
-space_history_state
-space_type
create_time
andlast_active_time
accept a timestamp in RFC-3339 format and the supported comparison operators are:=
,<
,>
,<=
,>=
.customer
is required and is used to indicate which customer to fetch spaces from.customers/my_customer
is the only supported value.display_name
only accepts theHAS
(:
) operator. The text to match is first tokenized into tokens and each token is prefix-matched case-insensitively and independently as a substring anywhere in the space'sdisplay_name
. For example,Fun Eve
matchesFun event
orThe evening was fun
, but notnotFun event
oreven
.external_user_allowed
accepts eithertrue
orfalse
.space_history_state
only accepts values from the [historyState
] (https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces#Space.HistoryState) field of aspace
resource.space_type
is required and the only valid value isSPACE
. Across different fields, onlyAND
operators are supported. A valid example isspace_type = "SPACE" AND display_name:"Hello"
and an invalid example isspace_type = "SPACE" OR display_name:"Hello"
. Among the same field,space_type
doesn't supportAND
orOR
operators.display_name
, 'space_history_state', and 'external_user_allowed' only supportOR
operators.last_active_time
andcreate_time
support bothAND
andOR
operators.AND
can only be used to represent an interval, such aslast_active_time < "2022-01-01T00:00:00+00:00" AND last_active_time > "2023-01-01T00:00:00+00:00"
. The following example queries are valid:customer = "customers/my_customer" AND space_type = "SPACE" customer = "customers/my_customer" AND space_type = "SPACE" AND display_name:"Hello World" customer = "customers/my_customer" AND space_type = "SPACE" AND (last_active_time < "2020-01-01T00:00:00+00:00" OR last_active_time > "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (display_name:"Hello World" OR display_name:"Fun event") AND (last_active_time > "2020-01-01T00:00:00+00:00" AND last_active_time < "2022-01-01T00:00:00+00:00") customer = "customers/my_customer" AND space_type = "SPACE" AND (create_time > "2019-01-01T00:00:00+00:00" AND create_time < "2020-01-01T00:00:00+00:00") AND (external_user_allowed = "true") AND (space_history_state = "HISTORY_ON" OR space_history_state = "HISTORY_OFF")
-
:useAdminAccess
(type:boolean()
) - Whentrue
, the method runs using the user's Google Workspace administrator privileges. The calling user must be a Google Workspace administrator with the manage chat and spaces conversations privilege. Requires either thechat.admin.spaces.readonly
orchat.admin.spaces
OAuth 2.0 scope. This method currently only supports admin access, thus onlytrue
is accepted for this field.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.SearchSpacesResponse{}}
on success -
{:error, info}
on failure
@spec chat_spaces_setup(Tesla.Env.client(), keyword(), keyword()) :: {:ok, GoogleApi.Chat.V1.Model.Space.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates a space and adds specified users to it. The calling user is automatically added to the space, and shouldn't be specified as a membership in the request. For an example, see Set up a space with initial members. To specify the human members to add, add memberships with the appropriate membership.member.name
. To add a human user, use users/{user}
, where {user}
can be the email address for the user. For users in the same Workspace organization {user}
can also be the id
for the person from the People API, or the id
for the user in the Directory API. For example, if the People API Person profile ID for user@example.com
is 123456789
, you can add the user to the space by setting the membership.member.name
to users/user@example.com
or users/123456789
. To specify the Google groups to add, add memberships with the appropriate membership.group_member.name
. To add or invite a Google group, use groups/{group}
, where {group}
is the id
for the group from the Cloud Identity Groups API. For example, you can use Cloud Identity Groups lookup API to retrieve the ID 123456789
for group email group@example.com
, then you can add the group to the space by setting the membership.group_member.name
to groups/123456789
. Group email is not supported, and Google groups can only be added as members in named spaces. For a named space or group chat, if the caller blocks, or is blocked by some members, or doesn't have permission to add some members, then those members aren't added to the created space. To create a direct message (DM) between the calling user and another human user, specify exactly one membership to represent the human user. If one user blocks the other, the request fails and the DM isn't created. To create a DM between the calling user and the calling app, set Space.singleUserBotDm
to true
and don't specify any memberships. You can only use this method to set up a DM with the calling app. To add the calling app as a member of a space or an existing DM between two human users, see Invite or add a user or app to a space. If a DM already exists between two users, even when one user blocks the other at the time a request is made, then the existing DM is returned. Spaces with threaded replies aren't supported. If you receive the error message ALREADY_EXISTS
when setting up a space, try a different displayName
. An existing space within the Google Workspace organization might already use this display name. Requires user authentication.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Chat.V1.Model.SetUpSpaceRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.Space{}}
on success -
{:error, info}
on failure
@spec chat_spaces_space_events_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.SpaceEvent.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns an event from a Google Chat space. The event payload contains the most recent version of the resource that changed. For example, if you request an event about a new message but the message was later updated, the server returns the updated Message
resource in the event payload. Note: The permissionSettings
field is not returned in the Space object of the Space event data for this request. Requires user authentication. To get an event, the authenticated user must be a member of the space. For an example, see Get details about an event from a Google Chat space.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the space event. Format:spaces/{space}/spaceEvents/{spaceEvent}
-
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.SpaceEvent{}}
on success -
{:error, info}
on failure
@spec chat_spaces_space_events_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Chat.V1.Model.ListSpaceEventsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists events from a Google Chat space. For each event, the payload contains the most recent version of the Chat resource. For example, if you list events about new space members, the server returns Membership
resources that contain the latest membership details. If new members were removed during the requested period, the event payload contains an empty Membership
resource. Requires user authentication. To list events, the authenticated user must be a member of the space. For an example, see List events from a Google Chat space.
Parameters
-
connection
(type:GoogleApi.Chat.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. Resource name of the Google Chat space where the events occurred. Format:spaces/{space}
. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:filter
(type:String.t
) - Required. A query filter. You must specify at least one event type (event_type
) using the has:
operator. To filter by multiple event types, use theOR
operator. Omit batch event types in your filter. The request automatically returns any related batch events. For example, if you filter by new reactions (google.workspace.chat.reaction.v1.created
), the server also returns batch new reactions events (google.workspace.chat.reaction.v1.batchCreated
). For a list of supported event types, see theSpaceEvents
reference documentation. Optionally, you can also filter by start time (start_time
) and end time (end_time
):start_time
: Exclusive timestamp from which to start listing space events. You can list events that occurred up to 28 days ago. If unspecified, lists space events from the past 28 days.end_time
: Inclusive timestamp until which space events are listed. If unspecified, lists events up to the time of the request. To specify a start or end time, use the equals=
operator and format in RFC-3339. To filter by bothstart_time
andend_time
, use theAND
operator. For example, the following queries are valid:start_time="2023-08-23T19:20:33+00:00" AND end_time="2023-08-23T19:21:54+00:00"
start_time="2023-08-23T19:20:33+00:00" AND (event_types:"google.workspace.chat.space.v1.updated" OR event_types:"google.workspace.chat.message.v1.created")
The following queries are invalid:start_time="2023-08-23T19:20:33+00:00" OR end_time="2023-08-23T19:21:54+00:00"
event_types:"google.workspace.chat.space.v1.updated" AND event_types:"google.workspace.chat.message.v1.created"
Invalid queries are rejected by the server with anINVALID_ARGUMENT
error. -
:pageSize
(type:integer()
) - Optional. The maximum number of space events returned. The service might return fewer than this value. Negative values return anINVALID_ARGUMENT
error. -
:pageToken
(type:String.t
) - Optional. A page token, received from a previous list space events call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to list space events must match the call that provided the page token. Passing different values to the other parameters might lead to unexpected results.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Chat.V1.Model.ListSpaceEventsResponse{}}
on success -
{:error, info}
on failure