Creates a comment on a file.

Scopes

You will need authorization for at least one of the following scopes to make a valid call:

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

If unset, the scope for this method defaults to https://www.googleapis.com/auth/drive. You can set the scope for this method like this: drive3 --scope <scope> comments create ...

Required Scalar Argument

  • <file-id> (string)
    • The ID of the file.

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Comment:
  anchor: string
  author:
    display-name: string
    email-address: string
    kind: string
    me: boolean
    permission-id: string
    photo-link: string
  content: string
  created-time: string
  deleted: boolean
  html-content: string
  id: string
  kind: string
  modified-time: string
  quoted-file-content:
    mime-type: string
    value: string
  resolved: boolean

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . anchor=sed
    • A region of the document represented as a JSON string. For details on defining anchor properties, refer to Manage comments and replies.
  • author display-name=ut
    • Output only. A plain text displayable name for this user.
  • email-address=gubergren
    • 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.
  • kind=rebum.
    • Output only. Identifies what kind of resource this is. Value: the fixed string &#34;drive#user&#34;.
  • me=true
    • Output only. Whether this user is the requesting user.
  • permission-id=ipsum
    • Output only. The user's ID as visible in Permission resources.

  • photo-link=ipsum

    • Output only. A link to the user's profile photo, if available.

  • .. content=est

    • The plain text content of the comment. This field is used for setting the content, while htmlContent should be displayed.
  • created-time=gubergren
    • The time at which the comment was created (RFC 3339 date-time).
  • deleted=false
    • Output only. Whether the comment has been deleted. A deleted comment has no content.
  • html-content=lorem
    • Output only. The content of the comment with HTML formatting.
  • id=eos
    • Output only. The ID of the comment.
  • kind=labore
    • Output only. Identifies what kind of resource this is. Value: the fixed string &#34;drive#comment&#34;.
  • modified-time=sed
    • The last time the comment or any of its replies was modified (RFC 3339 date-time).
  • quoted-file-content mime-type=duo
    • The MIME type of the quoted content.

  • value=sed

    • The quoted content itself. This is interpreted as plain text if set through the API.

  • .. resolved=true

    • Output only. Whether the comment has been resolved by one of its replies.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • 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.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").