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)
  }
  // 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

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

ナレッジベースの情報。ナレッジベースには、よくある質問の 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)

出力のみ。ナレッジベースが作成または更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

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/base2/12/1/knowledge」に解決されます。
displayName

string

必須。よくある質問ドキュメントの表示名。
updateTime

string (Timestamp format)

出力のみ。ドキュメントが作成または更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
operationInfo

object (OperationInfo)

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

string

よくある質問のドキュメントの URL。
rawContent

string (bytes format)

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

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

DialogflowCxIntegration

ビジネス メッセージ エージェントと 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 統合の動作状態に関する情報。

Methods

create

 統合を作成します。

delete

 統合を削除します。

get

 統合する。

list

 統合を一覧表示します。

patch

 統合を更新します。