Gestire commenti e risposte

I commenti sono feedback forniti dall'utente su un file, ad esempio la lettura di un documento di elaborazione testi che suggerisce come riformulare una frase. Esistono due metodi tipi di commenti: commenti ancorati e commenti non ancorati. Un elemento un commento è associato a una posizione specifica, ad esempio una frase in un di elaborazione di testi, all'interno di una specifica versione di un documento. Al contrario, un commento non ancorato è appena associato al documento.

Le risposte sono allegate ai commenti e rappresentano la risposta dell'utente ai . L'API Drive consente agli utenti di aggiungere commenti e risposte a documenti creati dalla tua app. Collettivamente, un commento con risposte è noto come una discussione.

Aggiungere un commento non ancorato

Per aggiungere un commento non ancorato a un documento, chiama il metodo comments.create con il parametro fileId e un Risorsa comments contenente il commento.

Il commento viene inserito come testo normale, ma il corpo della risposta fornisce un Campo htmlContent con contenuti formattati per la visualizzazione.

Aggiungere una risposta a un commento

Per aggiungere una risposta a un commento, chiama il replies.create con il commento, fileId e una risorsa replies contenente la risposta.

La risposta viene inserita come testo normale, ma il corpo della risposta fornisce una Campo htmlContent con contenuti formattati per la visualizzazione.

Aggiungi un commento ancorato all'ultima revisione di un documento

Quando aggiungi un commento, potrebbe essere utile ancorarlo a una regione nel file. Un anchor definisce la revisione e la regione del file in un file a cui si riferisce un commento fa riferimento. La risorsa comments definisce anchor come stringa JSON.

Per aggiungere un commento ancorato:

  1. (Facoltativo) Chiama il revisions.list per elencare ogni revisionID per un documento. Segui questo passaggio solo se vuoi ancorare un commento a qualsiasi revisione diversa dall'ultima. Se vuoi usare l'ultima revisione, usa head per revisionID.

  2. Chiama il metodo comments.create con il parametro fileID, un comments risorsa contenente il commento e una stringa di ancoraggio JSON contenente il revisionID (r) e regione (a).

Il modo in cui definisci una regione dipende dal tipo di contenuti del documento che stai lavorando con. Per saperne di più, consulta Definire una regione.

Definisci una regione

Come accennato in precedenza, la stringa di ancoraggio JSON contiene un parametro revisionID (r) e regione (a). La regione (a) è un array JSON contenente classificatori di regioni che specifica il formato e la posizione a cui è ancorato un commento. Un classificatore potrebbe essere un rettangolo bidimensionale per un'immagine, una riga di testo in un documento, o la durata di un video. Per definire una regione, seleziona la regione classificatore che corrisponda al tipo di contenuti a cui vuoi ancorare l'annuncio. Per Ad esempio, se i tuoi contenuti sono testuali, probabilmente utilizzerai txt o line.

Per un elenco di categorie di classificazione delle regioni nell'API Drive, consulta Regione classificatori.

L'esempio seguente mostra una stringa di ancoraggio JSON che ancora i commenti alle linee in due aree separate di un documento:

  • La prima area inizia dalla linea 12 ('n':12) e si estende per tre linee ('l':3).
  • La seconda area copre solo la linea 18 ('n':18, 'l':1").
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

Sostituisci REVISION_ID con head o l'ID di uno specifico revisione.

Risolvi un commento

Utilizza il metodo comment.update per impostare la proprietà resolved in comments risorsa di true quando un commento è stato risolto.

Quando l'app imposta la proprietà resolved su true, l'UI dovrebbe indicare che il commento è stato gestito. Ad esempio, la tua app potrebbe:

  • Non consentire ulteriori risposte e attenua tutte le risposte precedenti più l'originale .
  • Nascondi i commenti risolti.

Eliminare un commento

Utilizza il metodo comments.delete per eliminare i commenti. Quando un commento viene eliminato, Drive contrassegna la risorsa di commento come "deleted": "true".

Elenca commenti

Utilizza il metodo comments.list per elencare commenti. Se vuoi includere nei risultati i commenti eliminati, imposta il parametro includedDeleted su true.