Tài liệu này đã được cập nhật.
Bản dịch sang Tiếng Việt chưa hoàn tất.
Cập nhật bằng tiếng Anh: 25 tháng 10, 2021

API Bộ sưu tập nhóm sản phẩm

Bạn có thể dùng API này để tạo bộ sưu tập sử dụng trong Cửa hàng và thêm siêu dữ liệu vào nhóm sản phẩm, chẳng hạn như ảnh bìa và mô tả. Sau đó, các nhóm sản phẩm này sẽ sẵn sàng dùng làm bộ sưu tập trong Công cụ quản lý thương mại để tùy chỉnh Cửa hàng trên Facebook hoặc Instagram của bạn (nếu không, Bộ sưu tập sẽ được tạo theo cách thủ công). Bạn cũng có thể đăng trực tiếp các nhóm sản phẩm đã sẵn sàng này bằng cách cung cấp ID cửa hàng. Bạn có thể lấy ID cửa hàng qua API Thương mại.

Tìm hiểu thêm về cách Tạo bộ sưu tập trong Công cụ quản lý thương mại, Trung tâm trợ giúp doanh nghiệp.

POST (API Tạo/Cập nhật)

Quy trình tạo và cập nhật nhóm sản phẩm vẫn không đổi. Tuy nhiên, bạn cần lưu ý một vài trường không bắt buộc mới:

TrườngMô tả

metadata

Không bắt buộc.

Thông số chính dành cho khối siêu dữ liệu của bộ sưu tập.

publish_to_shops

Không bắt buộc.

Thông số cung cấp shop_id để trực tiếp tạo/cập nhật nhóm sản phẩm và đăng lên cửa hàng.

Trường siêu dữ liệu


TrườngMô tả

cover_image_url

Không bắt buộc.

URL ảnh bìa của bộ sưu tập.

description

Không bắt buộc.

Mô tả về nhóm sản phẩm được hiển thị với khách hàng.

external_url

Không bắt buộc.

URL của bộ sưu tập. URL này không hiển thị với người tiêu dùng, nhưng được phân phối theo mặc định khi tạo quảng cáo quảng bá nhóm sản phẩm của bạn.

Các trường Đăng lên cửa hàng

Trường publish_to_shops chấp nhận mảng trống hoặc mảng có các thông số được minh họa trong ví dụ bên dưới. Nếu mảng trống được cung cấp, nhóm sản phẩm đã cho sẽ bị hủy đăng khỏi tất cả các cửa hàng (nếu đã đăng trước đó).


TrườngMô tả

shop_id

Bạn cần cung cấp shop_id ở đây và có thể lấy dữ liệu này qua API Thương mại.

Ví dụ – Phần tải dữ liệu

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

Tạo nhóm sản phẩm

Tạo nhóm sản phẩm có siêu dữ liệu Bộ sưu tập khớp với ID sản phẩm cụ thể:

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

Cập nhật nhóm sản phẩm

Cập nhật nhóm sản phẩm hiện có với siêu dữ liệu Bộ sưu tập và đăng lên cửa hàng:

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 Đọc)

Trên nút GET, trường live_metadata trả về siêu dữ liệu được đăng và hiển thị trên một nhóm sản phẩm cụ thể, trong khi trường latest_metadata trả về siêu dữ liệu được gửi đến API lần gần đây nhất. Các trường này có thể khác nhau. Ví dụ: nếu một hình ảnh đã thay đổi sau khi cập nhật và bị từ chối vì không đáp ứng tính toàn vẹn.

Tất cả các trường đều không phải là trường mặc định và cần được gọi rõ ràng trong API Đồ thị dưới dạng thông số trường.

TrườngMô tả

latest_metadata

Thông tin siêu dữ liệu mới nhất đã được gửi. Có thể khác với live_metadata (ví dụ: nếu review_statusREJECTED).

live_metadata

Siêu dữ liệu trực tiếp hiện tại của nhóm sản phẩm này.

Trường siêu dữ liệu


TrườngMô tả

cover_image_url

URL ảnh bìa của nhóm sản phẩm được hiển thị với khách hàng.

description

Mô tả về nhóm sản phẩm được hiển thị với khách hàng.

external_url

URL của bộ sưu tập. URL này không hiển thị với người tiêu dùng, nhưng được phân phối theo mặc định khi tạo quảng cáo quảng bá nhóm sản phẩm của bạn.

integrity_review_status

Trạng thái xét duyệt tính toàn vẹn. Có thể là APPROVED, REJECTED, PENDING.

Ví dụ – Đọc nhóm sản phẩm để xem siêu dữ liệu nào đang hoạt động:

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}

Phản hồi:

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

Câu hỏi thường gặp

Hỏi: Tỷ lệ khung hình tối thiểu được chấp nhận của ảnh bìa là bao nhiêu?

Đáp: Hình ảnh phải có kích thước tối thiểu là 600x600 (mặc dù không cho phép chỉnh sửa phần cắt ảnh ở tỷ lệ này). Nếu bạn tải lên hình ảnh có kích thước từ 800x800 trở lên, tỷ lệ khung hình vuông sẽ được chọn theo mặc định. Để có kết quả tốt nhất, bạn nên chọn tỷ lệ khung hình là 1080x1080.

Hỏi: Kích thước file tối đa của ảnh bìa là bao nhiêu?

Đáp: Kích thước file tối đa là 8 MB.

Hỏi: Định dạng file nào được hỗ trợ cho ảnh bìa?

Đáp: Các định dạng được hỗ trợ là JPG và PNG.

Hỏi: Phần mô tả có bị hạn chế độ dài không?

Đáp: Phần mô tả không có độ dài tối thiểu. Độ dài tối đa là 200 ký tự.

Hỏi: Làm cách nào để hủy đăng Bộ sưu tập (nhóm sản phẩm) khỏi Cửa hàng?

Đáp: Bạn có thể sử dụng API Cập nhật và gỡ trường shop_id khỏi danh sách publish_to_shop mà bộ sưu tập đã được đăng trước đó. Nếu mảng trống ([]) được cung cấp, nhóm sản phẩm sẽ bị hủy đăng khỏi tất cả các cửa hàng.