Google Drive SDK

Comments: patch

Updates an existing comment. This method supports patch semantics. 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.

Request body

In the request body, supply a Comments resource.

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).Fetch();
    } 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_DriveService $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_Comment The patch comment. NULL is returned if an API error occurred.
 */
function patchComment($service, $fileId, $commentId, $newContent) {
  $patchedComment = new Google_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

Ruby

Uses the Ruby client library

##
# Patch a comment's content
#
# @param [Google::APIClient] client
#   Authorized client instance
# @param [String] file_id
#   ID of the file to update comment for
# @param [String] comment_id
#   ID of the comment to patch
# @param [String] new_content
#   The new text content for the comment
# @return [Google::APIClient::Schema::Drive::V2::File]
#   The patched comment if successful, nil otherwise
def patch_comment(client, file_id, comment_id, new_content)
  drive = client.discovered_api('drive', 'v2')
  result = client.execute(
    :api_method => drive.comments.patch,
    :body_object => { 'content' => new_content },
    :parameters => { 'fileId' => file_id, 'commentId' => comment_id })
  if result.status == 200
    return result.data
  end
  puts "An error occurred: #{result.data['error']['message']}"
  return nil
end

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.

Authentication required

You need to be signed in with Google+ to do that.

Signing you in...

Google Developers needs your permission to do that.