Google: Creates a comment on a file For more information, see Manage comments and replies (https: developers google com workspace drive api guides manage-comments) Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter)

Google driveComments.driveCommentsCreate: arguments, response, policy and SDK examples.

← Drive comments operations · Get started

Operation google.drive_comments_create

Provider route: POST /drive/v3/files/{fileId}/comments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/google with npm, or alter-sdk-google with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GoogleIntegration } from "@alter-ai/google";

async function execute(input: Parameters<GoogleIntegration["driveComments"]["driveCommentsCreate"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GoogleIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.driveComments.driveCommentsCreate(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_google import GoogleIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GoogleIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.drive_comments.drive_comments_create(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.fileId`	string	Required within parent	The ID of the file.
`query`	Model	Required within parent	Expand Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — request body — query
`body`	Model	Required within parent	Expand Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — request body — body

Referenced models: Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — request body — body, Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — request body — query

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	Model	Root	Expand Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body

Referenced models: Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body

Schemas

1 more schema is linked from the tables above, on the schema pages.

Gets a comment by ID. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
`anchor`	string	Optional	A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
`assigneeEmailAddress`	string	Optional	Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset. Read only: true
`author`	Model	Optional	Expand Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user Output only. The author of the comment. The author's email address and permission ID will not be populated.
`content`	string	Optional	The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
`createdTime`	string	Optional	The time at which the comment was created (RFC 3339 date-time). Format: date-time
`deleted`	boolean	Optional	Output only. Whether the comment has been deleted. A deleted comment has no content.
`htmlContent`	string	Optional	Output only. The content of the comment with HTML formatting.
`id`	string	Optional	Output only. The ID of the comment.
`kind`	string	Optional	Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. Default: drive#comment
`mentionedEmailAddresses`	array	Optional	Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty. Read only: true
`mentionedEmailAddresses[]`	string	Each item
`modifiedTime`	string	Optional	The last time the comment or any of its replies was modified (RFC 3339 date-time). Format: date-time
`quotedFileContent`	object	Optional	The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
`quotedFileContent.mimeType`	string	Optional	The MIME type of the quoted content.
`quotedFileContent.value`	string	Optional	The quoted content itself. This is interpreted as plain text if set through the API.
`replies`	array	Optional	Output only. The full list of replies to the comment in chronological order.
`replies[]`	Model	Each item	Expand Gets a reply by ID For more information, see Manage comments and replies (https: developers google com workspace drive api guides manage-comments) — response body
`resolved`	boolean	Optional	Output only. Whether the comment has been resolved by one of its replies.

Referenced models: Gets a reply by ID For more information, see Manage comments and replies (https: developers google com workspace drive api guides manage-comments) — response body, Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user

Creates a comment on a file. For more information, see [Manage comments and replies](https://developers.google.com/workspace/drive/api/guides/manage-comments). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	A comment on a file. Some resource methods (such as `comments.update`) require a `commentId`. Use the `comments.list` method to retrieve the ID for a comment in a file.
`anchor`	string	Optional	A region of the document represented as a JSON string. For details on defining anchor properties, refer to [Manage comments and replies](https://developers.google.com/workspace/drive/api/v3/manage-comments).
`assigneeEmailAddress`	string	Optional	Output only. The email address of the user assigned to this comment. If no user is assigned, the field is unset. Read only: true
`author`	Model	Optional	Expand Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user Output only. The author of the comment. The author's email address and permission ID will not be populated.
`content`	string	Required within parent	The plain text content of the comment. This field is used for setting the content, while `htmlContent` should be displayed.
`createdTime`	string	Optional	The time at which the comment was created (RFC 3339 date-time). Format: date-time
`deleted`	boolean	Optional	Output only. Whether the comment has been deleted. A deleted comment has no content.
`htmlContent`	string	Optional	Output only. The content of the comment with HTML formatting.
`id`	string	Optional	Output only. The ID of the comment.
`kind`	string	Optional	Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#comment"`. Default: drive#comment
`mentionedEmailAddresses`	array	Optional	Output only. A list of email addresses for users mentioned in this comment. If no users are mentioned, the list is empty. Read only: true
`mentionedEmailAddresses[]`	string	Each item
`modifiedTime`	string	Optional	The last time the comment or any of its replies was modified (RFC 3339 date-time). Format: date-time
`quotedFileContent`	object	Optional	The file content to which the comment refers, typically within the anchor region. For a text file, for example, this would be the text at the location of the comment.
`quotedFileContent.mimeType`	string	Optional	The MIME type of the quoted content.
`quotedFileContent.value`	string	Optional	The quoted content itself. This is interpreted as plain text if set through the API.
`replies`	array	Optional	Output only. The full list of replies to the comment in chronological order.
`replies[]`	Model	Each item	Expand Gets a reply by ID For more information, see Manage comments and replies (https: developers google com workspace drive api guides manage-comments) — response body
`resolved`	boolean	Optional	Output only. Whether the comment has been resolved by one of its replies.

Gets an approval by ID For more information, see Manage approvals (https: developers google com workspace drive api guides approvals) — request body — query

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`fields`	string	Required within parent	Selector specifying which fields to include in a partial response. Minimum length: 1
`prettyPrint`	boolean	Optional	Returns response with indentations and line breaks. Default: true
`quotaUser`	string	Optional	Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Gets information about the user, the user's Drive, and system capabilities. For more information, see [Return user info](https://developers.google.com/workspace/drive/api/guides/user-info). Required: The `fields` parameter must be set To return the exact fields you need, see Return specific fields (https: developers google com workspace drive api guides fields-parameter) — response body — user

Field	Type	Presence	Description and constraints
`$`	object	Root	Information about a Drive user.
`displayName`	string	Optional	Output only. A plain text displayable name for this user. Read only: true
`emailAddress`	string	Optional	Output only. The email address of the user. This may not be present in certain contexts if the user has not made their email address visible to the requester. Read only: true
`kind`	string	Optional	Output only. Identifies what kind of resource this is. Value: the fixed string `drive#user`. Default: drive#user Read only: true
`me`	boolean	Optional	Output only. Whether this user is the requesting user. Read only: true
`permissionId`	string	Optional	Output only. The user's ID as visible in Permission resources. Read only: true
`photoLink`	string	Optional	Output only. A link to the user's profile photo, if available. Read only: true

Policy, approvals and errors

SDK function policy ID: google.drive_comments_create. Catalog operation: drive.comments.create. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file"]

Official provider source

Report an issue with this page