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 文字（全角 100 文字）。
description

string

省略可。カードの説明。最大半角 2,000 文字（全角 1,000 文字）。
media

object (Media)

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

object (Suggestion)

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

メディア

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

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。

メソッド

create

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

updateReceipt

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