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

データ収集管理 API

最終更新 2026/10/03

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

1. データ収集プラン​

TE使用マニュアルを先に読んで、データ収集関連の機能を理解しておくことをお勧めします：データ収集プランとデータ検証

1. データ収集プランを照会する​

インターフェースURL

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

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
projectId30Integerはいプロジェクト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レスポンスデータ
data.commonEventProps-List共通イベントプロパティ情報
data.commonEventProps.name#device_idStringプロパティ名
data.commonEventProps.displayNameデバイスIDStringプロパティ表示名
data.commonEventProps.typestringStringタイプ
data.commonEventProps.descString説明
data.eventProps-Listイベントプロパティ一覧
data.eventProps.createTime2021-10-12 11:47:30Date作成日時
data.eventProps.creatorTG-38045d57-403c-424c-a6a6-b12f6a8943bdString作成者
data.eventProps.desc-String説明
data.eventProps.displayName理由String表示名
data.eventProps.lastUpdateAuthTG-38045d57-403c-424c-a6a6-b12f6a8943bdString最終更新者
data.eventProps.lastUpdateTime2021-10-12 11:47:30Date最終更新時間
data.eventProps.namereasonString名前
data.eventProps.typestringStringタイプ
data.events-Listイベントリスト
data.events.createTime2021-10-12 11:47:30Date作成日時
data.events.creatorTG-38045d57-403c-424c-a6a6-b12f6a8943bdString作成者
data.events.displayName-String表示名
data.events.eventDescアクティビティ参加3String説明
data.events.eventNameactivity_attendString名前
data.events.eventTag111,aaaStringタグ
data.events.lastUpdateAuthTG-38045d57-403c-424c-a6a6-b12f6a8943bdString最終更新者
data.events.lastUpdateTime2021-10-12 13:01:10Date最終更新時間
data.events.props["#city"]Listイベントプロパティ一覧
data.projectId377IntegerプロジェクトID
data.userProps-Stringユーザープロパティリスト
data.userProps.createTime2021-10-12 11:47:30Date作成日時
data.userProps.creatorTG-38045d57-403c-424c-a6a6-b12f6a8943bdString作成者
data.userProps.desc-String説明
data.userProps.displayName残高String表示名
data.userProps.lastUpdateAuthTG-38045d57-403c-424c-a6a6-b12f6a8943bdString最終更新者
data.userProps.lastUpdateTime2021-10-12 11:47:30Date最終更新時間
data.userProps.nameaccountbalanceString名前
data.userProps.typenumberStringタイプ
data.userProps.updateTypeName-String
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

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

2. データ収集プランをエクスポートする​

注意

Excel版のデータ収集プランをダウンロードします。このプロジェクトにデータ収集プランがない場合はエラーになります

インターフェースURL

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

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

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

成功レスポンスの例

エクスポートファイルはxlsx形式で、「連携時の必読事項」「#ユーザーID体系」「#イベントデータ」「#Public Event Properties」「#ユーザーデータ」「データ型の設計原則」「共通イベントプロパティの設定方法」「マルチプラットフォーム連携の注意点」「複数ユーザーID体系のデータ収集に関する提案」などのシートのデータが含まれます。下図のとおりです：

エラーレスポンスの例

{
    "return_code": -1023,
    "return_message": "対象オブジェクトは存在しません"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1023Integerリターンコード
return_message対象のオブジェクトは既に存在しませんStringリターンメッセージ

3. メタデータからデータ収集プランをエクスポートする​

インターフェースURL

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

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

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

成功レスポンスの例

エクスポートファイルはxlsx形式で、「連携時の必読事項」「#ユーザーID体系」「#イベントデータ」「#Public Event Properties」「#ユーザーデータ」「データ型の設計原則」「共通イベントプロパティの設定方法」「マルチプラットフォーム連携の注意点」「複数ユーザーID体系のデータ収集に関する提案」などのシートのデータが含まれます。下図のとおりです：

エラーレスポンスの例

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

4. データ収集を検証する​

インターフェースURL

/open/track-check?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

リクエスト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はい検証範囲
checkScope.checkDataTypesevent_dataListいいえ検証するデータタイプ。event_dataはイベントデータ、user_dataはユーザーデータです。デフォルトでは両方を検証します
checkScope.checkEventsstringListいいえイベントの検証範囲。nullの場合はすべてのイベントを検証します
checkScope.endTimestringDateいいえ検証期間の終了時間。デフォルトは現在のサーバー時間です
checkScope.eventFilter-Listいいえイベントのフィルター条件。メタデータのイベントプロパティでのみフィルターできます（仮想プロパティ、ユーザータグは使用できません）
checkScope.eventFilter.filterTypeSIMPLEStringいいえ

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
checkScope.eventFilter.filts-Listいいえフィルター値のリスト
checkScope.eventFilter.filts.filterTypeSIMPLEStringいいえ

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
checkScope.eventFilter.relationandStringいいえフィルターの論理関係
checkScope.hasEmptyCheckfalseBooleanいいえ空文字列を空値とみなすかどうか
checkScope.propNullValueThreshold0Integerいいえプロパティの空白率のしきい値
checkScope.startTimestringDateいいえ検証期間の開始時間。デフォルトはデータ収集プランのアップロード時間です
checkScope.userFilter-Listいいえユーザーのフィルター条件。メタデータのユーザープロパティでのみフィルターできます（仮想プロパティ、ユーザータグは使用できません）

checkScope.userFilter.filterType

SIMPLEStringいいえ

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
checkScope.userFilter.filts-Listいいえフィルター値のリスト

checkScope.userFilter.filts.filterType

SIMPLEStringいいえ

フィルター：

  • COMPOUND：複合タイプ
  • SIMPLE：シンプルタイプ
checkScope.userFilter.relationandStringいいえフィルターの論理関係
projectId0IntegerはいプロジェクトID
resultScope-Objectいいえ結果範囲の選択（nullの場合はデフォルトですべて選択）

resultScope.eventResults

["unreported_event"]

List

いいえ

イベント結果の範囲。選択可能な値は次のとおりです

  • unreported_event：データ収集プランにあるが、実際には送信されていないイベント
  • unplanned_event：データ収集プランにないが、実際には送信されているイベント
  • unplanned_event_prop：イベントはデータ収集プランにあるが、データ収集プランにないイベントプロパティ（プリセットプロパティは検証しません）
  • missing_event_prop：データ収集プランにあるが、実際に送信されたデータにそのプロパティがない
  • type_error_event_prop：イベントプロパティのタイプが実際に送信されたプロパティのタイプと一致しない

resultScope.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"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
datad611d456-e74d-47e3-b078-370b79a134afObject検証結果照会用のkey
return_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ

エラーレスポンスの例

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

5. データ収集の検証結果を照会する​

インターフェースURL

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

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

パラメータ名サンプル値パラメータタイプ必須パラメータの説明
tokenxxxStringはいクエリキー
keyd611d456-e74d-47e3-b078-370b79a134afStringはい検証結果の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_code0Integerリターンコード
return_messagesuccessStringリターンメッセージ
data-Object検証結果照会用のkey
data.projectId100IntegerプロジェクトID
data.checkTime2021-04-23 14:00:00Date検証時間
data.checkScope{}Object検証条件の範囲。/track-checkインターフェースのリクエストボディの内容
data.checkResultTyperesult_failString

checkResultType：検証結果のタイプ。次の4つの値があります

  • result_success：検証成功（送信データがデータ収集プランと完全に一致）。eventResultsとuserResultフィールドでデータの詳細を確認できます
  • result_fail：検証失敗（送信データとデータ収集プランに差異あり）。eventResultsとuserResultフィールドでデータの詳細を確認できます
  • checking：検証中。しばらく待ってから照会してください
  • check_fail：計算失敗。checkErrorフィールドで失敗の原因を確認できます
data.eventResults-Listイベントデータの検証結果
data.eventResults.nameevent1Stringイベント名
data.eventResults.resultTypesuccessString

イベントの検証結果タイプ。次の4種類があります

  • success：検証成功
  • fail：検証失敗
  • unreported：未送信
  • unplanned：計画外のデータ収集
data.eventResults.details-List明細データの集合
data.eventResults.details.sample{}Objectサンプル例。イベントの検証結果タイプが未送信の場合、サンプル例はありません
data.eventResults.propNullRates-Listプロパティの空白率
data.eventResults.propNullRates.propNameproperty1Stringイベントプロパティ名
data.eventResults.propNullRates.displayNamedisplayName1Stringイベントプロパティ表示名
data.eventResults.propNullRates.hasRequiredtrueBoolean必須項目かどうか
data.eventResults.propNullRates.propNullRate60Integer空白率
data.userResult-Objectユーザーデータの検証結果
data.userResult.userSamples{}Listユーザーのサンプル例10件
data.userResult.userPropDetails-Listユーザープロパティの詳細
data.userResult.userPropDetails.nameproperty1Stringユーザープロパティ名
data.userResult.userPropDetails.displayNameユーザープロパティ1Stringユーザープロパティ表示名
data.userResult.userPropDetails.resultTypesuccessString

ユーザープロパティの検証結果タイプ。次の4種類があります

  • success：検証成功
  • fail：検証失敗
  • unreported：未送信
  • unplanned_user_prop：計画外のユーザープロパティ
data.userResult.userPropDetails.propNullRate10Integerプロパティの空白率

エラーレスポンスの例

{
    "return_code": -1008,
    "return_message": "key not exist"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-1008Integerリターンコード
return_messagekey not existStringリターンメッセージ

6. データ収集項目をExcelで保存する​

注意

fileパラメータでExcelテンプレートをアップロードします

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

成功レスポンスの例

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

エラーレスポンスの例

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

7. データ収集項目を追加する​

注意

リクエストしたイベント名またはプロパティ名がデータ収集プランにすでに存在する場合は、エラーを返します

例：既存イベントにイベントプロパティを追加する（register_nameイベントプロパティを追加し、同時に既存イベントregisterに紐付ける）

インターフェースURL

/open/track-insert?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

リクエスト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": ""
        }
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId100IntegerはいプロジェクトID
events-Listいいえイベント情報
events.eventNameregisterStringはいイベント名
events.displayName登録イベントStringはいイベント表示名
events.hasAutoCollectfalseBooleanいいえ自動収集するかどうか。デフォルト値は「いいえ」
events.dataOriginiosStringいいえデータソース。データソースは元データの#libフィールドの値です。#libがない場合、ソースはその他になります
events.eventDesc登録イベントとは、ユーザーがゲームに登録したときにトリガーされるイベントですStringいいえイベントの説明
events.eventTagStringいいえイベントのカテゴリー
events.propsregister_nameListいいえイベントプロパティリスト。イベントプロパティ名の集合
eventProps-Listいいえイベントプロパティ情報
eventProps.nameregister_nameStringはいイベントプロパティ名。必須項目
eventProps.displayName登録名Stringはいイベントプロパティ表示名
eventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
eventProps.hasRequiredtrueBooleanいいえデフォルト値はtrue
eventProps.descStringいいえイベントプロパティの説明
userProps-Listいいえユーザープロパティ情報
userProps.nameuser_nameStringはいユーザープロパティ名
userProps.displayNameユーザー名Stringはいユーザープロパティ表示名
userProps.typestringStringはいユーザープロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
userProps.updateTypeuser_setStringいいえユーザープロパティの更新方法。user_setOnce, user_set, user_addの3種類があります
userProps.descStringいいえユーザープロパティの説明
userProps.propTagStringいいえユーザープロパティのカテゴリー
commonEventProps-Listいいえ共通イベントプロパティ情報
commonEventProps.name#device_idStringはいイベントプロパティ名
commonEventProps.displayNameデバイスIDStringはいイベントプロパティ表示名
commonEventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
commonEventProps.hasRequiredtrueBooleanいいえデフォルト値はtrue
commonEventProps.descStringいいえイベントプロパティの説明

成功レスポンスの例

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

エラーレスポンスの例

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

8. データ収集項目を保存する​

注意

追加インターフェースとの違いは、このインターフェースが既存のデータ収集プロパティの更新に対応していることです

インターフェースURL

/open/track-save?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

リクエスト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": ""
        }
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId100IntegerはいプロジェクトID
events-Listいいえイベント情報
events.eventNameregisterStringはいイベント名
events.displayName登録イベントStringはいイベント表示名
events.hasAutoCollectfalseBooleanいいえ自動収集するかどうか。デフォルト値は「いいえ」
events.dataOriginiosStringいいえデータソース。データソースは元データの#libフィールドの値です。#libがない場合、ソースはその他になります
events.eventDesc登録イベントとは、ユーザーがゲームに登録したときにトリガーされるイベントですStringいいえイベントの説明
events.eventTagStringいいえイベントのカテゴリー
events.propsregister_nameListいいえイベントプロパティリスト。イベントプロパティ名の集合
eventProps-Listいいえイベントプロパティ情報
eventProps.nameregister_nameStringはいイベントプロパティ名。必須項目
eventProps.displayName登録名Stringはいイベントプロパティ表示名
eventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
eventProps.hasRequiredtrueBooleanいいえデフォルト値はtrue
eventProps.descStringいいえイベントプロパティの説明
userProps-Listいいえユーザープロパティ情報
userProps.nameuser_nameStringはいユーザープロパティ名
userProps.displayNameユーザー名Stringはいユーザープロパティ表示名
userProps.typestringStringはいユーザープロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
userProps.updateTypeuser_setStringいいえユーザープロパティの更新方法。user_setOnce, user_set, user_addの3種類があります
userProps.descStringいいえユーザープロパティの説明
userProps.propTagStringいいえユーザープロパティのカテゴリー
commonEventProps-Listいいえ共通イベントプロパティ情報
commonEventProps.name#device_idStringはいイベントプロパティ名
commonEventProps.displayNameデバイスIDStringはいイベントプロパティ表示名
commonEventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
commonEventProps.hasRequiredtrueBooleanいいえデフォルト値はtrue
commonEventProps.descStringいいえイベントプロパティの説明

成功レスポンスの例

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

エラーレスポンスの例

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

9. データ収集項目を編集する​

注意

更新しないその他のフィールドにも正確な値を入力する必要があります。データは全体が更新されます

インターフェースURL

/open/track-update?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

リクエスト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"
        }
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId2IntegerはいプロジェクトID
targetNamebuy_shopitemStringはい対象名
events-List-イベント情報
events.eventNamebuy_shopitemStringはいイベント名
events.displayNametestNameStringはいイベント表示名
events.hasAutoCollectfalseBooleanいいえ自動収集するかどうか。デフォルト値は「いいえ」
events.dataOriginiosStringいいえデータソース。データソースは元データの#libフィールドの値です。#libがない場合、ソースはその他になります
events.eventDesc12Stringいいえイベントの説明
events.eventTagtestTagStringいいえイベントのカテゴリー
events.props["#app_version"]Listいいえイベントプロパティリスト。イベントプロパティ名の集合
eventProps-List-イベントプロパティ情報
eventProps.name#app_versionStringはいイベントプロパティ名。必須項目
eventProps.displayNameアプリバージョンStringはいイベントプロパティ表示名
eventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
eventProps.hasReportedtrueBooleanいいえデフォルト値はtrue
eventProps.descStringいいえイベントプロパティの説明
userProps-List-ユーザープロパティ情報
userProps.namecoin_numStringはいユーザープロパティ名
userProps.displayNameコイン数量カードStringはいユーザープロパティ表示名
userProps.typestringStringはいユーザープロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
userProps.updateTypeuser_setStringいいえユーザープロパティの更新方法。user_setOnce, user_set, user_addの3種類があります
userProps.descStringいいえユーザープロパティの説明
userProps.propTagtestPropTagStringいいえユーザープロパティのカテゴリー
commonEventProps-List-共通イベントプロパティ情報
commonEventProps.name#device_idStringはいイベントプロパティ名
commonEventProps.displayNameデバイスIDStringはいイベントプロパティ表示名
commonEventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
commonEventProps.hasReportedtrueBooleanいいえデフォルト値はtrue
commonEventProps.descStringいいえイベントプロパティの説明
deleteProps-Listいいえイベントプロパティを完全に削除
deleteProps.name#carrierStringはいイベントプロパティ名
deleteProps.displayName通信キャリアStringはいイベントプロパティ表示名
deleteProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
deleteProps.hasReportedtrueBooleanいいえデフォルト値はtrue
deleteProps.descStringいいえイベントプロパティの説明

成功レスポンスの例

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

エラーレスポンスの例

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

10. データ収集プランをアップロードする​

注意

このプロジェクトにすでにプランが存在する場合は、削除してから新規作成します

インターフェースURL

/open/track-upload?token=xxx

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

リクエスト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": ""
        }
    ]
}
パラメータ名サンプル値パラメータタイプ必須パラメータの説明
projectId100IntegerはいプロジェクトID
events-Listいいえイベント情報
events.eventNameregisterStringはいイベント名
events.displayName登録イベントStringはいイベント表示名
events.hasAutoCollectfalseBooleanいいえ自動収集するかどうか。デフォルト値は「いいえ」
events.dataOriginiosStringいいえデータソース。データソースは元データの#libフィールドの値です。#libがない場合、ソースはその他になります
events.eventDesc登録イベントとは、ユーザーがゲームに登録したときにトリガーされるイベントですStringいいえイベントの説明
events.eventTag共通Stringいいえイベントのカテゴリー
events.propsregister_nameStringいいえイベントプロパティリスト。イベントプロパティ名の集合
eventProps-Listいいえイベントプロパティ情報
eventProps.nameregister_nameStringはいイベントプロパティ名。必須項目
eventProps.displayName登録名Stringはいイベントプロパティ表示名
eventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
eventProps.hasRequiredtrueBooleanいいえ必須送信かどうか。デフォルト値はtrue
eventProps.descStringいいえイベントプロパティの説明
userProps-Listいいえユーザープロパティ情報
userProps.nameuser_nameStringはいユーザープロパティ名
userProps.displayNameユーザー名Stringはいユーザープロパティ表示名
userProps.typestringStringはいユーザープロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
userProps.updateTypeuser_setStringいいえユーザープロパティの更新方法。user_setOnce, user_set, user_addの3種類があります
userProps.descStringいいえユーザープロパティの説明
userProps.propTagStringいいえユーザープロパティのカテゴリー
commonEventProps-Listいいえ共通イベントプロパティ情報
commonEventProps.name#device_idStringはいイベントプロパティ名
commonEventProps.displayNameデバイスIDStringはいイベントプロパティ表示名
commonEventProps.typestringStringはいイベントプロパティのタイプ。string, number, datetime, bool, arrayの5種類があります
commonEventProps.hasRequiredtrueBooleanいいえ必須送信かどうか。デフォルト値はtrue
commonEventProps.descStringいいえイベントプロパティの説明

成功レスポンスの例

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

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}

11. データ収集プランを削除する​

インターフェースURL

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

リクエストメソッド

GET

Content-Type

application/json

リクエストQueryパラメータ

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

成功レスポンスの例

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

エラーレスポンスの例

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

12. データ収集項目を削除する​

注意
  1. イベントを削除すると、イベント全体と、そのイベントとイベントプロパティの紐付け関係が削除されます
  2. イベントプロパティを削除すると、すべてのイベントとの紐付け関係が削除されます

インターフェースURL

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

リクエストメソッド

POST

Content-Type

application/json

リクエストQueryパラメータ

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

リクエストBodyパラメータ

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

成功レスポンスの例

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

エラーレスポンスの例

{
    "return_code": -3004,
    "return_message": "無効なプロジェクト"
}
パラメータ名サンプル値パラメータタイプパラメータの説明
return_code-3004Integerリターンコード
return_message無効なプロジェクトStringリターンメッセージ
このページは役に立ちましたか？
このページの内容