REST Resource: projects.locations.privateOffers.documents

资源：PrivateOfferDocument

描述 PrivateOfferDocument 资源的消息。用于将文档附加到处于“草稿”状态的私密优惠。一旦私密优惠不再处于 DRAFT 状态，子文档集就不可变。无法更新或删除现有文档，也无法添加新文档。

一个私享优惠最多可以包含每种类型的一个文档，并且不能同时包含标准最终用户许可协议 (EULA) 和自定义 EULA。

哪些证件类型是必需的、可选的或不允许的，取决于相应优惠所适用的服务，并在 Service.document_requirement 中返回。

JSON 表示法 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "documentType": enum (DocumentType),
  "mimeType": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineContent": string
  // End of mutually exclusive fields.
}
字段
name

string

标识符。资源的名称。
createTime

string (Timestamp format)

仅限输出。资源的创建时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。资源的上次更新时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
documentType

enum (DocumentType)

必需。相应文档的分类类型。用于区分可能附加到私人优惠的不同类型的文档，这些文档用于不同的业务目的。
mimeType

string

可选。文档的 MIME 类型。用于区分不同的文档格式。支持的格式（未来可能会增加）

  • 'application/pdf'
用于存储文档内容的机制。以下是互斥字段的列表。在响应中，最多只能设置以下字段之一：
inlineContent

string (bytes format)

可选。非结构化文档的字节内容。大小上限：4MB

使用 base64 编码的字符串。
互斥字段的结束。

方法

create

 在给定的项目和位置中创建新的 PrivateOfferDocument。

delete

 删除目标 PrivateOfferDocument。

get

 获取单个 PrivateOfferDocument 的详细信息。

list

 列出指定父级对应的 PrivateOfferDocuments。

patch

 更新目标 PrivateOfferDocument。