商品セットコレクションAPI

このAPIを使って、ショップで使用されるコレクションを作成したり、商品セットにカバー画像や説明などのメタデータを追加したりできます。そのような商品セットを、コマースマネージャでコレクションとして使用すれば、FacebookショップやInstagramショップをカスタマイズできます(そうでない場合、コレクションは手動で作成します)。ショップIDを指定すれば、そのような準備のできた商品セットを直接公開することもできます。ショップIDは、コマースAPIを使用して確認できます。

コマースマネージャでコレクションを作成する方法をビジネスヘルプセンターでご確認ください。

POST (作成/更新API)

商品セットの作成と更新については、以前と同じです。しかし、いくつかの新しい任意のフィールドがあります。

メタデータのフィールド

Publish to Shopsフィールド

publish_to_shopsフィールドは、空の配列または以下の例に示されているパラメーターの配列を受け入れます。空の配列が指定された場合、該当する商品セットは、すべてのショップで非公開になります(それ以前に公開されていた場合)。

例 — ペイロード

{ 
    "name": "Best sellers",
    "filter": {
      "retailer_id": {
        "is_any": [
          "pid1",
          "pid2"
        ]
      } 
    },
    "metadata": {
      "cover_image_url": "https://foo.com/image.jpg" (https://foo.com/image.jpg%E2%80%9D),
      "external_url": "https://foo.com/best-sellers",
      "description":"Our best selling products"
    }
  "publish_to_shops": [{"shop_id": "shop_id1"}, {"shop_id": "shop_id2"}]
}

商品セットを作成する

特定の商品IDにマッチするコレクションメタデータを使用して商品セットを作成します。

curl \
  -F "name=Best Sellers" \
  -F "filter={'retailer_id': {'is_any': ['pid1', 'pid2']}}" 
  -F "metadata={'cover_image_url':'https://foo.com/image.jpg', 'external_url':'https://foo.com/best-sellers', 'description':'Our best selling products'}" \
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_CATALOG_ID/product_sets

商品セットを更新する

コレクションメタデータを使用して既存の商品セットを更新し、ショップに公開します。

curl \
  -F "name=Updated Best Sellers" \
  -F "metadata={'cover_image_url':'https://foo.com/image_updated.jpg', 'external_url':'https://foo.com/best-sellers-updated', 'description':'Our updated best selling products'}" \
  -F "publish_to_shops=[{'shop_id':'shop_id1'}, {'shop_id':'shop_id2'}]"
  -F "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/API_VERSION/PRODUCT_SET_ID

GET (読み取りAPI)

GETノードにおいて、live_metadataフィールドは特定の商品セットで公開されているメタデータを返します。一方、latest_metadataフィールドは最後にAPIに送られたメタデータを返します。これらのフィールドは異なっている可能性があります。たとえば、画像を変えて更新したものの、整合性のために却下された場合などです。

メタデータのフィールド

例 — 商品セットを読み取って、公開中のメタデータを調べます。

curl -G \
  -d "access_token=<ACCESS_TOKEN>" \
  https://graph.facebook.com/<API_VERSION>/<PRODUCT_SET_ID>/?fields=id,name,latest_metadata{cover_image_url, description, review_status},live_metadata{cover_image_url, description, review_status}

応答:

{ 
    "id": 1234567890,
    "name": "Best sellers",
    "latest_metadata": {
        "cover_image_url": "https://foo.com/some_new_image.jpg" (https://foo.com/image.jpg%E2%80%9D),
        "description":"Our best selling products",
        "integrity_review_status": "REJECTED"
    },
    "live_metadata": {
        "cover_image_url": "https://foo.com/some_good_image.jpg", 
        "description":"Our best selling products",
        "integrity_review_status": "APPROVED"
    }
}

よくある質問

Q: カバー画像のアスペクト比として可能な最小値は何ですか?

A: 画像は600×600以上でなければなりません(最小アスペクト比の場合は編集トリミングができない)。800×800以上をアップロードする場合、正方形のアスペクト比がデフォルトとして選択されます。最善の結果を得るには、1080×1080のアスペクト比をおすすめします。

Q: カバー画像のファイルサイズの上限は何ですか?

A: ファイルサイズの上限は8 MBです。

Q: カバー画像でサポートされるファイル形式は何ですか?

A: JPGとPNGがサポートされています。

Q: 説明の長さに制限はありますか?

A: 説明の長さに下限はありません。上限は200文字です。

Q: コレクション(商品セット)をショップで非公開にするには、どうすればいいですか?

A: 更新APIを使用し、前回公開したpublish_to_shopリストからshop_idフィールドを削除することができます。空の配列([])が指定された場合、商品セットはすべてのショップで非公開になります。

詳しくはこちら

• コマースマネージャでコレクションを作成する、ビジネスヘルプセンター
• 商品セット、MAPIリファレンス