REST Resource: projects.locations.privateOffers.documents

资源:PrivateOfferDocument

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

私密优惠必须包含最终用户许可协议,方法是分配标准最终用户许可协议或附加自定义最终用户许可协议文档,或者附加工作声明文档。

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

  // Union field content can be only one of the following:
  "inlineContent": string
  // End of list of possible types for union field content.
}
字段
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”
联合字段 content。用于存储文档内容的机制。content 只能是下列其中一项:
inlineContent

string (bytes format)

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

使用 base64 编码的字符串。

DocumentType

支持的证件类型。未来可能会添加其他证件类型。未来可能会发布更多版本的 Google Cloud Marketplace 标准 EULA,这可能会导致允许在新优惠中使用的标准 EULA 版本子集发生变化。

枚举
DOCUMENT_TYPE_UNSPECIFIED 默认值 / 未设置的值。请勿使用。
CUSTOM_END_USER_LICENSE_AGREEMENT

该文档是一份自定义的最终用户许可协议,用于取代标准产品最终用户许可协议。非公开优惠不得包含多个自定义 EULA 文档。

如果设置了此枚举值,则必须设置 mimeType 和 inlineContent。

STATEMENT_OF_WORK

该文档是所有专业服务产品非公开优惠所需的任务声明。Cloud Marketplace 产品专用条款要求提供该文档。此文档类型不允许用于任何其他产品类型的私下交易。一个私下交易不得包含多个工作说明文档。

必须设置 mimeType 和 inlineContent 字段。

STANDARD_END_USER_LICENSE_AGREEMENT_V1 该文档是 Marketplace 标准版最终用户许可协议,可通过以下链接查看:https://cloud.google.com/terms/marketplace/eula-standard-v1-12102020。现有优惠可能包含此文档类型,但新优惠不允许包含此文档类型。
STANDARD_END_USER_LICENSE_AGREEMENT_V2

该文档是 Marketplace 标准版最终用户许可协议,可通过以下链接查看:https://cloud.google.com/terms/marketplace/eula-standard-v2-01272021

使用标准 EULA 的新优惠应设置此枚举值。专业服务产品不允许使用此功能。

不得设置 mimeType 和 inlineContent 字段。

方法

create

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

delete

删除目标 PrivateOfferDocument。

get

获取单个 PrivateOfferDocument 的详细信息。

list

列出指定父级对应的 PrivateOfferDocuments。

patch

更新目标 PrivateOfferDocument。