문서가 업데이트되었습니다.
한국어로 번역이 아직 완료되지 않았습니다.
영어 업데이트됨: 2021. 10. 20.

제품 세트 컬렉션 API

이 API를 사용하면 Shops에서 사용하는 컬렉션을 만들고 제품 세트에 메타데이터(예: 커버 이미지, 설명)를 추가할 수 있습니다. 이러한 제품 세트는 커머스 관리자에서 바로 사용하여 Facebook 또는 Instagram Shop을 맞춤 설정할 수 있습니다(그렇지 않을 경우 컬렉션을 직접 만들어야 합니다). 또한 Shop ID를 제공하면 준비된 제품 세트를 직접 공개할 수 있습니다. Shop ID는 상거래 API를 사용하여 얻을 수 있습니다.

자세한 내용은 커머스 관리자에서 컬렉션을 만드는 방법, 비즈니스 지원 센터를 참조하세요.

POST(생성/업데이트 API)

제품 세트를 만들고 업데이트하는 방법은 예전과 동일합니다. 그러나 주의해야 할 몇 가지 새 선택 필드가 있습니다.

필드설명

metadata

선택 사항.

컬렉션의 메타데이터 블록에 대한 상위 매개변수.

publish_to_shops

선택 사항.

제품 세트를 직접 생성/업데이트하고 Shops에 공개하기 위해 shop_id를 제공하는 매개변수.

메타데이터 필드


필드설명

cover_image_url

선택 사항.

컬렉션 커버 이미지의 URL.

description

선택 사항.

고객에게 제공하는 제품 세트에 대한 설명.

external_url

선택 사항.

컬렉션 URL. 이 URL은 소비자에게 표시되지 않지만 제품 세트를 홍보하는 광고를 만들 때 기본값 역할을 합니다.

Publish to Shops 필드

publish_to_shops 필드는 빈 배열이나 아래의 예시에 나와 있는 매개변수가 포함된 배열을 허용합니다. 빈 배열을 제공할 경우 해당 제품 세트는 모든 Shop에서 공개 취소됩니다(이미 공개된 경우).


필드설명

shop_id

shop_id를 여기에 입력해야 하고, 상거래 API를 사용하여 얻을 수 있습니다.

예시 — 페이로드

{ 
    "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

제품 세트 업데이트

컬렉션 메타데이터로 기존 제품 세트를 업데이트하고 Shops에 공개:

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에 보낸 메타데이터를 반환합니다. 이러한 필드는 업데이트 시 이미지가 변경되어 무결성을 이유로 거부된 경우와 같은 상황에서 달라질 수 있습니다.

모든 필드는 기본값이 아닌 필드이고 그래프 API에서 명시적으로 필드 매개변수로서 호출해야 합니다.

필드설명

latest_metadata

가장 최근에 전송된 메타데이터 정보. live_metadata와 다를 수 있습니다(예를 들어 review_statusREJECTED인 경우).

live_metadata

이 제품 세트에 대해 현재 적용 중인 메타데이터.

메타데이터 필드


필드설명

cover_image_url

고객에게 제공하는 제품 세트 커버 이미지의 URL.

description

고객에게 제공하는 제품 세트 설명.

external_url

컬렉션 URL. 이 URL은 소비자에게 표시되지 않지만 제품 세트를 홍보하는 광고를 만들 때 기본값 역할을 합니다.

integrity_review_status

무결성 검토 상태. APPROVED, REJECTED, PENDING 중 하나일 수 있습니다.

— 제품 세트를 읽어 어떤 메타데이터를 적용 중인지 확인:

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"
    }
}

FAQ

Q: 커버 이미지의 허용 가능한 최소 가로세로비는 무엇인가요?

A: 이미지는 600x600 이상이어야 합니다(이 가로세로비에서는 자르기 편집을 사용할 수 없음). 800x800 이상을 업로드할 경우 기본적으로 정사각 가로세로비가 선택됩니다. 최상의 결과를 위해 가로세로비 1080x1080을 사용하는 것이 좋습니다.

Q: 커버 이미지의 최대 파일 용량은 얼마인가요?

A: 최대 파일 용량은 8MB입니다.

Q: 커버 이미지에 어떤 파일 형식이 지원되나요?

A: JPG와 PNG가 지원됩니다.

Q: 설명에 길이 제한이 있나요?

A: 설명에 대한 최소 길이는 없습니다. 최대 길이는 200자입니다.

Q: Shops에서 컬렉션(제품 세트)의 공개를 취소하려면 어떻게 해야 하나요?

A: 업데이트 API를 사용하여 이전에 공개되었던 publish_to_shop 리스트에서 shop_id 필드를 삭제합니다. 빈 배열([])을 제공하는 경우 제품 세트는 모든 Shop에서 공개가 취소됩니다.