REST Resource: projects.locations.privateOffers.documents

資源:PrivateOfferDocument

說明 PrivateOfferDocument 資源的訊息。用於將文件附加至狀態為草稿的私人方案。私人方案不再處於「草稿」狀態後,子項文件集就無法變更。無法更新或刪除現有文件,也無法新增文件。

每個類型的文件最多只能有一份,且不得同時包含標準和自訂使用者授權協議。

哪些文件類型為必要、選用或不允許,取決於優惠適用的服務,並會以 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

ID。資源名稱。

createTime

string (Timestamp format)

僅供輸出。資源的建立時間。

使用 RFC 3339,產生的輸出內容一律會經過 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 正規化,並使用 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)

選用。非結構化文件的位元組內容。大小上限:4 MB

Base64 編碼字串。

互斥欄位的結尾。

方法

create

在指定專案和位置建立新的 PrivateOfferDocument。

delete

刪除目標 PrivateOfferDocument。

get

取得單一 PrivateOfferDocument 的詳細資料。

list

列出指定上層的 PrivateOfferDocuments。

patch

更新目標 PrivateOfferDocument。