Method: echo

渡された clientMessage をエコーバックします。

この方法は、決済インテグレータと Google との間の基本的な接続をテストするためのものです。

リクエストの処理中にエンドポイントでエラーが発生した場合、このエンドポイントからのレスポンスは ErrorResponse タイプになります。

このメソッドが HTTP 200 を返さない場合、このクエリに対するレスポンスは空になる可能性があります。明確な説明の ErrorResponse を使用して攻撃者が他のインテグレータの決済インテグレータ アカウント ID を把握できるようにする場合は、レスポンスの本文が空になります。署名鍵が一致しない、決済インテグレータ ID が見つからなかった、暗号鍵が不明ななどの状況の場合、このメソッドは空の本文を含む HTTP 404 を返します。リクエストの署名を検証できた場合は、レスポンスの本文でエラーに関する追加情報が返されます。

リクエストの例を次に示します。


{
  "requestHeader": {
    "protocolVersion": {
      "major": 1,
      "minor": 0,
      "revision": 0
    },
    "requestId": "ZWNobyB0cmFuc2FjdGlvbg",
    "requestTimestamp": "1481899949606"
  },
  "clientMessage": "client message"
}

レスポンスの例を次に示します。


{
  "responseHeader": {
    "responseTimestamp": "1481900013178"
  },
  "clientMessage": "client message",
  "serverMessage": "server message"
}

HTTP リクエスト

POST https://vgw.googleapis.com/secure-serving/gsp/v1/echo/:PIAID

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requestHeader": {
    object (RequestHeader)
  },
  "clientMessage": string
}
フィールド
requestHeader

object (RequestHeader)

必須: すべてのリクエストに共通のヘッダー。
clientMessage

string

必須: レスポンスでエコーするメッセージ。

レスポンスの本文

echo メソッドに対するレスポンス オブジェクト。

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現 
{
  "responseHeader": {
    object (ResponseHeader)
  },
  "clientMessage": string,
  "serverMessage": string
}
フィールド
responseHeader

object (ResponseHeader)

必須: すべてのレスポンスに共通のヘッダー。
clientMessage

string

必須: リクエストで受信されたメッセージ。
serverMessage

string

省略可: サーバー メッセージ。エコーされる clientMessage とは関係ありません。

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

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