REST Resource: brands.agents

リソース: Agent

ブランドを表す会話エンティティ。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "brandName": string,

  // Union field detail_info can be only one of the following:
  "rcsBusinessMessagingAgent": {
    object (RcsBusinessMessagingAgent)
  }
  // End of list of possible types for union field detail_info.
}
フィールド
name

string

エージェントの一意の識別子。

読み取り専用。プラットフォームによって定義されます。
displayName

string

必須。エージェントがユーザーに表示する名前。100 文字以内で指定します。

エージェントの確認後に変更することはできません。
brandName

string

出力専用。エージェントに関連付けられているブランドの名前。

共用体フィールド detail_info。特定の商品に必要なフィールドが含まれます。

必須。detail_info は次のいずれかになります。
rcsBusinessMessagingAgent

object (RcsBusinessMessagingAgent)

RCS ビジネス メッセージの詳細なエージェント情報。

RcsBusinessMessagingAgent

RCS ビジネス メッセージに特に関連するエージェント情報。エージェントを作成する場合は、少なくとも 1 つの連絡方法（電話、メール、ウェブサイト）と、対応するラベルを指定することをおすすめします。エージェント リリースでは、対応するラベルが付いた電話番号またはメールアドレスの連絡先が少なくとも 1 つ必要です。

JSON 表現 
{
  "description": string,
  "logoUri": string,
  "heroUri": string,
  "phoneNumbers": [
    {
      object (PhoneEntry)
    }
  ],
  "emails": [
    {
      object (EmailEntry)
    }
  ],
  "websites": [
    {
      object (WebEntry)
    }
  ],
  "privacy": {
    object (WebEntry)
  },
  "termsConditions": {
    object (WebEntry)
  },
  "color": string,
  "billingConfig": {
    object (RcsBusinessMessagingAgentBillingConfig)
  },
  "agentUseCase": enum (AgentUseCase),
  "hostingRegion": enum (HostingRegion),
  "partner": {
    object (PartnerEntry)
  },
  "launchDetails": {
    string: {
      object (RcsBusinessMessagingRegionLaunch)
    },
    ...
  }
}
フィールド
description

string

必須。ユーザーに表示されるエージェントの説明。（100 文字以内）。詳細な要件については、エージェント情報を編集するをご覧ください。
logoUri

string

必須。エージェントのロゴの一般公開 URL。最大 50 KB。

エージェントの確認後に変更することはできません。
heroUri

string

必須。エージェントのヒーロー画像の一般公開 URL。最大 200 KB。

エージェントの確認後に変更することはできません。
phoneNumbers[]

object (PhoneEntry)

エージェントに関連付けられている電話番号。メールアドレスが指定されていない場合は必須です。
emails[]

object (EmailEntry)

エージェントに関連付けられているメールアドレス。電話番号が指定されていない場合に必須です。
websites[]

object (WebEntry)

省略可。エージェントに関連付けられているウェブサイト。最大 3 個。
privacy

object (WebEntry)

必須。エージェントに関連付けられているプライバシー ポリシー。
termsConditions

object (WebEntry)

必須。エージェントに関連付けられている利用規約。
color

string

必須。ユーザーに表示されるエージェントのテーマカラー（16 進数）。例: #FF6347。
billingConfig

object (RcsBusinessMessagingAgentBillingConfig)

必須。エージェントの課金構成。
agentUseCase

enum (AgentUseCase)

省略可。ボットのユースケース。
hostingRegion

enum (HostingRegion)

必須。エージェントのホスティング リージョン。
partner

object (PartnerEntry)

出力専用。エージェントに関連付けられているパートナー。
launchDetails

map (key: string, value: object (RcsBusinessMessagingRegionLaunch))

出力専用。エージェントのリリースの詳細。携帯通信会社に対してのみ入力され、その場合も、問い合わせを行った携帯通信会社に関連するリリースの詳細のみが入力されます。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

PhoneEntry

エージェントに関連付けられている電話番号。

JSON 表現 
{
  "phoneNumber": {
    object (Phone)
  },
  "label": string
}
フィールド
phoneNumber

object (Phone)

必須。電話番号は、E.164 形式（例: +12223334444）または「+」、局番、国コードを含まない市内通話/フリーダイヤルの電話番号（例: 6502530000）のいずれかの形式で指定できます。注: 緊急通報番号は使用できません。
label

string

必須。電話番号のラベル。

EmailEntry

エージェントに関連付けられているメールアドレス。

JSON 表現 
{
  "address": string,
  "label": string
}
フィールド
address

string

必須。メールアドレス。
label

string

必須。メールアドレスのラベル。

WebEntry

エージェントに関連付けられているウェブベースのリソース。

JSON 表現 
{
  "uri": string,
  "label": string
}
フィールド
uri

string

必須。エージェントに関連付けられた、一般公開されている URI。HTTP または HTTPS プロトコルを使用する必要があります。
label

string

必須。URI のラベル。

RcsBusinessMessagingAgentBillingConfig

エージェントの課金構成。

JSON 表現 
{
  "billingCategory": enum (BillingCategory)
}
フィールド
billingCategory

enum (BillingCategory)

エージェントの請求カテゴリ。

BillingCategory

サポートされている請求カテゴリ。

列挙型
BILLING_CATEGORY_UNSPECIFIED カテゴリが指定されていません。
CONVERSATIONAL_LEGACY 既存のエージェントの課金構成をサポートするレガシー カテゴリ。
CONVERSATIONAL ユーザーとブランドが連続してメッセージをやり取りする、より長く複雑なセッション向けに設計されています。
SINGLE_MESSAGE SMS に代わる高度なメッセージ エクスペリエンスを提供します。CONVERSATIONAL として請求されることはありません。
BASIC_MESSAGE 請求モデルは SMS と類似しています。CONVERSATIONAL として請求されることはありません。

AgentUseCase

ストレージで使用されるエージェントのユースケースのタイプ。

列挙型
AGENT_USE_CASE_UNSPECIFIED ユースケースが指定されていません。
TRANSACTIONAL 重要なメッセージ、必要なメッセージ、時間に敏感なメッセージのみを送信するエージェント。
PROMOTIONAL セールス、マーケティング、プロモーション メッセージを送信するエージェント。デフォルトのタイプ。
OTP ワンタイム パスワードのみを送信するエージェント。
MULTI_USE 複数のユースケースがあるエージェント。

HostingRegion

エージェントのホスティングに使用できるリージョン。P2A メッセージをリージョン化されたサーバーに正しく転送するために使用されます。

列挙型
HOSTING_REGION_UNSPECIFIED ホスティング リージョンが指定されていません。
NORTH_AMERICA 北米。
EUROPE 送信できるようにします。
ASIA_PACIFIC アジア太平洋

PartnerEntry

エージェントに関連付けられているパートナー。

JSON 表現 
{
  "partnerId": string,
  "displayName": string,
  "company": string
}
フィールド
partnerId

string

出力専用。パートナーの一意の識別子。
displayName

string

出力専用。商品のパートナーを関連付けるためにビジネスに表示される名前。パートナー間で一意にする必要があります。
company

string

出力専用。指定したパートナーの会社名。（Twilio、HeyMarket など）。

RcsBusinessMessagingRegionLaunch

各地域での RCS ビジネス メッセージ エージェントのリリースに関する詳細。

JSON 表現 
{
  "launchState": enum (LaunchState),
  "comment": string,
  "updateTime": string
}
フィールド
launchState

enum (LaunchState)

地域のリリース ステータス。
comment

string

携帯通信会社からのコメント。
updateTime

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

LaunchState

エンティティのリリース ステータス。

列挙型
LAUNCH_STATE_UNSPECIFIED 未指定の状態
LAUNCH_STATE_UNLAUNCHED エンティティがリリースされていません。
LAUNCH_STATE_PENDING リリースの審査中。
LAUNCH_STATE_LAUNCHED リリース済み。
LAUNCH_STATE_REJECTED リリースが拒否されました。
LAUNCH_STATE_SUSPENDED リリースは一時停止されています。
LAUNCH_STATE_PENDING_UNLAUNCH 審査中の公開停止。
LAUNCH_STATE_INVALID_IN_GMB 関連付けられている Google マイビジネス リスティングがメッセージングをサポートしていないため、リリースは無効です。Google マイビジネスでの再確認は、ここで自動的に再開されます。ロケーションにのみ適用されます。

メソッド

create

 ブランドを表す新しいエージェントを作成します。

delete
(deprecated)

 非推奨: エージェントの削除は非推奨になりました。

get

 エージェントに関する情報を取得します。

getLaunch

 エージェントの起動情報を取得します。

getVerification

 エージェントの確認情報を取得します。

list

 ブランドに関連付けられているすべてのエージェントを一覧表示します。

patch

 エージェントに関する情報を更新します。

requestLaunch

 エージェントのリリース プロセスを開始します。

requestVerification

 エージェントのビジネス確認情報を送信します。

updateLaunch

 エージェントのリリース情報を更新します。

updateVerification

 エージェントの確認ステータスを更新します。