API Postman ガイドライン

Postman は、HTTP リクエストの作成、送信、分析を行うための使いやすいインターフェースを提供することで、Merchant API のテストと理解を大幅に強化します。さまざまな API 呼び出し（GET、POST、PUT、DELETE）をさまざまなエンドポイントに対して簡単に作成して変更し、パラメータ、ヘッダー、リクエスト本文を調整して実際のシナリオをシミュレートできます。

このツールでは、ステータス コード、ヘッダー、ペイロードなどのレスポンスがわかりやすく表示されるため、API の動作をすばやく確認し、問題のデバッグに役立てることができます。この構造化されたアプローチにより、開発ライフサイクルが加速し、API の品質が向上し、Merchant API の機能と複雑さに対する理解が深まります。

概要

Postman インスタンスで MAPI Postman コレクションを使用するには、まずいくつかの手順に沿って環境を構成する必要があります。手順は次のとおりです。

プラットフォームの詳細については、Postman の説明をご覧ください。

1. サービス アカウントの構成

serviceAccountKey と api_key が返されます。

  1. 詳細な手順については、サービス アカウントを使用して API にアクセスする方法をご覧ください。
  2. Google Cloud プロジェクト > [認証情報] > [認証情報を作成] > [サービス アカウント]
  3. フォームに入力し、[作成して続行] をクリックします。
  4. [オーナー] のロールを選択し、[続行] をクリックします。
  5. [完了] をクリックします
  6. JSON キーをダウンロードする手順は次のとおりです。
    1. 作成したサービス アカウントのメールアドレス（{YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com など）をクリックします。
    2. [キー] タブをクリックする
    3. [鍵を追加] > [鍵を作成] をクリックします。
    4. [JSON] を選択し、[作成] をクリックして JSON をダウンロードします。

警告: キーをダウンロードできるのは 1 回のみです。キーを紛失した場合は、新しいキーを作成してこのキーを削除する必要があります。

  1. Merchant Center を開きます。
  2. [設定] > [アクセスとサービス] で、[ユーザーとアクセス] をクリックします。
  3. [ユーザーを追加] をクリックし、新しいユーザーのメールアドレスとしてサービス アカウント ID を使用します。

2. Postman の設定

  1. Postman 環境テンプレート JSON をダウンロードする
  2. MAPI Postman コレクション JSON をダウンロードする
  3. Postman にログインするか、新しいアカウントを作成します。
  4. Postman 環境テンプレートをインポートする
    1. 完全な JSON を [Environment] > [MyAccount] > [serviceAccountKey] にコピーします。
    2. JSON からコレクションの [Environment] > [MyAccount] > [api_key] に private_key をコピーします。
  5. MAPI Postman コレクションの JSON をインポートする
  6. 右上にある環境を選択します。

3. デベロッパーの登録

デベロッパーとして登録して、Merchant Center アカウントを Google Cloud プロジェクトにリンクします。API デベロッパー ロールを持つユーザーは、サービスに関する重要なお知らせ、デベロッパー アンケート、最適化案など、API 関連の通知を受け取ります。

  1. Postman > [Collections] > [Merchant API Official] を開きます。
  2. accounts_v1 > accounts > accounts.developerRegistration > registerGcp を開きます。
  3. パス内の {account} プレースホルダを MC ID に置き換えます。
  4. 本文の {email} プレースホルダをメールアドレスに置き換える
  5. [送信] をクリックして登録を実行します。
  6. すべてが正しく行われた場合は、次のような確認 JSON レスポンスが返されます。 json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Postman で Merchant API をテストする

  1. Postman > [Collections] > [Merchant API Official] > [accounts_v1] > [accounts] > [list] を開きます。
  2. [Send] をクリックします。
  3. すべてが正しく行われた場合は、次のような確認 JSON レスポンスが返されます。 json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }