Merchant Center Query Language(MCQL)は、SQL に似たクエリ言語です。MCQL と Merchant Reports API を使用して、商品と競合する市場のパフォーマンス データを取得できます。
文法
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]
は文字範囲を示します。|
は「または」を表します。
大文字と小文字の区別
ほとんどの MCQL 演算子では大文字と小文字が区別されます。
演算子 | 大文字と小文字の区別 |
---|---|
= または != | 大文字と小文字を区別 |
(NOT)IN | 大文字と小文字を区別 |
(NOT)LIKE | 大文字と小文字を区別 |
CONTAINS (...) | 大文字と小文字を区別 |
REGEXP_MATCH | 必要に応じて両方 |
句
MCQL でクエリできる句は次のとおりです。
SELECT
SELECT
句には、取得するフィールドのカンマ区切りのリストを指定します。
使用しているビューから任意のフィールドを選択できます。選択できるフィールドの例を以下に示します。
1 つのリクエストで複数のフィールド タイプをクエリできます。次の例をご覧ください。
SELECT
date,
marketing_method,
impressions,
clicks
FROM product_performance_view
WHERE date BETWEEN '2023-08-01' AND '2023-08-31'
FROM
FROM
句は、リクエストでデータの取得元となるテーブルを指定します。FROM
句で指定できるフィールドは 1 つだけです。FROM
句はすべてのクエリで必須です。
WHERE
WHERE
句を使用して、リクエストのデータをフィルタします。パフォーマンス クエリには WHERE
句が必要です。すべてのセグメント フィールドでフィルタできます。また、SELECT
句で追加の指標フィールドを指定すると、そのフィールドでフィルタできます。
WHERE
を使用して、指定した期間(8 月)のインプレッションのみを返す例を次に示します。
SELECT offer_id, impressions
FROM product_performance_view
WHERE date BETWEEN '2023-08-01' AND '2023-08-31'
AND
演算子を使用すると、1 つのクエリで複数の条件でフィルタできます。完全な条件の間に AND
を使用します(例: WHERE marketing_method !=
"ADS" AND marketing_method != "ORGANIC"
)。1 つの条件の値間に AND
を使用できません(WHERE marketing_method != "ADS" AND
"ORGANIC"
など)。
8 月の ADS
マーケティング方法で、100 回を超えるクリックがあったオファーごとのクリック数を返す例を次に示します。
SELECT offer_id, clicks
FROM product_performance_view
WHERE clicks > 100
AND marketing_method = 'ADS'
AND date BETWEEN '2023-08-01' AND '2023-08-31'
WHERE
句は OR
をサポートしていません。演算子では大文字と小文字が区別されます。演算子の一覧については、文法をご覧ください。
ORDER BY(省略可)
ORDER BY
句を使用すると、指定した順序で結果を取得できます。
並べ替え順序は field_name
、ASC
、または DESC
で指定します。並べ替えることができるのは、クエリの SELECT
句で指定されたフィールドのみです。指定しない場合、ORDER BY
はデフォルトで ASC
になります。
次のクエリは、返された行をクリック数で降順に並べ替えます。
SELECT offer_id, clicks
FROM product_performance_view
WHERE date BETWEEN '2023-08-01' AND '2023-08-31'
ORDER BY clicks DESC
ORDER BY
句では、複数のフィールドをカンマ区切りのリストで指定できます。
たとえば、次のクエリの結果は、offer_id
で昇順、インプレッション数で降順、クリック数で降順に並べ替えられます。
SELECT offer_id, impressions, clicks
FROM product_performance_view
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'
ORDER BY
offer_id,
impressions DESC,
clicks DESC
LIMIT
LIMIT
句を使用すると、返される結果の数を指定できます。
次に、行がさらにあっても 50 件の結果のみを返す例を示します。
SELECT offer_id, impressions
FROM product_performance_view
WHERE date BETWEEN '2020-08-01' AND '2020-08-31'
ORDER BY impressions DESC
LIMIT 50
pageSize
フィールドを使用して、結果の長いリストを処理します。
期間
MCQL では、カスタム期間または相対期間を指定できます。すべてのパフォーマンス クエリに date
範囲を指定するには、WHERE
句を使用する必要があります。
カスタム
ISO 8601(YYYY-MM-DD)の日付は、次の形式で指定できます。
date BETWEEN '2021-01-01' AND '2021-01-31'
date >= '2021-01-01' AND date <= '2021-01-31'
日付文字列は、単一引用符('
)または二重引用符("
)で定義できます。
相対
BETWEEN
と AND
の代わりに DURING
を使用すると、LAST_30_DAYS
や THIS_MONTH
などの相対的な期間を指定できます。
WHERE date DURING LAST_30_DAYS
使用可能な相対日付範囲の一覧については、構文をご覧ください。