SQL文生成API

最終更新 2026/10/03

呼び出し方法は、Open APIドキュメントの呼び出し方法の説明を参照してください。

1. ユーザーを照会するSQL文の生成

インターフェースURL

/open/get-sql-for-user-search?token=xxx&projectId=377

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
token	xxx	String	はい	クエリキー
projectId	0	Integer	はい	プロジェクトID

リクエストBodyパラメータ

{
  "filter": {
      "filterType": "COMPOUND",
      "relation": "and",
      "filts": [
        {
          "filterType": "SIMPLE",
          "tableType": "user",
          "columnName": "city",
          "comparator": "equal",
          "ftv": [
            "上海市"
          ]
        },
        {
          "filterType": "SIMPLE",
          "tableType": "user",
          "columnName": "companynature",
          "comparator": "equal",
          "ftv": [
            "民営"
          ]
        }
      ]
  },
  "selectAllColumns": false,
  "selectColumns": [
     "#account_id", "#distinct_id"
  ]
}

パラメータ名	サンプル値	パラメータタイプ	必須	パラメータの説明
selectAllColumns	false	Boolean	いいえ	すべてのフィールドを照会するかどうか。デフォルトはfalse
selectColumns	["#account_id", "#distinct_id"]	List	いいえ	照会するフィールド名のリスト
filter	-	Object	はい	プロパティフィルター
filter.filterType	COMPOUND	String	いいえ	フィルター COMPOUND：複合タイプ SIMPLE：シンプルタイプ
filter.relation	and	String	いいえ	フィルターの論理関係
filter.filts	-	List	いいえ	フィルター対象のリスト
filter.filts.filterType	SIMPLE	String	いいえ	フィルター COMPOUND：複合タイプ SIMPLE：シンプルタイプ
filter.filts.tableType	user	String	いいえ	user：ユーザープロパティ
filter.filts.columnName	city	String	はい	フィールド名
filter.filts.comparator	equal	String	いいえ	比較演算子
filter.filts.ftv	["民営"]	List	いいえ	フィルター値のリスト

成功レスポンスの例

{
  "data": {
    "sql": "select \"#user_id\", \"#account_id\", \"#distinct_id\" from (v_user_377) where (\"city\" IN ('上海市')) and (\"companynature\" IN ('民営'))"
  },
  "return_code": 0,
  "return_message": "success"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
data	-	Object	戻り値
data.sql	"select \"#user_id\", \"#account_id\", \"#distinct_id\" from (v_user_377) where (\"city\" IN ('上海市')) and (\"companynature\" IN ('民営'))"	String	SQL文
return_code	0	Integer	リターンコード
return_message	success	String	リターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "エラーの説明"
}

パラメータ名	サンプル値	パラメータタイプ	パラメータの説明
return_code	-1008	Integer	リターンコード
return_message	エラーの説明	String	リターンメッセージ