目录
此内容是否有帮助?

# 埋め込みポイント管理 API

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

# I.埋め込みポイントスキーム

埋め込みポイントの関連機能を理解するために TA 使用マニュアルを読むことをお勧めします:埋め込みポイントスキームとデータ受け入れ

# 埋め込みポイントスキームのクエリ

インターフェイス URL

/open/track-query?token=xxx&projectId=30

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

{
    "data": {
        "commonEventProps": [{
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "desc": ""
        }],
        "createTime": "2021-10-12 11:47:31",
        "eventProps": [
            {
                "createTime": "2021-10-12 11:47:30",
                "creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "desc": "",
                "displayName": "原因",
                "lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "lastUpdateTime": "2021-10-12 11:47:30",
                "name": "reason",
                "type": "string"
            }
        ],
        "events": [
            {
                "createTime": "2021-10-12 11:47:30",
                "creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "displayName": "",
                "eventDesc": "参加活动3",
                "eventName": "activity_attend",
                "eventTag": "111,aaa",
                "lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "lastUpdateTime": "2021-10-12 13:01:10",
                "props": [
                    "#city"
                ]
            }
        ],
        "projectId": 377,
        "userProps": [
            {
                "createTime": "2021-10-12 11:47:30",
                "creator": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "desc": "",
                "displayName": "余额",
                "lastUpdateAuth": "TG-38045d57-403c-424c-a6a6-b12f6a8943bd",
                "lastUpdateTime": "2021-10-12 11:47:30",
                "name": "accountbalance",
                "type": "number",
                "updateTypeName": ""
            }
        ]
    },
    "return_code": 0,
    "return_message": "success"
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 -
 Object
 データを返す
∟ commonEventProps -
 List
 パブリックイベントのプロパティ
∟ name #device_id
 String
 プロパティ名
∟ displayName デバイスID
 String
 プロパティ表示名
∟ type string
 String
 タイプ
∟ desc String
 説明
∟ eventProps -
 List
 イベントプロパティ一覧
∟ createTime 2021-10-12 11:47:30
 Date
 作成時間
∟ creator TG-38045d57-403c-424c-a6a6-b12f6a8943bd
 String
 作成者
∟ desc -
 String
 説明
∟ displayName 登録名
 String
 表示名
∟ lastUpdateAuth TG-38045d57-403c-424c-a6a6-b12f6a8943bd
 String
 最終更新者
∟ lastUpdateTime 2021-10-12 11:47:30
 Date
 最終更新時刻
∟ name register_name
 String
 名前
∟ type string
 String
 タイプ
∟ events -
 List
 イベントリスト
∟ createTime 2021-10-12 11:47:30
 Date
 作成時間
∟ creator TG-38045d57-403c-424c-a6a6-b12f6a8943bd
 String
 作成者
∟ displayName -
 String
 表示名
∟ eventDesc イベントに参加3
 String
 説明
∟ eventName activity_attend
 String
 名前
∟ eventTag 111,aaa
 String
 タグ
∟ lastUpdateAuth TG-38045d57-403c-424c-a6a6-b12f6a8943bd
 String
 最終更新者
∟ lastUpdateTime 2021-10-12 13:01:10
 Date
 最終更新イベント
∟ props ["#city"]
 List
 イベントプロパティ一覧
∟ projectId 377
 Integer
 プロジェクトID
∟ userProps -
 String
 ユーザープロパティ一覧
∟ createTime 2021-10-12 11:47:30
 Date
 作成時間
∟ creator TG-38045d57-403c-424c-a6a6-b12f6a8943bd
 String
 作成者
∟ desc -
 String
 説明
∟ displayName 残高
 String
 表示名
∟ lastUpdateAuth TG-38045d57-403c-424c-a6a6-b12f6a8943bd
 String
 最終更新者
∟ lastUpdateTime 2021-10-12 11:47:30
 Date
 最終更新時刻
∟ name accountbalance
 String
 名前
∟ type number
 String
 タイプ
∟ updateTypeName -
 String
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

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

# 埋め込みスキームのエクスポート

注意

Excel 版埋め込みプログラムをダウンロードし、このプロジェクトの下に埋め込みプログラムがない場合はエラー

インターフェイス URL

/open/track-export?token=xxx&projectId=2

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

エクスポートテキスト形式は xlsx テキストで、「アクセス必須」、「#ユーザー ID システム」、「#イベントデータ」、「#公共イベント属性」、「#ユーザーデータ」、「データ型設計原則」、「公共イベント属性設定方式」、「マルチアクセス注意点」、「マルチユーザー ID システムの埋め込み点提案」などの sheet ページデータが含まれています。

エラー応答の例

{
    "return_code": -1023,
    "return_message": "目标对象已不存在"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1023
 Integer
 リターンコード
return_message
 ターゲットオブジェクトは既に存在しません
 String
 戻る情報

# メタデータエクスポート埋め込みスキーム

インターフェイス URL

/open/meta-export-track?token=xxx&projectId=2

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

エクスポートテキスト形式は xlsx テキストで、「アクセス必須」、「#ユーザー ID システム」、「#イベントデータ」、「#公共イベント属性」、「#ユーザーデータ」、「データ型設計原則」、「公共イベント属性設定方式」、「マルチアクセス注意点」、「マルチユーザー ID システムの埋め込み点提案」などの sheet ページデータが含まれています。

エラー応答の例

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

# 埋め込みポイントチェック

インターフェイス URL

/open/track-check?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "projectId": 0,
    "checkScope": {
       "startTime": "2021-01-01 10:00",
       "endTime": "2021-02-01 10:00",
       "checkDataTypes": ["event_data", "user_data"],
       "checkEvents": ["event1", "event2"],
       "eventFilter": {
       },
       "userFilter": {
         "tableType":"user",
         "columnName": "#os",
         "comparator": "equal",
         "ftv": [
           "ios"
         ]
       }
    },
    "resultScope": {
        "eventResults": ["unreported_event", "unplanned_event"],
        "userResults": ["unreported_user_prop", "unplanned_user_prop"]
    }
}
パラメーター名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
checkScope
 -
 Object
 はい
 検証範囲
∟ checkDataTypes event_data
 List
 いいえ
 検証データ型は、event_dataイベントデータ、user_dataユーザデータ、デフォルト値の両方を検証
∟ checkEvents string
 List
 いいえ
 イベントチェック範囲、nullはイベント全体のチェックを表します
∟ endTime string
 Date
 いいえ
 チェック期間の終了時刻、デフォルト値は現在のサーバー時刻です
∟ eventFilter -
 List
 いいえ
 イベントフィルター条件は、メタデータイベント属性のみをフィルター処理できます(仮想属性、ユーザーラベルは使用できません)
∟ filterType SIMPLE
 String
 いいえ
 フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
∟ filts -
 List
 いいえ
 フィルタ値リスト
∟ filterType SIMPLE
 String
 いいえ
 フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
∟ relation and
 String
 いいえ
 論理関係のフィルタリング
∟ hasEmptyCheck false
 Boolean
 いいえ
 空の文字列がnullレートであるかどうか
∟ propNullValueThreshold 0
 Integer
 いいえ
 プロパティのnullレートしきい値
∟ startTime string
 Date
 いいえ
 検査時間帯の開始時間、デフォルト値は埋め込みポイント案のアップロード時間
∟ userFilter -
 List
 いいえ
 ユーザーフィルター条件は、メタデータユーザー属性(仮想属性、ユーザーラベルは使用できません)
∟ filterType SIMPLE
 String
 いいえ
 フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
∟ filts -
 List
 いいえ
 フィルタ値リスト
∟ filterType SIMPLE
 String
 いいえ
 フィルター、
COMPOUND:複合タイプ
SIMPLE:シンプルタイプ
∟ relation and
 String
 いいえ
 論理関係のフィルタリング
projectId
 0
 Integer
 はい
 プロジェクトID
resultScope
 -
 Object
 いいえ
 結果範囲を選択(nullの場合はデフォルトですべて選択)
∟ eventResults ["unreported_event"]
 List
 いいえ
 イベントの結果範囲、オプションの値
unreported_event:埋没点案では、実際に報告されていない事件
unplanned_event:埋没地点案にはなく、実際に報告された事件
unplanned_event_prop:イベントは埋め込みスキームにありますが、イベントプロパティは埋め込みスキームのイベントプロパティにありません(プリセットプロパティはチェックされません)
missing_event_prop:埋め込みポイントシナリオでは、実際にはレポートデータにこの属性
type_error_event_prop:イベントプロパティの型は、実際に報告されたプロパティの型と一致しません
∟ userResults ["missing_user_prop"]
 List
 いいえ
 ユーザーの結果範囲、オプションの値があります
unreported_user_prop:埋め込みポイントスキームでは、実際に報告されていないユーザープロパティ
unplanned_user_prop:埋め込みポイントスキームではなく、実際に報告されたユーザー属性
type_error_user_prop:ユーザーのプロパティタイプと実際に報告されたプロパティタイプが一致しません

成功応答の例

{
    "data": "d611d456-e74d-47e3-b078-370b79a134af",
    "return_code": 0,
    "return_message": "success"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
data
 d611d456-e74d-47e3-b078-370b79a134af
 Object
 チェック結果クエリkey
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報

エラー応答の例

{
    "return_code": -1008,
    "return_message": "projectId 不能为null"
}
パラメータ名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 -1008
 Integer
 リターンコード
return_message
 projectIdはnullにできません
 String
 戻る情報

# 埋め込みポイントチェック結果クエリ

インターフェイス URL

/open/track-check-result-query?token=xxx&key=d611d456-e74d-47e3-b078-370b79a134af

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
token
 xxx
 String
 はい
 トークン
key
 d611d456-e74d-47e3-b078-370b79a134af
 String
 はい
 チェック結果key

成功応答の例

{
    "return_code": 0,
    "return_message": "success",
    "data": {
        "projectId": 100,
        "checkTime": "2021-04-23 14:00:00",
        "checkScope": {},
        "checkResultType": "result_fail",
        "eventResults": [
            {
                "name": "event1",
                "resultType": "success",
                "details": [
                    {
                        "sample": [
                            ""
                        ]
                    }
                ],
                "propNullRates": [
                    {
                        "propName": "property1",
                        "displayName": "displayName1",
                        "hasRequired": true,
                        "propNullRate": 60
                    }
                ]
            },
            {
                "name": "event2",
                "displayName": "事件2",
                "resultType": "fail",
                "details": [
                    {
                        "propName": "property1",
                        "errorType": "type_error_prop",
                        "reportType": "string",
                        "planType": "number",
                        "sample": [
                            ""
                        ]
                    },
                    {
                        "propName": "property2",
                        "errorType": "unreported"
                    }
                ],
                "propNullRates": [
                    {
                        "propName": "property1",
                        "displayName": "displayName1",
                        "hasRequired": true,
                        "propNullRate": 60
                    }
                ]
            }
        ],
        "userResult": {
            "userSamples": [
                {}
            ],
            "userPropDetails": [
                {
                    "name": "property1",
                    "displayName": "用户属性1",
                    "resultType": "success",
                    "propNullRate": 10
                }
            ]
        }
    }
}
パラメーター名
 サンプル値
 パラメーターの種類
 パラメーターの説明
return_code
 0
 Integer
 リターンコード
return_message
 success
 String
 戻る情報
data
 -
 Object
 チェック結果クエリkey
∟ projectId 100
 Integer
 プロジェクトID
∟ checkTime 2021-04-23 14:00:00
 Date
 チェック時間
∟ checkScope {}
 Object
 検証条件範囲、インタフェース/track-check要求本体内容
∟ checkResultType result_fail
 String
 checkResultType:検査結果タイプ、4種類の値
result_success:データの詳細はeventResultsフィールドとuserResultフィールドで確認できます
result_fail:検証に失敗しました(報告されたデータは埋め込みスキームから逸脱しています)。eventResultsフィールドとuserResultフィールドでデータの詳細
checking:チェック、後でお問い合わせください
check_fail:計算に失敗し、checkErrorフィールドから失敗の原因
∟ eventResults -
 List
 イベントデータのチェック結果
∟ name event1
 String
 イベント名
∟ resultType success
 String
 イベントチェック結果タイプは、4種類あり、
success:検査の成功
fail:チェック失敗
unreported:報告なし
unplanned:計画外埋設点
∟ details -
 List
 詳細データコレクション
∟ sample {}
 Object
 サンプル例、イベントチェック結果タイプは未報告時サンプル例なし
∟ propNullRates -
 List
 プロパティのnull率
∟ propName property1
 String
 イベントプロパティ名
∟ displayName displayName1
 String
 イベントプロパティ表示名
∟ hasRequired true
 Boolean
 必要かどうか
∟ propNullRate 60
 Integer
 ヌル率
∟ userResult -
 Object
 ユーザーデータのチェック結果
∟ userSamples {}
 List
 ユーザーサンプリング例10本
∟ userPropDetails -
 List
 ユーザー属性の詳細
∟ name property1
 String
 ユーザープロパティ名
∟ displayName ユーザープロパティ1
 String
 ユーザ属性表示名
∟ resultType success
 String
 ユーザー属性チェック結果タイプは、4種類
success:検査の成功
fail:チェック失敗
unreported:報告なし
unplanned_user_prop:スケジュール外のユーザープロパティ
∟ propNullRate 10
 Integer
 プロパティのnull率

エラー応答の例

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

# 埋め込み項目 Excel を保存

注意

file パラメータ excel テンプレートをアップロード

インターフェイス URL

/open/track-excel-save?token=xxx&projectId=0

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

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

エラー応答の例

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

# 埋め込み項目を追加

注意

要求されたイベント名またはプロパティ名が埋もれている場合、エラーが返され

例:既存のイベントのイベントプロパティを追加します(既存のイベント register にバインドされた新しい register_name イベントプロパティ)

インターフェイス URL

/open/track-insert?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "projectId": 100,
    "events": [
        {
            "eventName": "register",
            "displayName": "注册事件",
            "hasAutoCollect": false,
            "dataOrigin": "ios",
            "eventDesc": "注册事件是指用户注册游戏触发的事件",
            "eventTag": "",
            "props": [
                "register_name"
            ]
        }
    ],
    "eventProps": [
        {
            "name": "register_name",
            "displayName": "注册名",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ],
    "userProps": [
        {
            "name": "user_name",
            "displayName": "用户名称",
            "type": "string",
            "updateType": "user_set",
            "desc": "",
            "propTag": ""
        }
    ],
    "commonEventProps": [
        {
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ]
}
パラメーター名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
projectId
 100
 Integer
 はい
 プロジェクトID
events
 -
 List
 いいえ
 イベント情報
∟ eventName register
 String
 はい
 イベント名
∟ displayName 登録イベント
 String
 はい
 イベント表示名
∟ hasAutoCollect false
 Boolean
 いいえ
 自動的に取得するかどうか、既定値はいいえです
∟ dataOrigin ios
 String
 いいえ
 データソース、データソースは元のデータの#libフィールド値、#libがなければソースはその他
∟ eventDesc 登録イベントとは、ユーザがゲームを登録することを契機とするイベントである
 String
 いいえ
 イベントの説明
∟ eventTag String
 いいえ
 イベントタグ
∟ props register_name
 List
 いいえ
 イベントプロパティリスト、イベントプロパティ名コレクション
eventProps
 -
 List
 いいえ
 イベントの属性情報
∟ name register_name
 String
 はい
 イベントプロパティ名、必須項目
∟ displayName 登録名
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasRequired true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明
userProps
 -
 List
 いいえ
 ユーザ属性情報
∟ name user_name
 String
 はい
 ユーザープロパティ名
∟ displayName ユーザー名
 String
 はい
 ユーザ属性表示名
∟ type string
 String
 はい
 ユーザー属性タイプは、string, number, datetime, bool, arrayの5種類
∟ updateType user_set
 String
 いいえ
 ユーザー属性更新方式は、user_setOnce, user_set, user_addの3種類
∟ desc String
 いいえ
 ユーザー属性の説明
∟ propTag String
 いいえ
 ユーザ属性ラベル
commonEventProps
 -
 List
 いいえ
 パブリックイベントのプロパティ
∟ name #device_id
 String
 はい
 イベントプロパティ名
∟ displayName デバイスID
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasRequired true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明

成功応答の例

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

エラー応答の例

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

# 埋め込み項目を保存

注意

と埋め込みポイントアイテム違いは、このインターフェイスが既存の埋め込みポイントプロパティの更新

インターフェイス URL

/open/track-save?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "projectId": 100,
    "events": [
        {
            "eventName": "register",
            "displayName": "注册事件",
            "hasAutoCollect": false,
            "dataOrigin": "ios",
            "eventDesc": "注册事件是指用户注册游戏触发的事件",
            "eventTag": "",
            "props": [
                "register_name"
            ]
        }
    ],
    "eventProps": [
        {
            "name": "register_name",
            "displayName": "注册名",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ],
    "userProps": [
        {
            "name": "user_name",
            "displayName": "用户名称",
            "type": "string",
            "updateType": "user_set",
            "desc": "",
            "propTag": ""
        }
    ],
    "commonEventProps": [
        {
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ]
}
パラメーター名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
projectId
 100
 Integer
 はい
 プロジェクトID
events
 -
 List
 いいえ
 イベント情報
∟ eventName register
 String
 はい
 イベント名
∟ displayName 登録イベント
 String
 はい
 イベント表示名
∟ hasAutoCollect false
 Boolean
 いいえ
 自動取得かどうか、既定値はいいえ
∟ dataOrigin ios
 String
 いいえ
 データソース、データソースは元のデータの#libフィールド値、#libがなければソースはその他
∟ eventDesc 登録イベントとは、ユーザがゲームを登録することを契機とするイベント
 String
 いいえ
 イベントの説明
∟ eventTag String
 いいえ
 イベントタグ
∟ props register_name
 List
 いいえ
 イベントプロパティリスト、イベントプロパティ名コレクション
eventProps
 -
 List
 いいえ
 イベントのプロパティ情報
∟ name register_name
 String
 はい
 イベントプロパティ名、必須項目
∟ displayName 登録名
 String
 はい
 イベントプロパティの表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasRequired true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明
userProps
 -
 List
 いいえ
 ユーザ属性情報
∟ name user_name
 String
 はい
 ユーザープロパティ名
∟ displayName ユーザー名
 String
 はい
 ユーザ属性表示名
∟ type string
 String
 はい
 ユーザー属性タイプは、string, number, datetime, bool, arrayの5種類
∟ updateType user_set
 String
 いいえ
 ユーザー属性更新方式は、user_setOnce, user_set, user_addの3種類
∟ desc String
 いいえ
 ユーザー属性の説明
∟ propTag String
 いいえ
 ユーザ属性ラベル
commonEventProps
 -
 List
 いいえ
 パブリックイベントのプロパティ
∟ name #device_id
 String
 はい
 イベントプロパティ名
∟ displayName デバイスID
 String
 はい
 イベントプロパティの表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasRequired true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明

成功応答の例

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

エラー応答の例

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

# 埋め込み項目の編集

注意

他の更新しないフィールドの正確な値を記入する必要があります。つまり、全体的にデータ更新

インターフェイス URL

/open/track-update?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "projectId": 2,
    "targetName": "buy_shopitem",
    "event": {
        "eventName": "buy_shopitem",
        "displayName": "testName",
        "eventTag": "testTag",
        "eventDesc": "12",
        "props": [
            "#app_version"
        ]
    },
    "deleteProps": [
        {
            "displayName": "运营商",
            "hasReported": true,
            "name": "#carrier",
            "type": "string"
        }
    ],
    "eventProps": [
        {
            "displayName": "app版本",
            "hasReported": true,
            "name": "#app_version",
            "type": "string"
        }
    ],
    "userProps": [
        {
            "displayName": "金币数量卡",
            "desc": "",
            "name": "coin_num",
            "type": "string",
            "updateType": "user_set",
            "propTag": "testPropTag"
        }
    ]
}
パラメーター名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
projectId
 2
 Integer
 はい
 プロジェクトID
targetName
 buy_shopitem
 String
 はい
 ターゲット名
events
 -
 List
 -
 イベント情報
∟ eventName buy_shopitem
 String
 はい
 イベント名
∟ displayName テスト名
 String
 はい
 イベント表示名
∟ hasAutoCollect false
 Boolean
 いいえ
 自動的に取得するかどうか、既定値はいいえです
∟ dataOrigin ios
 String
 いいえ
 データソース、データソースは元のデータの#libフィールド値、#libがなければソースはその他
∟ eventDesc 12
 String
 いいえ
 イベントの説明
∟ eventTag testTag
 String
 いいえ
 イベントタグ
∟ props ["#app_version"]
 List
 いいえ
 イベントプロパティリスト、イベントプロパティ名コレクション
eventProps
 -
 List
 -
 イベントの属性情報
∟ name #app_version
 String
 はい
 イベントプロパティ名、必須項目
∟ displayName アプリバージョン
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasReported true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明
userProps
 -
 List
 -
 ユーザ属性情報
∟ name coin_num
 String
 はい
 ユーザープロパティ名
∟ displayName 金貨の数量カード
 String
 はい
 ユーザ属性表示名
∟ type string
 String
 はい
 ユーザー属性タイプは、string, number, datetime, bool, arrayの5種類
∟ updateType user_set
 String
 いいえ
 ユーザー属性更新方式は、user_setOnce, user_set, user_addの3種類
∟ desc String
 いいえ
 ユーザー属性の説明
∟ propTag testPropTag
 String
 いいえ
 ユーザ属性ラベル
commonEventProps
 -
 List
 -
 パブリックイベントのプロパティ
∟ name #device_id
 String
 はい
 イベントプロパティ名
∟ displayName デバイスID
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasReported true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明
deleteProps
 -
 List
 いいえ
 イベントプロパティを完全に削除
∟ name #device_id
 String
 はい
 イベントプロパティ名
∟ displayName キャリア
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasReported true
 Boolean
 いいえ
 既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明

成功応答の例

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

エラー応答の例

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

# 埋め込みシナリオをアップロード

注意

プロジェクトにスキーマが既に存在する場合は、新しいスキーマを削除します

インターフェイス URL

/open/track-upload?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "projectId": 0,
    "events": [
        {
            "eventName": "register",
            "displayName": "注册事件",
            "hasAutoCollect": false,
            "dataOrigin": "ios",
            "eventDesc": "注册事件是指用户注册游戏触发的事件",
            "eventTag": "通用",
            "props": ["register_name"]
        }
    ],
    "eventProps": [
         {
             "name": "register_name",
             "displayName": "注册名",
             "type": "string",
             "hasRequired": true,
             "desc": "",
         }
    ],
    "userProps": [
        {
            "name": "user_name",
            "displayName": "用户名称",
            "type": "string",
            "updateType": "user_set",
            "desc": "",
            "propTag": ""
        }
    ],
    "commonEventProps": [
        {
            "name": "#device_id",
            "displayName": "设备id",
            "type": "string",
            "hasRequired": true,
            "desc": ""
        }
    ]
}
パラメーター名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
projectId
 100
 Integer
 はい
 プロジェクトID
events
 -
 List
 いいえ
 イベント情報
∟ eventName register
 String
 はい
 イベント名
∟ displayName 登録イベント
 String
 はい
 イベント表示名
∟ hasAutoCollect false
 Boolean
 いいえ
 自動的に取得するかどうか、既定値はいいえです
∟ dataOrigin ios
 String
 いいえ
 データソース、データソースは元のデータの#libフィールド値、#libがなければソースはその他
∟ eventDesc 登録イベントとは、ユーザがゲームを登録することを契機とするイベントである
 String
 いいえ
 イベントの説明
∟ eventTag 通用
 String
 いいえ
 イベントタグ
∟ props register_name
 String
 いいえ
 イベントプロパティリスト、イベントプロパティ名コレクション
eventProps
 -
 List
 いいえ
 イベントの属性情報
∟ name register_name
 String
 はい
 イベントプロパティ名、必須項目
∟ displayName 登録名
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasRequired true
 Boolean
 いいえ
 必要かどうか、既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明
userProps
 -
 List
 いいえ
 ユーザ属性情報
∟ name user_name
 String
 はい
 ユーザープロパティ名
∟ displayName ユーザー名
 String
 はい
 ユーザ属性表示名
∟ type string
 String
 はい
 ユーザー属性タイプは、string, number, datetime, bool, arrayの5種類
∟ updateType user_set
 String
 いいえ
 ユーザー属性更新方式は、user_setOnce, user_set, user_addの3種類
∟ desc String
 いいえ
 ユーザー属性の説明
∟ propTag String
 いいえ
 ユーザ属性ラベル
commonEventProps
 -
 List
 いいえ
 パブリックイベントのプロパティ
∟ name #device_id
 String
 はい
 イベントプロパティ名
∟ displayName デバイスID
 String
 はい
 イベントプロパティ表示名
∟ type string
 String
 はい
 イベント属性型には、string, number, datetime, bool, arrayの5種類
∟ hasRequired true
 Boolean
 いいえ
 必要かどうか、既定値はtrueです
∟ desc String
 いいえ
 イベントプロパティ説明

成功応答の例

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

エラー応答の例

{
    "return_code": -3004,
    "return_message": "无效项目"
}

# 埋め込みスキームを削除

インターフェイス URL

/open/track-delete?token=xxx&projectId=100

リクエスト方法

GET

コンテンツタイプ

application/json

Query パラメーター

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

成功応答の例

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

エラー応答の例

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

# 埋め込み項目を削除

注意

  1. イベントを削除すると、イベント全体とそのイベントとイベントプロパティのバインド関係
  2. イベントプロパティを削除すると、すべてのイベントとのバインド関係

インターフェイス URL

/open/track-delete-item?token=xxx

リクエスト方法

POST

コンテンツタイプ

application/json

Query パラメーター

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

要求 Body パラメーター

{
    "projectId": 0,
    "events": [
        "login_in"
    ],
    "eventPropNames": [
        "register_name"
    ],
    "userPropNames": [
        "user_name"
    ],
    "commonEventPropNames": [
        "#device_id"
    ]
}
パラメータ名
 サンプル値
 パラメーターの種類
 必須かどうか
 パラメーターの説明
projectId
 100
 Integer
 はい
 プロジェクトID
events
 ["login_in"]
 List
 いいえ
 イベント名リスト
eventPropNames
 ["register_name"]
 List
 いいえ
 イベントプロパティ名リスト
userPropNames
 ["user_name"]
 List
 いいえ
 ユーザ属性名リスト
commonEventPropNames
 ["#device_id"]
 List
 いいえ
 共通イベントプロパティ名リスト

成功応答の例

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

エラー応答の例

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

#

← ユーザーサブグループとタグ API →