POST
/api/v4/locations/listings/mark-as-duplicate掲載情報を重複としてマークする
検出された1件以上の掲載情報項目を確認済みの重複としてマークし、Listings API がそれらを非表示にできるようにします。
パラメーター
ボディ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| input.listingItemIds | array | 必須 | Array of base64-encoded listing item IDs to mark as duplicates. Use the `listingItemId` values from the duplicate-listings endpoints. |
| input.locationId | string | 任意 | Location that owns the listing items (base64-encoded Relay ID or raw numeric ID). Scopes the operation to a single location. |
リクエストの例
そのまま貼り付けられるボディです。プレースホルダーの ID と値をご自身のものに置き換えてください。
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "listingItemIds": ["TGlzdGluZ0l0ZW06MjM1OTg0NTA="] }}レスポンス
200Listing items marked as duplicates. On failure, `success` is `false` and `errors` describes why.
{ "data": { "markAsDuplicate": { "success": true, "errors": null } }}400Validation error, e.g. an unknown or malformed listing item ID. See the `errors` array (`code`, `message`, `path`).
401Unauthenticated, missing or invalid API key.
特定の掲載情報項目が重複であることを確定し、Listings API にそれらの非表示化または削除を指示します。listingItemIdsには、拠点の重複掲載情報を取得するで返されたlistingItemIdの値(またはアカウント全体の集計で得られたidの値)を設定します。
ユースケース:確認済みの重複に対処する
確認担当者が重複グループを確認した後、該当する項目の ID を1回の呼び出しで送信します。
{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "listingItemIds": ["TGlzdGluZ0l0ZW06MjM1OTg0NTA="] }}listingItemIdsは必須で、複数の ID を受け付けるため、掲載情報ごとに呼び出すのではなく、1つの拠点の確認済みの重複をすべて1つのリクエストにまとめます。200でsuccess: trueが返された場合は、項目が非表示化の対象として受け付けられています。200でsuccess: falseが返された場合(または400の場合)は、値の入ったerrors配列が返されるため、再試行する前に各要素のcodeとmessageを確認してください。
ユースケース:誤った操作を取り消す
項目を誤ってマークした場合は、同じ形式のリクエストボディを受け付ける掲載情報を重複ではないとしてマークするを使用して取り消します。これは書き込み操作であり、アカウントのレート制限の対象となるため、項目ごとにリクエストを送信するよりも、まとめて処理することを推奨します。
Request
curl -X POST 'https://listingsapi.com/api/v4/locations/listings/mark-as-duplicate' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "input": { "locationId": "TG9jYXRpb246MTgwMDI4OQ==", "listingItemIds": [ "TGlzdGluZ0l0ZW06MjM1OTg0NTA=" ] } }'