目录
此内容是否有帮助?

# メタデータ管理 API

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

まず、TA 使用マニュアルのメタデータ管理セクションを読んで、関連機能:メタデータ管理

# I.イベント管理

# 仮想イベントのクエリ

インターフェイス URL

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

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
377
Integer
はい
プロジェクトID
eventName
ta@test222
String
はい
イベント名

成功応答の例

{
    "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",
    "showStackMessage": false
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
eventDesc 仮想イベントのテスト
String
イベント表示名
eventName ta@teset
String
イベント名
remark -
String
イベントメモ
rule -
Object
仮想イベントルール
events -
List
イベントリスト
eventDesc 金貨を得る
String
イベント表示名
eventName obtain_coin
String
イベント名
filter -
Object
プロパティフィルター
filterType COMPOUND
String
フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
filterfilts []
List
フィルタ値リスト
filterrelation and
String
論理関係のフィルタリング
filter -
Object
プロパティフィルター
filterType COMPOUND
String
フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
filts []
List
フィルタ値リスト
relation and
String
論理関係のフィルタリング
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

# イベントメタ情報リスト

インターフェイス URL

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

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
377
Integer
はい
プロジェクトID
propName
-
String
いいえ
プロパティの名前。プロパティに関連するイベントのクエリに使用されます。送信されない場合は、すべての物理イベントと仮想イベント

成功応答の例

{
    "data": {
        "events": [
            {
                "eventDesc": "参加活动",
                "eventName": "activity_attend",
                "eventTag": "111,aaa",
                "eventType": "event",
                "isHide": false,
                "remark": "参加活动321"
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
events -
List
イベントリスト
eventDesc イベントに参加する
String
イベントの説明
eventName activity_attend
String
イベント名
eventTag 111,aaa
String
イベントタグ
eventType event
String
イベントの種類
event:物理イベント
event_v:仮想イベント
isHide false
Boolean
隠すかどうか
remark イベントに参加
String
イベントメモ
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

# 仮想イベントの作成

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
override
false
String
はい
同じ名前の仮想イベントがすでに存在する場合、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"
            }
          ]
        }
      }
    ]
  }
}
パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
eventName
ta@test_vevent
String
はい
イベント名
eventDesc
仮想イベントのテスト
String
いいえ
イベント表示名
remark
String
いいえ
イベントメモ
rule
-
Object
はい
ルール
events -
List
はい
イベントリスト
eventName activity_attend
String
はい
イベント名
eventDesc イベントに参加する
String
いいえ
イベント表示名
filter -
Object
いいえ
プロパティフィルター
filterType SIMPLE
String
いいえ
フィルター
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
filts -
List
いいえ
フィルタオブジェクトリスト
comparator equal
String
いいえ
比較タイプ
columnDesc ネットワークタイプ
String
いいえ
フィールド表示名
columnName network
String
はい
フィールド名
ftv ["4G"]
List
いいえ
フィルタ値リスト
selectType string
String
いいえ
フィルター値フィルターボックスタイプ
tableType event
String
いいえ
event:イベントプロパティ、user:ユーザープロパティ
filterType SIMPLE
String
いいえ
フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
relation and
String
いいえ
論理関係のフィルタリング

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "eventName 不能为空,rule 不能为null"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
eventNameは空ではなく、ruleはnullではありません
String
戻る情報

# イベントの表示名を変更

注意

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

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID

要求 Body パラメーター

{
    "eventName": "test007",
    "eventDesc": "testDesc"
}
パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
eventName
test
String
はい
イベント名
eventDesc
testDesc
String
はい
イベント表示名

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "事件test007已被隐藏或删除,请重新设置条件"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
イベントtest007が非表示または削除されました、条件を再設定
String
戻る情報

# 仮想イベントの削除

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
eventName
test
String
はい
イベント名

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "事件test已被隐藏或删除,请重新设置条件"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
String
リターンコード
return_message
イベントtestが非表示または削除されました。条件を再設定
String
戻る情報

# 二、属性管理

# 仮想プロパティのクエリ

インターフェイス URL

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

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
propName
#vp@location
String
はい
プロパティ名
tableType
event
String
はい
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
データを返す
relatedEvents -
List
関連イベントリスト
eventName event_name
String
イベント名
eventDesc イベント表示名
String
イベント表示名
sqlEventRelationType relation_default
String
relation_default:関連イベントの自動解析
常に関係:すべての事件は関連事である
relation_by_setting: relatedEvents内の関連イベント
sqlExpression concat("#country",'-',"#province",'-',"#city")
String
SQL式
vProp -
Object
仮想プロパティ一覧
property -
Object
仮想プロパティ
columnDesc 地理的位置情報
String
フィールド表示名
columnName #vp@location
String
フィールド名
selectType string
String
フィルター値フィルターボックスタイプ
tableType event
String
プロパティの種類
event:イベントプロパティ
user:ユーザープロパティ
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "用户属性test007已被隐藏或删除,请重新设置条件"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
ユーザー属性test007が非表示または削除されました。条件を再設定
String
戻る情報

# プロパティリスト

インターフェイス URL

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

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
tableType
event
String
はい
プロパティの種類
event:イベントプロパティ
user:ユーザープロパティ
eventName
-
String
いいえ
tableTypeがイベントの場合に有効です。物理イベントまたは仮想イベントの名前。イベントに関連するプロパティのクエリに使用されます。渡さない場合は、すべての物理プロパティと仮想プロパティ

成功応答の例

{
    "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",
    "showStackMessage": false
}
パラメーター名
サンプル値
パラメーターの種類
パラメーターの説明
data
-
Object
データを返す
properties -
List
canCreateDict true
Boolean
ディメンションテーブルを作成できるかどうか
columnDesc イベントプロジェクトdef:123123123123123123
String
フィールド表示名
columnName activity_item_operation
String
フィールド名
columnRemark -
String
フィールドの説明
dictProps -
List
関連するディメンションフィールド
canCreateDict false
String
を作成できるかどうか
columnDesc -
String
フィールド表示名
columnName activity_item_operation@channel_name
String
フィールド名
columnRemark -
String
フィールドの説明
isHide false
Boolean
隠すかどうか
propType vprop_dict
String
プロパティの種類
selectType string
String
フィルター値フィルターボックスタイプ
tableType event
String
フィールドが属するテーブルタイプ
isHide false
Boolean
隠すかどうか
propType prop_unpreset
String
プロパティの種類
prop_preset:プレハブ物理プロパティ
prop_unpreset:カスタム物理プロパティ
vprop_dict:物理プロパティに基づくディメンションテーブルプロパティ
vprop_sql:物理プロパティに基づく仮想プロパティ
vprop_dict_v:仮想プロパティに基づくディメンションテーブルプロパティ
vprop_sql_v:ディメンションテーブルプロパティに基づく仮想プロパティ
selectType string
String
フィルター値フィルターボックスタイプ
tableType event
String
フィールドが属するテーブルタイプ
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

# プロパティ表示名の変更

注意

  1. 属性表示名は最長 60 文字で、超過部分は自動的に切り捨てられ、emoji 表情を含めることはできない。仮想属性は他の仮想属性表示名と属性名の再名、物理属性は他の物理属性表示名と属性名の再名
  2. プロパティの説明最大 200 文字、セクションを超える自動切り捨て
  3. 同じ名前の仮想プロパティが既に存在する場合は、仮想プロパティ定義

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID

要求 Body パラメーター

{
    "columnName": "test",
    "columnDesc": "testDesc",
    "columnRemark": "testRemark",
    "tableType": "event"
}
パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
columnName
test
String
はい
フィールド名
columnDesc
testDesc
String
はい
フィールド表示名
columnRemark
testRemark
String
いいえ
フィールドの説明
tableType
testType
String
はい
プロパティの種類
event:イベントプロパティ
user:ユーザープロパティ

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1023,
    "return_message": "event property(test)不存在"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1023
Integer
リターンコード
return_message
event property(test)は存在しない
String
戻る情報

# ディメンション辞書のチェックサム作成

ディメンション属性関連機能は TA 取扱説明書:ディメンションテーブルのアップロード

注意

テキストアップロード方法ディメンション辞書の作成、テキストサイズ制限 200M

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

text/csv

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
createParam
test
String
はい
-

成功応答の例

{
    "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_code
0
String
リターンコード
return_message
success
String
戻る情報
data
-
Object
データを返す
totalLineNum 4
Integer
行の解析
successLineNum 1
Integer
インポートに成功した行数
duplcatedMainKeyLineNum 1
Integer
繰り返し主キーの行数
duplcatedMainKeyColumns ["city@test"]
List
繰り返し主キーの行リスト
mainKeyErrorLineNum 1
Integer
エラー主キータイプの行数
mainKeyErrorColumns ["brand@quantity"]
List
エラー主キータイプの行リスト
typeErrorLineNum 1
Integer
その他の列には、型エラーの行数が含まれます
typeErrorColumns ["iswin@num"]
List
その他の列には、型エラーの行のリストが含まれます
repeatWithConlumnName -
List
表示名とプロパティ名の重複リスト
columnName channel@channel_name
String
属性フィールド名
columnDesc チャネルタイプ
String
プロパティ表示名
repeatWithConlumnDesc -
List
表示名と表示名の重複リスト
columnName channel@channel_name
String
属性フィールド名
columnDesc チャネルタイプ
String
プロパティ表示名

エラー応答の例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-3004
String
リターンコード
return_message
無効なプロジェクト
String
戻る情報

# 新しい仮想プロパティ

注意

同じ名前の仮想プロパティが既に存在する場合は、仮想プロパティ定義

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
110
Integer
はい
プロジェクトID

要求 Body パラメーター

{
  "sqlExpression": "get_ip_location(\"#ip\")",
  "vProp" : {
    "property" : {
      "columnDesc": "IP地址解析的地理位置信息",
      "columnName": "#vp@location_array_from_ip",
      "tableType": "event",
      "selectType":"array"
    }
  },
  "sqlEventRelationType" : "relation_default",
}
パラメーター名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
sqlExpression
get_ip_location(\"#ip\")
String
はい
SQL式
vProp
-
Object
はい
仮想プロパティ情報
property -
Object
はい
仮想プロパティ情報
columnDesc IPアドレス解決の地理的位置情報
String
いいえ
フィールド名
columnName #vp@location_array_from_ip
String
はい
フィールド表示名
tableType event
String
はい
テーブルタイプ
event:イベントプロパティ
user:ユーザープロパティ
selectType array
String
はい
フィルター値フィルターボックスタイプ
sqlEventRelationType
relation_default
String
いいえ
解析タイプ、デフォルトrelation_default
relation_default:関連イベントの自動解析
relation_always:すべてのイベントは関連イベントです
relation_by_setting: relatedEvents内の関連イベント

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
String
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -3004,
    "return_message": "无效项目"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-3004
String
リターンコード
return_message
無効なプロジェクト
String
戻る情報

# ディメンション属性の削除

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
tableType
event
String
はい
プロパティの種類
event:イベントプロパティ
user:ユーザープロパティ
mainColumnName
test
String
はい
ディメンションテーブルに関連付けられているマスタープロパティ名

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "事件属性test已被隐藏或删除,请重新设置条件"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1008
Integer
リターンコード
return_message
イベントプロパティtestが非表示または削除されました。条件を再設定
String
戻る情報

# SQL 仮想プロパティの削除

インターフェイス URL

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

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
サンプル値
パラメーターの種類
必須かどうか
パラメーターの説明
token
xxx
String
はい
トークン
projectId
0
Integer
はい
プロジェクトID
tableType
event
String
はい
プロパティの種類
イベント
user:ユーザー
propName
test
String
はい
プロパティ名

成功応答の例

{
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
0
Integer
リターンコード
return_message
success
String
戻る情報

エラー応答の例

{
    "return_code": -1023,
    "return_message": "virtual event prop test不存在"
}
パラメータ名
サンプル値
パラメーターの種類
パラメーターの説明
return_code
-1023
Integer
リターンコード
return_message
virtual event prop testは存在しない
String
戻る情報