Google Chat API (chat:v1)

Additions

Methods


• ▼ ▲ chat.spaces.messagePins.delete

  Parameters :

  name

  Type : string

  Pattern : ^spaces/[^/]+/messagePins/[^/]+$

  Description : Required. The resource name of the message pin to remove. Format: spaces/{space}/messagePins/{message_pin}

  Location : path

  Required : Yes

  Flat Path : v1/spaces/{spacesId}/messagePins/{messagePinsId}

  Description : Deletes a message pin. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`

  HTTP Method : DELETE

  Path : v1/{+name}

  Scopes :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.pins

  Parameter Order : name

• ▼ ▲ chat.spaces.messagePins.create

  HTTP Method : POST

  Parameter Order : parent

  Scopes :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.pins

  Flat Path : v1/spaces/{spacesId}/messagePins

  Path : v1/{+parent}/messagePins

  Description : Creates a message pin. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces`

  Parameters :

  parent

  Pattern : ^spaces/[^/]+$

  Type : string

  Location : path

  Required : Yes

  Description : Required. The parent space in which to create the message pin. Format: spaces/{space}

• ▼ ▲ chat.spaces.messagePins.list

  Parameter Order : parent

  Description : Lists message pins in a space. Users can pin important messages in spaces for easy access. For more information, see [Pin or unpin a conversation in Google Chat](https://support.google.com/chat/answer/15622437). Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.spaces.pins.readonly` - `https://www.googleapis.com/auth/chat.spaces.pins` - `https://www.googleapis.com/auth/chat.spaces.readonly` - `https://www.googleapis.com/auth/chat.spaces`

  HTTP Method : GET

  Flat Path : v1/spaces/{spacesId}/messagePins

  Scopes :

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.pins
  • https://www.googleapis.com/auth/chat.spaces.pins.readonly
  • https://www.googleapis.com/auth/chat.spaces.readonly

  Parameters :

  parent

  Location : path

  Required : Yes

  Pattern : ^spaces/[^/]+$

  Type : string

  Description : Required. The parent space which owns the collection of pinned items Format: `spaces/{space}`

  pageSize

  Location : query

  Format : int32

  Type : integer

  Description : Optional. The maximum number of message pins returned. The service might return fewer messages than this value. The maximum value is 100. If you use a value more than 100, it's automatically changed to 100. If unspecified, at most 100 message pins will be returned. Negative values return an `INVALID_ARGUMENT` error.

  pageToken

  Type : string

  Description : Optional. A page token received from a previous list message pins 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.

  Location : query

  Path : v1/{+parent}/messagePins