転送設定定義作成
    • PDF

    転送設定定義作成

    • PDF

    Article summary

    Post
    /api/job_definitions

    転送設定定義を作成します。

    Security
    API Key
    Header parameter nameAuthorization

    認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
    API KEYがabc123の場合は、Authorization: Token abc123とします。
    API KEYの作成方法は、trocco APIについてを参照ください。

    Body parameters
    Expand All
    object
    name
    string

    転送設定名

    description
    string

    転送設定メモ

    resource_group_id
    integer | null

    リソースグループID。リソースグループに追加すると、他のユーザーに設定を共有できるようになります。

    is_runnable_concurrently
    boolean

    終了していないジョブが存在するとき、並列でジョブが起動することを許可するかどうかを設定します。

    Defaultfalse
    retry_limit
    integer

    1以上を設定すると、転送が途中で失敗した場合に転送処理を最初からやり直します。転送処理が冪等でない場合、レコード重複等が発生する場合があります。

    Default0
    resource_enhancement
    string | null

    ※このパラメーターはプロフェッショナルプランでのみご利用いただけます。
    ジョブ実行時に利用するリソースサイズを指定できます。指定しなかった場合、転送設定側で指定されているリソースサイズが適用されます。
    また、コネクタによって指定できる値が異なります。

    Valid values[ "medium", "custom_spec", "large", "xlarge" ]
    input_option_type
    string

    転送元の種別 作成可能なコネクタには限りがあります。詳しくはenum部分を参照ください。

    Valid values[ "mysql", "gcs", "snowflake" ]
    input_option
    object
    gcs_input_option
    object
    csv_parsers
    delimiter
    string

    区切り文字

    Default","
    quote
    string

    クォート文字

    Default"\""
    escape
    string | null

    エスケープ文字

    Default"\\"
    skip_header_lines
    integer

    スキップするヘッダー行数

    Default0
    null_string_enabled
    boolean

    NULLに置換される文字列

    Defaultfalse
    null_string
    string

    置換元の文字列。未入力の場合、空文字がNULLに置換されます。

    trim_if_not_quoted
    boolean

    引用符がない場合に値から空白を取り除くかどうか

    Defaultfalse
    quotes_in_quoted_fields
    string

    イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法

    Valid values[ "ACCEPT_ONLY_RFC4180_ESCAPED", "ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS" ]
    Default"ACCEPT_ONLY_RFC4180_ESCAPED"
    comment_line_marker
    string

    コメントラインマーカー。この文字が行の始めにあったらスキップします

    allow_optional_columns
    boolean

    カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する

    Defaultfalse
    allow_extra_columns
    boolean

    カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する

    Defaultfalse
    max_quoted_size_limit
    integer

    引用符で囲める最大データ量

    Default131072
    stop_on_invalid_record
    boolean

    不正なレコードが存在した場合に転送を中止するかどうか。

    Defaulttrue
    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    default_date
    string

    日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値

    Default"1970-01-01"
    newline
    string

    改行コード

    Valid values[ "CRLF", "LF", "CR" ]
    Default"CRLF"
    charset
    string

    文字コード

    columns
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    jsonl_parsers
    stop_on_invalid_record
    boolean

    不正なレコードが存在した場合に転送を中止するかどうか

    Defaulttrue
    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    newline
    string | null

    改行コード

    Default"CRLF"
    charset
    string | null

    文字エンコーディング

    columns
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    time_zone
    string

    タイムゾーン

    jsonpath_parsers
    root
    string

    ルート

    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    columns
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    time_zone
    string

    タイムゾーン

    ltsv_parsers
    newline
    string | null

    改行コード

    Default"CRLF"
    charset
    string | null

    文字エンコーディング

    columns
    Array of object Required

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    excel_parsers
    default_time_zone
    string

    日時カラムのタイムゾーン

    sheet_name
    string

    シート名

    skip_header_lines
    integer

    スキップするヘッダー行数

    columns
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    formula_handling
    string
    xml_parsers
    root
    string Required

    ルートのパス(XPath形式)

    columns
    Array of object Required

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。typeがtimestampのときに指定することができます。

    path
    string Required

    パス(XPath形式)

    timezone
    string

    タイムゾーン。typeがtimestampのときに指定することができます。

    parquet_parsers
    columns
    Array of object Required

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    jsonl_parser
    stop_on_invalid_record
    boolean

    不正なレコードが存在した場合に転送を中止するかどうか

    Defaulttrue
    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    newline
    string | null

    改行コード

    Default"CRLF"
    charset
    string | null

    文字エンコーディング

    columns
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    time_zone
    string

    タイムゾーン

    mysql_input_option
    object
    database
    string Required

    データベース名

    query
    string | null

    クエリ。incremental_loading_enabledがfalseの場合は必須です。

    incremental_loading_enabled
    boolean

    転送方法。 true: 差分転送 (前回転送時からの増分データのみ転送) false: クエリを使用して転送

    Defaultfalse
    table
    string | null

    テーブル名。差分転送の場合必須です。

    incremental_columns
    string | null

    増分データを判別するカラム。 ここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。 2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。 複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。

    last_record
    string | null

    最後に転送されたレコード 差分更新時はここで指定された値より新しいデータを転送します。 フォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。 データの重複が起こる可能性があります。

    fetch_rows
    integer

    カーソルが一度に処理するレコード数

    Default10000
    connect_timeout
    integer

    接続タイムアウト (秒)

    Default300
    socket_timeout
    integer

    ソケットタイムアウト (秒)

    Default1800
    default_time_zone
    string | null

    タイムゾーン

    use_legacy_datetime_code
    boolean | null

    レガシーな時刻コード設定

    Defaultfalse
    mysql_connection_id
    integer Required

    MySQL接続情報ID

    custom_variable_settings

    カスタム変数の設定

    name
    string Required

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string Required

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    input_option_columns
    object Required
    name
    string Required

    カラム名

    type
    string Required

    カラムの型

    Valid values[ "boolean", "long", "timestamp", "double", "string", "json" ]
    snowflake_input_option
    object
    warehouse
    string Required

    ウェアハウス名

    database
    string Required

    データベース名

    schema
    string

    スキーマ名

    Default"PUBLIC"
    query
    string Required

    クエリ

    fetch_rows
    integer

    カーソルが一度に処理するレコード数

    Default10000
    connect_timeout
    integer

    接続タイムアウト (秒)

    Default300
    socket_timeout
    integer

    ソケットタイムアウト (秒)

    Default1800
    snowflake_connection_id
    integer Required

    Snowflake接続情報ID

    custom_variable_settings

    カスタム変数の設定

    name
    string Required

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string Required

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    input_option_columns
    object Required
    name
    string Required

    カラム名

    type
    string Required

    カラムの型

    Valid values[ "boolean", "long", "timestamp", "double", "string", "json" ]
    output_option_type
    string

    転送先の種別 作成可能なコネクタには限りがあります。詳しくはenum部分を参照ください。

    Valid values[ "bigquery", "snowflake" ]
    output_option
    object
    bigquery_output_option
    object
    dataset
    string Required

    データセット名

    table
    string Required

    テーブル名

    mode
    string

    転送モード

    Valid values[ "append", "append_direct", "replace", "delete_in_advance", "merge" ]
    Default"append"
    location
    string

    データセットのロケーション

    Default"US"
    auto_create_dataset
    boolean

    データセットの自動生成オプション

    Defaultfalse
    auto_create_table
    boolean

    テーブル自動生成オプション

    Defaultfalse
    open_timeout_sec
    integer

    接続開始までのタイムアウト (秒)

    Default300
    timeout_sec
    integer

    タイムアウト (秒)

    Default300
    send_timeout_sec
    integer

    送信タイムアウト (秒)

    Default300
    read_timeout_sec
    integer

    読込タイムアウト (秒)

    Default300
    retries
    integer

    再試行回数

    Default5
    partitioning_type
    string | null

    パーティショニング null: パーティションなし ingestion_time: 取り込み時間により分割 time_unit_column: フィールドにより分割

    Valid values[ "ingestion_time", "time_unit_column" ]
    time_partitioning_type
    string | null

    パーティションタイプ

    Valid values[ "HOUR", "DAY", "MONTH", "YEAR" ]
    time_partitioning_field
    string | null

    パーティションフィールド 分割の基準として用いるフィールドを、DATE, TIMESTAMP, DATETIMEのいずれかの型のフィールドから指定してください。

    time_partitioning_expiration_ms
    integer | null

    パーティションの存続期間 パーティションの存続期間 (ミリ秒) です。最小値はありません。パーティションの日付にこの整数値を足した値が有効期限になります。デフォルト値は指定なし (永久に保存) です。

    template_table
    string | null

    スキーマ情報をテンプレートとして参照するテーブル このテーブルのスキーマ情報からGoogle BigQueryへの取り込み時のスキーマ情報を生成します

    bigquery_connection_id
    string Required

    BigQuery接続情報ID

    bigquery_output_option_column_options
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    データ型

    Valid values[ "BOOLEAN", "INTEGER", "FLOAT", "STRING", "TIMESTAMP", "DATETIME", "DATE", "RECORD", "NUMERIC" ]
    mode
    string Required

    モード

    Valid values[ "NULLABLE", "REQUIRED", "REPEATED" ]
    timestamp_format
    string | null

    日付フォーマット

    timezone
    string | null

    タイムゾーン

    description
    string | null

    説明

    bigquery_output_option_clustering_fields
    Array of string | null

    クラスタリング化列 クラスタリングはテーブル新規作成時のみ設定できます。クラスタ化列は最大で4つ指定できます。

    string
    bigquery_output_option_merge_keys
    Array of string | null

    マージキー mode: mergeの場合のみ設定できます。

    string
    custom_variable_settings

    カスタム変数の設定

    name
    string Required

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string Required

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    snowflake_output_option
    object
    warehouse
    string Required

    ウェアハウス名

    database
    string Required

    データベース名

    schema
    string Required

    スキーマ名

    table
    string Required

    テーブル名

    mode
    string

    転送モード

    Valid values[ "insert", "insert_direct", "truncate_insert", "replace", "merge" ]
    Default"insert"
    empty_field_as_null
    boolean

    空文字をNULLに置換するかどうか

    Defaulttrue
    delete_stage_on_error
    boolean

    エラー時に一時ステージを削除するかどうか

    Defaultfalse
    batch_size
    integer

    バッチサイズ (MB)

    Default50
    retry_limit
    integer

    最大リトライ回数

    Default12
    retry_wait
    integer

    リトライ待ち時間(ミリ秒)

    Default1000
    max_retry_wait
    integer

    リトライ待ち時間の最大値(ミリ秒) 再試行時の待ち時間の上限

    Default1800000
    default_time_zone
    string

    デフォルトタイムゾーン

    Default"UTC"
    snowflake_connection_id
    string Required

    Snowflake接続情報ID

    snowflake_output_option_column_options
    Array of object

    カラム設定

    object
    name
    string Required

    カラム名

    type
    string Required

    データ型

    Valid values[ "BIGINT", "INTEGER", "VARCHAR", "STRING", "BOOLEAN", "DOUBLE", "DOUBLE PRECISION", "DATE", "DATETIME", "TIMESTAMP", "TIME", "VARIANT", "OBJECT", "ARRAY", "NUMBER" ]
    value_type
    string

    value type もし、デフォルト値を設定したい場合、value_typeは設定しないでください。 詳細: https://documents.trocco.io/docs/data-destination-snowflake

    Valid values[ "byte", "short", "int", "long", "double", "float", "boolean", "string", "nstring", "date", "time", "timestamp", "decimal", "json", null ]
    timestamp_format
    string | null

    日付フォーマット

    timezone
    string | null

    タイムゾーン

    snowflake_output_option_merge_keys
    Array of string | null

    マージキー mode: mergeの場合のみ設定できます。

    string
    custom_variable_settings

    カスタム変数の設定

    name
    string Required

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string Required

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    filter_columns
    Array of object
    object
    name
    string Required

    列の絞り込みや追加を行います。ここで指定した列のみプレビュー・転送されます。 転送元のカラムに変更があった場合は、カラム定義の再読み込みを実行することで最新の定義に更新することができます。 詳細はヘルプドキュメント「カラム定義を再読み込み」をご覧ください。

    src
    string Required

    元カラム

    type
    string Required

    データ型

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    default
    string | null

    デフォルト値。既存カラムの場合、inputがnullの場合のみこちらの值が挿入されます。新規力ラムの場合、すべてにこちらの值が挿入されます。

    format
    string | null

    日時フォーマット

    json_expand_enabled
    boolean | null

    JSONカラムを展開するかどうか

    Defaultfalse
    json_expand_keep_base_column
    boolean | null

    展開前のJSONカラムも転送する

    Defaultfalse
    json_expand_columns
    Array of object

    JSONカラムの展開対象をどう展開するか

    object
    name
    string Required

    カラム名

    json_path
    string Required

    JSONパス。{"id": 10, "person": {"age": 30}}のようなJSONカラムから id, ageを抜き出す場合、JSONパスにそれぞれ id, person.age と指定します。

    type
    string Required

    データ型

    Valid values[ "boolean", "long", "timestamp", "string" ]
    format
    string | null

    日付フォーマット。typeがtimestampの場合のみ有効です。

    timezone
    string | null

    タイムゾーン。typeがtimestampの場合のみ有効です。

    filter_rows
    object
    condition
    string Required

    条件。and条件で絞り込むかor条件で絞り込むかを指定します。

    Valid values[ "and", "or" ]
    filter_row_conditions
    Array of object Required

    絞り込み条件のリスト。

    object
    column
    string Required

    対象カラム名。フィルター条件に利用するカラム名(カラム定義における元カラム)を入力してください。

    operator
    string Required

    演算子。フィルター条件に利用する演算子を入力してください。

    Valid values[ "greater", "greater_equal", "less", "less_equal", "equal", "not_equal", "start_with", "end_with", "include", "is_null", "is_not_null", "regexp" ]
    argument
    string Required

    フィルター条件の引数。

    filter_masks
    Array of object
    object
    name
    string Required

    マスキング対象の列名。転送先カラム名を指定してください。

    mask_type
    string Required

    マスクの種類。 全文字列: すべて「」で置換します メールアドレス: @マークまでを「」で置換します 正規表現: 正規表現パターンにマッチした箇所を「」で置換します 部分文字列: 開始位置・終了位置を指定して、「」で置換します

    Valid values[ "all", "email", "regex", "substring" ]
    length
    integer | null

    マスクの長さ。「*」でマスクする文字列の長さを指定できます。

    pattern
    string | null

    マスクのパターン。マスクの種類がregexの場合に指定してください。

    start_index
    integer | null

    マスクの開始位置。マスクの種類がsubstringの場合に指定してください。

    end_index
    integer | null

    マスクの終了位置。マスクの種類がsubstringの場合に指定してください。

    filter_add_time
    object
    column_name
    string Required

    カラム名

    type
    string Required

    日時の型

    Valid values[ "timestamp", "string" ]
    timestamp_format
    string | null

    タイムスタンプのフォーマット。typeがstring場合に指定できます。

    Example%Y-%m-%d %H:%M:%S.%N %Z
    time_zone
    string | null

    タイムゾーン。

    filter_gsub
    Array of object
    object
    column_name
    string Required

    対象カラム。

    pattern
    string Required

    正規表現のパターン。

    to
    string Required

    合致したパターンを置換させる文字列。

    filter_string_transforms
    Array of object
    object
    column_name
    string Required

    対象カラム

    type
    string

    変換方法 正規化 (NFKC) 例: normalize_nfkc: 全角英数 → 半角 (ABC123 → ABC123) 、半角カナ → 全角 (アイ → アイ) など

    Valid values[ "normalize_nfkc" ]
    Default"normalize_nfkc"
    filter_hashes
    Array of object
    object
    name
    string Required

    対象カラム

    filter_unixtime_conversions
    Array of object
    object
    column_name

    対象カラム type: string

    kind
    string Required

    変換方法

    Valid values[ "unixtime_to_timestamp", "unixtime_to_string", "timestamp_to_unixtime", "string_to_unixtime" ]
    unixtime_unit
    string Required

    変換前、変換後のUNIX時間の単位

    Valid values[ "second", "millisecond", "microsecond", "nanosecond" ]
    datetime_format
    string Required

    変換前、変換後の日時フォーマット

    datetime_timezone

    変換前、変換後の日時のタイムゾーン

    labels
    Array of string

    ラベル設定を指定します。

    Min items0
    Max items40
    string

    ラベル名を指定します。

    schedules
    Array of object
    Min items0
    Max items10
    object
    frequency
    string Required

    データマートジョブ実行スケジュールの頻度です。
    hourly: 毎時
    daily: 毎日
    weekly: 毎週
    monthly: 毎月

    Valid values[ "hourly", "daily", "weekly", "monthly" ]
    minute
    integer (int64)

    分の値を示します。

    hour
    integer (int64)

    時間の値を示します。

    day
    integer (int64)

    日にちの値を示します。

    day_of_week
    integer (int64)

    曜日の値を示します。

    time_zone
    string Required

    日時のタイムゾーンです。

    ExampleEtc/UTC
    notifications
    Array of object
    Min items0
    Max items20
    object
    destination_type
    string Required

    通知先です。

    Valid values[ "slack", "email" ]
    slack_channel_id
    integer (int64)

    slack channel IDです。
    destination_typeがslackのとき必須です。

    email_id
    integer (int64)

    Email IDです。
    destination_typeがemailのとき必須です。

    notification_type
    string Required

    通知タイプです。
    job: ジョブ実行(終了/エラー)通知
    record: レコード条件(超過/過不足)通知
    exec_time: 実行時間経過通知

    Valid values[ "job", "record", "time" ]
    notify_when
    string

    通知条件です。
    jobタイプのとき必須です。

    Valid values[ "finished", "failed" ]
    message
    string Required

    通知内容です。

    record_count
    integer (int64)

    閾値のレコード数
    recordタイプのとき必須です。

    record_operator
    string

    レコード数の比較演算子です
    recordタイプのとき必須
    above: 以上
    below: 以下

    Valid values[ "above", "below" ]
    record_type

    通知するレコード数条件
    recordタイプのとき必須
    transfer: 転送した
    skipped: スキップされた

    Responses
    201

    作成した転送設定詳細を返します。

    Expand All
    object
    name
    string

    転送設定名

    description
    string

    転送設定メモ

    resource_group_id
    integer | null

    リソースグループID。リソースグループに追加すると、他のユーザーに設定を共有できるようになります。

    is_runnable_concurrently
    boolean

    終了していないジョブが存在するとき、並列でジョブが起動することを許可するかどうかを設定します。

    Defaultfalse
    retry_limit
    integer

    1以上を設定すると、転送が途中で失敗した場合に転送処理を最初からやり直します。転送処理が冪等でない場合、レコード重複等が発生する場合があります。

    Default0
    resource_enhancement
    string | null

    ※このパラメーターはプロフェッショナルプランでのみご利用いただけます。
    ジョブ実行時に利用するリソースサイズを指定できます。指定しなかった場合、転送設定側で指定されているリソースサイズが適用されます。
    また、コネクタによって指定できる値が異なります。

    Valid values[ "medium", "custom_spec", "large", "xlarge" ]
    id
    integer

    転送設定定義ID

    input_option_type
    string

    転送元の種別

    Valid values[ "mysql", "gcs", "snowflake" ]
    input_option
    object

    転送元の設定の詳細

    gcs_input_option
    object
    csv_parsers
    delimiter
    string

    区切り文字

    Default","
    quote
    string

    クォート文字

    Default"\""
    escape
    string | null

    エスケープ文字

    Default"\\"
    skip_header_lines
    integer

    スキップするヘッダー行数

    Default0
    null_string_enabled
    boolean

    NULLに置換される文字列

    Defaultfalse
    null_string
    string

    置換元の文字列。未入力の場合、空文字がNULLに置換されます。

    trim_if_not_quoted
    boolean

    引用符がない場合に値から空白を取り除くかどうか

    Defaultfalse
    quotes_in_quoted_fields
    string

    イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法

    Valid values[ "ACCEPT_ONLY_RFC4180_ESCAPED", "ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS" ]
    Default"ACCEPT_ONLY_RFC4180_ESCAPED"
    comment_line_marker
    string

    コメントラインマーカー。この文字が行の始めにあったらスキップします

    allow_optional_columns
    boolean

    カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する

    Defaultfalse
    allow_extra_columns
    boolean

    カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する

    Defaultfalse
    max_quoted_size_limit
    integer

    引用符で囲める最大データ量

    Default131072
    stop_on_invalid_record
    boolean

    不正なレコードが存在した場合に転送を中止するかどうか。

    Defaulttrue
    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    default_date
    string

    日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値

    Default"1970-01-01"
    newline
    string

    改行コード

    Valid values[ "CRLF", "LF", "CR" ]
    Default"CRLF"
    charset
    string

    文字コード

    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    jsonl_parsers
    stop_on_invalid_record
    boolean

    不正なレコードが存在した場合に転送を中止するかどうか

    Defaulttrue
    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    newline
    string | null

    改行コード

    Default"CRLF"
    charset
    string | null

    文字エンコーディング

    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    time_zone
    string

    タイムゾーン

    jsonpath_parsers
    root
    string

    ルート

    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    time_zone
    string

    タイムゾーン

    ltsv_parsers
    newline
    string | null

    改行コード

    Default"CRLF"
    charset
    string | null

    文字エンコーディング

    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    excel_parsers
    default_time_zone
    string

    日時カラムのタイムゾーン

    sheet_name
    string

    シート名

    skip_header_lines
    integer

    スキップするヘッダー行数

    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    formula_handling
    string
    xml_parsers
    root
    string

    ルートのパス(XPath形式)

    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。typeがtimestampのときに指定することができます。

    path
    string

    パス(XPath形式)

    timezone
    string

    タイムゾーン。typeがtimestampのときに指定することができます。

    parquet_parsers
    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    jsonl_parser
    stop_on_invalid_record
    boolean

    不正なレコードが存在した場合に転送を中止するかどうか

    Defaulttrue
    default_time_zone
    string

    デフォルトのタイムゾーン

    Default"UTC"
    newline
    string | null

    改行コード

    Default"CRLF"
    charset
    string | null

    文字エンコーディング

    columns
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    format
    string

    フォーマット。型がtimestampのときに指定することができます。

    time_zone
    string

    タイムゾーン

    mysql_input_option
    object
    database
    string

    データベース名

    query
    string | null

    クエリ。incremental_loading_enabledがfalseの場合は必須です。

    incremental_loading_enabled
    boolean

    転送方法。 true: 差分転送 (前回転送時からの増分データのみ転送) false: クエリを使用して転送

    Defaultfalse
    table
    string | null

    テーブル名。差分転送の場合必須です。

    incremental_columns
    string | null

    増分データを判別するカラム。 ここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。 2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。 複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。

    last_record
    string | null

    最後に転送されたレコード 差分更新時はここで指定された値より新しいデータを転送します。 フォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。 データの重複が起こる可能性があります。

    fetch_rows
    integer

    カーソルが一度に処理するレコード数

    Default10000
    connect_timeout
    integer

    接続タイムアウト (秒)

    Default300
    socket_timeout
    integer

    ソケットタイムアウト (秒)

    Default1800
    default_time_zone
    string | null

    タイムゾーン

    use_legacy_datetime_code
    boolean | null

    レガシーな時刻コード設定

    Defaultfalse
    mysql_connection_id
    integer

    MySQL接続情報ID

    custom_variable_settings

    カスタム変数の設定

    name
    string

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    input_option_columns
    object
    name
    string

    カラム名

    type
    string

    カラムの型

    Valid values[ "boolean", "long", "timestamp", "double", "string", "json" ]
    snowflake_input_option
    object
    warehouse
    string

    ウェアハウス名

    database
    string

    データベース名

    schema
    string

    スキーマ名

    Default"PUBLIC"
    query
    string

    クエリ

    fetch_rows
    integer

    カーソルが一度に処理するレコード数

    Default10000
    connect_timeout
    integer

    接続タイムアウト (秒)

    Default300
    socket_timeout
    integer

    ソケットタイムアウト (秒)

    Default1800
    snowflake_connection_id
    integer

    Snowflake接続情報ID

    custom_variable_settings

    カスタム変数の設定

    name
    string

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    input_option_columns
    object
    name
    string

    カラム名

    type
    string

    カラムの型

    Valid values[ "boolean", "long", "timestamp", "double", "string", "json" ]
    output_option_type
    string

    転送先の種別

    Valid values[ "bigquery", "snowflake" ]
    output_option
    object

    転送先の設定の詳細

    bigquery_output_option
    object
    dataset
    string

    データセット名

    table
    string

    テーブル名

    mode
    string

    転送モード

    Valid values[ "append", "append_direct", "replace", "delete_in_advance", "merge" ]
    Default"append"
    location
    string

    データセットのロケーション

    Default"US"
    auto_create_dataset
    boolean

    データセットの自動生成オプション

    Defaultfalse
    auto_create_table
    boolean

    テーブル自動生成オプション

    Defaultfalse
    open_timeout_sec
    integer

    接続開始までのタイムアウト (秒)

    Default300
    timeout_sec
    integer

    タイムアウト (秒)

    Default300
    send_timeout_sec
    integer

    送信タイムアウト (秒)

    Default300
    read_timeout_sec
    integer

    読込タイムアウト (秒)

    Default300
    retries
    integer

    再試行回数

    Default5
    partitioning_type
    string | null

    パーティショニング null: パーティションなし ingestion_time: 取り込み時間により分割 time_unit_column: フィールドにより分割

    Valid values[ "ingestion_time", "time_unit_column" ]
    time_partitioning_type
    string | null

    パーティションタイプ

    Valid values[ "HOUR", "DAY", "MONTH", "YEAR" ]
    time_partitioning_field
    string | null

    パーティションフィールド 分割の基準として用いるフィールドを、DATE, TIMESTAMP, DATETIMEのいずれかの型のフィールドから指定してください。

    time_partitioning_expiration_ms
    integer | null

    パーティションの存続期間 パーティションの存続期間 (ミリ秒) です。最小値はありません。パーティションの日付にこの整数値を足した値が有効期限になります。デフォルト値は指定なし (永久に保存) です。

    template_table
    string | null

    スキーマ情報をテンプレートとして参照するテーブル このテーブルのスキーマ情報からGoogle BigQueryへの取り込み時のスキーマ情報を生成します

    bigquery_connection_id
    string

    BigQuery接続情報ID

    bigquery_output_option_column_options
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    データ型

    Valid values[ "BOOLEAN", "INTEGER", "FLOAT", "STRING", "TIMESTAMP", "DATETIME", "DATE", "RECORD", "NUMERIC" ]
    mode
    string

    モード

    Valid values[ "NULLABLE", "REQUIRED", "REPEATED" ]
    timestamp_format
    string | null

    日付フォーマット

    timezone
    string | null

    タイムゾーン

    description
    string | null

    説明

    bigquery_output_option_clustering_fields
    Array of string

    クラスタリング化列 クラスタリングはテーブル新規作成時のみ設定できます。クラスタ化列は最大で4つ指定できます。

    string
    bigquery_output_option_merge_keys
    Array of string

    マージキー mode: mergeの場合のみ設定できます。

    string
    custom_variable_settings

    カスタム変数の設定

    name
    string

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    snowflake_output_option
    object
    warehouse
    string

    ウェアハウス名

    database
    string

    データベース名

    schema
    string

    スキーマ名

    table
    string

    テーブル名

    mode
    string

    転送モード

    Valid values[ "insert", "insert_direct", "truncate_insert", "replace", "merge" ]
    Default"insert"
    empty_field_as_null
    boolean

    空文字をNULLに置換するかどうか

    Defaulttrue
    delete_stage_on_error
    boolean

    エラー時に一時ステージを削除するかどうか

    Defaultfalse
    batch_size
    integer

    バッチサイズ (MB)

    Default50
    retry_limit
    integer

    最大リトライ回数

    Default12
    retry_wait
    integer

    リトライ待ち時間(ミリ秒)

    Default1000
    max_retry_wait
    integer

    リトライ待ち時間の最大値(ミリ秒) 再試行時の待ち時間の上限

    Default1800000
    default_time_zone
    string

    デフォルトタイムゾーン

    Default"UTC"
    snowflake_connection_id
    string

    Snowflake接続情報ID

    snowflake_output_option_column_options
    Array of object

    カラム設定

    object
    name
    string

    カラム名

    type
    string

    データ型

    Valid values[ "BIGINT", "INTEGER", "VARCHAR", "STRING", "BOOLEAN", "DOUBLE", "DOUBLE PRECISION", "DATE", "DATETIME", "TIMESTAMP", "TIME", "VARIANT", "OBJECT", "ARRAY", "NUMBER" ]
    value_type
    string

    value type もし、デフォルト値を設定したい場合、value_typeは設定しないでください。 詳細: https://documents.trocco.io/docs/data-destination-snowflake

    Valid values[ "byte", "short", "int", "long", "double", "float", "boolean", "string", "nstring", "date", "time", "timestamp", "decimal", "json", null ]
    timestamp_format
    string | null

    日付フォーマット

    timezone
    string | null

    タイムゾーン

    snowflake_output_option_merge_keys
    Array of string | null

    マージキー mode: mergeの場合のみ設定できます。

    string
    custom_variable_settings

    カスタム変数の設定

    name
    string

    カスタム変数の変数名を指定します。
    変数名を$で囲ってください。

    Example$start_time$
    type
    string

    カスタム変数タイプです。
    string: 文字列
    timestamp: 時刻・日付(キューイング時)
    timestamp_runtime: 時刻・日付(実行時)

    Valid values[ "string", "timestamp", "timestamp_runtime" ]
    Exampletimestamp_runtime
    value
    string

    カスタム変数名を展開する値を指定します。
    カスタム変数タイプがstringのときのみ有効です。

    Examplejobs
    quantity
    integer (int64)

    unit 時間の数を指定します。
    カスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example1
    unit
    string

    時間の単位を指定します。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "hour", "date", "month" ]
    Examplehour
    direction
    string

    時間軸の方向です。
    ago: 前
    later: 後
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Valid values[ "ago", "later" ]
    Exampleago
    format
    string

    日付フォーマットです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    Example%Y-%m-%d %H:%M:%S
    time_zone
    string

    日付フォーマットの日時を解釈するタイムゾーンです。
    タイプがtimestampかtimestamp_runtime のときのみ有効です。

    ExampleEtc/UTC
    filter_columns
    Array of object
    object
    name
    string

    列の絞り込みや追加を行います。ここで指定した列のみプレビュー・転送されます。 転送元のカラムに変更があった場合は、カラム定義の再読み込みを実行することで最新の定義に更新することができます。 詳細はヘルプドキュメント「カラム定義を再読み込み」をご覧ください。

    src
    string

    元カラム

    type
    string

    データ型

    Valid values[ "string", "long", "timestamp", "double", "boolean", "json" ]
    default
    string | null

    デフォルト値。既存カラムの場合、inputがnullの場合のみこちらの值が挿入されます。新規力ラムの場合、すべてにこちらの值が挿入されます。

    format
    string | null

    日時フォーマット

    json_expand_enabled
    boolean | null

    JSONカラムを展開するかどうか

    Defaultfalse
    json_expand_keep_base_column
    boolean | null

    展開前のJSONカラムも転送する

    Defaultfalse
    json_expand_columns
    Array of object

    JSONカラムの展開対象をどう展開するか

    object
    name
    string

    カラム名

    json_path
    string

    JSONパス。{"id": 10, "person": {"age": 30}}のようなJSONカラムから id, ageを抜き出す場合、JSONパスにそれぞれ id, person.age と指定します。

    type
    string

    データ型

    Valid values[ "boolean", "long", "timestamp", "string" ]
    format
    string | null

    日付フォーマット。typeがtimestampの場合のみ有効です。

    timezone
    string | null

    タイムゾーン。typeがtimestampの場合のみ有効です。

    filter_rows
    object
    condition
    string

    条件。and条件で絞り込むかor条件で絞り込むかを指定します。

    Valid values[ "and", "or" ]
    filter_row_conditions
    Array of object

    絞り込み条件のリスト。

    object
    column
    string

    対象カラム名。フィルター条件に利用するカラム名(カラム定義における元カラム)を入力してください。

    operator
    string

    演算子。フィルター条件に利用する演算子を入力してください。

    Valid values[ "greater", "greater_equal", "less", "less_equal", "equal", "not_equal", "start_with", "end_with", "include", "is_null", "is_not_null", "regexp" ]
    argument
    string

    フィルター条件の引数。

    filter_masks
    Array of object
    object
    name
    string

    マスキング対象の列名。転送先カラム名を指定してください。

    mask_type
    string

    マスクの種類。 全文字列: すべて「」で置換します メールアドレス: @マークまでを「」で置換します 正規表現: 正規表現パターンにマッチした箇所を「」で置換します 部分文字列: 開始位置・終了位置を指定して、「」で置換します

    Valid values[ "all", "email", "regex", "substring" ]
    length
    integer | null

    マスクの長さ。「*」でマスクする文字列の長さを指定できます。

    pattern
    string | null

    マスクのパターン。マスクの種類がregexの場合に指定してください。

    start_index
    integer | null

    マスクの開始位置。マスクの種類がsubstringの場合に指定してください。

    end_index
    integer | null

    マスクの終了位置。マスクの種類がsubstringの場合に指定してください。

    filter_add_time
    object
    column_name
    string

    カラム名

    type
    string

    日時の型

    Valid values[ "timestamp", "string" ]
    timestamp_format
    string | null

    タイムスタンプのフォーマット。typeがstring場合に指定できます。

    Example%Y-%m-%d %H:%M:%S.%N %Z
    time_zone
    string | null

    タイムゾーン。

    filter_gsub
    Array of object
    object
    column_name
    string

    対象カラム。

    pattern
    string

    正規表現のパターン。

    to
    string

    合致したパターンを置換させる文字列。

    filter_string_transforms
    Array of object
    object
    column_name
    string

    対象カラム

    type
    string

    変換方法 正規化 (NFKC) 例: normalize_nfkc: 全角英数 → 半角 (ABC123 → ABC123) 、半角カナ → 全角 (アイ → アイ) など

    Valid values[ "normalize_nfkc" ]
    Default"normalize_nfkc"
    filter_hashes
    Array of object
    object
    name
    string

    対象カラム

    filter_unixtime_conversions
    Array of object
    object
    column_name

    対象カラム type: string

    kind
    string

    変換方法

    Valid values[ "unixtime_to_timestamp", "unixtime_to_string", "timestamp_to_unixtime", "string_to_unixtime" ]
    unixtime_unit
    string

    変換前、変換後のUNIX時間の単位

    Valid values[ "second", "millisecond", "microsecond", "nanosecond" ]
    datetime_format
    string

    変換前、変換後の日時フォーマット

    datetime_timezone

    変換前、変換後の日時のタイムゾーン

    labels
    Array of string

    ラベル設定を指定します。

    Min items0
    Max items40
    string

    ラベル名を指定します。

    schedules
    Array of object

    スケジュール設定を指定します。

    Min items0
    Max items10
    object
    frequency
    string

    データマートジョブ実行スケジュールの頻度です。
    hourly: 毎時
    daily: 毎日
    weekly: 毎週
    monthly: 毎月

    Valid values[ "hourly", "daily", "weekly", "monthly" ]
    minute
    integer (int64)

    分の値を示します。

    hour
    integer (int64)

    時間の値を示します。

    day
    integer (int64)

    日にちの値を示します。

    day_of_week
    integer (int64)

    曜日の値を示します。

    time_zone
    string

    日時のタイムゾーンです。

    ExampleEtc/UTC
    notifications
    Array of object

    通知設定を指定します。

    Min items0
    Max items20
    object
    destination_type
    string

    通知先です。

    Valid values[ "slack", "email" ]
    slack_channel_id
    integer (int64)

    slack channel IDです。
    destination_typeがslackのとき必須です。

    email_id
    integer (int64)

    Email IDです。
    destination_typeがemailのとき必須です。

    notification_type
    string

    通知タイプです。
    job: ジョブ実行(終了/エラー)通知
    record: レコード条件(超過/過不足)通知
    exec_time: 実行時間経過通知

    Valid values[ "job", "record", "time" ]
    notify_when
    string

    通知条件です。
    jobタイプのとき必須です。

    Valid values[ "finished", "failed" ]
    message
    string

    通知内容です。

    record_count
    integer (int64)

    閾値のレコード数
    recordタイプのとき必須です。

    record_operator
    string

    レコード数の比較演算子です
    recordタイプのとき必須
    above: 以上
    below: 以下

    Valid values[ "above", "below" ]
    record_type

    通知するレコード数条件
    recordタイプのとき必須
    transfer: 転送した
    skipped: スキップされた

    400

    Bad request.
    不正なリクエストです。

    401

    Not authenticated.
    認証エラーです。API KEYをご確認ください。


    Was this article helpful?