REST Resource: brands.agents.integrations

リソース: 統合

統合に関する情報。

JSON 表現 
{
  "name": string,
  "status": enum (IntegrationStatus),

  // Union field integration_info can be only one of the following:
  "dialogflowEsIntegration": {
    object (DialogflowEsIntegration)
  },
  "dialogflowCxIntegration": {
    object (DialogflowCxIntegration)
  },
  "agentWebhookIntegration": {
    object (AgentWebhookIntegration)
  }
  // End of list of possible types for union field integration_info.
}
フィールド
name

string

出力専用。インテグレーションの一意の識別子。読み取り専用。プラットフォームによって定義されます。
status

enum (IntegrationStatus)

出力専用。統合ステータス。
共用体フィールド integration_info。インテグレーションの詳細情報。integration_info は次のいずれかになります。
dialogflowEsIntegration

object (DialogflowEsIntegration)

関連付けられた Dialogflow ES プロジェクトに関する情報。https://cloud.google.com/dialogflow/es/docs
dialogflowCxIntegration

object (DialogflowCxIntegration)

関連付けられた Dialogflow CX プロジェクトに関する情報。https://cloud.google.com/dialogflow/cx/docs/basics
agentWebhookIntegration

object (AgentWebhookIntegration)

エージェントの Webhook に関する情報。Webhook がエージェント レベルで構成されている場合、パートナー レベルの Webhook よりも優先されます。

IntegrationStatus

統合のステータス。

列挙型
INTEGRATION_STATUS_UNSPECIFIED 統合のステータスが指定されていません。
ENABLED 有効です。
DISABLED 無効です。

DialogflowEsIntegration

ビジネス メッセージ エージェントと Dialogflow ES プロジェクトの関連付けに関する情報。

JSON 表現 
{
  "dialogflowProjectId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  },
  "dialogflowKnowledgeBases": [
    {
      object (DialogflowKnowledgebase)
    }
  ]
}
フィールド
dialogflowProjectId

string

必須。Dialogflow プロジェクト ID。

編集できません。この値を変更するには、このエージェントから Dialogflow プロジェクトを削除してから、新しい統合を作成する必要があります。
autoResponseStatus

enum (AutoResponseStatus)

必須。ENABLED の場合、ビジネス メッセージは Dialogflow のレスポンスをユーザーに自動的に送信します。
dialogflowServiceAccountEmail

string

出力専用。Dialogflow プロジェクトで「Dialogflow コンソール エージェント編集者」ロールと「Dialogflow API クライアント」ロールを使用して構成する必要があるサービス アカウント。これは、Dialogflow API へのアクセス権を付与するために必要です。
operationInfo

object (OperationInfo)

出力専用。Dialogflow との統合の動作状態に関する情報。
dialogflowKnowledgeBases[]

object (DialogflowKnowledgebase)

Dialogflow プロジェクトに関連付けられたナレッジベース。

省略可

AutoResponseStatus

Dialogflow の自動応答ステータス。

列挙型
AUTO_RESPONSE_STATUS_UNSPECIFIED 自動応答が指定されていません。
ENABLED 自動返信が有効になっている。
DISABLED 自動返信は無効になっています。

OperationInfo

Dialogflow オペレーション情報。

JSON 表現 
{
  "operationName": string,
  "operationType": enum (OperationType),
  "operationState": enum (OperationState),
  "error": {
    object (Status)
  }
}
フィールド
operationName

string

出力専用。サーバーによって割り当てられる名前（オペレーション ID）。最初にその名前を返すサービスと同じサービス内でのみ一意になります。
operationType

enum (OperationType)

出力専用。Dialogflow オペレーション タイプ。
operationState

enum (OperationState)

出力専用。Dialogflow オペレーションの状態。
error

object (Status)

出力専用。エラー結果（ある場合）。

OperationType

Dialogflow のオペレーション タイプ。

列挙型
OPERATION_TYPE_UNSPECIFIED 未指定のタイプ。
ASSOCIATE_DIALOGFLOW Dialogflow を関連付けます。
DISSOCIATE_DIALOGFLOW Dialogflow の関連付けを解除します。
ADD_DOCUMENT_TO_KNOWLEDGEBASE ナレッジベースにドキュメントを追加します。
DELETE_DOCUMENT_FROM_KNOWLEDGEBASE ナレッジベースからドキュメントを削除します。

OperationState

Dialogflow のオペレーションのステータス。

列挙型
OPERATION_STATE_UNSPECIFIED 未指定の状態
PROCESSING 処理中です。
COMPLETED 完了しています。
FAILED エラーが発生しました。

ステータス

Status 型は、REST API や RPC API など、さまざまなプログラミング環境に適した論理エラーモデルを定義します。gRPC により使用されます。各 Status メッセージには、エラーコード、エラー メッセージ、エラーの詳細という 3 種類のデータが含まれます。

このエラーモデルと使い方について詳しくは、API 設計ガイドをご覧ください。

JSON 表現 
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
フィールド
code

integer

ステータス コード。google.rpc.Code の列挙値である必要があります。
message

string

デベロッパー向けのエラー メッセージ。英語で記述します。ユーザー向けのエラー メッセージは、ローカライズして google.rpc.Status.details フィールドで送信するか、クライアントでローカライズする必要があります。
details[]

object

エラーの詳細を保持するメッセージのリスト。API が使用する共通のメッセージ タイプのセットがあります。

任意のデータ型のフィールドを含むオブジェクトであり、型を識別する URI を含むフィールド "@type" を追加できます。例: { "id": 1234, "@type": "types.example.com/standard/id" }

DialogflowKnowledgebase

ナレッジベースの情報。ナレッジベースには複数の FAQ URL を設定できます。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "documents": [
    {
      object (DialogflowDocument)
    }
  ],
  "updateTime": string
}
フィールド
name

string

出力専用。ナレッジベース ID。

ナレッジベースの作成後に Dialogflow サービスから返される一意の識別子。ブランド ID が「1234」、エージェント ID が「5678」、統合 ID が「9092」、ナレッジベース ID が「1111」の場合、このパラメータは「brands/1234/agents/5678/integrations/9092/knowledgebases/1111」に解決されます。
displayName

string

必須。ナレッジベースの表示名。
documents[]

object (DialogflowDocument)

ナレッジベースのドキュメント。

省略可
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"。

DialogflowDocument

ナレッジベースのドキュメント。ドキュメントには、ウェブサイトの URL または CSV ファイルの URL を指定できます。URL は一般公開されている必要があります。CSV ファイルには、1 つ以上の質問と回答のペアが含まれている必要があります。各ペアは 1 行で表します。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "updateTime": string,
  "operationInfo": {
    object (OperationInfo)
  },

  // Union field content can be only one of the following:
  "faqUrl": string,
  "rawContent": string
  // End of list of possible types for union field content.
}
フィールド
name

string

システム生成のドキュメント ID。

ブランド ID が「1234」、エージェント ID が「5678」、インテグレーション ID が「9092」、ナレッジベース ID が「1111」、ドキュメント ID が「2222」の場合、このパラメータは「brands/1234/agents/5678/integrations/9092/knowledgebases/1111/documents/2222」に解決されます。
displayName

string

必須。FAQ ドキュメントの表示名。
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"
operationInfo

object (OperationInfo)

出力専用。オペレーション情報は、ドキュメントが既存のナレッジベースに追加された場合にのみ入力されます。
共用体フィールド content。ドキュメントの内容。content は次のいずれかになります。
faqUrl

string

FAQ ドキュメントの URL。
rawContent

string (bytes format)

ドキュメントの未加工のコンテンツ。

Base64 でエンコードされた文字列。

DialogflowCxIntegration

Business Messages エージェントと Dialogflow CX プロジェクトの関連付けに関する情報。

JSON 表現 
{
  "dialogflowProjectId": string,
  "dialogflowAgentId": string,
  "autoResponseStatus": enum (AutoResponseStatus),
  "dialogflowServiceAccountEmail": string,
  "operationInfo": {
    object (OperationInfo)
  }
}
フィールド
dialogflowProjectId

string

必須。Dialogflow プロジェクト ID。

編集できません。この値を変更するには、このエージェントから Dialogflow プロジェクトを削除してから、新しい統合を作成する必要があります。
dialogflowAgentId

string

必須。Dialogflow エージェント ID。
autoResponseStatus

enum (AutoResponseStatus)

必須。ENABLED の場合、ビジネス メッセージは Dialogflow のレスポンスをユーザーに自動的に送信します。
dialogflowServiceAccountEmail

string

出力専用。Dialogflow プロジェクトで「Dialogflow コンソール エージェント編集者」ロールと「Dialogflow API クライアント」ロールを使用して構成する必要があるサービス アカウント。これは、Dialogflow API へのアクセス権を付与するために必要です。
operationInfo

object (OperationInfo)

出力専用。Dialogflow との統合の動作状態に関する情報。

AgentWebhookIntegration

ビジネス メッセージ エージェントの Webhook に関する情報。

JSON 表現 
{
  "webhookUri": string,
  "verificationToken": string
}
フィールド
webhookUri

string

必須。メッセージが配信される Webhook URL。
verificationToken

string

入力専用。確認トークン。

メソッド

create

 統合を作成する

delete

 統合を削除します。

get

 統合を取得します。

list

 統合を一覧表示します。

patch

 インテグレーションを更新します。