SendGrid

SendGrid コネクタを使用すると、SendGrid データセットに対して挿入、削除、更新、読み取りの各オペレーションを実行できます。

始める前に

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

  • Google Cloud プロジェクトで次の操作を行います。
    • コネクタを構成するユーザーに 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）

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

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

コネクタを構成する

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

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

    [接続] ページに移動

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

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

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

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

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

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

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

    7. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    8. [NEXT] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。詳細については、認証を構成するをご覧ください。|
  6. [NEXT] をクリックします。
  7. Review: 接続と認証の詳細を確認します。
  8. [作成] をクリックします。

認証を構成する

  • API キー認証
    • API キー: API キーの Secret Manager のシークレットを選択します。
    • シークレットのバージョン: シークレットのバージョンを選択します。
    •

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

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

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

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

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

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

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

    システムの上限

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

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

    アクション

    このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。

    SendMail アクション

    このアクションを行うと、添付ファイルとともにメールが送信されます。

    SendMail アクションの入力パラメータ

    パラメータ名 データ型 必須 説明
    件名 文字列 ○ 送信するメールの件名。
    ContentValue 文字列 いいえ 送信するメールの内容。
    ContentType 文字列 いいえ 送信するコンテンツのタイプ。サポートされている値は text/plain と text/html です。
    コンテンツ 文字列 ○ Content オブジェクトの集計。
    SendAt 文字列 いいえ メールを送信する日時。72 時間以上前にスケジュールすることはできません。
    FromEmail 文字列 ○ 送信者のメールアドレス。
    FromName 文字列 いいえ 送信者の名前。
    ToEmail 文字列 いいえ メールの送信先メールアドレス。
    ToName 文字列 いいえ メールの送信先とするメールの名前。
    送信先 文字列 いいえ 宛先の集計。
    ToCCEmail 文字列 いいえ メールのコピーを受信する受信者のメールアドレス。
    ToCCName 文字列 いいえ メールのコピーを受け取る受信者の名前。
    ToBCCName 文字列 いいえ メールのブラインド カーボンコピーを受け取る受信者の名前。
    ToBCC 文字列 いいえ ToBCC 受信者の集計。
    ReplyToEmail 文字列 いいえ 返信先のユーザーのメールアドレス。
    ReplyToName 文字列 いいえ 返信先のユーザーの名前。
    AttachmentPaths 文字列 いいえ 送信するメールに添付するファイルのパス。
    TemplateId 文字列 いいえ 送信するテンプレートの ID。
    DynamicTemplateData 文字列 いいえ ダイナミック テンプレートのデータ。
    パーソナライズ 文字列 ○ メッセージの配列とそのメタデータ。カスタマイズ内の各オブジェクトはエンベロープと見なすことができます。エンベロープは、個々のメッセージを受信するユーザーと、そのメッセージの処理方法を定義します。

    SendMail アクションの出力パラメータ

    このアクションにより、SendMail のメールが正常に送信されたかどうかの確認メッセージが返されます。

    アクションの例

    このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

    例: メールを送信する

    1. [Configure connector task] ダイアログで、[Actions] をクリックします。
    2. [SendMail] アクションを選択してから、[完了] をクリックします。
    3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Value フィールドに次のような値を入力します。
      {
"Personalizations": "[{"subject": "Test Subject2",
"send_at": 1698659820,
"from": {"name": "hi","email": "testmail@test.com"},
"to": [{"email": "xyz@test.com","name": "test"}]
}]",   
"FromName": "SampleName",   
"FromEmail": "testmail@test.com",   
"Subject": "SubjectAdded",   
"Content": "[{"value": "abc@test1.com","type": "text/plain"}]', Attachments='[{"filename": "Test2.txt","content": "VGVzdCBBdHRhY2htZW50"}]" 
}

      4. このアクションにより、SendMail の確認メッセージが返されます。アクションが成功すると、タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

      [{
"Status": "True"
}]

    エンティティ オペレーションの例

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

    例 - すべての連絡先を一覧表示する

    この例では、NMCContacts エンティティ内のすべての連絡先を一覧表示します。

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity から NMCContacts を選択します。
    3. [List] オペレーションを選択し、[完了] をクリックします。
    4. 必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。 例: City='Bangalore'論理演算子を使用して複数のフィルタ条件を指定することもできます。例: City='Bangalore' and region='asia-south2'。

    例 - レコードを取得する

    この例では、NMCSegments エンティティから、指定した ID のレコードを取得します。

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity から NMCSegments を選択します。
    3. [Get] オペレーションを選択してから、[完了] をクリックします。
    4. [コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] フィールドに 0d44bb3f-d28e-4bcf-aba2-c77be831ad46 を入力します。

      ここで、0d44bb3f-d28e-4bcf-aba2-c77be831ad46 は NMCSegments エンティティ内の主キーの値です。

    例 - レコードを作成する

    この例では、NMCSenders エンティティに レコードを作成します。

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity から NMCSenders を選択します。
    3. [Create] オペレーションを選択し、[完了] をクリックします。
    4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Value フィールドに次のような値を入力します。
      {
"Nickname": "Test",
"FromEmail": "test1@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test1@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}

      統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

      {
"Id": 5360940.0
}

    例 - レコードを作成する

    この例では、NMCLists エンティティに レコードを作成します。

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

      統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

      {
"Id": "d927f128-b718-447a-affe-417f1a8b3abd"}

    例 - レコードを更新する

    この例では、NMCSenders エンティティに レコードを作成します。

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity から NMCSenders を選択します。
    3. [Update] オペレーションを選択してから、[完了] をクリックします。
    4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Value フィールドに次のような値を入力します。
      {
"Nickname": "Test",
"FromEmail": "test2@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test2@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}
    5. [エンティティ ID] をクリックし、[デフォルト値] フィールドに「5360940.0」と入力します。

      統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。

      {
"Id":"5360940.0"
}

    例 - レコードを削除する

    この例では、NMCSegments エンティティ内の指定された ID のレコードを削除します。

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity から NMCSegments を選択します。
    3. [Delete] オペレーションを選択してから、[完了] をクリックします。
    4. [コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに c58b9151-7279-428a-bac2-12b4bf2b48b0 を入力します。

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

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

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

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

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

    パラメータ名 データ型 必須 説明

    統合で SendGrid 接続を使用する

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

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

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

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

    次のステップ