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

最終更新日: 2023-08-17
  • トピック:
  • Data Model
    このトピックの詳細を表示
  • 作成対象:
  • Experienced
    Developer

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

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

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

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

関連トピック :

手順 1:識別キーの設定

メモ

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

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

  2. 次に移動: Administration / Development / Custom resources メニューを開き、 Profile リソース。

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

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

    メモ

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

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

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

メモ

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

  1. Adobe Analytics の Filter definition タブ、クリック Add an element​次に、フィルター定義のラベルと ID を入力します。

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

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

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

  5. Adobe Analytics の 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>
メモ

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

この例では、「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 のドキュメント.

このページ