RequestHeader

可對傳送至伺服器的所有要求定義的標頭物件。

JSON 表示法
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
欄位
requestId

string

必要項目:要求的專屬 ID。

這個字串的長度上限為 100 個半形字元,且只能包含「a-z」、「A-Z」、「0-9」、「:」、「-」和「_」等字元。

requestTimestamp

string (int64 format)

REQUIRED:這項要求的時間戳記,以 Epoch 紀元時間起算的毫秒數表示。接收端應驗證這個時間戳記是否為「現在」的 ±60 秒。重試時此要求的時間戳記不是冪等。

userLocale
(deprecated)

string

已淘汰:由二或三個字母組成的 ISO 639-2 Alpha 3 語言代碼,後面加上連字號和 ISO 3166-1 Alpha-2 國家/地區代碼,例如「pt」、「pt-BR」、「fil」或「fil-PH」。這有助於在回應中呈現 userMessage 欄位。

protocolVersion

object (Version)

必要項目:要求的版本。

版本

傳統版 a.b.c 版本結構的結構化格式版本物件。只要是相同數字的主要版本,我們保證會相容。請注意,微幅和修訂可能經常變更,恕不另行通知。整合商必須支援對相同主要版本的所有要求。

JSON 表示法
{
  "major": integer,
  "minor": integer,
  "revision": integer
}
欄位
major

integer

必要項目:主要版本。標示此選項,代表不同版本的相容性要求不保證能相容。

minor

integer

必要項目:子版本。這代表了重大錯誤修正。

revision

integer

必要項目:子版本。這代表微小的錯誤修正。