Query リソース

リソース URL

形式

JSON

使用可能なバージョン

36.0

HTTP のメソッド

POST

POST のリクエストボディ

パラメータ名	型	説明	必須か省略可能	使用可能なバージョン
query	Object (Saql​Query​Input​Representation)	JSON 形式のクエリ。	必須	36.0

リクエストボディの例

POST のレスポンスボディ

説明	検索条件グループとバージョン	使用可能なバージョン
SAQL クエリの結果 (JSON 形式)。グルーピングと列の型/名前を説明する metadata が含まれる場合もあります。レスポンスボディの例とクエリの metadata が説明されているセクションを参照してください。	Small、36.0	36.0

SaqlQueryInputRepresentation

プロパティ名	型	説明	必須か省略可能	使用可能なバージョン
name	String	クエリ名。	必須	41.0
query	String	クエリ。	必須	36.0

レスポンスボディの例 (metadata を含まない)

レスポンスボディの例 (metadata を含む)

クエリの metadadta

クライアントは SAQL クエリを解析し、使用されているディメンションとグループを判断できますが、コストが高くなる可能性があります。そのためほとんどの場合、クエリ応答には metadata セクションが含まれ、このセクションでグルーピングと列情報が提供されます。metadata セクションが存在する場合は、クエリ応答ペイロードの結果キーで見つけることができます。metadata セクションは、columns キーと groups キーで構成されます。

columns キーには、クエリの射影の名前と型が含まれます。groups キーには、クエリで使用されるグループのリストが含まれます。

• metadata は、クエリが成功したときに追加されます。クエリの実行が失敗した場合、構文エラーがある場合、または認証コールバックが失敗した場合、metadata は結果に追加されません。
• 列名に設定される値は、ディメンションの名前ではなく射影に付けられた別名です。
• クエリが複雑ではなく、返されるグループ名が非決定的な (グループの名前がクエリの複数のストリームで使用されている) 場合、クエリで使用されるグループのリストが groups キーで返されます。これは、クエリが cogroup または union を使用する場合です。そのような場合、groups キーは空になります。

メモ

SAQL クエリの作成についての詳細は、『Analytics SAQL リファレンス』および『Analytics SDK Guide (Analytics SDK ガイド)』を参照してください。