このページでは、Merchant API の概要と、Merchant Center でのアカウント、商品、在庫の管理に関連するさまざまなワークフローを自動化するために Merchant API を使用する方法について説明します。
Merchant API を使用すると、より多くのユーザーにリーチし、Google のさまざまなサービスに商品を掲載できます。Merchant API を使用して、大規模または複雑な Merchant Center アカウントを管理できます。一般的なユースケースは次のとおりです。
- アカウント管理の自動化
- 自動化されたプロダクト管理
- 広告在庫の自動管理
- カスタム レポートの作成
Merchant API を使用すると、複数のデータソースを作成して管理できるため、商品、プロモーション、レビューに関する情報をより効率的に整理できます。Merchant API を使用すると、ファイルや自動フィードなどの他の商品データ アップロード方法を補完する形で商品を管理できます。Merchant API では、複数の個別のリクエストを並行して実行することもできます。
Merchant API は、Content API for Shopping の再設計版です。複数のサブ API で構成されています。
Merchant API の新機能
Merchant API にアップグレードする理由をいくつかご紹介します。
次の新しいメソッドの導入により、在庫データの管理が改善されました。
補助データソースの作成と取得、および補助データソースとメイン データソースのリンクにより、補助データソースの管理を可能にします。
商品データの変更に関する通知を有効にすると、商品ステータスが変更されたときに通知が届くため、定期的な取得は不要になります。
accounts.autofeedSettings
リソースと、自動フィード設定を取得および更新するメソッドを導入します。accounts.productInputs
リソースの導入により、accounts.products
リソースが簡素化されました。ファイルなどの他のデータ アップロード方法と組み合わせて商品データを更新できます。
小売業者のウェブサイトへのトラフィックに関する情報など、商品以外のパフォーマンス データ用の新しい
NonProductPerformanceView
テーブル。モジュール設計により、機能の改善をより頻繁に個別に行うことができます。
Google の API 改善提案との連携を改善しました。
ドキュメントとコードサンプルを更新しました。
デベロッパー登録を通じて、デベロッパー向けのサポートとコミュニケーションを改善しました。
詳しくは、Merchant API ベータ版の新機能をご覧ください。
始める前に
Merchant API リクエストを実行するには、次のものが必要です。
Merchant Center アカウント: このアカウントに対して、データのクエリ、更新、アップロードを行います。このアカウントで商品と在庫を管理するために必要な権限があることを確認してください。
Google Cloud プロジェクト: このプロジェクトは、アカウントへの API アクセス権を取得するために使用されます。
デベロッパー登録メソッドを呼び出して、Merchant Center アカウントを Google Cloud プロジェクトにリンクします。リンクされたアカウントのユーザーは、必須のサービスに関するお知らせ、デベロッパー アンケート、機会など、API 通信を受け取ります。
Merchant API による認証
認証には次のオプションを使用できます。
- アプリの OAuth 2.0 クライアント ID とシークレットを生成できます。この ID とシークレットは、Merchant Center アカウントへの API 呼び出しに必要な OAuth 2.0 認証情報の生成に使用できます。
- サービス アカウントを作成し、その秘密鍵をダウンロードして API 呼び出しを行うことができます。
アカウントと商品の識別情報
Merchant API は、識別に ID ではなくリソース名を使用します。商品アイテムのリソース名の例は accounts/123456/products/online~en~US~sku123
です。ここで、123456
はアカウントの一意の識別子、online~en~US~sku123
は商品アイテムの一意の識別子です。
リクエスト URL の形式
リソースを操作するには、次の形式の URL にリクエストを送信します。
https://merchantapi.googleapis.com/{SUB_API}/{VERSION}/{RESOURCE_NAME}:{METHOD}
リストや取得などの標準メソッドでは、:{METHOD}
の部分は省略されます。
たとえば、次のリクエストはリージョン インベントリを削除します。
DELETE https://merchantapi.googleapis.com/inventories/v1beta/accounts/123456/products/online~en~US~sku123/regionalInventories/456
リソースを作成するには、親リソースのリソース名と次の URL を使用します。
POST https://merchantapi.googleapis.com/{SUB_API}/{VERSION}/{RESOURCE_NAME_OF_PARENT}/{RESOURCE}
たとえば、次のリクエストは、accounts/123456
のリージョンを作成する方法を示しています。
POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/123456/regions?regionId=WA HTTP/1.1
{
"displayName": "Washington",
"name": "Washington",
"postalCodeArea": {
"postalCodes": [
{
"begin": "98039",
"end": "98118"
}
],
"regionCode": "US"
}
}
特定のサービスの詳細については、Merchant API リファレンス ドキュメントをご覧ください。
Merchant API を使ってみる
Merchant API の仕組みを簡単に確認し、サンプル商品をアップロードするには、Merchant API のスタートガイドをご覧ください。
gRPC または REST を使用する
Merchant API は gRPC と REST をサポートしています。Merchant API 呼び出しを行う方法は次の 2 つです。
gRPC(推奨) | REST |
---|---|
|
|
クライアント ライブラリとコードサンプルを使用する
各サブ API には、使用を開始するのに役立つクライアント ライブラリがあります。コードサンプルは、Java、PHP、Python でのコードの作成を開始する際に役立ちます。詳しくは、Merchant API のサンプルをご覧ください。
ヘルプ
サポートの利用については、Merchant API のサポートを受けるをご覧ください。
フィードバックを送信
ベータ版期間は、一般提供版のリリース前にフィードバックを収集して対応する機会となります。フィードバックを送信するには、次のいずれかを送信します。
- API の機能: フィードバック フォームを送信する
- ドキュメント: ページ内の高評価 / 低評価と [フィードバックを送信] ボタンを使用します。
- サンプルとライブラリ: コードサンプルの GitHub リポジトリで問題を報告します。
各タスクを実装した後に一般的なフィードバックを送信するには、フィードバック フォームを使用します。
次のステップ
下位互換性については、Content API for Shopping の互換性をご覧ください。
Merchant API の主な機能について詳しくは、左側のナビゲーション メニューにあるガイドをご覧ください。
使用可能なリソースとサービスについては、リファレンス ドキュメントをご覧ください。