Method: spaces.messagePins.list

Listet angepinnte Nachrichten in einem Gruppenbereich auf. Nutzer können wichtige Nachrichten in Gruppenbereichen anpinnen, um einfach darauf zuzugreifen. Weitere Informationen finden Sie unter Unterhaltungen in Google Chat anpinnen oder die Anpinnung aufheben.

Erfordert eine Nutzerauthentifizierung mit einem der folgenden Autorisierungsbereiche:

  • 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-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der übergeordnete Gruppenbereich, zu dem die Sammlung angepinnter Elemente gehört. Format: spaces/{space}

Suchparameter

Parameter
pageSize

integer

Optional. Die maximale Anzahl der zurückgegebenen angepinnten Nachrichten. Der Dienst gibt möglicherweise weniger Nachrichten als diesen Wert zurück. Der Maximalwert ist 100. Wenn Sie einen Wert über 100 verwenden, wird er automatisch auf 100 geändert. Wenn nicht angegeben, werden maximal 100 angepinnte Nachrichten zurückgegeben. Bei negativen Werten wird ein INVALID_ARGUMENT-Fehler zurückgegeben.
pageToken

string

Optional. Ein Seitentoken, das von einem vorherigen Aufruf zum Auflisten angepinnter Nachrichten empfangen wurde. Geben Sie diesen Parameter an, um die nächste Seite abzurufen.

Bei der Paginierung müssen alle anderen angegebenen Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat. Wenn Sie für die anderen Parameter andere Werte übergeben, kann dies zu unerwarteten Ergebnissen führen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwortnachricht für das Auflisten angepinnter Nachrichten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "messagePins": [
    {
      object (MessagePin)
    }
  ],
  "nextPageToken": string
}
Felder
messagePins[]

object (MessagePin)

Die angepinnten Nachrichten aus dem angegebenen Gruppenbereich.
nextPageToken

string

Sie können ein Token als pageToken senden, um die nächste Seite mit Ergebnissen abzurufen. Wenn leer, gibt es keine weiteren Seiten.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • 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

Weitere Informationen finden Sie im Autorisierungsleitfaden.