结账功能可让准备购买的客户直接从 Google 商品详情进入您网站的购物车或结账页,从而加快购买流程,提高转化率并提升购物体验。
借助 Merchant API,您可以使用 CheckoutSettings
资源管理此功能的设置。
本指南介绍了如何使用 Merchant API 以编程方式创建和管理结账功能的注册。
如需了解详情,请参阅为商品添加结账链接。
前提条件
如需使用 CheckoutSettings
资源和关联的方法,请务必执行以下操作:
- 您必须已获批准并参与购物广告和/或非付费商品详情计划。
- 您的目标销售国家/地区必须是美国。
方法
如需创建、检索、更新和删除结账设置,您可以使用以下方法:
创建结账设置
如需创建结账设置,请使用 checkoutSettings.create
方法。在请求正文中添加 uri_settings
(包含 checkout_uri_template
或 cart_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 账号的唯一标识符。
以下是成功调用的示例响应:
{
"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_template
或cart_uri_template
),您可以使用子 API 或 Merchant Center 设置。此模板会应用于您所有符合条件的商品。我们建议您为所有商品使用一致的网址。例如yourstore.com/checkout?id={id}
。商品级别(Feed):如需为个别商品提供特定结账网址,请在商品 Feed 中使用
checkout_link_template
属性。这样,您就可以为每件商品提供自定义网址,或者仅为部分商品目录提供结账功能。如果您使用此子 API 设置账号级别网址模板,请确保您不会在 Feed 中为这些商品提交
checkout_link_template
属性的值。如果您使用
checkout_link_template
Feed 属性,请确保您未使用子 API 或 Merchant Center 设置设置账号级网址模板。如果您仅通过 Feed 管理网址,则仍然可以使用子 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
方法运行且无需客户登录的有效网页。 - 所提供的结账模板中的域名必须与商品域名一致。