RequestHeader

サーバーに送信されるすべてのリクエストに定義されるヘッダー オブジェクト。

JSON 表現
{
  "requestId": string,
  "requestTimestamp": string,
  "userLocale": string,
  "protocolVersion": {
    object (Version)
  }
}
フィールド
requestId

string

必須: このリクエストの一意の識別子。

これは、最大長が 100 文字で、「a ~ z」、「A ~ Z」、「0 ~ 9」、「:」、「-」、「_」のみを含む文字列です。

requestTimestamp

string (int64 format)

必須: エポックからのミリ秒単位で表されるこのリクエストのタイムスタンプ。受信者は、このタイムスタンプが「現在」の ± 60 秒であることを確認する必要があります。このリクエストのタイムスタンプは、再試行時にべき等ではありません。

userLocale
(deprecated)

string

非推奨: 2 文字または 3 文字の 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

必須: マイナー バージョン。マイナーなバグ修正を示します。