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

購入手続き機能を使用すると、購入の準備ができたユーザーは 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 を使用して uri_settings を指定せずに eligible_destinations を選択できます。

購入手続きページの 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 メソッドを使用して機能し、お客様のログインを必要としない、サイト上の有効なページを参照する必要があります。
  • 指定した購入手続きテンプレートのドメインは、商品のドメインと一致している必要があります。

その他の情報