MailChimp

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

始める前に

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

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

MailChimp の構成

MailChimp アカウントを設定する

MailChimp アカウントの設定の詳細については、アカウントへのログインをご覧ください。

認証の設定

API キー - 認証タイプ

MailChimp API キーの生成については、API キーを生成するをご覧ください。

MailChimp アカウントの [API キー] セクションに移動します。
[新しいキーを作成] をクリックし、わかりやすい名前を入力します。
生成されたキーをコピーして安全な場所に保管します。後でキーを表示またはコピーすることはできません。

OAuth 2.0 - 認証タイプ

MailChimp アカウントの OAuth 認証情報の生成については、OAuth 認証情報を生成するをご覧ください。

MailChimp アカウントの [登録済みアプリ] ページに移動します。
[アプリを登録] をクリックします。
[アプリを登録] フォームに必要事項を入力します。
[作成] をクリックします。
表示されたクライアント ID とクライアントシークレットをコピーします。

コネクタを構成する

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

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

接続構成のサンプル

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

API キー - 接続タイプ

フィールド名	詳細
ロケーション	us-central1
コネクタ	MailChimp
コネクタのバージョン	1
接続名	google-cloud-mailchimp-api-conn
サービスアカウント	SERVICE_ACCOUNT_NAME@serviceaccount
ノードの最小数	2
ノードの最大数	50
Authentication:Not Available	True
API キー	API_KEY
シークレットのバージョン	1

OAuth 2 - 接続タイプ

フィールド名	詳細
ロケーション	us-central1
コネクタ	MailChimp
コネクタのバージョン	1
接続名	google-cloud-mailchimp-oauth-conn
サービスアカウント	SERVICE_ACCOUNT_NAME@serviceaccount
ノードの最小数	2
ノードの最大数	50
認証:OAuth 2.0 - 認証コード	True
クライアント ID	CLIENT_ID
クライアントシークレット	CLIENT_SECRET
シークレットのバージョン	1

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

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

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

システムの上限

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

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

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

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

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

操作

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

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

CampaignTest アクション

MailChimp キャンペーンのテストメールを送信します。

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

パラメータ名	データ型	必須	説明
CampaignID	文字列	True	テストするキャンペーンの ID。
TestEmails	文字列	True	送信するメールのカンマ区切りのリスト。
SendType	文字列	True	送信するテストメールのタイプ。html または plaintext。指定できる値は html、plaintext です。デフォルト値は html です。

CampaignTest アクションの構成方法の例については、アクションの例をご覧ください。

CampaignSend アクション

MailChimp キャンペーンを送信します。

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

パラメータ名	データ型	必須	説明
CampaignID	文字列	True	送信するキャンペーンの ID。

CampaignSend アクションの構成方法の例については、アクションの例をご覧ください。

CampaignPause アクション

MailChimp RSS キャンペーンを一時停止します。

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

パラメータ名	データ型	必須	説明
CampaignID	文字列	True	一時停止するキャンペーンの ID。

CampaignPause アクションの構成方法の例については、アクションの例をご覧ください。

CampaignResume アクション

MailChimp RSS キャンペーンを再開します。

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

パラメータ名	データ型	必須	説明
CampaignID	文字列	True	再開するキャンペーンの ID。

CampaignResume アクションの構成方法の例については、アクションの例をご覧ください。

アクションの例

例 - CampaignTest

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CampaignTest ] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"CampaignID": "4bd7a9abac",
"TestEmails": "sample@gmail.com",
"SendType": "plaintext"
}
```

アクションが成功すると、CampaignTest タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

{
"Success": "true"
}

例 - CampaignSend

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CampaignSend] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"CampaignID": "1699382f6d"
} 
```

アクションが成功すると、CampaignSend タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

{
"Success": "true"
}

例 - CampaignPause

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CampaignPause ] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"CampaignID": "4bd7a9abac"
}
```

アクションが成功すると、CampaignPause タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

 {
"Success": "true"
}

例 - CampaignResume

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CampaignResume ] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"CampaignID": "4bd7a9abac"
}
```

この例では、特定のオブジェクトレコードが表示されます。アクションが成功すると、CampaignResume タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

{
"Success": "true"
}

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

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

例 - すべてのキャンペーンを一覧表示する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity リストから Campaigns を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。
必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。フィルタ句の値は、常に単一引用符（'）内で指定します。

例 - 単一の自動化を取得する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Automations を選択します。
[Get] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで [entityId] をクリックし、[デフォルト値] フィールドに 1ac204985e を入力します。
ここで、1ac204985e は Automations エンティティの一意のレコード ID です。

例 - キャンペーンを削除する

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Campaigns を選択します。
[Delete] オペレーションを選択し、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 06f20ace93 を入力します。

例 - キャンペーンフォルダを作成する

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

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

{ "Name": "CampaignFolderCreated1707812599459" }

Running this example, returns a response similar to the following in the connector task's connectorOutputPayload output variable:

{
"Id": "650469bb07"
}

Example - Update a file manager folder

In the Configure connector task dialog, click Entities.
Select FileManagerFolders from the Entity list.
Select the Update operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{   
"Name": "MyNewFolder9"
}
```
[エンティティ ID] をクリックし、[デフォルト値] フィールドに「18159」と入力します。
この例を実行すると、コネクタタスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。
```
{   
"Id": "18159"
}
```

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

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

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

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

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

パラメータ名	データ型	必須	説明
datacenter	ENUM	False	MailChip アカウントで使用されているデータセンターです。サポートされている値は、None、US1、US2、US3、US4、US5、US6、US7、US8、US9、US10、US11、US12、US13 です。
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 です。

統合で MailChimp 接続を使用する

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

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

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

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