Twilio

Twilio コネクタを使用すると、Twilio インスタンスに接続し、従来のデータベースとして Twilio データにアクセスできます。

始める前に

Twilio コネクタを使用する前に、次の作業を行います。

  • Google Cloud プロジェクトで次の操作を行います。
    • ネットワーク接続が設定されていることを確認します。ネットワーク パターンの詳細については、Network Connectivity をご覧ください。
    • コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
    • コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。

    • 次のサービスを有効にします。
      • secretmanager.googleapis.com(Secret Manager API)
      • connectors.googleapis.com(Connectors API)

      サービスを有効にする方法については、サービスを有効にするをご覧ください。

      以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

  • Twilio インスタンスから Twilio アカウント SID と認証トークンを取得します。アカウント SID、認証トークンをご覧ください。

コネクタを構成する

コネクタを構成するには、データソース(バックエンド システム)への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

  1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [接続] ページに移動

  2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
  3. [ロケーション] セクションで、接続のロケーションを選択します。
    1. リージョン: プルダウン リストからロケーションを選択します

      サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。

    2. [NEXT] をクリックします。
  4. [接続の詳細] セクションで、次の操作を行います。
    1. コネクタ: 使用可能なコネクタのプルダウン リストから [Twilio] を選択します。
    2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
    3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
    4. 必要に応じて、接続インスタンスの [説明] を入力します。
    5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
    6. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
    7. 必要に応じて、接続ノードの設定を構成します。

      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。

    8. プロキシを使用: このチェックボックスを選択して、接続用のプロキシ サーバーを構成し、次の値を構成します。
      • Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
        • 基本: 基本的な HTTP 認証。
        • ダイジェスト: ダイジェスト HTTP 認証。
      • Proxy User: プロキシ サーバーでの認証に使用されるユーザー名。
      • プロキシ パスワード: ユーザーのパスワードの Secret Manager シークレット。
      • Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次の認証タイプがサポートされています。
        • 自動: デフォルトの設定。URL が HTTPS URL の場合は、[トンネル] オプションが使用されます。URL が HTTP URL の場合、[なし] オプションが使用されます。
        • 常に: 接続は常に SSL 対応です。
        • なし: 接続は SSL に対応していません。
        • トンネル: 接続はトンネリング プロキシ経由で行われます。プロキシ サーバーがリモートホストへの接続を開き、トラフィックはプロキシを経由するようになります。
      • [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
        1. [+ 宛先を追加] をクリックします。
        2. [宛先の種類] を選択します。
          • Host address: 宛先のホスト名または IP アドレスを指定します。

            バックエンドへのプライベート接続を確立する場合は、次のようにします。

    9. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    10. [NEXT] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

      Twilio 接続でサポートされる認証タイプは次のとおりです。

      • ユーザー名とパスワードを指定する
    2. これらの認証タイプを構成する方法については、認証を構成するをご覧ください。

    3. [NEXT] をクリックします。
  6. Review: 接続と認証の詳細を確認します。
  7. [作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

  • ユーザー名とパスワード
    • アカウント SID: 現在認証されているユーザーのアカウント SID。
    • 認証トークン: 現在認証されているユーザーの認証トークン。

接続構成のサンプル

このセクションでは、Twilio コネクタの作成時に構成するさまざまなフィールドのサンプル値を示します。

Twilio サーバー - ウェブ接続タイプ

フィールド名 詳細
ロケーション us-east1
コネクタ Twilio
コネクタのバージョン 1
接続名 gcp-twilio-rest-conn
サービス アカウント SERVICE_ACCOUNT_NAME@serviceaccount
ノードの最小数 2
ノードの最大数 50
アカウント SID ACCOUNT_SID
認証トークン AUTH_TOKEN
シークレット バージョン 1

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

  • エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

    ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

  • オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。

    使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

  • アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

Twilio コネクタは、ノードごとに 1 秒あたり 25 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてthrottlesされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます(可用性を高めるため)。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

例 - すべてのレコーディングを一覧表示する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [レコーディング] を選択します。
  3. [List] オペレーションを選択し、[完了] をクリックします。

例 - 単一の録音を取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [レコーディング] を選択します。
  3. [Get] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を「単一の録音」に設定します。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] に RE2e915e78549694bd0a0742d2d39454e5 を入力します。

例 - 通話を削除する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. [Entity] リストから [Calls] を選択します。
  3. [Delete] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を設定して、通話を削除します。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] に CAaa4a99c300bd9d1bcc0d1ae9dcd248c6 を入力します。

例 - 通話のフィードバックを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. [Entity] リストから [フィードバック] を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
    {
                        "Sid": "CAdefbf2b4caa7df11dc48106385e32345",
                        "QualityScore": 5
                      }

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
                        "Sid": "CAdefbf2b4caa7df11dc48106385e32345"
                      }

例 - 通話のフィードバックの概要を作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから FeedbackSummary を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
    {
                        "StartDate": "2014-06-01",
                        "EndDate": "2014-06-04"
                      }

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
                        "Sid": "FS11f26a89d7260fb8cef070b768fcf5d1"
                      }

例 - メッセージの作成

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストからメッセージを選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
    {
                        "To": "whatsapp:+9178923*****",
                        "Sender": "whatsapp:+14155238886",
                        "Body": "Message is sent from Google Cloud"
                      }

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
                        "Sid": "SMdfde81ab903c0a9e67f932f9bef91090"
                      }

例 - メッセージの更新

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストからメッセージを選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. メッセージを更新するエンティティ ID を設定します。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] に SM3ad97d41e786c02bca47c8ce1745053b を入力します。
  5. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
    {
                        "Body": ""
                      }
  6. [entityId] を指定する代わりに、[filterClause] を SM3ad97d41e786c02bca47c8ce1745053b に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {}

例 - IncomingPhoneNumbers を更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから IncomingPhoneNumbers を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を設定して、IncomingPhoneNumbers を更新します。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] に PN4047ac009a15885690a50a1d388b8411 を入力します。
  5. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
    {
                        "Name": "name of IncomingPhoneNumber is getting updated"
                      }
  6. [entityId] を指定する代わりに、[filterClause] を PN4047ac009a15885690a50a1d388b8411 に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
                        "Sid": "PN4047ac009a15885690a50a1d388b8411"
                      }

例 - OutgoingCallerIds の更新

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [OutgoingCallerIds] を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. OutgoingCallerIds を更新するようにエンティティ ID を設定します。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] に PN6f5f9bf39cb1801a6e21a5a80d274bdd を入力します。
  5. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
    {
                        "Name": "Name Updated for 99025*****"
                      }
  6. [entityId] を指定する代わりに、[filterClause] を PN6f5f9bf39cb1801a6e21a5a80d274bdd に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
                        "Sid": "PN6f5f9bf39cb1801a6e21a5a80d274bdd"
                      }

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名 データ型 必須 説明
proxy_enabled BOOLEAN False 接続用のプロキシ サーバーを構成するには、このチェックボックスをオンにします。
proxy_auth_scheme ENUM False ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。
proxy_user STRING False ProxyServer プロキシへの認証に使用されるユーザー名です。
proxy_password SECRET False ProxyServer プロキシの認証に使用されるパスワード。
proxy_ssltype ENUM False ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。

統合で Twilio 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

  • Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
  • Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

次のステップ