Gérer les commentaires et les réponses

Les commentaires sont des commentaires fournis par l'utilisateur sur un fichier. Par exemple, un lecteur d'un document de traitement de texte peut suggérer de reformuler une phrase. Il existe deux types de commentaires: les commentaires ancrés et les commentaires non ancrés. Un commentaire ancré est associé à un emplacement spécifique, comme une phrase dans un document de traitement de texte, dans une version spécifique d'un document. À l'inverse, un commentaire non ancré n'est associé qu'au document.

Remarque :Pour les fichiers blob, l'API Google Drive n'est compatible qu'avec les commentaires non ancrés. Les commentaires ancrés sur des fichiers blob ou des fichiers de l'éditeur Google Docs ne sont pas acceptés.

Les réponses sont jointes aux commentaires et représentent la réponse d'un utilisateur à un commentaire. L'API Drive permet à vos utilisateurs d'ajouter des commentaires et des réponses aux documents créés par votre application. Un commentaire avec des réponses est appelé discussion.

Ajouter un commentaire non ancré

Pour ajouter un commentaire non ancré à un document, appelez la méthode comments.create avec le paramètre fileId et une ressource comments contenant le commentaire.

Le commentaire est inséré en texte brut, mais le corps de la réponse fournit un champ htmlContent contenant du contenu mis en forme pour l'affichage.

Important :Nous vous recommandons de vérifier qu'un utilisateur dispose des autorisations appropriées pour ajouter des commentaires. De plus, seul le créateur d'un commentaire ou d'une réponse peut le supprimer ou le modifier. Des erreurs se produisent lorsqu'un utilisateur ayant un rôle non-créateur tente de supprimer ou de modifier un commentaire. Pour éviter ces erreurs, vérifiez le champ author.me de la ressource comments pour vous assurer que l'utilisateur à l'origine de la requête est l'auteur du commentaire, puis vérifiez ses autorisations par rapport au commentaire.

Ajouter une réponse à un commentaire

Pour ajouter une réponse à un commentaire, appelez la méthode replies.create avec le commentaire, le paramètre fileId et une ressource replies contenant la réponse.

La réponse est insérée sous forme de texte brut, mais le corps de la réponse fournit un champ htmlContent contenant du contenu mis en forme pour être affiché.

Ajouter un commentaire ancré à la dernière révision d'un document

Lorsque vous ajoutez un commentaire, vous pouvez l'ancrer à une région du fichier. Un ancrage définit la révision et la région d'un fichier auxquels un commentaire fait référence. La ressource comments définit le champ anchor en tant que chaîne JSON.

Remarque :Pour les fichiers blob, l'API Drive n'accepte que les commentaires non ancrés. Les commentaires ancrés sur des fichiers blob ou des fichiers de l'éditeur Google Docs ne sont pas acceptés.

Important :Les ancres sont immuables, et leur position par rapport au contenu d'un document ne peut pas être garantie entre les révisions. Nous vous recommandons d'utiliser des ancres dans les documents dont la position ne change pas, tels que les fichiers image ou les documents en lecture seule.

Pour ajouter un commentaire ancré:

1. (Facultatif) Appelez la méthode revisions.list pour lister tous les revisionID d'un document. Ne suivez cette étape que si vous souhaitez ancrer un commentaire à une révision autre que la dernière. Si vous souhaitez utiliser la dernière révision, utilisez head pour revisionID.

2. Appelez la méthode comments.create avec le paramètre fileID, une ressource comments contenant le commentaire et une chaîne d'ancrage JSON contenant le revisionID (r) et la région (a).

La manière dont vous définissez une région dépend du type de contenu du document avec lequel vous travaillez. Pour en savoir plus, consultez Définir une région.

Remarque :Nous vous recommandons de vérifier qu'un utilisateur dispose des autorisations appropriées pour ajouter des commentaires. De plus, seul le créateur d'un commentaire ou d'une réponse peut le supprimer ou le modifier. Des erreurs se produisent lorsqu'une personne n'ayant pas le rôle de créateur tente de supprimer ou de modifier un commentaire. Pour éviter ces erreurs, vérifiez le champ author.me de la ressource comments.

Définir une région

Comme indiqué précédemment, la chaîne d'ancrage JSON contient un revisionID (r) et une région (a). La région (a) est un tableau JSON contenant des classificateurs de région spécifiant le format et l'emplacement auxquels un commentaire est ancré. Un classificateur peut être un rectangle bidimensionnel pour une image, une ligne de texte dans un document ou une durée dans une vidéo. Pour définir une région, sélectionnez le classificateur de région correspondant au type de contenu auquel vous essayez de vous ancrer. Par exemple, si votre contenu est du texte, vous utiliserez probablement le classificateur de région txt ou line.

Pour obtenir la liste des classificateurs de région dans l'API Drive, consultez la section Classificateurs de région.

L'exemple suivant montre une chaîne d'ancrage JSON qui ancre des commentaires sur des lignes dans deux zones distinctes d'un document:

• La première zone commence à la ligne 12 ('n':12) et s'étend sur trois lignes ('l':3).
• La deuxième zone ne couvre que la ligne 18 ('n':18, 'l':1`).

    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

Remplacez REVISION_ID par head ou par l'ID d'une révision spécifique.

Important :Si votre application permet aux utilisateurs de mettre à jour et de partager plusieurs révisions d'un document, les commentaires des anciennes révisions peuvent ne plus s'appliquer à l'emplacement ancré. Par conséquent, vous devez indiquer clairement dans votre UI à quelle révision chaque commentaire appartient.

Fermer un commentaire

Utilisez la méthode comment.update pour définir la propriété resolved de la ressource comments sur true lorsqu'un commentaire a été traité.

Lorsque votre application définit la propriété resolved sur true, votre UI doit indiquer que le commentaire a été traité. Par exemple, votre application peut:

• Interdiction de toute nouvelle réponse et atténuation de toutes les réponses précédentes, ainsi que du commentaire d'origine.
• Masquer les commentaires fermés.

Supprimer un commentaire

Utilisez la méthode comments.delete pour supprimer les commentaires. Lorsqu'un commentaire est supprimé, Drive le marque comme "deleted": "true".

Répertorier les commentaires

Utilisez la méthode comments.list pour lister les commentaires. Si vous souhaitez inclure les commentaires supprimés dans les résultats, définissez le champ includedDeleted sur true.