API 要求の作成
学習の目的
この単元を完了すると、次のことができるようになります。
- REST API を使用して Marketing Cloud Engagement の連絡先を作成する。
- Marketing Cloud Engagement 開発者環境のセットアップを検証する。
Hello, World!
どの開発者学習体験も、新しいスキルをテストする「Hello, World!」プロジェクトなしには完了しません。ここまでで、Marketing Cloud Engagement でパッケージを作成し、認証資格情報をどこで取得するかを理解したので、REST API を使用して連絡先を作成することによって開発者環境のセットアップを検証しましょう。
JSON パラメーター
連絡先の作成を開始する前に、このルートを使用する簡略された例のパラメーターを確認しましょう。
| 名前 |
種別 |
必須 |
説明 |
|---|---|---|---|
| contactKey |
string |
はい |
連絡先のプライマリアドレス |
| attributeSets |
array |
はい |
新しい連絡先を作成するために使用される情報の配列 |
| attributeSets.name |
string |
はい |
連絡先情報を追加する属性グループの名前 |
| attributeSets.values |
array |
いいえ |
属性と適用する値を示す名前と値のペア |
この API ルートで何ができるかの完全なリストについてはは、Salesforce Developers の「Create Contacts」REST リファレンスを参照してください。
API 要求の作成
REST API を使用して Marketing Cloud Engagement の連絡先を作成するには、次の手順に従います。Marketing Cloud Engagement に対するアクセス権と前の単元で作成したパッケージが必要です。
任意の API 開発ツールで、新しい連絡先を作成する要求を作成します。
- 次のサンプルコードを使用して、Host の REST ベース URI と Authorization のアクセストークンを置き換えます。この情報は、インストール済みパッケージのコンポーネント詳細で確認できます。
- contactKey の値に有効なサブドメインを含めます。HTML Enabled の値は必須です。
- サンプルコードを使用する代わりに、独自のメールアドレスを入力できます。
各呼び出しは、各属性セットの 1 つのインスタンスのみを受け取ります。
Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
POST /contacts/v1/contacts
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN
{
"contactKey": "example@salesforce.com",
"attributeSets": [{
"name": "Email Addresses",
"items": [{
"values": [{
"name": "Email Address",
"value": "example@salesforce.com"
},
{
"name": "HTML Enabled",
"value": true
}]
}]
}]
}
要求が作成されたので、この要求を Marketing Cloud Engagement に送信して連絡先を作成します。
要求の検証
新しい連絡先が Marketing Cloud Engagement に存在することを確認しましょう。応答を受信するには数時間かかることがありますので、すぐに表示されなくても慌てないでください。作業を検証する方法は 2 つあります。
最初の方法では、開発ツール内で次のような応答を受信します。
200 (OK)
Content-Type: application/json
{
"operationStatus": "OK",
"rowsAffetcted": 1,
"contactKey": "example@salesforce.com",
"contactId": 12345678,
"contactTypeID": 0,
"isNewContactKey": false,
"requestServiceMessageID": "8b51b524-28c1-46fc-9a44-02fca5b0a08c",
"hasErrors": false,
"resultMessages": [],
"serviceMessageID": "80676c59-ceb9-48aa-ad35-81e150094a17"
2 つ目の方法では、Marketing Cloud Engagement の Contact Builder に移動して、連絡先が存在することを確認します。
- Marketing Cloud Engagement Contact Builder で [All Contacts (すべての連絡先)] をクリックします。
- 作成した連絡先を検索します。
- 連絡先をクリックして、連絡先のデータを API 要求と比較して確認します。
お疲れさまでした! Marketing Cloud Engagement API 要求を初めて作成することに成功しました。
作業を検証できない場合は、Salesforce Developers で「Handle Errors in REST API (REST API でのエラー処理)」を参照してください。
次のステップ
Marketing Cloud Engagement での作業に使用できる Marketing Cloud Engagement API、SDK、プログラム言語について少し学習しました。Marketing Cloud Engagement アカウントの全体的な構造 (テナント、MID、エンドポイント、ビジネスユニットなど) やユーザーと権限によってアクセス権が決まるしくみなどの管理者の基本についても学習しました。さらに、開発者環境を設定し、それを検証するために Marketing Cloud Engagement の連絡先を作成しました。
次は何をすればよいでしょうか。コーディングを開始する準備ができたら、Marketing Cloud Engagement Developer Center で Marketing Cloud Engagement 開発者リソースを利用してさらに学習を進めることができます。このサイトを通じて大規模な開発者コミュニティに参加すれば、アイデアを共有したり、開発者グループに参加したり、サクセスストーリーを読んだりすることができます。
リソース
- Trailhead: Content Builder Block SDK
- 外部リンク: GitHub リポジトリ - Salesforce Marketing Cloud Engagement プラットフォーム
- Salesforce 開発者: Handle Errors in REST API (REST API でのエラー処理)
- Salesforce 開発者: Marketing Cloud Engagement Developer Center (Marketing Cloud Engagement 開発者センター)
- Salesforce 開発者: Marketing Cloud Engagement REST API - Create Contacts (連絡先の作成)