購入手続き設定を管理する

購入手続き機能を使用すると、購入の準備ができたユーザーは Google の商品リスティングからウェブサイトのカートページまたは購入手続きページに直接移動できるため、コンバージョン率の向上とスムーズなショッピング体験の提供につながります。

Merchant API を使用すると、CheckoutSettings リソースを使用してこの機能の設定を管理できます。

このガイドでは、Merchant API を使用して、購入手続き機能プログラムへの登録をプログラムで作成、管理する方法について説明します。

詳しくは、商品の購入手続きリンクを 追加するをご覧ください。

前提条件

CheckoutSettings リソースと関連メソッドを使用するには、次のことを確認してください。

  • ショッピング広告、無料リスティング、またはその両方が承認され、参加している必要があります。
  • 販売国は米国である必要があります。

メソッド

購入手続きの設定を作成、取得、更新、削除するには、次のメソッドを使用します。

購入手続きの設定を作成する

購入手続きの設定を作成するには、checkoutSettings.create メソッドを使用します。 リクエスト本文に、checkout_uri_template または cart_uri_template のいずれかと、選択した eligible_destinations を含む uri_settings を含めます。

以下はリクエストのサンプルです。

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

購入手続きの設定を取得する

URL テンプレート、選択した掲載先、登録ステータス、URL の審査ステータスなど、購入手続きの設定を取得するには、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

以下は、URL を更新して広告の掲載先を削除するリクエストのサンプルです。

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

呼び出しが成功すると、空のレスポンス本文が返されます。

商品に購入手続きページの URL を指定する方法は 2 つあります。

  • アカウント単位（サブ API または Merchant Center）: 単一の URL テンプレート（checkout_uri_template または cart_uri_template）を定義するには、 サブ API または Merchant Center の設定を使用します。このテンプレートは、対象となるすべての商品に適用されます。商品間で URL を統一することをおすすめします。例: yourstore.com/checkout?id={id}

  • 商品単位（フィード）: 個々の商品に固有の購入手続きページの URL を指定するには、商品フィードで checkout_link_template 属性を使用します。これにより、商品ごとに URL をカスタマイズしたり、在庫の一部のみを購入手続きの対象にしたりできます。

  • このサブ API を使用してアカウント単位の URL テンプレートを設定する場合は、それらの商品のフィードで checkout_link_template 属性の値を送信しないようにしてください。

  • checkout_link_template フィード属性を使用する場合は、サブ API または Merchant Center の設定を使用してアカウント単位の URL テンプレートを設定しないようにしてください。フィードのみで URL を管理している場合は、サブ API を使用して eligible_destinations を選択できます。この場合、uri_settings を指定する必要はありません。

購入手続きページの URL テンプレート

購入手続きページの URL テンプレートを使用すると、商品データに購入手続きページの URL を指定して、オンラインの買い物客がリスティングから購入手続きページに直接移動できるように設定できます。 {ID} パラメータのプレースホルダを含め、 ドメインを一致させる必要があります。

サブ API を使用して購入手続きリンクを設定する場合は、uri_settings フィールドを使用します。 このフィールドでは、次の 2 つのテンプレートのいずれかを使用できます。

  • checkout_uri_template: プレースホルダが入力されると、特定のアイテムを購入できる状態で購入手続きページにユーザーを誘導する URL テンプレート。
  • cart_uri_template: 特定のアイテムがカートに追加された状態でショッピング カート ページにユーザーを誘導する URL テンプレート。

テンプレートの例

  • 購入手続き: https://www.your-store.com/checkout?item_id={id}
  • カート: https://shop.your-store.com/add_to_cart?product_sku={id}

次の要件を満たしていることを確認してください。

  • URL テンプレートは、登録したドメインと一致し、HTTP GET メソッドを使用して機能し、ユーザーのログインを必要としない、サイト上の有効なページを指している必要があります。
  • 指定した購入手続きテンプレートのドメインは、商品のドメインと一致している必要があります。

詳細