メインコンテンツまでスキップ

モデルクエリAPI

最終更新 2026/10/03

このドキュメントで説明する内容はAEの高度な機能に属し、技術的な詳細を多く含むため、関連機能の使用経験があるユーザー向けの参考資料です。ドキュメントの内容についてご不明な点がある場合は、担当のデータコンサルタントにお問い合わせのうえ、個別のサポートを受けてください。

モデルクエリAPIは、主に各種データ分析レポートの取得に使用します。

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

1. 共通パラメータ​

1. プロパティの表現​

ほぼすべてのAPIでプロパティを使用します。たとえば、特定のプロパティによるフィルター、グループ化、集計などです。プロパティにはイベントプロパティ、ユーザープロパティ、コホートプロパティがあり、通常は名前とテーブルタイプの2つのフィールドで表現します。たとえば、省（#province）というイベントプロパティを表す式は次のとおりです:

{
    "tableType":"event",
    "columnName":"#province"
}

ユーザープロパティも同様です。たとえば、ユーザーレベル（user_level）を表す場合:

{
    "tableType":"user",
    "columnName":"user_level"
}

2. フィルター式​

フィルター式も大部分のAPIで使用でき、特定のイベントやユーザーに対するフィルター操作を表します。次の形式のJSONで表現します:

{
  // filts 内の各条件の関係が OR か AND かを表します
  "relation": "and",
  // 具体的な条件のリスト。複数指定できます
  "filts": [{
    // 条件の左辺値。プロパティを指定します
    "tableType":"event",
    "columnName": "#os",
    // 条件の比較演算子。ここでは「等しい」を表します
    "comparator": "equal",
    // 条件の比較値。比較演算子に応じて1つまたは複数指定できます
    "ftv": [
      "ios"
    ]
  },
  {
    "tableType":"user",
    "columnName":"user_level",
    "comparator": "equal",
    "ftv": [
      "5"
    ]
  }]
}

現在サポートされている演算子は次のとおりです:

  • equal / notEqual

等しい/等しくないを表します。文字列型と数値型に有効です。ftv が複数ある場合は In または Not In に相当します。たとえば、レベルが3と5のユーザーを絞り込む場合:

{
    "tableType":"user",
    "columnName":"user_level",
    "comparator": "equal",
    "ftv": ["3","5"]
}
  • isTrue / isFalse

ブール型にのみ有効です。

  • isNull / notNull

プロパティに値があるかどうかを表します。文字列型と数値型に有効です。

  • include / notInclude

部分文字列を含むか含まないかを表します:

{
    "tableType":"user",
    "columnName":"channel",
    "comparator": "include",
    "ftv": ["Tencent MyApp"]
}
  • less / greater / range：より小さい/より大きい/2つの値の間（以上かつ以下）を表します。range は両端を含む閉区間で、数値型と時間型に有効です。たとえば、アイテムの残り数量が3から9の間にあるすべてのイベントを絞り込む場合:
{
    "tableType":"event",
    "columnName":"count_left",
    "comparator": "range",
    "ftv": [3, 9]
}

または、最終ログイン時間が2019-11-13 00:00~2019-11-23 00:00の間にあるすべてのユーザーを絞り込む場合

{
    "tableType":"user",
    "columnName":"latest_login_time",
    "comparator": "range",
    "ftv":["2019-11-13 00:00","2019-11-23 00:00"]
}
  • regexMatch / notRegexMatch

正規表現にマッチする/マッチしないを表します。文字列型にのみ有効です。

  • relativeCurrentBetween / relativeCurrentBefore

日付型の演算子で、それぞれ「現在時刻を基準として過去N日から過去M日までの間」「現在時刻を基準として過去N日より前」を表します。たとえば、登録時間が現在時刻を基準として過去3日より前のすべてのユーザーを絞り込む場合:

{
    "tableType":"user",
    "columnName":"register_time",
    "comparator": "relativeCurrentBefore",
    "ftv": [3]
}

または、登録時間が現在時刻を基準として過去9日から過去3日までの間にあるすべてのユーザーを絞り込む場合:

{
    "tableType":"user",
    "columnName":"register_time",
    "comparator": "relativeCurrentBetween",
    "ftv": [9, 3]
}
  • relativeEventBefore / relativeEventAfter / relativeEventAbsolute

日付型の演算子で、それぞれ「イベント発生時刻を基準として前のN単位時間以内」「イベント発生時刻を基準として後のN単位時間以内」「イベント発生時刻を基準として前後N単位時間以内」を表します。たとえば、ユーザーの前回ログイン時間がイベント発生時刻を基準として前の3時間以内であるイベントを絞り込む場合:

{
    "tableType":"user",
    "columnName":"latest_login_time",
    "comparator": "relativeEventBefore",
    "ftv": [3],
    "timeUnit": "hour"
}
  • arrayIncludeItem / arrayNotIncludeItem

リスト型の演算子で、リストに特定の要素が含まれるかどうかを表します

  • arrayItemPos

リスト型の演算子で、リストのn番目の要素が特定の値に等しいことを表します

  • arrayIsNull / arrayNotNull

リスト型の演算子で、リストが存在するかどうかを表します

3. テーブルタイプの列挙値​

  • event

イベントテーブル

  • user

ユーザーテーブル

  • cluster

コホート/タグテーブル

このページは役に立ちましたか？
このページの内容