Reporting API

Reporting API を使用すると、販売者は Merchant Center Query Language を介してパフォーマンス データにプログラムでアクセスできます。これは、Merchant Center で直接カスタム レポートを作成する機能に似ています。Reporting API には次の利点があります。

  • 大規模な販売者は、商品リスティングのパフォーマンス データを社内またはサードパーティのレポート システムにインポートできます。
  • Merchant Center アカウントを管理するユーザー、サードパーティ パートナー、アグリゲータがレポートにアクセスできるようにします。

API ユーザーは、検索呼び出しのレスポンスで取得するパフォーマンス データを指定できます。たとえば、次のようなデータを指定できます。

  • 返される指標（クリック数、インプレッション数など）
  • データを分類するディメンション（例: OfferId、Date）
  • 満たす必要のある条件（例: クリック数 > 100）

Reporting API のクエリ言語では、Reports サービスの Search メソッドを使用して、Content API for Shopping にパフォーマンス指標（クリック数、インプレッション数）をクエリできます。このとき、さまざまなディメンション（プログラムや日付などのレポートされたイベント属性、ブランドやカテゴリなどの商品属性）でセグメント化することもできます。

Reports サービスに対するクエリの結果は ReportRow インスタンスのリストです。各 ReportRow は、クエリで指定したセグメントのリクエストされた指標の値を表します。セグメントが指定されていない場合は、すべてのセグメントで集計された指標を含む単一行が返されます。それ以外の場合、指標とともにセグメントがリクエストされると、レスポンスには一意のセグメント タプルごとに 1 行が表示されます。1 つのクエリで複数のセグメントと複数の指標を選択できます。

指標のクエリ

返される指標（クリック数、インプレッション数、クリック率など）をクエリできます。Reports サービスをクエリするには、日付範囲のフィルタを追加する必要があります。次のサンプルクエリは、日付範囲の条件が追加されたクリック数の合計を 1 行で返します。

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

レスポンスの例

次の JSON コード レスポンスのサンプルは、この販売者が 2020 年 12 月 1 日から 2020 年 12 月 21 日までの間に、すべての商品のすべてのリンク先で合計 4,440 回のクリックを獲得したことを示しています。

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

セグメントのクエリ

指標に加えて、セグメントのクエリも実行できます。セグメントは、商品（offer_id、brand、category など）の属性またはレポートされたイベント（date、program）の属性にすることができます。レポートされたイベントは、商品のインプレッションまたはクリックです。

セグメントは、SQL の GROUP BY と同様に機能します。セグメントは、選択した指標を分割し、SELECT 句の各セグメントでグループ化します。次のサンプルクエリは、日付範囲の追加条件内でクリック数の降順で並べ替えられた、1 日あたりのクリック数を返します。リクエストされた指標の少なくとも 1 つがゼロ以外の行のみが返されます。

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

レスポンスの例

次の JSON コード レスポンスのサンプルは、この販売者が 2020 年 12 月 1 日にすべての商品のすべての掲載先で 1,546 回のクリックを獲得し、2020 年 12 月 2 日にすべての商品のすべての掲載先で 829 回のクリックを獲得したことを示しています。販売者は 2020 年 12 月 3 日にクリックがなかったため、オブジェクトは返されません。

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}
次へ
クエリ文法