Merchant Promotions API の概要

プロモーションを使用して、Google で販売する商品のスペシャル オファーを紹介します。 プロモーションは、Google 検索などのさまざまな Google サービスに表示されます。 ショッピング、Chrome。

商品にプロモーションを追加すると、買い物客に 例: 「15% オフ」または [送料無料] を選択します。特典リンクは 買い物客に購入を促すことができます

詳しくは、プロモーション 基本をご覧ください。

前提条件

お客様のビジネスに関する具体的な情報をご提供ください。 プロモーション情報を表示できます次のものが必要です。

また、プロモーション プログラムに販売アカウントを登録する必要があります。条件 すでに登録済みかどうかご不明な場合は、Merchant Center Center にあります。

まだ登録していない場合は、リクエスト フォームに記入してください。「 実装を開始する準備が整うと、プロモーション チームから通知が届きます。

詳しくは、参加条件と ポリシーをご覧ください。

データソースを作成する

datasource.create API を使用してプロモーション フィードを作成します。既存の プロモーション フィードが利用可能な場合は、datasource.get を使用してプロモーション フィードを datasource.name

リクエストの形式は次のとおりです。

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/{account}/dataSources/{datasource}

この例は、一般的なリクエストとレスポンスを示しています。

リクエスト:

POST https://merchantapi.googleapis.com/datasources/v1beta/accounts/123/dataSources {"displayName": "test api feed", "promotionDataSource":{"targetCountry":"US", "contentLanguage":"en"}}

対応:

{
  "name": "accounts/123/dataSources/1000000573361824",
  "dataSourceId": "1000000573361824",
  "displayName": "test api feed",
  "promotionDataSource": {
    "targetCountry": "US",
    "contentLanguage": "en"
  },
  "input": "API"
}

プロモーションを実施する

こちらの accounts.promotions.insert メソッドを使用してプロモーションを作成または更新します。accounts.promotions.insert メソッド は、promotions リソースとデータソース名を入力として受け取ります。このメソッドは、 成功した場合は新規または更新されたプロモーションです

プロモーションを作成するには、 datasource.name

Google はプロモーションを配信する前に審査して承認します。詳細 詳しくは、プロモーションの承認 プロセスをご覧ください。

リクエストの形式:

POST https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*/}promotions:insert

次のサンプル プロモーションを参考にしてください。

サンプル 1: ローカル プロモーション適用対象 すべての商品と全店舗

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions:insert

{
  "promotion": {
    "promotionId": "buy_2_get_10_off",
    "contentLanguage": "en",
    "targetCountry": "US",
    "redemptionChannel": [
      "IN_STORE"
    ],
    "attributes": {
      "longTitle": "Buy 2 and get 10$ OFF purchase",
      "productApplicability": "ALL_PRODUCTS",
      "offerType": "NO_CODE",
      "couponValueType": "BUY_M_GET_MONEY_OFF",
      "promotionDisplayTimePeriod": {
        "startTime": "2024-2-06T00:47:44Z",
        "endTime": "2024-5-06T00:47:44Z"
      },
      "promotionEffectiveTimePeriod": {
        "startTime": "2024-2-06T00:47:44Z",
        "endTime": "2024-5-06T00:47:44Z"
      },
      "moneyOffAmount": {
        "amountMicros": "1000000",
        "currencyCode": "USD"
      },
      "minimum_purchase_quantity": 2,
      "storeApplicability": "ALL_STORES",
      "promotionUrl": "http://promotionnew4url.com/",
      "promotionDestinations": [
        "LOCAL_INVENTORY_ADS"
      ],
    }
  },
  "dataSource": "accounts/123/dataSources/1000000573361824"
}

例 2: 一部の商品にクーポンを適用したオンライン プロモーション コード

POST https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions:insert

{
 "promotion": {
   "promotionId": "25_pct_off",
   "contentLanguage": "en",
   "targetCountry": "US",
   "redemptionChannel": [
     "ONLINE"
   ],
   "attributes": {
     "longTitle": "10% off on selected items",
     "productApplicability": "SPECIFIC_PRODUCTS",
     "offerType": "GENERIC_CODE",
     "genericRedemptionCode": "SPRINGSALE",
     "couponValueType": "PERCENT_OFF",
     "promotionDisplayTimePeriod": {
       "startTime": "2024-2-06T00:47:44Z",
       "endTime": "2024-5-06T00:47:44Z"
     },
     "promotionEffectiveTimePeriod": {
       "startTime": "2024-2-06T00:47:44Z",
       "endTime": "2024-5-06T00:47:44Z"
     },
     "percentOff": 25,
     "promotionDestinations": [
       "FREE_LISTINGS"
     ],
     "itemIdInclusion": [
       "1499860100",
       "1499860101",
       "1499860102",
       "1499860103",
       "1499860104"
     ],
   }
 },
 "dataSource": "accounts/123/dataSources/1000000573361824"
}

特記事項

プロモーションの作成後、作成に数分かかることがあります。

プロモーション関連の属性の一覧については、構造化データを追加する 属性です

プロモーションを作成して管理する前に、プロモーションのベスト プラクティスを プラクティスをご覧ください。

プロモーションを表示

プロモーションを表示するには、次のコマンドを使用します。 accounts.promotions.get。 この get は読み取り専用です。これには、merchantId と 。get メソッドは、対応するプロモーション リソースを返します。

例:

GET https://merchantapi.googleapis.com/promotions/v1beta/{name=accounts/*/promotions/*}

こちらのサンプルをご覧ください。

例 1: ローカル プロモーション

GET https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions/in_store~en~US~buy_2_get_10_off

{
 "name": "accounts/123/promotions/in_store~en~US~buy_2_get_10_off",
 "promotionId": "buy_2_get_10_off",
 "contentLanguage": "en",
 "targetCountry": "US",
 "redemptionChannel": [
   "IN_STORE"
 ],
 "attributes": {
   "longTitle": "Buy 2 and get 10$ OFF purchase",
   "productApplicability": "ALL_PRODUCTS",
   "offerType": "NO_CODE",
   "couponValueType": "BUY_M_GET_MONEY_OFF",
   "promotionDisplayTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "promotionEffectiveTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "moneyOffAmount": {
     "amountMicros": "1000000",
     "currencyCode": "USD"
   },
   "minimum_purchase_quantity": 2,
   "storeApplicability": "ALL_STORES",
   "promotionUrl": "http://promotionnew4url.com/",
   "promotionDestinations": [
     "LOCAL_INVENTORY_ADS"
   ],
 }
 "dataSource": "accounts/123/dataSources/1000000573361824"
}

Sample 2. オンライン プロモーション

GET https://merchantapi.googleapis.com/promotions/v1beta/accounts/123/promotions/online~en~US~25_pct_off
{
 "name": "accounts/123/promotions/online~en~US~25_pct_off",
 "promotionId": "25_pct_off",
 "contentLanguage": "en",
 "targetCountry": "US",
 "redemptionChannel": [
   "ONLINE"
 ],
 "attributes": {
   "longTitle": "10% off on selected items",
   "productApplicability": "SPECIFIC_PRODUCTS",
   "offerType": "GENERIC_CODE",
   "genericRedemptionCode": "WINTERGIFT",
   "couponValueType": "PERCENT_OFF",
   "promotionDisplayTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "promotionEffectiveTimePeriod": {
     "startTime": "2024-2-06T00:47:44Z",
     "endTime": "2024-5-06T00:47:44Z"
   },
   "percentOff": 25,
   "promotionDestinations": [
     "FREE_LISTINGS"
   ],
   "itemIdInclusion": [
     "1499860100",
     "1499860101",
     "1499860102",
     "1499860103",
     "1499860104"
   ],
 }
 "dataSource": "accounts/{account}/dataSources/{dataSource}"
}

プロモーションを一覧表示する

こちらの promotions.list メソッドを使用して、作成されたすべてのプロモーションを表示します。

GET https://merchantapi.googleapis.com/promotions/v1beta/{parent=accounts/*}/promotions

プロモーション ステータス

プロモーションのステータスは、promotionStatus 属性で確認できます。 返品元 promotions.get および promotions.list

承認プロセスについて詳しくは、プロモーションの承認 プロセスをご覧ください。

プロモーション ステータスの例

次のサンプルは、成功と失敗の違いを示しています。 できます。

例 1.次のレスポンス本文は、オンライン プロモーションの例を示しています。 商品マッピングがないために拒否されました

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "REJECTED"
      }
    ],
    "itemLevelIssues": [
      {
        "code": "promotion_sku_unmapped",
        "severity": "DISAPPROVED",
        "resolution": "merchant_action",
        "reportingContext": "FREE_LISTINGS",
        "description": "Unmapped",
        "detail": "This promotion couldn't be tested during review because it doesn't apply to any products that are currently in your Products feed",
        "documentation": "https://support.google.com/merchants/answer/2906014",
        "applicableCountries": [
          "US"
        ]
      },
      {
        "code": "promotion_sku_additional_requirements",
        "severity": "DISAPPROVED",
        "resolution": "merchant_action",
        "reportingContext": "FREE_LISTINGS",
        "description": "Promotion conditions not allowed",
        "detail": "This promotion has additional requirements that are not allowed such as requiring customers to verify additional details like phone number or ID before showing the promotion details",
        "documentation": "https://support.google.com/merchants/answer/2906014",
        "applicableCountries": [
          "US"
        ]
      }
    ]
  }

Sample 2. 次のレスポンス本文には、承認されたプロモーションが表示されます。

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "PENDING"
      },
      {
        "destination": "SHOPPING_ADS",
        "status": "PENDING"
      }
    ],
    "itemLevelIssues": []
  }

サンプル 3.承認済みの公開中のプロモーション

  "promotionStatus": {
    "destinationStatuses": [
      {
        "reportingContext": "FREE_LISTINGS",
        "status": "LIVE"
      },
      {
        "destination": "SHOPPING_ADS",
        "status": "LIVE"
 }  ],
    "itemLevelIssues": []
  }

その他の情報

詳しくは、プロモーションのヘルプをご覧ください。 Center にあります。

Content API for Shopping からの移行について詳しくは、プロモーションの移行をご覧ください。 管理をご覧ください。