複合 ID キーを使用したリソースの呼び出し calling-a-resource-using-a-composite-identification-key
場合によっては、リソースに対して、2つのフィールドで構成される識別キーを定義する必要が生じる場合があります。 ID キーを設定したら、Campaign Standard インターフェイスまたはAPIから、このID キーを使用してリソースを呼び出せるように、フィルター定義を設定する必要があります。
この使用例では、プロファイル リソースが、カスタム "CRM ID"および"category" フィールドで拡張されています。 プロファイルリソース用の識別キーを作成します。このキーは、これら2つのフィールドで構成されます。 次に、フィルター定義を設定して、ID キーを使用してプロファイルリソースにアクセスできるようにします。
このユースケースの主な手順は次のとおりです。
- 2つのフィールドに基づいて、プロファイルリソースの識別キーを設定します。
- ID キーを使用してプロファイルリソースを呼び出すことができるように、フィルター定義を設定します。
- インターフェイスまたはAPからプロファイルリソースを呼び出します。
関連トピック :
手順1:識別キーの設定 step-1-configure-the-identification-key
-
ID キーを設定する前に、リソースが目的のフィールドで拡張され、公開されていることを確認します。 詳しくは、この節を参照してください。
-
Administration / Development / Custom resources メニューに移動し、Profile リソースを開きます。
-
Identification keys セクションで、「Create element」ボタンをクリックします。
-
2つのカスタム「CRM ID」フィールドと「カテゴリ」フィールドを追加し、Confirmをクリックします。
note NOTE プロファイルのインターフェイスに2つのカスタムフィールドを表示する場合は、「Screen definition」タブを設定します。 詳しくは、この節を参照してください。 -
これで、フィルター定義を設定して、ID キーを使用してリソースを呼び出せるようになりました。
手順2:フィルター定義の設定 step-2-configure-the-filter-definition
-
「Filter definition」タブで「Add an element」をクリックし、フィルター定義のラベルとIDを入力します。
-
フィルター定義のプロパティを編集して、ルールを設定します。
-
ID キーで使用されるフィールドを含むテーブルをワークスペースにドラッグ&ドロップします。
-
ID キー(「CRM ID」)で使用される最初のフィールドを選択し、Switch to parameters オプションを有効にします。
-
Filter conditions セクションで、Equal演算子を保持し、パラメーターの名前を定義し、プラス記号をクリックして作成します。
note NOTE + ボタンをクリックすると、パラメーターの名前が自動的に生成されます。 APIのフィルターを使用する必要があるため、この情報に注意してください。 -
ID キー(「カテゴリ」)を構成するすべてのフィールドで上記の手順を繰り返し、変更を保存します。
-
これで、フィルター定義が設定されました。 リソースを公開して、フィルターを使用できるようにすることができます。
手順3:ID キーに基づいてリソースを呼び出す step-3-call-the-resource-based-on-its-identification-key
識別キーとそのフィルター定義を設定したら、それらを使用して、Campaign標準インターフェイスまたはREST APIからリソースを呼び出すことができます。
インターフェイスからフィルター定義を使用するには、ワークフローでQuery アクティビティを使用します(このセクション を参照)。 その後、左側のペインでフィルターを利用できます。
Campaign Standard REST APIのフィルター定義を使用するには、次の構文を使用します。
GET /profileAndServicesExt/<resourceName>/by<filterName>?<param1_parameter>=<value>&<param2_parameter>=<value>
この場合、「123456」 CRM IDを持つ「spring」カテゴリからプロファイルを取得する構文は次のようになります。
GET https://mc.adobe.io/<ORGANIZATION>/campaign/profileAndServicesExt/profile/byidentification_key?category_parameter=spring&crm_id_parameter=123456
詳しくは、Campaign Standard REST API ドキュメント を参照してください。