SendGrid

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

始める前に

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

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）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

API キーを使用した認証を設定する

[設定] に移動し、[API キー] を選択します。
[Create API Key] をクリックします。
API キーの名前を入力します。
[完全アクセス]、[制限付きアクセス]、[お支払いアクセス] のいずれかを選択します。
[制限付きアクセス] または [課金アクセス] を選択し、各カテゴリに必要な権限を選択します。
[作成と表示] をクリックします。
APi キーをコピーして、後で使用できるように保存します。

コネクタを構成する

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

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [NEXT] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [SendGrid] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
9. [NEXT] をクリックします。
[認証] セクションで、認証の詳細を入力します。詳細については、認証を構成するをご覧ください。|
[NEXT] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

API キー認証

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

接続構成のサンプル

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

ウェブ接続の種類

フィールド名	詳細
ロケーション	us-central1
コネクタ	Sendgrid
コネクタのバージョン	1
接続名	sendgrid-google-cloud-conn
サービスアカウント	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
ノードの最小数	2
ノードの最大数	50
API キー	API_KEY
シークレットバージョン	1

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

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

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがいずれかのエンティティオペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。
アクション: コネクタインターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

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

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

注: Integration Connectors ノードの数は、使用状況に応じて動的に自動スケーリングされます。ただし、自動スケーリングを待たずに大量の容量を確保する場合は、接続の最小ノード値を調整できます。1 つの接続により多くのトランザクションを処理するには、より多くのノードが必要です。逆に、接続が処理するトランザクションが少ない場合は、必要なノードの数が少なくなります。ノードの値を構成するには、次の手順を行います。

従量課金制をご利用のお客様は、接続の編集ページでノードの最小値と最大値を構成します。
サブスクリプションベースで利用されているお客様は、サポートにお問い合わせください。

ノードが処理できる最大トランザクションは、さまざまな要因によって異なります。そのため、スループットを高めるために最小ノードを調整する前に、バックエンドシステムが必要なトラフィックを処理するために最適に設定されているかどうかを確認することをおすすめします。

アクション

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

注: すべてのアクションの結果は、統合を実行した後に Connectors タスクの connectorOutputPayload レスポンスパラメータで JSON レスポンスとして利用できます。

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 のメールが正常に送信されたかどうかの確認メッセージが返されます。

アクションの例

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

例: メールを送信する

[Configure connector task] ダイアログで、[Actions] をクリックします。
[SendMail] アクションを選択してから、[完了] をクリックします。

[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

{
    "FromName": "Name",
    "FromEmail": "cloudysanfrancisco@gmail.com",
    "Subject": "[{\"value\": \"cymbalgroup.com\",\"type\": \"text/plain\"}]",
    "TemplateId": "d-c4bc730a0b094a3a9d9cabb7347b5edc",
    "Personalizations": "[{\"subject\": \"Test Subject3\",\"send_at\": 1698659820,\"from\": {\"name\": \"hi\",\"email\": \"email@gmail\"},\"to\":      
    [{\"email\": \"email@gmail.com\",\"name\": \"test\"}\n ]}]",
    "Content": "[{\"value\": \"abc@cdata.com\",\"type\": \"text/plain\"}]"
}

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

[{
"Success": "True"
}]

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

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

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

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

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

例 - レコードを取得する

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

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

例 - レコードを作成する

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

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から NMCSenders を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、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 エンティティにレコードを作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から NMCLists を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"Name": "TEST_CON_LIST1699262238224",
"ContactCount": 3.0}
```
統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。
```
{
"Id": "d927f128-b718-447a-affe-417f1a8b3abd"}
```

例 - レコードを更新する

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

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から NMCSenders を選択します。
[Update] オペレーションを選択してから、[完了] をクリックします。

[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。

{
"Nickname": "Test",
"FromEmail": "test2@examplepetstore.com",
"FromName": "testuser",   
"ReplytoEmail": "test2@examplepetstore.com",  
"Address": "NA", 
"City": "NA", 
"Country": "India"}

[エンティティ ID] をクリックし、[デフォルト値] フィールドに「5360940.0」と入力します。
統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。
```
{
"Id":"5360940.0"
}
```

例 - レコードを削除する

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

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から NMCSegments を選択します。
[Delete] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [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 フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

SendGrid

始める前に

API キーを使用した認証を設定する

コネクタを構成する

認証を構成する

接続構成のサンプル

ウェブ接続の種類

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

システムの上限

アクション

SendMail アクション

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

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

アクションの例

例: メールを送信する

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

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

例 - レコードを取得する

例 - レコードを作成する

例 - レコードを作成する

例 - レコードを更新する

例 - レコードを削除する

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

統合で SendGrid 接続を使用する

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

次のステップ

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