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

概要

Reporting API

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

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

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

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

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

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

指標のクエリ

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

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"
      }
    }
]}

クエリ文法