REST Resource: brands.agents

リソース: Agent

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

JSON 表現

JSON 表現
{ "name": string, "displayName": string, "brandName": string, "isArchived": boolean, // 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,
  "brandName": string,
  "isArchived": boolean,

  // 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` 必須。エージェントがユーザーに表示する名前。最大 40 文字。エージェントの確認後に変更することはできません。
`brandName`	`string` 出力専用。エージェントに関連付けられているブランドの名前。
`isArchived`	`boolean` 省略可。`true` の場合、エージェントはアーカイブされ、デフォルトでリスト結果に含まれません。
共用体フィールド `detail_info`。特定のプロダクトに必要なフィールドが含まれます。必須。`detail_info` は次のいずれかになります。
`rcsBusinessMessagingAgent`	`object (RcsBusinessMessagingAgent)` RCS for Business のエージェントの詳細情報。

RcsBusinessMessagingAgent

RCS for Business に関連するエージェント情報。エージェントを作成する際は、対応するラベルとともに、少なくとも 1 つの連絡方法（電話、メール、ウェブサイト）を指定することをおすすめします。エージェントを起動するには、対応するラベルが付いた連絡方法（電話、メール、ウェブサイト）が少なくとも 1 つ必要です。

JSON 表現

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`) }, ... }, "indiaPrincipalEntityId": string }

{
  "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)
    },
    ...
  },
  "indiaPrincipalEntityId": string
}

フィールド
`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))` 出力専用。エージェントのリリースに関する詳細。携帯通信会社に対してのみ入力され、通話している携帯通信会社に関連するリリース情報のみが入力されます。
`indiaPrincipalEntityId`	`string` 省略可。エージェントに関連付けられているビジネスのインドのビジネスプリンシパルエンティティ ID（PE ID）。インドでエージェントをリリースする場合は必須です。

PhoneEntry

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

JSON 表現
{ "phoneNumber": { object (`Phone`) }, "label": string }

フィールド

フィールド
`phoneNumber`	`object (Phone)` 必須。電話番号は、E.164 形式（例: +12223334444）または「+」、プレフィックス、国コードを含まない形式（例: 6502530000）のいずれかで指定します。注: 緊急通報番号は使用できません。
`label`	`string` 必須。電話番号のラベル。

phoneNumber

object (Phone)

必須。電話番号は、E.164 形式（例: +12223334444）または「+」、プレフィックス、国コードを含まない形式（例: 6502530000）のいずれかで指定します。注: 緊急通報番号は使用できません。

label

string

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

EmailEntry

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

JSON 表現
{ "address": string, "label": string }

フィールド

フィールド
`address`	`string` 必須。メールアドレス。
`label`	`string` 必須。メールアドレスのラベル。

address

string

必須。メールアドレス。

label

string

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

WebEntry

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

JSON 表現
{ "uri": string, "label": string }

フィールド

フィールド
`uri`	`string` 必須。エージェントに関連付けられた一般公開 URI。HTTP または HTTPS プロトコルを使用する必要があります。
`label`	`string` `websites` の場合は必須、それ以外の場合は省略可能です。URI のラベル。

uri

string

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

label

string

websites の場合は必須、それ以外の場合は省略可能です。URI のラベル。

RcsBusinessMessagingAgentBillingConfig

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

JSON 表現
{ "billingCategory": enum (`BillingCategory`) }

フィールド

フィールド
`billingCategory`	`enum (BillingCategory)` エージェントの請求カテゴリ。

billingCategory

enum (BillingCategory)

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

BillingCategory

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

列挙型
`BILLING_CATEGORY_UNSPECIFIED`	カテゴリが指定されていません。
`CONVERSATIONAL_LEGACY`	既存のエージェントの課金構成をサポートするレガシーカテゴリ。`CONVERSATIONAL` を代わりに使用してください。この項目は非推奨です。
`CONVERSATIONAL`	ユーザーとブランドが一連のメッセージをやり取りする、より長く複雑なセッション向けに設計されています。
`SINGLE_MESSAGE`	SMS に代わる、よりリッチなメッセージエクスペリエンスを提供します。CONVERSATIONAL として請求されることはありません。この項目は非推奨です。
`BASIC_MESSAGE`	課金モデルは SMS と同様です。CONVERSATIONAL として請求されることはありません。この項目は非推奨です。
`NON_CONVERSATIONAL`	以前の SINGLE_MESSAGE カテゴリと BASIC_MESSAGE カテゴリに代わる、非会話型の請求カテゴリを表します。これは、主に一方向（A2P）のコミュニケーションを行うエージェント向けです。

AgentUseCase

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

列挙型
`AGENT_USE_CASE_UNSPECIFIED`	ユースケースが指定されていません。
`TRANSACTIONAL`	重要なメッセージ、必要なメッセージ、時間的制約のあるメッセージのみを送信するエージェント。
`PROMOTIONAL`	セールス、マーケティング、プロモーションメッセージを送信するエージェント。デフォルトのタイプ。
`OTP`	ワンタイムパスワードのみを送信するエージェント。
`MULTI_USE`	複数のユースケースに対応するエージェント。これには、1 つのユースケースがすぐにリリースされ、2 つ目のユースケースが今後のリリースで予定されているエージェントが含まれます。詳細については、多目的のドキュメントをご覧ください。

HostingRegion

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

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

PartnerEntry

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

JSON 表現
{ "partnerId": string, "displayName": string, "company": string }

フィールド

フィールド
`partnerId`	`string` 出力専用。パートナーの固有識別子。
`displayName`	`string` 出力専用。商品でパートナーを関連付けるためにビジネスに表示される名前。パートナー間で一意にする必要があります。
`company`	`string` 出力専用。指定されたパートナーの会社の公開名。

partnerId

string

出力専用。パートナーの固有識別子。

displayName

string

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

company

string

出力専用。指定されたパートナーの会社の公開名。

RcsBusinessMessagingRegionLaunch

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

JSON 表現
{ "launchState": enum (`LaunchState`), "comment": string, "updateTime": string, "isHidden": boolean }

フィールド
`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"`。
`isHidden`	`boolean` 省略可。コンソールと API ビューの可視性に影響する、エージェントが携帯通信会社に対して非表示としてマークされているかどうかを指定します。

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`	エージェントの確認ステータスを更新します。

REST Resource: brands.agents

リソース: Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

メソッド

`create`

`delete (deprecated)`

`get`

`getLaunch`

`getVerification`

`list`

`patch`

`requestLaunch`

`requestVerification`

`updateLaunch`

`updateVerification`

REST Resource: brands.agents コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

リソース: Agent

RcsBusinessMessagingAgent

PhoneEntry

EmailEntry

WebEntry

RcsBusinessMessagingAgentBillingConfig

BillingCategory

AgentUseCase

HostingRegion

PartnerEntry

RcsBusinessMessagingRegionLaunch

LaunchState

メソッド

delete (deprecated)

REST Resource: brands.agents

`delete (deprecated)`