REST Resource: projects.locations.orders.comments

Resource: Comment

A comment on an order.

JSON representation
{
  "name": string,
  "createTime": string,
  "labels": {
    string: string,
    ...
  },
  "author": string,
  "text": string,
  "customerViewedTime": string,
  "authorEntity": enum (Entity)
}
Fields
name

string

Identifier. Name of this comment. Format: projects/{project}/locations/{location}/orders/{order}/comments/{comment}

createTime

string (Timestamp format)

Output only. Time when this comment was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

labels

map (key: string, value: string)

Optional. Labels associated with this comment as key value pairs. For more information about labels, see Create and manage labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

author

string

Output only. Username of the author of this comment. This is auto-populated from the credentials used during creation of the comment.

text

string

Required. Text of this comment. The length of text must be <= 1000 characters.

customerViewedTime

string (Timestamp format)

Output only. Timestamp of the first time this comment was viewed by the customer. If the comment wasn't viewed then this timestamp will be unset.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

authorEntity

enum (Entity)

Output only. The entity the author belongs to.

Entity

Entity is used to denote an organization or party.

Enums
ENTITY_UNSPECIFIED Entity is unspecified.
GOOGLE Google.
CUSTOMER Customer.
VENDOR Vendor.

Methods

create

Creates a new comment on an order.

get

Gets the content of a comment.

list

Lists the comments on an order.

recordAction

Record Action on a Comment.