フォールバックオファーは、他のオファーの対象とならない顧客に送信されます。。フォールバックオファーを作成する手順は、オファーを作成する場合など、1 つまたは複数の表示域を作成することで構成されます。
Offer Library API に対して単一の GET リクエストを実行することで、コンテナ内のすべてのフォールバックオファーのリストを表示できます。
API 形式
GET /{ENDPOINT_PATH}/{CONTAINER_ID}/queries/core/search?schema={SCHEMA_FALLBACK_OFFER}&{QUERY_PARAMS}
パラメーター | 説明 | 例 |
---|---|---|
{ENDPOINT_PATH} |
リポジトリ API のエンドポイントパス。 | https://platform.adobe.io/data/core/xcore/ |
{CONTAINER_ID} |
フォールバックオファーが配置されているコンテナ。 | e0bd8463-0913-4ca1-bd84-6309134ca1f6 |
{SCHEMA_FALLBACK_OFFER} |
フォールバックオファーに関連付けられたスキーマを定義します。 | https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1 |
{QUERY_PARAMS} |
結果をフィルターするオプションのクエリパラメーター。 | limit=1 |
リクエスト
curl -X GET \
'https://platform.adobe.io/data/core/xcore/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1&limit=1' \
-H 'Accept: *,application/vnd.adobe.platform.xcore.hal+json; schema="https://ns.adobe.com/experience/xcore/hal/results"' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {IMS_ORG}' \
-H 'x-sandbox-name: {SANDBOX_NAME}'
リソースのリストを表示する際に、クエリパラメーターを使用してページを作成し、結果をフィルターできます。
ページングに最も一般的なクエリパラメーターは次のとおりです。
パラメーター | 説明 | 例 |
---|---|---|
q |
選択したフィールドで検索するオプションのクエリ文字列。クエリ文字列は小文字にする必要があり、二重引用符で囲むことで、トークン化を防ぎ、特殊文字をエスケープできます。次の文字 + - = && || > < ! ( ) { } [ ] ^ \" ~ * ? : \ / は特別な意味を持ち、クエリ文字列に出現する場合はバックスラッシュでエスケープする必要があります。 |
default |
qop |
「q」クエリ文字列パラメーターの値に AND または OR 演算子を適用します。 | AND または OR |
field |
検索を制限するフィールドのリスト(オプション)。このパラメーターは、field=field1[,field=field2,…] のように繰り返すことができます(パス式は「_instance.xdm:name」などのドット区切りパスの形式です)。 | _instance.xdm:name |
orderBy |
特定のプロパティで結果を並べ替えます。タイトルの前に - を追加すると(orderby=-title )、アイテムがタイトルの降順(Z-A)に並べ替えられます。 |
-repo:createdDate |
limit |
返されるフォールバックオファーの数を制限します。 | limit=5 |
応答
正常な応答では、アクセス可能なコンテナ内に存在するフォールバックオファーのリストが返されます。
{
"containerId": "e0bd8463-0913-4ca1-bd84-6309134ca1f6",
"schemaNs": "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1",
"requestTime": "2020-10-22T07:12:30.923768Z",
"_embedded": {
"results": [
{
"instanceId": "053bc610-f8f9-11ea-ad6e-775ad2c9b1a1",
"schemas": [
"https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.5"
],
"productContexts": [
"acp"
],
"repo:etag": 3,
"repo:createdDate": "2020-09-17T15:18:20.657299Z",
"repo:lastModifiedDate": "2020-10-02T02:34:48.034583Z",
"repo:createdBy": "{CREATED_BY}",
"repo:lastModifiedBy": "{MODIFIED_BY}",
"repo:createdByClientId": "{CREATED_CLIENT_ID}",
"repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
"_instance": {
"xdm:name": "F1: Web fallback ",
"xdm:representations": [
{
"xdm:components": [
{
"xdm:content": "aaa",
"@type": "https://ns.adobe.com/experience/offer-management/content-component-json",
"dc:format": "application/json",
"repo:name": "aa"
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:placement": "xcore:offer-placement:122201b2150d98c2"
},
{
"xdm:components": [
{
"xdm:content": "bb",
"@type": "https://ns.adobe.com/experience/offer-management/content-component-html",
"dc:format": "text/html",
"repo:name": "bb"
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:placement": "xcore:offer-placement:122201c34354a2b4"
},
{
"xdm:components": [
{
"xdm:deliveryURL": "https://mysite.com",
"@type": "https://ns.adobe.com/experience/offer-management/content-component-imagelink",
"dc:format": "image/png",
"repo:name": "ll"
}
],
"xdm:channel": "https://ns.adobe.com/xdm/channel-types/web",
"xdm:placement": "xcore:offer-placement:122207eddb05205a"
}
],
"xdm:status": "approved",
"xdm:tags": [],
"@id": "xcore:fallback-offer:122206064e0d98df"
},
"_links": {
"self": {
"name": "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.5#053bc610-f8f9-11ea-ad6e-775ad2c9b1a1",
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/instances/053bc610-f8f9-11ea-ad6e-775ad2c9b1a1",
"@type": "https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.5"
}
},
"sandboxName": "ode-prod-va7-edge-testing"
}
],
"total": 5,
"count": 1
},
"_links": {
"self": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?schema=https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
},
"next": {
"href": "/e0bd8463-0913-4ca1-bd84-6309134ca1f6/queries/core/search?start=053bc610-f8f9-11ea-ad6e-775ad2c9b1a1&orderby=instanceId&schema=https://ns.adobe.com/experience/offer-management/fallback-offer;version=0.1&limit=1",
"@type": "https://ns.adobe.com/experience/xcore/hal/results"
}
}
}