Method: spaces.messagePins.list

Liste les messages épinglés dans un espace. Les utilisateurs peuvent épingler des messages importants dans des espaces pour y accéder facilement. Pour en savoir plus, consultez Épingler ou désépingler une conversation dans Google Chat.

Nécessite l'authentification de l'utilisateur avec l'un des niveaux d'accès des autorisations suivants :

  • 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

Requête HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/messagePins

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Espace parent qui possède la collection d'éléments épinglés. Format : spaces/{space}

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de messages épinglés renvoyés. Le service peut renvoyer moins de messages que cette valeur. La valeur maximale est 100. Si vous utilisez une valeur supérieure à 100, elle est automatiquement remplacée par 100. Si aucune valeur n'est spécifiée, 100 messages épinglés au maximum sont renvoyés. Les valeurs négatives renvoient une erreur INVALID_ARGUMENT.
pageToken

string

Facultatif. Jeton de page reçu d'un appel de liste de messages épinglés précédent. Fournissez ce paramètre pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis doivent correspondre à l'appel ayant fourni le jeton de page. Transmettre différentes valeurs aux autres paramètres peut entraîner des résultats inattendus.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse pour la liste des messages épinglés.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
Champs
messagePins[]

object (MessagePin)

Messages épinglés de l'espace spécifié.
nextPageToken

string

Vous pouvez envoyer un jeton en tant que pageToken pour récupérer la page de résultats suivante. Si ce champ est vide, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide sur l'autorisation.