Method: projects.locations.apps.sessions.generateChatToken

チャット ウィジェットが Session API で認証するためのセッション スコープ トークンを生成します。

HTTP リクエスト

POST https://ces.googleapis.com/v1/{name=projects/*/locations/*/apps/*/sessions/*}:generateChatToken

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。チャット トークンを生成するセッション名。形式: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

リクエストの本文

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

JSON 表現 
{
  "deployment": string,
  "recaptchaToken": string,
  "liveHandoffEnabled": boolean
}
フィールド
deployment

string

必須。セッションで使用するアプリのデプロイ。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
recaptchaToken

string

省略可。クライアントサイドのチャット ウィジェットによって生成された reCAPTCHA トークン。
liveHandoffEnabled

boolean

省略可。セッションでライブ ハンドオフが有効になっているかどうかを示します。

レスポンスの本文

WidgetService.GenerateChatToken に対するレスポンス メッセージです。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "chatToken": string,
  "expireTime": string
}
フィールド
chatToken

string

Session API で認証するためのチャット ウィジェットのセッション スコープ トークン。
expireTime

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"。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

詳細については、Authentication Overview をご覧ください。