管理結帳設定

結帳功能可讓準備下單的消費者直接從 Google 產品資訊頁面前往網站的購物車或結帳頁面,加快購物流程,進而提高轉換率並提供順暢的購物體驗。

透過 Merchant API,您可以使用 CheckoutSettings 資源管理這項功能的設定。

本指南說明如何使用 Merchant API,以程式化方式建立及管理結帳功能中的註冊。

詳情請參閱「新增產品的結帳連結」。

必要條件

如要使用 CheckoutSettings 資源和相關方法,請務必執行下列操作:

  • 你必須已獲准使用購物廣告和/或免費產品資訊,並參與這兩項功能。
  • 銷售國家/地區必須是美國。

方法

如要建立、擷取、更新及刪除結帳設定,您可以使用下列方法:

建立結帳設定

如要建立結帳設定,請使用 checkoutSettings.create 方法。在要求主體中,加入 uri_settingscheckout_uri_templatecart_uri_template,以及所選的 eligible_destinations

以下是範例要求:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings

{
  "uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS",
    "SHOPPING_ADS"
  ]
}

{ACCOUNT_ID} 替換為 Merchant Center 帳戶的專屬 ID。

以下是成功呼叫的回應範例:

{
  "name": "accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings",
  "uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS",
    "SHOPPING_ADS"
  ],
  "enrollment_state": "ENROLLED",
  "review_state": "IN_REVIEW",
  "effective_uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "effective_enrollment_state": "ENROLLED",
  "effective_review_state": "IN_REVIEW"
}

擷取結帳設定

如要擷取結帳設定 (包括網址範本、所選目的地、註冊狀態和網址審查狀態),請使用 checkoutSettings.get 方法。

以下是範例要求:

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings

以下是成功呼叫的回應範例:

{
  "name": "accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings",
  "uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS",
    "SHOPPING_ADS"
  ],
  "enrollment_state": "ENROLLED",
  "review_state": "APPROVED",
  "effective_uri_settings": {
    "checkout_uri_template": "https://www.your-store.com/checkout?item_id={id}"
  },
  "effective_enrollment_state": "ENROLLED",
  "effective_review_state": "APPROVED"
}

更新結帳設定

如要更新結帳設定,請使用 checkoutSettings.update 方法。在要求主體中加入要變更的欄位,並在 update_mask 查詢參數中指定這些欄位。

update_mask 支援下列欄位:

  • eligible_destinations
  • uri_settings

以下是更新網址及移除廣告目的地的範例要求:

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings?update_mask=uri_settings,eligible_destinations

{
  "uri_settings": {
    "cart_uri_template": "https://shop.your-store.com/add_to_cart?sku={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS"
  ]
}

以下是成功呼叫的回應範例:

{
  "name": "accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings",
  "uri_settings": {
    "cart_uri_template": "https://shop.your-store.com/add_to_cart?sku={id}"
  },
  "eligible_destinations": [
    "FREE_LISTINGS"
  ],
  "enrollment_state": "ENROLLED",
  "review_state": "IN_REVIEW", // Review state will always be set to "IN_REVIEW" after URL update
  "effective_uri_settings": {
    "cart_uri_template": "https://shop.your-store.com/add_to_cart?sku={id}"
  },
  "effective_enrollment_state": "ENROLLED",
  "effective_review_state": "IN_REVIEW"
}

刪除

如要刪除結帳設定,請使用 checkoutSettings.delete 方法。

這項操作會移除帳戶層級設定、取消註冊結帳系統,並停止在免費產品資訊和購物廣告中顯示結帳連結。

以下是範例要求:

DELETE https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/checkout/checkoutSettings

成功的呼叫會傳回空白的回應主體。

你可以透過兩種方式提供產品的結帳網址:

  • 帳戶層級 (子 API 或 Merchant Center):如要定義單一網址範本 (checkout_uri_templatecart_uri_template),可以使用子 API 或 Merchant Center 設定。這個範本會套用至所有符合資格的產品。建議您在各產品中使用一致的網址。例如:yourstore.com/checkout?id={id}

  • 產品層級 (動態饋給):如要為個別產品提供特定結帳網址,請在產品動態饋給中使用 checkout_link_template 屬性。這樣一來,你可以為每項產品自訂網址,或只為部分商品目錄提供結帳功能。

  • 如果您使用這個子 API 設定帳戶層級網址範本,請務必不要在這些產品的動態饋給中提交 checkout_link_template 屬性的值。

  • 如果使用 checkout_link_template 動態饋給屬性,請確認你並未使用子 API 或 Merchant Center 設定設定帳戶層級網址範本。如果您只透過動態饋給管理網址,仍可使用子 API 選取 eligible_destinations,而無須提供 uri_settings

結帳網址範本

你可以使用結帳網址範本,在產品資料中加入結帳網址,方便線上購物者直接從產品資訊頁面前往結帳頁面。必須包含 {ID} 參數預留位置,且具有相符的網域。

使用子 API 設定結帳連結時,請使用 uri_settings 欄位。這個欄位可接受下列兩種範本之一:

  • checkout_uri_template網址範本,當填入預留位置時,會將使用者帶往結帳頁面,並顯示可供購買的特定商品。
  • cart_uri_template網址範本,可將使用者導向購物車頁面,並將特定商品加入購物車。

範例範本

  • 結帳: https://www.your-store.com/checkout?item_id={id}
  • 購物車: https://shop.your-store.com/add_to_cart?product_sku={id}

請確認符合下列規定:

  • 網址範本必須指向網站上的有效網頁,且該網頁必須與已註冊的網域相符、使用 HTTP GET 方法運作,且不需要客戶登入。
  • 提供的結帳範本中的網域必須與產品網域相符。

瞭解詳情