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

メタデータ管理 API

最終更新 2026/10/03

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

AE使用マニュアルのメタデータ管理の部分を先に読んで、関連機能を理解しておくことをお勧めします：データ管理-イベントとプロパティ

1. イベント管理​

1. 仮想イベントを照会する​

インターフェースURL

/open/get-virtual-event-by-name?token=xxx&projectId=377&eventName=ta@test222

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId377IntegerはいプロジェクトID
eventNameta@test222Stringはいイベント名

成功レスポンスの例

{
    "data": {
        "eventDesc": "テスト仮想イベント",
        "eventName": "ta@teset",
        "remark": "",
        "rule": {
            "events": [
                {
                    "eventDesc": "ゴールド獲得",
                    "eventName": "obtain_coin",
                    "filter": {
                        "filterType": "COMPOUND",
                        "filts": [],
                        "relation": "and"
                    }
                }
            ],
            "filter": {
                "filterType": "COMPOUND",
                "filts": [],
                "relation": "and"
            }
        }
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.eventDescテスト仮想イベントStringイベント表示名
data.eventNameta@tesetStringイベント名
data.remark-Stringイベントの備考
data.rule-Object仮想イベントのルール
data.rule.events-Listイベントリスト
data.rule.events.eventDescゴールド獲得Stringイベント表示名
data.rule.events.eventNameobtain_coinStringイベント名
data.rule.events.filter-Objectプロパティフィルター
data.rule.events.filter.filterTypeCOMPOUNDString

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
data.rule.events.filter filts[]Listフィルター値のリスト
data.rule.events.filter relationandStringフィルターの論理関係
data.rule.filter-Objectプロパティフィルター
data.rule.filter.filterTypeCOMPOUNDString

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
data.rule.filter.filts[]Listフィルター値のリスト
data.rule.filter.relationandStringフィルターの論理関係
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

2. イベントのメタ情報一覧​

インターフェースURL

/open/list-event-meta?token=xxx&projectId=377

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId377IntegerはいプロジェクトID

propName

-

String

いいえ

プロパティ名。このパラメータは、プロパティに関連するイベントを照会するために使用します。指定しない場合は、すべての物理イベントと仮想イベントを返します

成功レスポンスの例

{
    "data": {
        "events": [
            {
                "eventDesc": "アクティビティ参加",
                "eventName": "activity_attend",
                "eventType": "event",
                "isHide": false,
                "remark": "アクティビティ参加321"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.events-Listイベントリスト
data.events.eventDescアクティビティ参加Stringイベントの説明
data.events.eventNameactivity_attendStringイベント名
data.events.eventTypeeventString

イベントタイプ

  • event：物理イベント
  • event_v：仮想イベント
data.events.isHidefalseBoolean非表示かどうか
data.events.remarkアクティビティ参加321Stringイベントの備考
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

3. 仮想イベントを作成する​

インターフェースURL

/open/create-virtual-event?token=xxx&projectId=0&override=false

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
overridefalseStringはい同名の仮想イベントがすでに存在する場合、override=falseのときはエラーになり、override=trueのときは仮想イベントの定義が更新されます。

リクエストBodyパラメータ

{
  "eventName": "ta@test_vevent",
  "eventDesc": "テスト仮想イベント",
  "remark": "",
  "rule": {
    "events": [
      {
        "eventDesc": "アクティビティ参加",
        "eventName": "activity_attend",
        "filter": {
          "relation": "and",
          "filts": [
            {
              "comparator": "equal",
              "columnDesc": "ネットワークタイプ",
              "columnName": "network",
              "ftv": [
                "4G"
              ],
              "selectType": "string",
              "tableType": "event"
            }
          ]
        }
      }
    ]
  }
}
$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventNameta@test_veventStringはいイベント名
eventDescテスト仮想イベントStringいいえイベント表示名
remarkStringいいえイベントの備考
rule-Objectはいルール
rule.events-Listはいイベントリスト
rule.events.eventNameactivity_attendStringはいイベント名
rule.events.eventDescアクティビティ参加Stringいいえイベント表示名
rule.events.filter-Objectいいえプロパティフィルター
rule.events.filter.filterTypeSIMPLEStringいいえ

フィルター

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
rule.events.filter.filts-Listいいえフィルター対象のリスト
rule.events.filter.filts.comparatorequalStringいいえ比較タイプ
rule.events.filter.filts.columnDescネットワークタイプStringいいえフィールドの表示名
rule.events.filter.filts.columnNamenetworkStringはいフィールド名
rule.events.filter.filts.ftv["4G"]Listいいえフィルター値のリスト
rule.events.filter.filts.selectTypestringStringいいえフィルター値の選択ボックスのタイプ
rule.events.filter.filts.tableTypeeventStringいいえevent：イベントプロパティ、user：ユーザープロパティ
rule.events.filter.filts.filterTypeSIMPLEStringいいえ

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
rule.events.filter.relationandStringいいえフィルターの論理関係

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "eventNameは空にできません、ruleはnullにできません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageeventNameは空にできません、ruleはnullにできませんStringリターンメッセージ

4. イベントの表示名と備考を変更する​

注意
  • イベントの表示名は最大60文字で、超過した部分は自動的に切り捨てられます
  • イベントの表示名に絵文字を含めることはできません
  • 仮想イベントの表示名は、他の仮想イベントの表示名やイベント名と重複できません
  • 物理イベントの表示名は、他の物理イベントの表示名やイベント名と重複できません

インターフェースURL

/open/update-event-info?token=xxx&projectId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID

リクエストBodyパラメータ

{
    "eventName": "test007",
    "eventDesc": "testDesc",
    "eventRemark": "testRemark"
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
eventNametestStringはいイベント名
eventDesctestDescStringはいイベント表示名
eventRemarktestRemarkStringいいえイベントの備考

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "イベントtest007は非表示または削除されています。条件を再設定してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageイベントtest007は非表示または削除されています。条件を再設定してくださいStringリターンメッセージ

5. 仮想イベントを削除する​

インターフェースURL

/open/delete-virtual-event-by-name?token=xxx&projectId=0&eventName=test

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
eventNametestStringはいイベント名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "イベントtestは非表示または削除されています。条件を再設定してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Stringリターンコード
return_messageイベントtestは非表示または削除されています。条件を再設定してくださいStringリターンメッセージ

2. プロパティ管理​

1. 仮想プロパティを照会する​

インターフェースURL

/open/get-sql-prop-by-name?token=xxx&projectId=0&propName=%23vp@location&tableType=event

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
propName#vp@locationStringはいプロパティ名
tableTypeeventStringはいevent：イベントプロパティ、user：ユーザープロパティ

成功レスポンスの例

{
    "data": {
        "relatedEvents": [
            {
                "eventName": "イベント名",
                "eventDesc": "イベント表示名"
            }
        ],
        "sqlEventRelationType": "relation_default",
        "sqlExpression": "concat(\"#country\",'-',\"#province\",'-',\"#city\")",
        "vProp": {
            "property": {
                "columnDesc": "位置情報",
                "columnName": "#vp@location",
                "selectType": "string",
                "tableType": "event"
            }
        }
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.relatedEvents-List関連イベントのリスト
data.relatedEvents.eventNameイベント名Stringイベント名
data.relatedEvents.eventDescイベント表示名Stringイベント表示名
data.sqlEventRelationTyperelation_defaultString
  • relation_default：関連イベントを自動解析
  • relation_always：すべてのイベントが関連イベント
  • relation_by_setting：関連イベントはrelatedEventsで指定
data.sqlExpressionconcat("#country",'-',"#province",'-',"#city")StringSQL式
data.vProp-Object仮想プロパティのリスト
data.vProp.property-Object仮想プロパティ
data.vProp.property.columnDesc位置情報Stringフィールドの表示名
data.vProp.property.columnName#vp@locationStringフィールド名
data.vProp.property.selectTypestringStringフィルター値の選択ボックスのタイプ
data.vProp.property.tableTypeeventString

プロパティタイプ

  • event：イベントプロパティ
  • user：ユーザープロパティ
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "ユーザープロパティtest007は非表示または削除されています。条件を再設定してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageユーザープロパティtest007は非表示または削除されています。条件を再設定してくださいStringリターンメッセージ

2. プロパティ一覧​

インターフェースURL

/open/list-props?token=xxx&projectId=0&tableType=event&eventName=xxx

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
tableTypeeventStringはい

プロパティタイプ

  • event：イベントプロパティ
  • user：ユーザープロパティ
eventName-StringいいえtableTypeがeventの場合に有効です。物理イベントまたは仮想イベントの名前。このパラメータは、イベントに関連するプロパティを照会するために使用します。指定しない場合は、すべての物理プロパティと仮想プロパティを返します

成功レスポンスの例

{
    "data": {
        "properties": [
            {
                "canCreateDict": true,
                "columnDesc": "アクティビティ項目def:123123123123123123",
                "columnName": "activity_item_operation",
                "columnRemark": "",
                "dictProps": [
                    {
                        "canCreateDict": false,
                        "columnDesc": "",
                        "columnName": "activity_item_operation@channel_name",
                        "columnRemark": "",
                        "isHide": false,
                        "propType": "vprop_dict",
                        "selectType": "string",
                        "tableType": "event"
                    }
                ],
                "isHide": false,
                "propType": "prop_unpreset",
                "selectType": "string",
                "tableType": "event"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
data-Objectレスポンスデータ
data.properties-List
data.properties.canCreateDicttrueBoolean参照テーブルを作成できるかどうか
data.properties.columnDescアクティビティ項目def:123123123123123123Stringフィールドの表示名
data.properties.columnNameactivity_item_operationStringフィールド名
data.properties.columnRemark-Stringフィールドの説明
data.properties.dictProps-List関連付けられた参照テーブルのフィールド
data.properties.dictProps.canCreateDictfalseString参照テーブルを作成できるかどうか
data.properties.dictProps.columnDesc-Stringフィールドの表示名
data.properties.dictProps.columnNameactivity_item_operation@channel_nameStringフィールド名
data.properties.dictProps.columnRemark-Stringフィールドの説明
data.properties.dictProps.isHidefalseBoolean非表示かどうか
data.properties.dictProps.propTypevprop_dictStringプロパティタイプ
data.properties.dictProps.selectTypestringStringフィルター値の選択ボックスのタイプ
data.properties.dictProps.tableTypeeventStringフィールドが属するテーブルのタイプ
data.properties.isHidefalseBoolean非表示かどうか
data.properties.propTypeprop_unpresetString

プロパティタイプ

  • prop_preset：プリセット物理プロパティ
  • prop_unpreset：カスタム物理プロパティ
  • vprop_dict：物理プロパティに基づく参照テーブルのプロパティ
  • vprop_sql：物理プロパティに基づく仮想プロパティ
  • vprop_dict_v：仮想プロパティに基づく参照テーブルのプロパティ
  • vprop_sql_v：参照テーブルのプロパティに基づく仮想プロパティ
data.properties.selectTypestringStringフィルター値の選択ボックスのタイプ
data.properties.tableTypeeventStringフィールドが属するテーブルのタイプ
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

3. プロパティの表示名を変更する​

注意
  1. プロパティの表示名は最大60文字で、超過した部分は自動的に切り捨てられます。絵文字を含めることはできません。仮想プロパティは他の仮想プロパティの表示名やプロパティ名と重複できず、物理プロパティは他の物理プロパティの表示名やプロパティ名と重複できません
  2. プロパティの説明は最大200文字で、超過した部分は自動的に切り捨てられます
  3. 同名の仮想プロパティがすでに存在する場合は、仮想プロパティの定義が更新されます

インターフェースURL

/open/update-prop-info?token=xxx&projectId=0

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID

リクエストBodyパラメータ

{
    "columnName": "test",
    "columnDesc": "testDesc",
    "columnRemark": "testRemark",
    "tableType": "event"
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
columnNametestStringはいフィールド名
columnDesctestDescStringはいフィールドの表示名
columnRemarktestRemarkStringいいえフィールドの説明
tableTypetestTypeStringはい

プロパティタイプ

  • event：イベントプロパティ
  • user：ユーザープロパティ

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "event property(test)が存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messageevent property(test)が存在しませんStringリターンメッセージ

4. ディメンション辞書の検証と作成​

注意

ファイルアップロードでディメンション辞書を作成します。ファイルサイズの上限は200Mです

インターフェースURL

/open/dict-create?token=xxx&projectId=0&createParam=test

リクエストメソッド

POST

Content-Type

text/csv

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
createParamtestStringはい-

成功レスポンスの例

{
    "data": {
        "totalLineNum": 4,
        "successLineNum": 1,
        "duplcatedMainKeyLineNum": 1,
        "duplcatedMainKeyColumns": ["city@test"],
        "mainKeyErrorLineNum": 1,
        "mainKeyErrorColumns": ["brand@quantity"],
        "typeErrorLineNum": 1,
        "typeErrorColumns": ["iswin@num"],
        "repeatWithConlumnName": [{
            "columnName": "channel@channel_name",
            "columnDesc": "チャネルタイプ"
        }],
        "repeatWithConlumnDesc": [{
            "columnName": "channel@channel_name",
            "columnDesc": "チャネルタイプ"
        }]
    },
    "return_code": 0,
    "return_message": "success"
}
$$パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Stringリターンコード
return_messagesuccessStringリターンメッセージ
data-Objectレスポンスデータ
data.totalLineNum4Integer解析した総行数
data.successLineNum1Integerインポートに成功した行数
data.duplcatedMainKeyLineNum1Integer主キーが重複している行数
data.duplcatedMainKeyColumns["city@test"]List主キーが重複している行のリスト
data.mainKeyErrorLineNum1Integer主キーの型が誤っている行数
data.mainKeyErrorColumns["brand@quantity"]List主キーの型が誤っている行のリスト
data.typeErrorLineNum1Integer他の列に型エラーを含む行数
data.typeErrorColumns["iswin@num"]List他の列に型エラーを含む行のリスト
data.repeatWithConlumnName-List表示名がプロパティ名と重複しているリスト
data.repeatWithConlumnName.columnNamechannel@channel_nameStringプロパティのフィールド名
data.repeatWithConlumnName.columnDescチャネルタイプStringプロパティ表示名
data.repeatWithConlumnDesc-List表示名が他の表示名と重複しているリスト
data.repeatWithConlumnDesc.columnNamechannel@channel_nameStringプロパティのフィールド名
data.repeatWithConlumnDesc.columnDescチャネルタイプStringプロパティ表示名

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-3004Stringリターンコード
return_message無効なプロジェクトStringリターンメッセージ

5. 仮想プロパティを新規作成する​

注意

同名の仮想プロパティがすでに存在する場合は、仮想プロパティの定義が更新されます

インターフェースURL

/open/create-sql-prop?token=xxx&projectId=110

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId110IntegerはいプロジェクトID

リクエストBodyパラメータ

{
  "sqlExpression": "get_ip_location(\"#ip\")",
  "vProp" : {
    "property" : {
      "columnDesc": "IPアドレスから解析した位置情報",
      "columnName": "#vp@location_array_from_ip",
      "tableType": "event",
      "selectType":"array"
    }
  },
  "sqlEventRelationType" : "relation_default"
}
$$パラメータ名サンプル値パラメータタイプ必須パラメータの説明
sqlExpressionget_ip_location(\"#ip\")StringはいSQL式
vProp-Objectはい仮想プロパティの情報
vProp.property-Objectはい仮想プロパティの情報

vProp.property.columnDesc

IPアドレスから解析した位置情報

String

いいえフィールド名
vProp.property.columnName#vp@location_array_from_ipStringはい

フィールドの表示名

vProp.property.tableTypeeventStringはい

テーブルタイプ

  • event：イベントプロパティ
  • user：ユーザープロパティ
vProp.property.selectTypearrayStringはいフィルター値の選択ボックスのタイプ
sqlEventRelationTyperelation_defaultStringいいえ

解析タイプ。デフォルトはrelation_default

  • relation_default：関連イベントを自動解析
  • relation_always：すべてのイベントが関連イベント
  • relation_by_setting：関連イベントはrelatedEventsで指定

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Stringリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-3004Stringリターンコード
return_message無効なプロジェクトStringリターンメッセージ

6. 参照テーブルのプロパティを削除する​

インターフェースURL

/open/delete-dict-props?token=xxx&projectId=0&tableType=event&mainColumnName=test

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
tableTypeeventStringはい

プロパティタイプ

  • event：イベントプロパティ
  • user：ユーザープロパティ
mainColumnNametestStringはい参照テーブルが関連付けられている主プロパティの名前

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "イベントプロパティtestは非表示または削除されています。条件を再設定してください"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messageイベントプロパティtestは非表示または削除されています。条件を再設定してくださいStringリターンメッセージ

7. SQL仮想プロパティを削除する​

インターフェースURL

/open/delete-sql-prop-by-name?token=xxx&projectId=0&tableType=event&propName=test

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId0IntegerはいプロジェクトID
tableTypeeventStringはい

プロパティタイプ

  • event：イベント
  • user：ユーザー
propNametestStringはいプロパティ名

成功レスポンスの例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "virtual event prop testが存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_messagevirtual event prop testが存在しませんStringリターンメッセージ
このページは役に立ちましたか？
このページの内容