Administrar comentarios y respuestas

Los comentarios son las opiniones que proporcionan los usuarios sobre un archivo, por ejemplo, el lector de una de procesamiento de texto que sugiere cómo reformular una oración. Existen dos tipos de comentarios: comentarios fijos y comentarios no fijos. Un comentario está asociado con una ubicación específica, como una oración en una de procesamiento de texto, dentro de una versión específica de un documento. Por el contrario, un comentario sin ancla solo se asocia con el documento.

Las respuestas se adjuntan a los comentarios y representan la respuesta de un usuario a la comentario. La API de Drive permite que los usuarios agreguen comentarios y respuestas a documentos que creó tu app. En conjunto, un comentario con respuestas se conoce como un debate.

Cómo agregar un comentario no anclado

Para agregar un comentario no anclado a un documento, llama al método comments.create con el parámetro fileId y una Recurso comments que contiene el comentario.

El comentario se inserta como texto sin formato, pero el cuerpo de la respuesta proporciona Campo htmlContent que incluye contenido con formato para visualización.

Cómo agregar una respuesta a un comentario

Para responder un comentario, llama al replies.create con el comentario. Parámetro fileId y un recurso replies que contiene la respuesta.

La respuesta se inserta como texto sin formato, pero el cuerpo de la respuesta proporciona Campo htmlContent que incluye contenido con formato para visualización.

Agrega un comentario fijo a la última revisión de un documento

Cuando agregues un comentario, es posible que desees anclarlo a una región del archivo. Los Ancho define la revisión del archivo y la región en un archivo en el cual un comentario se refiere. El recurso comments define la anchor como una cadena JSON.

Para agregar un comentario fijo, sigue estos pasos:

  1. (Opcional) Llama a revisions.list. para enumerar cada revisionID de un documento. Solo sigue este paso si Quieres anclar un comentario a cualquier revisión que no sea la última. Si deseas usar la última revisión, usa head para la revisionID.

  2. Llama al método comments.create. con el parámetro fileID, un objeto comments recurso que contiene el comentario y una cadena de anclaje JSON con el elemento revisionID (r) y región (a).

La forma en que se define una región depende del tipo de contenido del documento con el que se trabaja tus amigos. Para obtener más información, consulta Define una región.

Define una región

Como se mencionó antes, la string de anclaje JSON contiene un revisionID (r) y región (a). La región (a) es un array JSON que contiene clasificadores de regiones. que especifican el formato y la ubicación a los que se ancla un comentario. Un clasificador puede ser un rectángulo bidimensional de una imagen, una línea de texto en un documento, o un tiempo en un video. Para definir una región, selecciona la región que coincida con el tipo de contenido al que intentas anclar. Para Por ejemplo, si tu contenido es texto, es probable que uses txt o line.

Para ver una lista de clasificadores de regiones en la API de Drive, consulta Región clasificadores disponibles.

En el siguiente ejemplo, se muestra una cadena de anclaje JSON que ancla comentarios en líneas en dos áreas separadas de un documento:

  • La primera área comienza en la línea 12 ('n':12) y se extiende por tres líneas. ('l':3)
  • La segunda área solo cubre la línea 18 ('n':18, 'l':1`).
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

Reemplaza REVISION_ID por head o el ID de una cuenta a los cambios en el software.

Resolver un comentario

Usa el método comment.update para establecer la propiedad resolved en el comments recurso a true cuando se haya abordado un comentario.

Cuando tu app establece la propiedad resolved en true, tu IU debe indicar de que se haya abordado el comentario. Por ejemplo, tu app podría hacer lo siguiente:

  • No permitir más respuestas y atenuar todas las respuestas anteriores y la original comentario.
  • Ocultar los comentarios resueltos.

Cómo borrar un comentario

Usa el método comments.delete para eliminar comentarios. Cuando se borra un comentario, Drive marca el recurso de comentario como "deleted": "true".

Comentarios de la lista

Usa el método comments.list para crear una lista comentarios. Si quieres incluir comentarios borrados en los resultados, establece la includedDeleted como true.