Comments: patch

Stay organized with collections Save and categorize content based on your preferences.

Updates an existing comment. Try it now or see an example.

Request

HTTP request

PATCH https://www.googleapis.com/drive/v2/files/fileId/comments/commentId

Parameters

Parameter name Value Description
Path parameters
commentId string The ID of the comment.
fileId string The ID of the file.

Authorization

This request allows authorization with at least one of the following scopes:

Scope
https://www.googleapis.com/auth/drive
https://www.googleapis.com/auth/drive.file

Some scopes are restricted and require a security assessment for your app to use them. For more information, see the authentication and authorization page.

Request body

In the request body, supply the relevant portions of a Comments resource, according to the rules of patch semantics, with the following properties:

Property name Value Description Notes
Required Properties
content string The plain text content used to create this comment. This is not HTML safe and should only be used as a starting point to make edits to a comment's content. writable

Response

If successful, this method returns a Comments resource in the response body.

Examples

Note: The code examples available for this method do not represent all supported programming languages (see the client libraries page for a list of supported languages).

Java

Uses the Java client library.

import com.google.api.services.drive.Drive;
import com.google.api.services.drive.model.Comment;

import java.io.IOException;
// ...

public class MyClass {

  // ...

  /**
   * Patch a comment's content.
   *
   * @param service Drive API service instance.
   * @param fileId ID of the file to update comment for.
   * @param commentId ID of the comment to patch.
   * @param newContent The new text content for the comment.
   * @return The patched comment if successful, {@code null} otherwise.
   */
  private static Comment patchComment(Drive service, String fileId,
      String commentId, String newContent) {
    Comment patchedComment = new Comment();
    patchedComment.setContent(newContent);
    try {
      return service.comments().patch(
          fileId, commentId, patchedComment).execute();
    } catch (IOException e) {
      System.out.println("An error occurred: " + e);
    }
    return null;
  }

  // ...

}

.NET

Uses the .NET client library.

import com.google.api.services.drive.Drive;
import com.google.api.services.drive.model.Comment;

import java.io.IOException;
// ...

public class MyClass {

  // ...

  /**
   * Patch a comment's content.
   *
   * @param service Drive API service instance.
   * @param fileId ID of the file to update comment for.
   * @param commentId ID of the comment to patch.
   * @param newContent The new text content for the comment.
   * @return The patched comment if successful, {@code null} otherwise.
   */
  private static Comment patchComment(DriveService service, String fileId,
      String commentId, String newContent) {
    Comment patchedComment = new Comment();
    patchedComment.Content = newContent;
    try {
      return service.Comments.Patch(
          patchedComment, fileId, commentId).Execute();
    } catch (Exception e) {
      Console.WriteLine("An error occurred: " + e.Message);
    }
    return null;
  }

  // ...

}

PHP

Uses the PHP client library.

/**
 * Patch a comment's content.
 *
 * @param Google_Service_Drive $service Drive API service instance.
 * @param String $fileId ID of the file to patch comment for.
 * @param String $commentId ID of the comment to patch.
 * @param String $newContent The new text content for the comment.
 * @return Google_Service_Drive_Comment The patched comment. NULL is returned if
 *     an API error occurred.
 */
function patchComment($service, $fileId, $commentId, $newContent) {
  $patchedComment = new Google_Service_Drive_Comment();
  $patchedComment->setContent(newContent);
  try {
    return $service->comments->patch($fileId, $commentId, $patchedComment);
  } catch (Exception $e) {
    print "An error occurred: " . $e->getMessage();
  }
  return NULL;
}

Python

Uses the Python client library.

from apiclient import errors
# ...

def patch_comment(service, file_id, comment_id, new_content):
  """Patch a comment's content.

  Args:
    service: Drive API service instance.
    file_id: ID of the file to update comment for.
    comment_id: ID of the comment to patch.
    new_content: The new text content for the comment.

  Returns:
    The patched comment if successful, None otherwise.
  """
  patched_comment = {'content': new_content}
  try:
    return service.comments().patch(
        fileId=file_id, commentId=comment_id,
        body=patched_comment).execute()
  except errors.HttpError, error:
    print 'An error occurred: %s' % error
  return None

JavaScript

Uses the JavaScript client library.

/**
 * Patch a comment's content.
 *
 * @param {String} fileId ID of the file to update comment for.
 * @param {String} commentId ID of the comment to update.
 * @param {String} newContent The new text content for the comment.
 */
function patchComment(fileId, commentId, newContent) {
  var body = {'content': newContent};
    var request = gapi.client.drive.comments.patch({
      'fileId': fileId,
      'commentId': commentId,
      'resource': body
    });
    request.execute(function(resp) { });
}

Try it!

Use the APIs Explorer below to call this method on live data and see the response.