Kommentare sind Feedback von Nutzern zu einer Datei, z. B. der Leser einer Textverarbeitungsdokuments mit Vorschlägen zur Umformulierung eines Satzes. Es gibt zwei Arten von Kommentaren: verankerte Kommentare und nicht verankerte Kommentare. Ein verankertes Kommentar ist mit einem bestimmten Ort verknüpft, beispielsweise einem Satz in einer Textverarbeitungsdokuments in einer bestimmten Version eines Dokuments. Umgekehrt wird nur ein nicht verankerter Kommentar mit dem Dokument verknüpft.
Antworten werden Kommentaren beigefügt und stellen die Antwort eines Nutzers auf den Kommentar. Mit der Drive API können Ihre Nutzer Kommentare und Antworten auf Dokumente, die von Ihrer App erstellt wurden. Zusammenfassend wird ein Kommentar mit Antworten Eine Diskussion.
Unverankerten Kommentar hinzufügen
Um einem Dokument einen nicht verankerten Kommentar hinzuzufügen, rufen Sie die Methode comments.create
mit dem Parameter fileId
und einem
comments
-Ressource mit dem Kommentar.
Der Kommentar wird als Nur-Text eingefügt, der Antworttext enthält jedoch ein
Feld htmlContent
mit für die Anzeige formatierten Inhalten.
Antwort auf einen Kommentar hinzufügen
Um eine Antwort auf einen Kommentar hinzuzufügen, rufen Sie die
replies.create
-Methode mit dem Kommentar,
Parameter fileId
und eine replies
-Ressource
mit der Antwort.
Die Antwort wird als Nur-Text eingefügt, aber der Antworttext enthält ein
Feld htmlContent
mit für die Anzeige formatierten Inhalten.
Fügen Sie der letzten Version eines Dokuments einen verankerten Kommentar hinzu
Wenn Sie einen Kommentar hinzufügen, empfiehlt es sich, in einem Bereich der Datei zu verankern. Eine
anchor definiert die Dateiversion und -region in einer Datei, in der ein Kommentar angezeigt wird.
verweist. Die Ressource comments
definiert die
anchor
als JSON-String.
So fügen Sie einen verankerten Kommentar hinzu:
Optional: Rufen Sie die
revisions.list
auf. , um allerevisionID
für ein Dokument aufzulisten. Führen Sie diesen Schritt nur aus, wenn möchten Sie einen Kommentar bei einer anderen als der letzten Überarbeitung verankern. Wenn Sie die neueste Version verwenden möchten, verwenden Siehead
fürrevisionID
.Rufen Sie die Methode
comments.create
auf. mit demfileID
-Parameter, einemcomments
-Ressource mit dem Kommentar und einem JSON-Ankerstring mit demrevisionID
(r
) und Region (a
).
Wie Sie eine Region definieren, hängt von der Art des Dokumentinhalts ab, den Sie bearbeiten. mit. Weitere Informationen finden Sie unter Region definieren.
Region definieren
Wie bereits erwähnt, enthält der JSON-Ankerstring ein revisionID
(r
) und
Region (a
) Die Region (a
) ist ein JSON-Array, das Regionsklassifikatoren enthält
gibt das Format und die Position an, an der ein Kommentar verankert ist. Einen Klassifikator
kann ein zweidimensionales Rechteck für ein Bild, eine Textzeile in einem Dokument,
oder eine Zeitdauer in einem Video. Wählen Sie zum Definieren einer Region die Region aus
Klassifikator, der dem Inhaltstyp entspricht, in dem Sie verankern möchten. Für
Wenn es sich bei deinem Inhalt beispielsweise um Text handelt, verwendest du wahrscheinlich entweder das Format txt
oder line
als Regionsklassifikator.
Eine Liste der Regionsklassifikatoren in der Drive API finden Sie unter Region Klassifikatoren.
Das folgende Beispiel zeigt einen JSON-Ankerstring, der Kommentare in Zeilen verankert in zwei separaten Bereichen eines Dokuments:
- Der erste Bereich beginnt bei Zeile 12 (
'n':12
) und erstreckt sich über drei Linien. ('l':3
) - Der zweite Bereich deckt nur Zeile 18 (
'n':18, 'l':1
`) ab.
{
'r': 'REVISION_ID',
'a': [
{
'line':
{
'n': 12,
'l': 3,
}
},
{
'line':
{
'n': 18,
'l': 1,
}
}]
}
Ersetzen Sie REVISION_ID durch head
oder die ID eines bestimmten
Überarbeitung.
Kommentare klären
Verwenden Sie die Methode comment.update
, um Folgendes festzulegen:
die resolved
-Eigenschaft im comments
Ressource an true
, wenn ein Kommentar bearbeitet wurde.
Wenn Ihre App das Attribut resolved
auf true
setzt, sollte in Ihrer UI Folgendes angezeigt werden:
dass der Kommentar bearbeitet wurde. Ihre App kann beispielsweise:
- Weitere Antworten nicht zulassen und alle vorherigen und das ursprüngliche Antworten ausblenden Kommentar.
- Geklärte Kommentare ausblenden.
Kommentare löschen
Verwenden Sie die Methode comments.delete
, um
Kommentare löschen Wenn ein Kommentar gelöscht wird, markiert Google Drive den
Kommentarressource als "deleted": "true"
.
Listenkommentare
Verwenden Sie die Methode comments.list
, um
Kommentare. Wenn die Ergebnisse auch gelöschte Kommentare enthalten sollen, legen Sie das
includedDeleted
auf true
.