複合 ID キーを使用したリソースの呼び出し

場合によっては、2つのフィールドで構成される識別キーをリソースに対して定義する必要があります。 IDキーを設定したら、Campaign StandardインターフェイスまたはAPIからこのIDキーを使用してリソースを呼び出せるように、フィルター定義を設定する必要があります。

この場合、プロファイル​リソースは、カスタムの​"CRM ID"​および​"カテゴリ"​フィールドを使用して拡張されています。 この2つのフィールドで構成されるプロファイルリソースのIDキーを作成します。 次に、IDキーを使用してプロファイルリソースにアクセスできるように、フィルター定義を設定します。

この使用例の主な手順は次のとおりです。

  1. 2つのフィールドに基づいて、プロファイルリソースのIDキーを設定します。
  2. IDキーを使用してプロファイルリソースを呼び出せるように、フィルター定義を設定します。
  3. プロファイルリソースをインターフェイスまたはAPから呼び出します。

関連トピック :

手順1:IDキーを設定

メモ

IDキーを設定する際のグローバルな概念については、この節で詳しく説明します。

  1. IDキーを設定する前に、目的のフィールドでリソースが拡張され、発行されていることを確認します。 詳しくは、こちらの節を参照してください。

  2. Administration / Development / Custom resources​メニューに移動し、Profile​リソースを開きます。

  3. Identification keys」セクションで、「Create element」ボタンをクリックします。

  4. 2つ追加のカスタム「CRM ID」と「カテゴリ」フィールドを選択し、Confirm​をクリックします。

    メモ

    プロファイルのインターフェイスに2つのカスタムフィールドを表示する場合は、「Screen definition」タブを設定します。 詳しくは、こちらの節を参照してください。

  5. これで、フィルター定義のIDキーを使用してリソースを呼び出せるようにフィルター定義を設定できます。

手順2:フィルタ定義を設定

メモ

フィルター定義を設定する際のグローバル概念については、このセクションで詳しく説明します。

  1. Filter definition」タブで、「Add an element」をクリックし、フィルター定義のラベルとIDを入力します。

  2. フィルター定義のプロパティを編集して、ルールを設定します。

  3. IDキーで使用されるフィールドを含むテーブルをワークスペースにドラッグ&ドロップします。

  4. IDキーで使用される最初のフィールド(「CRM ID」)を選択し、Switch to parameters​オプションをアクティブにします。

  5. Filter conditions​セクションで、Equal​演算子を残し、パラメーターの名前を定義し、プラス記号をクリックして作成します。

    メモ

    +」ボタンをクリックすると、パラメーター名が自動的に生成されます。 この情報は、APIのフィルタを使用する必要があるので、注意してください。

  6. IDキー(「カテゴリ」)を構成するすべてのフィールドに対して上記の手順を繰り返し、変更を保存します。

  7. これで、フィルター定義が設定されます。 リソースを公開して、フィルターを使用できます。

手順3:識別キーに基づいてリソースを呼び出す

IDキーとそのフィルター定義が設定されたら、それらを使用して、キャンペーン標準インターフェイスまたはREST APIからリソースを呼び出すことができます。

インターフェイスのフィルター定義を使用するには、ワークフローで​Query​アクティビティを使用します(このセクションを参照)。 その後、左側のペインでフィルターを使用できます。

Campaign StandardREST APIのフィルター定義を使用するには、次の構文を使用します。

GET /profileAndServicesExt/<resourceName>/by<filterName>?<param1_parameter>=<value>&<param2_parameter>=<value>
メモ

カスタムフィルターを呼び出すには、手順2でフィルター定義を設定する際に定義したフィルター名の後に、「by」プレフィックスを使用します。

この例では、「123456」CRM IDを持つ「spring」カテゴリからプロファイルを取得する構文は次のようになります。

GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byidentification_key?category_parameter=spring&crm_id_parameter=123456

詳しくは、Campaign StandardREST APIのドキュメントを参照してください。

このページ