このページは Cloud Translation API によって翻訳されました。

概要

Reporting API

Reporting API を使用すると、販売者は Merchant Center のクエリ言語を使ってプログラムでパフォーマンスデータを利用できます。これは、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"
      }
    }
]}

クエリ文法