Merchant Center Query Language

Merchant Center のクエリ言語(MCQL)は、SQL に似たクエリ言語です。MCQL と Merchant Reports API を使用すると、貴社の商品と競合している市場のパフォーマンス データを取得できます。

Grammar

MCQL の文法リファレンスは次のとおりです(正規表現表記)。

Query            -> SelectClause FromClause? WhereClause? OrderByClause? LimitClause?
SelectClause     -> SELECT FieldName (, FieldName)*
FromClause       -> FROM TableName
WhereClause      -> WHERE Condition (AND Condition)*
OrderByClause    -> ORDER BY Ordering (, Ordering)*
LimitClause      -> LIMIT PositiveInteger

Condition        -> FieldName Operator Value | FieldName BETWEEN Value AND Value
Operator         -> = | != | > | >= | < | <= | <> | IN | NOT IN |
                    CONTAINS ANY | CONTAINS ALL | CONTAINS NONE | DURING |
                    LIKE | NOT LIKE | REGEXP_MATCH | NOT REGEXP_MATCH
Value            -> Number | NumberList | String | StringList | Function
Ordering         -> FieldName (ASC | DESC)?

FieldName        -> [a-z] ([a-zA-Z0-9._])*
TableName        -> [A-Z] ([a-zA-Z_])*

StringList       -> ( String (, String)* )
NumberList       -> ( Number (, Number)* )

PositiveInteger  -> [1-9] ([0-9])*
Number           -> -? [0-9]+ (. [0-9] [0-9]*)?
String           -> (' Char* ') | (" Char* ")
Function         -> LAST_14_DAYS | LAST_30_DAYS | LAST_7_DAYS |
                    LAST_BUSINESS_WEEK | LAST_MONTH | LAST_WEEK_MON_SUN |
                    LAST_WEEK_SUN_SAT | THIS_MONTH | THIS_WEEK_MON_TODAY |
                    THIS_WEEK_SUN_TODAY | TODAY | YESTERDAY

次の記号を使用できます。

  • ? は省略可能な要素です。
  • * は 0 以上を意味し、+ は 1 以上を意味します。
  • (xxxxxx) はグループを示します。
  • [a-z0-9] は文字範囲を示します。
  • | は「OR」を表します。

大文字と小文字の区別

ほとんどの MCQL 演算子では大文字と小文字が区別されます。

演算子 Case Sensitivity
= または != 大文字と小文字の区別
(NOT)IN 大文字と小文字の区別
(NOT)LIKE 大文字と小文字の区別
次を含む(...) 大文字と小文字の区別
REGEXP_MATCH 必要に応じて両方

MCQL でクエリできる句は次のとおりです。

SELECT

SELECT 句には、取得するフィールドのカンマ区切りのリストを指定します。

使用しているビューから任意のフィールドを選択できます。選択できるフィールドの例を以下に示します。

1 回のリクエストで複数のフィールド タイプをクエリできます。次の例をご覧ください。

SELECT
  date,
  marketingMethod,
  impressions,
  clicks
FROM ProductPerformanceView
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'

FROM

FROM 句は、リクエストでデータを取得するテーブルを指定します。FROM 句に指定できるフィールドは 1 つのみです。FROM 句は、すべてのクエリで必要です。

WHERE

WHERE 句を使用して、リクエストのデータをフィルタリングします。WHERE 句は、パフォーマンス クエリに必要です。SELECT 句で指定した場合は、すべてのセグメント フィールドと、追加のmetricsフィールドでフィルタリングできます。

次の例では、WHERE を使用して、指定された期間(8 月)のインプレッションのみを返します。

SELECT offerId, impressions
FROM ProductPerformanceView
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'

AND 演算子を使用すると、1 つのクエリ内の複数の条件でフィルタできます。完全な条件の間には AND を使用します(例: WHERE marketingMethod != "ADS" AND marketingMethod != "ORGANIC")。1 つの条件の値の間に AND を使用することはできません(例: WHERE marketingMethod != "ADS" AND "ORGANIC")。

次の例では、8 月の ADS マーケティング メソッドで、クリック数が 100 を超える商品ごとのクリック数を返す場合があります。

SELECT offerId, clicks
FROM ProductPerformanceView
WHERE clicks > 100
  AND marketingMethod = 'ADS'
  AND date BETWEEN '2020-08-01' AND '2020-08-31'

WHERE 句は OR をサポートしていません。演算子では大文字と小文字が区別されます。演算子の一覧については、文法をご覧ください。

ORDER BY(省略可)

ORDER BY 句を使用すると、指定した順序で結果を取得できます。

fieldName で順序を指定し、次に ASC または DESC で順序を指定します。並べ替えは、クエリの SELECT 句で指定されたフィールドでのみ行うことができます。指定しない場合、ORDER BY はデフォルトで ASC になります。

次のクエリは、返された行をクリック数の多い順に並べ替えます。

SELECT offerId, clicks
FROM ProductPerformanceView
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'
ORDER BY clicks DESC

カンマ区切りのリストを使用して、ORDER BY 句に複数のフィールドを指定できます。

たとえば、次のクエリの結果は、offerId の昇順、インプレッション数の降順、クリック数の降順で並べ替えられます。

SELECT offerId, impressions, clicks
FROM ProductPerformanceView
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'
ORDER BY
  offerId,
  impressions DESC,
  clicks DESC

LIMIT

LIMIT 句を使用すると、返される結果の数を指定できます。

次の例では、利用できる行がそれ以上あっても、50 件の結果のみが返されます。

SELECT offerId, impressions
FROM ProductPerformanceView
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'
ORDER BY impressions DESC
LIMIT 50

pageSize フィールドは、結果の長いリストを処理する場合に使用します。

期間

MCQL では、カスタムの期間または相対的な期間を指定できます。WHERE 句を使用して、すべてのパフォーマンス クエリdate 範囲を指定する必要があります。

カスタム

ISO 8601(YYYY-MM-DD)の日付を次の形式で指定できます。

  • date BETWEEN '2021-01-01' AND '2021-01-31'
  • date >= '2021-01-01' AND date <= '2021-01-31'

日付文字列は、一重引用符(')または二重引用符(")で定義できます。

相対的

BETWEENAND の代わりに DURING を使用して、LAST_30_DAYSTHIS_MONTH などの相対期間を指定できます。

WHERE date DURING LAST_30_DAYS

使用可能な相対期間の全一覧については、文法をご覧ください。