# ディメンションテーブル API
呼び出し方法Open APIドキュメントの呼び出し方法の説明を参照してください。
# ディメンションテーブルの作成
注意
- 要求本体はディメンションテーブルの内容で、ディメンションテーブル作成パラメータ
createParam
の構成 - デフォルトの最大テキスト制限は 200M です
インターフェイス URL
/open/dict-create?token=xxx&projectId=0
リクエスト方法
POST
コンテンツタイプ
text/csv
Query パラメーター
パラメータ名 | サンプル値 | パラメーターの種類 | 必須かどうか | パラメーターの説明 |
---|---|---|---|---|
token | xxx | String | はい | トークン |
projectId | 0 | Integer | はい | プロジェクトID |
createParam | {"mainColumn":{"property":{"columnName":"channel","tableType":"event"}},"columns":[{"property":{"columnName":"channel_id","selectType":"string"}},{"property":{"columnName":"channel_name","columnDesc":"channel_name","selectType":"string"}}]} | String | はい | ディメンション列情報記述の作成 |
ディメンションテーブル作成パラメータ**createParam**の構成
ディメンションプロパティの作成
ここでのメインフィールドはchannel
で、ディメンションテーブルのchannel_id
関連付けて接続し、ディメンションテーブルプロパティchannel_name
1.次元テーブルの例
次元テーブルデータは csv 形式で、最初に関連フィールド
最初の行は列名で、2 行目はデータで始まる。
channel_id,channel_name
1,龙腾1区
2,龙腾2区
3,龙腾3区
Param の 2.create 例(イベントテーブルの channelchannel
フィールドにディメンションテーブルを作成)
columns リストでは、要素の順序は次元テーブルデータの列の順序と一致し、名前は一致している必要があります。最初の要素(最初の関連列に対応)の名前は、親要素と同じか、異なる場合があります(異なる場合は、文字の先頭のみがサポートされ、英数字の下線のみが含まれます)。
{
"mainColumn": {
"property": {
"columnName": "channel",
"tableType": "event",
"timestampJoinFormat": null
}
},
"columns": [
{
"property": {
"columnName": "channel_id",
"selectType": "number"
}
},
{
"property": {
"columnName": "channel_name",
"columnDesc": "渠道类型",
"selectType": "string"
}
}
]
}
3.createParam フィールド解釈
mainColumn ノード(ディメンションテーブルを作成するプライマリフィールド記述ノード)
プロパティ名 | プロパティの説明 |
---|---|
property | マスタープロパティ(物理プロパティと仮想プロパティの両方) |
columnName | マスタープロパティフィールド名 |
tableType | 主属性が属するテーブルタイプ、event:イベント属性、user:ユーザー属性 |
timestampJoinFormat | マスタープロパティが時間型(timestamp)の場合、タイムスタンプによる粒度計算がサポートされている場合、バインドされたディメンションプロパティ |
timestampJoinFormat
は次の粒度タイプをサポートします。
値です | 説明 |
---|---|
DATE_STR_YEAR | プロパティを"yyyy"文字列に書式設定するときにディメンションプロパティ |
DATE_STR_MONTH | プロパティは"yyyy-MM"にフォーマットされます |
DATE_STR_DAY | プロパティは"yyyy-MM-dd"にフォーマットされます |
DATE_STR_HOUR | プロパティは"yyyy-MM-ddhh"にフォーマットされます |
DATE_STR_MINUTE | プロパティは"yyyy-MM-ddHH: mm"にフォーマットされます |
DATE_STR_SECOND | プロパティは"yyyy-MM-ddHH: mm: ss"にフォーマットされます |
DATE_STR_MILLISECOND | プロパティは"yyyy-MM-dd HH: mm: ss.SSS"時にバインドディメンションプロパティ |
columns リスト(ディメンションフィールド記述ノード)
columns リストでは、要素の順序は次元テーブルデータの列の順序と一致している必要があります。
プロパティ名 | プロパティの説明 |
---|---|
property | ディメンションフィールドのプロパティ一覧 |
columnName | ディメンションフィールド名 |
columnDesc | ディメンションフィールドの説明、つまりフィールドの表示名(オプション) |
selectType | ディメンションフィールドタイプ:数値、ブール、文字列、datetime日付タイプ |
4.結果の作成
作成が成功すると、ディメンションテーブルプロパティディメンションテーブル
ディメンションテーブルプロパティ
成功応答の例
{
"data": {
"duplcatedMainKeyColumns": ["activity_type@type_test"],
"duplcatedMainKeyLineNum": 2,
"mainKeyErrorColumns": ["activity_type@type_test"],
"mainKeyErrorLineNum": 3,
"successLineNum": 27,
"totalLineNum": 40,
"typeErrorColumns": ["numwrong_test", "boolwrong_test"],
"typeErrorLineNum": 8
},
"return_code": 0,
"return_message": "success"
}
パラメーター名 | サンプル値 | パラメーターの種類 | パラメーターの説明 |
---|---|---|---|
return_code | 0 | Integer | リターンコード |
return_message | success | String | 戻る情報 |
data | - | Object | 結果を返す |
∟ duplcatedMainKeyColumns | ["activity_type@type_test"] | List | プライマリフィールドに重複する列名 |
∟ duplcatedMainKeyLineNum | 2 | Integer | プライマリフィールドの重複行数を関連付けます(自動的に破棄されます) |
∟ mainKeyErrorColumns | ["activity_type@type_test"] | List | プライマリフィールドのパースエラーを関連付けるカラム名 |
∟ mainKeyErrorLineNum | 3 | Integer | プライマリフィールドの解析エラーの行数を関連付けます(自動的に破棄されます) |
∟ successLineNum | 27 | Integer | 成功した行の数 |
∟ totalLineNum | 40 | Integer | 総行数 |
∟ typeErrorColumns | ["numwrong_test", "boolwrong_test"] | List | その他のフィールドタイプエラーの列名 |
∟ typeErrorLineNum | 8 | Integer | 他のフィールドタイプが間違っている行の数(空) |
エラー応答の例
{
"return_code": -1008,
"return_message": "上传文件大小不能超过209715200字节"
}
パラメータ名 | サンプル値 | パラメーターの種類 | パラメーターの説明 |
---|---|---|---|
return_code | -1100 | Integer | リターンコード |
return_message | アップロードされたテキストのサイズは209715200バイトを超えてはなりません | String | 戻る情報 |
curl の例
curl --header 'Content-Type: text/csv' --data-binary '@test.csv' 'http://ta2:8992/open/dict-create?token=bTOzKiTIozG4e19FgXphcA8dDV3DIY8RwdHTO7aSnBsRqSNaIk19BnBMecJDWibD&projectId=377&createParam=%7B%22mainColumn%22%3A%7B%22property%22%3A%7B%22columnName%22%3A%22channel%22%2C%22tableType%22%3A%22event%22%7D%7D%2C%22columns%22%3A%5B%7B%22property%22%3A%7B%22columnName%22%3A%22channel_id%22%2C%22selectType%22%3A%22string%22%7D%7D%2C%7B%22property%22%3A%7B%22columnName%22%3A%22channel_name%22%2C%22columnDesc%22%3A%22%E6%B8%A0%E9%81%93%E7%B1%BB%E5%9E%8B%22%2C%22selectType%22%3A%22string%22%7D%7D%5D%7D'