REST Resource: conversations.messages

リソース: Message

エージェントとユーザーの会話におけるメッセージ。

JSON 表現 
{
  "name": string,
  "messageId": string,
  "representative": {
    object (Representative)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ],
  "fallback": string,
  "containsRichText": boolean,

  // Union field content can be only one of the following:
  "text": string,
  "image": {
    object (Image)
  },
  "richCard": {
    object (RichCard)
  }
  // End of list of possible types for union field content.
}
フィールド
name

string

ビジネス メッセージで設定されているメッセージの名前。"conversations/{conversationId}/messages/{messageId}" に解決します。{conversationId} は会話の一意の ID、{messageId} はメッセージの一意の ID です。
messageId

string

必須。エージェントによって割り当てられたメッセージの一意の識別子。メッセージで以前のメッセージと同じ messageId を使用しようとすると、メッセージの適切な配信に影響が及ぶ可能性があります。
representative

object (Representative)

メッセージを送信した担当者（人間または chatbot）の詳細。
suggestions[]

object (Suggestion)

関連メッセージに続けて候補ワードのリストとして表示される、返信の候補リスト。候補は最大 13 個です。

チップは、関連するメッセージが会話内の最新のメッセージである場合にのみ表示されます（エージェント メッセージとユーザー メッセージの両方を含む）。ユーザーは返信の候補をタップして、エージェントにテキスト返信を送信できます。
fallback

string

（省略可）ユーザーのデバイスがメッセージの種類またはコンテンツをサポートしていない場合に表示される代替テキスト。最大 3,072 文字です。
containsRichText

boolean

（省略可）true の場合、メッセージにリッチテキストが含まれていることを示します。メッセージに無効な形式が含まれている場合、ビジネス メッセージはエラーを返します。
共用体フィールド content。メッセージの内容。content は次のいずれかになります。
text

string

テキスト メッセージ。最大 3,072 文字です。
image

object (Image)

画像メッセージです。
richCard

object (RichCard)

リッチカード メッセージ。

画像

画像。

JSON 表現 
{

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
フィールド
共用体フィールド content。画像コンテンツ。content は次のいずれかになります。
contentInfo

object (ContentInfo)

画像に関する情報（画像の URL や画像のサムネイルの URL など）。

ContentInfo

コンテンツ情報を含むメッセージ。

JSON 表現 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "forceRefresh": boolean,
  "altText": string
}
フィールド
fileUrl

string

ファイルの公開アクセス可能な URL。プラットフォームは、ファイルを取得するときに HTTP ヘッダーの content-type フィールドからファイルの MIME タイプを判断します。URL からの HTTP レスポンスには、content-type フィールドが正確に存在している必要があります。

最大 5 MB です。

サポートされているコンテンツ タイプ: image/jpeg、image/jpg、image/png、image/webp
thumbnailUrl

string

（省略可）サムネイルの公開アクセス可能な URL。

サムネイル URL を指定しない場合、ユーザーのデバイスがファイルをダウンロードするまで、プラットフォームでは空白のプレースホルダ サムネイルが表示されます。

最大 25 KB。

サポートされているコンテンツ タイプ: image/jpeg、image/jpg、image/png、image/webp
forceRefresh

boolean

設定すると、プラットフォームはファイル（またはサムネイル）のコピーをキャッシュに保存している場合でも、指定された URL からファイルやサムネイルを取得します。
altText

string

ユーザー補助機能のために、メディアの詳細を説明するテキスト。

RichCard

エージェントからユーザーに送信されるスタンドアロンのリッチカードまたはリッチカードのカルーセル。

JSON 表現 
{

  // Union field card can be only one of the following:
  "standaloneCard": {
    object (StandaloneCard)
  },
  "carouselCard": {
    object (CarouselCard)
  }
  // End of list of possible types for union field card.
}
フィールド
共用体フィールド card。リッチカードの種類。card は次のいずれかになります。
standaloneCard

object (StandaloneCard)

スタンドアロンのカード。
carouselCard

object (CarouselCard)

カードのカルーセル。

StandaloneCard

スタンドアロンのカード。

JSON 表現 
{
  "cardContent": {
    object (CardContent)
  }
}
フィールド
cardContent

object (CardContent)

カードのコンテンツ。

CardContent

カードのコンテンツ。

JSON 表現 
{
  "title": string,
  "description": string,
  "media": {
    object (Media)
  },
  "suggestions": [
    {
      object (Suggestion)
    }
  ]
}
フィールド
title

string

（省略可）カードのタイトル。最大 200 文字。
description

string

（省略可）カードの説明。最大 2,000 文字です。
media

object (Media)

（省略可）カードに含めるメディア。
suggestions[]

object (Suggestion)

（省略可）カードに含める候補のリスト。候補は最大 4 個です。

Media

リッチカード内のメディア ファイル。

JSON 表現 
{
  "height": enum (Height),

  // Union field content can be only one of the following:
  "contentInfo": {
    object (ContentInfo)
  }
  // End of list of possible types for union field content.
}
フィールド
height

enum (Height)

リッチカード内のメディアの高さ。
共用体フィールド content。メディア コンテンツ。content は次のいずれかになります。
contentInfo

object (ContentInfo)

ファイルに関する情報（ファイルの URL やファイルのサムネイルの URL など）。

高さ

メディアの高さ

列挙型
HEIGHT_UNSPECIFIED 指定されていません。
SHORT 112 DP。
MEDIUM 168 DP。
TALL 264 DP。カードの幅が SMALL に設定されている場合、リッチカード カルーセルには使用できません。

アドバイス

チップリスト内の候補。

JSON 表現 
{

  // Union field option can be only one of the following:
  "reply": {
    object (SuggestedReply)
  },
  "action": {
    object (SuggestedAction)
  },
  "liveAgentRequest": {
    object (LiveAgentRequest)
  },
  "authenticationRequest": {
    object (AuthenticationRequest)
  }
  // End of list of possible types for union field option.
}
フィールド
共用体フィールド option。返信文の候補。option は次のいずれかになります。
reply

object (SuggestedReply)

ユーザーが指定したテキストで返信するための候補です。
action

object (SuggestedAction)

デバイスでネイティブ操作を開始する、推奨される操作です。
liveAgentRequest

object (LiveAgentRequest)

会話に参加する人間のエージェントをリクエスト。
authenticationRequest

object (AuthenticationRequest)

認証フロー開始リクエスト。

SuggestedReply

タップすると、テキスト返信がエージェントに返されます。

JSON 表現 
{
  "text": string,
  "postbackData": string
}
フィールド
text

string

ユーザーがタップしたときに、定型返信文に表示され、エージェントに送信されるテキスト。半角 25 文字（全角 12 文字）まで入力できます。
postbackData

string

ユーザーが返信の候補をタップしたときにエージェントが受け取る文字列。最大 2,048 文字です。

SuggestedAction

タップすると、対応するネイティブ アクションがデバイスで開始されます。

JSON 表現 
{
  "text": string,
  "postbackData": string,

  // Union field action can be only one of the following:
  "openUrlAction": {
    object (OpenUrlAction)
  },
  "dialAction": {
    object (DialAction)
  }
  // End of list of possible types for union field action.
}
フィールド
text

string

提案された操作で表示されるテキスト。半角 25 文字（全角 12 文字）まで入力できます。
postbackData

string

ユーザーが提案されたアクションをタップしたときにエージェントが受け取る文字列。最大 2,048 文字です。
共用体フィールド action。提案された操作をユーザーがタップしたときにデバイスで開始されるネイティブ操作です。action は次のいずれかになります。
openUrlAction

object (OpenUrlAction)

指定した URL を開きます。
dialAction

object (DialAction)

ユーザーのデフォルトの電話アプリを開きます。

OpenUrlAction

指定した URL を開きます。

JSON 表現 
{
  "url": string
}
フィールド
url

string

URL

DialAction

指定した電話番号が入力されたユーザーのデフォルトの電話アプリを開きます。

JSON 表現 
{
  "phoneNumber": string
}
フィールド
phoneNumber

string

必須。指定された電話番号（RFC 3966 形式）。例: 「+1-201-555-0123」。

LiveAgentRequest

このタイプにはフィールドがありません。

タップすると、ライブ対応のエージェントに会話への参加リクエストが送信されます。

AuthenticationRequest

会話の認証をリクエストします。

JSON 表現 
{

  // Union field authentication_type can be only one of the following:
  "oauth": {
    object (Oauth)
  }
  // End of list of possible types for union field authentication_type.
}
フィールド
共用体フィールド authentication_type。認証タイプ。authentication_type は次のいずれかになります。
oauth

object (Oauth)

OAuth による認証の詳細。

OAuth

OAuth による認証の詳細。

JSON 表現 
{
  "clientId": string,
  "codeChallenge": string,
  "scopes": [
    string
  ],
  "codeChallengeMethod": string
}
フィールド
clientId

string

必須。承認を要求するアプリケーションの ID。
codeChallenge

string

必須。アクセス トークンの交換に使用するコード チャレンジ。
scopes[]

string

必須。リクエストのスコープを指定する配列。
codeChallengeMethod

string

（省略可）コード チャレンジを生成するために使用されるコード チャレンジ メソッド。このパラメータを省略すると、サーバーは plain と見なします。

CarouselCard

カードのカルーセル。

JSON 表現 
{
  "cardWidth": enum (CardWidth),
  "cardContents": [
    {
      object (CardContent)
    }
  ]
}
フィールド
cardWidth

enum (CardWidth)

カルーセル内のカードの幅。
cardContents[]

object (CardContent)

カルーセル内の各カードのコンテンツのリスト。カルーセルには、最小 2 枚、最大 10 枚のカードを配置できます。

CardWidth

カルーセル内のカードの幅。

列挙型
CARD_WIDTH_UNSPECIFIED 指定しない
SMALL 136 DP。縦長のメディアは使用できません。
MEDIUM 280 DP。

Methods

create

 エージェントからユーザーにメッセージを送信します。

updateReceipt

 エージェントからユーザーにメッセージの領収書を送信します。