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

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

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

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

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

関連トピック :

手順1:識別キーの設定

メモ

識別キーを設定する際のグローバルな概念について詳しくは、この節を参照してください。

  1. 識別キーを設定する前に、目的のフィールドを使用してリソースが拡張され、公開されていることを確認します。 詳しくは、この節を参照してください。

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

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

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

    メモ

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

  5. これで、フィルター定義を設定し、その識別キーを使用してリソースを呼び出せるようになりました。

手順2:フィルター定義の設定

メモ

フィルター定義を設定する際のグローバルな概念について詳しくは、この節を参照してください。

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

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

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

  4. 識別キーで使用する最初のフィールド(「CRM ID」)を選択し、Switch to parameters​オプションを有効にします。

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

    メモ

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

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

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

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

識別キーとそのフィルター定義を設定したら、それらを使用して、Campaign Standardインターフェイスまたは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のドキュメントを参照してください。

このページ