API を使用したRecommendationsカタログの管理

また、 Recommendations API を使用するための要件では、 アクセストークンの生成 JWT 認証フローを使用して Adobe Target の管理 API Adobe Developer Console.

これで、 Recommendations API recommendations カタログの項目を追加、更新、削除する場合。 残りのAdobe Target Admin API と同様に、Recommendations API では認証が必要です。

NOTE
次を送信: IMS:ユーザートークンを介して JWT を生成+認証 認証用にアクセストークンを更新する必要が生じたときにリクエストを送信します。リクエストの有効期限は 24 時間後に切れるからです。 詳しくは、 AdobeAPI 認証の設定 」を参照してください。

JWT3ff

続行する前に、 Recommendations Postmanコレクション.

エンティティ保存 API での項目の作成と更新

製品ページで実行される CSV 製品フィードや Target リクエストではなく、API を使用してRecommendations製品データベースに値を入力するには、 エンティティ保存 API. このリクエストは、単一の Target 環境内の項目を追加または更新します。 構文は次のとおりです。

POST https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities

たとえば、「保存エンティティ」を使用すると、在庫や価格のしきい値など、特定のしきい値を満たした場合にアイテムを更新し、それらのアイテムにフラグを設定してレコメンデーションを防ぐことができます。

  1. に移動します。 Target > 設定 > ホスト > 制御環境 を使用して、項目を追加または更新する Target 環境 ID を取得します。

    SaveEntities1

  2. 検証 TENANT_ID および API_KEY 前に確立したPostman環境変数を参照します。 比較には、以下の画像を使用します。 必要に応じて、API リクエストのヘッダーとパスを、以下の画像のヘッダーと一致するように変更します。

    SaveEntities3

  3. JSON に次のように入力します。 raw コード 本文. 忘れずに、 environment 変数を使用します。 (以下の例では、環境 ID は 6781 です)。

    SaveEntities4.png

    以下に、Toaster Oven 製品の関連エンティティ値を含む entity.id kit2001 を環境 6781 に追加する JSON のサンプルを示します。

    code language-none
        {
        "entities": [{
                "name": "Toaster Oven",
                "id": "kit2001",
                "environment": 6781,
                "categories": [
                    "housewares:appliances"
                ],
                "attributes": {
                    "inventory": 77,
                    "margin": 23,
                    "message": "crashing helicopter",
                    "pageUrl": "www.foobar.foo.com/helicopter.html",
                    "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                   "value": 19.2
                }
            }]
        }
    
  4. 送信」をクリックします。次の応答を受け取ります。

    SaveEntities5.png

    JSON オブジェクトは、複数の製品を送信するように拡大・縮小できます。 例えば、この JSON は 2 つのエンティティを指定します。

    code language-none
        {
            "entities": [{
                    "name": "Toaster Oven",
                    "id": "kit2001",
                    "environment": 6781,
                    "categories": [
                        "housewares:appliances"
                    ],
                    "attributes": {
                        "inventory": 89,
                        "margin": 11,
                        "message": "Toaster Oven",
                        "pageUrl": "www.foobar.foo.com/helicopter.html",
                        "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                        "value": 102.5
                    }
                },
                {
                    "name": "Blender",
                    "id": "kit2002",
                    "environment": 6781,
                    "categories": [
                        "housewares:appliances"
                    ],
                    "attributes": {
                        "inventory": 36,
                        "margin": 5,
                        "message": "Blender",
                        "pageUrl": "www.foobar.foo.com/helicopter.html",
                        "thumbnailUrl": "www.foobar.foo.com/helicopter.jpg",
                        "value": 54.5
                    }
                }
            ]
        }
    
  5. 今度は君の番だ! 以下を使用します。 エンティティを保存 次の項目をカタログに追加する API。 上記のサンプル JSON を出発点として使用してください。 (追加のエンティティを含めるには、JSON を拡張する必要があります)。

    SaveEntities6.png

最後の 2 つの項目が属していないようです。 では、 エンティティを取得 API を削除し、必要に応じて、 エンティティを削除 API.

Get Entity API を使用した品目の詳細の取得

既存の項目の詳細を取得するには、 エンティティ API を取得. 構文は次のとおりです。

GET https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities/[entity.id]

エンティティの詳細は、一度に 1 つのエンティティに対してのみ取得できます。 「エンティティを取得」を使用して、カタログで期待どおりに更新がおこなわれたことを確認したり、カタログの内容を監査したりできます。

  1. API リクエストで、変数を使用してエンティティ ID を指定します。 entityId. 次の例では、entityId=kit2004 のエンティティの詳細が返されます。

    GetEntity1

  2. 検証 TENANT_ID および API_KEY 前に確立したPostman環境変数を参照します。 比較には、以下の画像を使用します。 必要に応じて、API リクエストのヘッダーとパスを、以下の画像のヘッダーと一致するように変更します。

    GetEntity2

  3. リクエストを送信します。

    GetEntity3
    エンティティが見つからなかったことを示すエラーが表示された場合は、上の例で示すように、リクエストを正しい Target 環境に送信していることを確認します。

    note note
    NOTE
    環境が明示的に指定されていない場合、Get Entity は、 デフォルト環境 のみ。 デフォルト環境以外の環境から取り込む場合は、環境 ID を指定する必要があります。
  4. 必要に応じて、 environmentId パラメーターを使用し、リクエストを再送信します。

    GetEntity4

  5. 別のものを送信 エンティティを取得 リクエストを送信する際に、この時点で entityId=kit2005 のエンティティを調べます。

    GetEntity5

これらのエンティティをカタログから削除する必要があると判断したとします。 次を使用します。 エンティティを削除 API.

エンティティ削除 API での品目の削除

カタログから項目を削除するには、 エンティティ削除 API. 構文は次のとおりです。

DELETE https://mc.adobe.io/{{TENANT_ID}}/target/recs/entities?ids=[comma-delimited-entity-ids]&environment=[environmentId]
WARNING
エンティティを削除 API は、指定した ID で参照されているエンティティを削除します。 エンティティ ID を指定しない場合、指定した環境内のすべてのエンティティが削除されます。 環境 ID が指定されていない場合、エンティティはすべての環境から削除されます。 この機能は慎重に使用してください。
  1. に移動します。 Target > 設定 > ホスト > 環境 をクリックして、項目を削除する Target 環境 ID を取得します。

    DeleteEntities1

  2. API リクエストで、構文を使用して、削除するエンティティのエンティティ ID を指定します &ids=[comma-delimited-entity-ids] (クエリパラメーター)。 複数のエンティティを削除する場合は、コンマで ID を区切ります。

    DeleteEntities2

  3. 構文を使用して環境 ID を指定します &environment=[environmentId]そうしないと、すべての環境のエンティティが削除されます。

    DeleteEntities3

  4. 検証 TENANT_ID および API_KEY 前に確立したPostman環境変数を参照します。 比較には、以下の画像を使用します。 必要に応じて、API リクエストのヘッダーとパスを、以下の画像のヘッダーと一致するように変更します。

    DeleteEntities4

  5. リクエストを送信します。

    DeleteEntities5

  6. 次を使用して結果を検証: エンティティを取得」と表示され、削除されたエンティティが見つからないことを示すようになりました。

    DeleteEntities6

    DeleteEntities6

おめでとうございます。Recommendations API を使用して、カタログ内のエンティティの詳細を作成、更新、削除、取得できるようになりました。 次の節では、カスタム条件の管理方法について説明します。

<!— 次:「カスタム条件の管理」> —>

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3