> ## Documentation Index
> Fetch the complete documentation index at: https://documents.trocco.io/llms.txt
> Use this file to discover all available pages before exploring further.
# 転送設定定義作成
> 転送設定定義を作成します。
## OpenAPI
````json POST /api/job_definitions
{
"openapi": "3.0.3",
"info": {
"title": "trocco APIリファレンス",
"description": "trocco APIリファレンス",
"version": "0.0.1"
},
"servers": [
{
"url": "https://trocco.io"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"tags": [
{
"name": "users",
"description": "ユーザー",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-account-user"
}
},
{
"name": "teams",
"description": "チーム",
"externalDocs": {
"url": "https://documents.trocco.io/docs/team"
}
},
{
"name": "connections",
"description": "接続情報",
"externalDocs": {
"url": "https://documents.trocco.io/docs/connection-configurations"
}
},
{
"name": "custom_connectors",
"description": "カスタムコネクタ定義"
},
{
"name": "datamart_definitions",
"description": "データマート定義",
"externalDocs": {
"url": "https://documents.trocco.io/docs/data-mart"
}
},
{
"name": "environment_groups",
"description": "環境グループ"
},
{
"name": "environments",
"description": "環境"
},
{
"name": "jobs",
"description": "転送ジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/etl-configuration"
}
},
{
"name": "pipeline_jobs",
"description": "ワークフロージョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/about-workflow"
}
},
{
"name": "resource_groups",
"description": "リソースグループ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/resource-group"
}
},
{
"name": "dbt_git_repositories",
"description": "dbt Gitリポジトリ"
},
{
"name": "dbt_job_definitions",
"description": "dbtジョブ設定",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "dbt_jobs",
"description": "dbtジョブ",
"externalDocs": {
"url": "https://documents.trocco.io/docs/dbt-job-configuration"
}
},
{
"name": "notification_destinations",
"description": "通知先",
"externalDocs": {
"url": "https://documents.trocco.io/docs/trocco-tutorial-additional-settings"
}
}
],
"externalDocs": {
"description": "trocco APIについて",
"url": "https://documents.trocco.io/docs/trocco-api"
},
"paths": {
"/api/job_definitions": {
"post": {
"summary": "転送設定定義作成\n",
"description": "転送設定定義を作成します。\n",
"tags": [
"job_definitions"
],
"operationId": "postJobDefinition",
"requestBody": {
"content": {
"application/json": {
"schema": {
"title": "JobDefinitionCreateInput",
"type": "object",
"allOf": [
{
"title": "JobDefinitionGeneral",
"type": "object",
"properties": {
"name": {
"description": "転送設定名",
"type": "string"
},
"description": {
"description": "転送設定メモ",
"type": "string"
},
"resource_group_id": {
"description": "リソースグループID。リソースグループに追加すると、他のユーザーに設定を共有できるようになります。",
"type": "integer",
"nullable": true
},
"self_hosted_runner_cluster_id": {
"description": "Self-Hosted Runnerクラスタ ID。指定すると、指定したクラスタ上でジョブを実行します。未指定の場合はTROCCOがホストする実行基盤で実行されます。
\nSelf-Hosted Runnerが利用可能なアカウントでのみ指定できます。利用できないアカウントで指定した場合や、実行権限のないクラスタを指定した場合はエラーになります。\n",
"type": "integer",
"nullable": true
},
"is_runnable_concurrently": {
"description": "終了していないジョブが存在するとき、並列でジョブが起動することを許可するかどうかを設定します。\n",
"type": "boolean",
"default": false
},
"retry_limit": {
"description": "1以上を設定すると、転送が途中で失敗した場合に転送処理を最初からやり直します。転送処理が冪等でない場合、レコード重複等が発生する場合があります。\n",
"type": "integer",
"default": 0
},
"resource_enhancement": {
"description": "※このパラメーターはプロフェッショナルプランでのみご利用いただけます。
\nジョブ実行時に利用するリソースサイズを指定できます。指定しなかった場合、転送設定側で指定されているリソースサイズが適用されます。
\nまた、コネクタによって指定できる値が異なります。
\n- 通常のコネクタ: `medium`, `large`, `xlarge`
\n- 一部例外的なコネクタ: `custom_spec`, `xlarge`
\n指定できる各値のスペックや、一部例外的なコネクタの種類など、詳しくは[リソース増強オプションの種類およびスペック](https://documents.trocco.io/docs/professional-plan#%E3%83%AA%E3%82%BD%E3%83%BC%E3%82%B9%E5%A2%97%E5%BC%B7%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E7%A8%AE%E9%A1%9E%E3%81%8A%E3%82%88%E3%81%B3%E3%82%B9%E3%83%9A%E3%83%83%E3%82%AF)を参照ください。
\n",
"type": "string",
"enum": [
"medium",
"custom_spec",
"large",
"xlarge"
],
"nullable": true
}
}
},
{
"properties": {
"input_option_type": {
"description": "転送元の種別\n作成可能なコネクタには限りがあります。詳しくはenum部分を参照ください。\n",
"type": "string",
"enum": [
"backlog",
"bakuraku",
"bigquery",
"custom_connector",
"databricks",
"facebook_ads_insights",
"gcs",
"google_ads",
"google_analytics4",
"google_drive",
"google_spreadsheets",
"http",
"hubspot",
"kaonavi",
"kintone",
"marketo",
"mongodb",
"mysql",
"oracle",
"pagerduty",
"postgresql",
"redshift",
"s3",
"salesforce",
"sftp",
"smart_hr",
"snowflake",
"sqlserver",
"yahoo_ads_api_ydn",
"yahoo_ads_api_yss"
]
},
"input_option": {
"type": "object",
"allOf": [
{
"title": "InputOption",
"type": "object",
"description": "転送元の設定内容\n",
"properties": {
"gcs_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GcsInputOptionCreateInput",
"type": "object",
"description": "転送元gcsでの入力オプション\n",
"properties": {
"gcs_connection_id": {
"description": "GCSの接続情報のID",
"type": "integer"
},
"bucket": {
"description": "GCSのバケット名\n",
"type": "string"
},
"path_prefix": {
"description": "パスプレフィックス\n",
"type": "string"
},
"incremental_loading_enabled": {
"description": "差分転送するかどうかのフラグ\n",
"type": "boolean",
"default": false
},
"last_path": {
"description": "差分転送の場合、最後に転送されたパスを指定。 差分更新時はここで指定されたパスより辞書順で後ろのデータを転送します。 フォームが空欄の場合は最初から転送します。 特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。",
"type": "string",
"nullable": true
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうかのフラグ ヘッダー行を含まないCSV/TSVファイルの場合、TROCCO側で生成した仮のヘッダー名を割り当てます。",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか",
"type": "boolean",
"default": false
},
"decompression_type": {
"description": "圧縮形式 圧縮されていないファイルの場合はnullを指定するか項目自体省略可能です。",
"type": "string",
"enum": [
"bzip2",
"gzip",
"targz",
"zip"
],
"nullable": true
},
"nul_character_removal_enabled": {
"description": "ファイル内のNUL文字 (0x00) をパース前に除去するかどうかのフラグ。 NUL文字が原因で行が欠落する、またはカラム数不足のエラーになる場合に有効にしてください。 入力ファイル形式がCSVで、かつ文字コードがASCII互換 (UTF-8 / Shift_JIS / EUC-JP / US-ASCII / ISO-8859系) の場合のみ適用されます。 条件を満たさない場合はtrueを指定してもfalseとして保存されます。",
"type": "boolean",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderInput",
"type": "object",
"properties": {
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
}
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersCreateInputs",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
]
}
}
}
],
"required": [
"bucket",
"path_prefix",
"gcs_connection_id"
]
}
]
},
"mysql_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MysqlInputOptionInput",
"type": "object",
"description": "転送元MySQLでの入力オプション\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"query": {
"type": "string",
"description": "クエリ。incremental_loading_enabledがfalseの場合は必須です。\n",
"nullable": true
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"default_time_zone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n"
},
"use_legacy_datetime_code": {
"type": "boolean",
"nullable": true,
"description": "レガシーな時刻コード設定\n",
"default": false
},
"mysql_connection_id": {
"type": "integer",
"description": "MySQL接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"mysql_connection_id",
"input_option_columns"
]
}
]
},
"snowflake_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SnowflakeInputOptionInput",
"type": "object",
"description": "転送元snowflakeでの入力オプション\n",
"properties": {
"warehouse": {
"type": "string",
"description": "ウェアハウス名\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n",
"default": "PUBLIC"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"snowflake_connection_id": {
"type": "integer",
"description": "Snowflake接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"warehouse",
"database",
"query",
"snowflake_connection_id",
"input_option_columns"
]
}
]
},
"salesforce_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SalesforceInputOptionInput",
"type": "object",
"description": "転送元Salesforceのプロパティ\n",
"properties": {
"soql": {
"type": "string",
"description": "SOQL\nオブジェクト取得方法(object_acquisition_method)がオブジェクトの項目を全転送(all_columns)の場合、この項目は入力不要です。\nsoqlの場合のみ指定します。\n"
},
"api_version": {
"type": "string",
"description": "APIバージョン\n",
"default": "64.0"
},
"object": {
"type": "string",
"description": "オブジェクト名\n"
},
"object_acquisition_method": {
"type": "string",
"description": "オブジェクト取得方法\nall_columns: オブジェクトの項目を全転送。指定したオブジェクトの項目を、すべて転送します。あとで「クエリ(SOQL) を記述して転送」に変更することもできます。\nsoql: クエリ (SOQL) を記述して転送。指定したオブジェクトに対し、SOQLを記述して転送します。転送項目をカスタマイズしたい場合に適しています。\nincremental: オブジェクトの項目を差分転送。前回転送時からの増分データのみ転送します。\n",
"enum": [
"all_columns",
"soql",
"incremental"
],
"default": "all_columns"
},
"is_convert_type_custom_columns": {
"type": "boolean",
"description": "型変換モード\nfalse: カスタムカラム(columns)を元に転送をします。\ntrue: カスタムカラム(columns)をSTRING型に変更。カスタムカラムをSTRING型に変更を選択した場合、BOOLEAN型以外のすべてのカスタムカラムの型をSTRINGに変更します。\n",
"default": false
},
"include_deleted_or_archived_records": {
"type": "boolean",
"description": "削除済み・アーカイブ済みレコードの抽出\n",
"default": false
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。\nオブジェクト取得方法(object_acquisition_method)がincrementalの場合は必須です。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"salesforce_connection_id": {
"type": "integer",
"description": "Salesforce接続情報ID\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"title": "ColumnSetting",
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"salesforce_connection_id",
"object",
"columns"
]
}
]
},
"google_spreadsheets_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleSpreadsheetsInputOptionInput",
"type": "object",
"description": "転送元Google Spreadsheetsでの入力オプション\n",
"properties": {
"google_spreadsheets_connection_id": {
"type": "integer",
"description": "Google Spreadsheets接続情報ID\n"
},
"spreadsheets_url": {
"type": "string",
"description": "シートのURL\n"
},
"worksheet_title": {
"type": "string",
"description": "シート名\n"
},
"start_row": {
"type": "integer",
"default": 2,
"description": "取り込み開始行番号。\n取り込むデータの最初の行番号を入力してください。\n見出しの行がある場合は、その次の行番号を入力してください。\n"
},
"start_column": {
"type": "string",
"default": "A",
"description": "取り込み開始列番号。\n取り込むデータの最初の列番号をアルファベットで入力してください。\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン。東京の場合 `Asia/Tokyo`、UTCの場合は `Etc/Utc` です。\n",
"example": "Asia/Tokyo"
},
"null_string": {
"type": "string",
"description": "NULLと認識させたい文字列を入力してください。未入力の場合、空文字がNULLとして認識されます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "GoogleSpreadsheetsInputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
},
"format": {
"type": "string",
"nullable": true,
"description": "カラムのフォーマット",
"example": "%Y/%m/%d %H:%M:%S"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"google_spreadsheets_connection_id",
"spreadsheets_url",
"worksheet_title",
"default_time_zone",
"input_option_columns"
]
}
]
},
"postgresql_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "PostgreSQLInputOptionInput",
"type": "object",
"description": "転送元postgresqlでの入力オプション\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n",
"default": "public"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"default_time_zone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n",
"default": "UTC"
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"postgresql_connection_id": {
"type": "integer",
"description": "PostgreSQL接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_column_options": {
"allOf": [
{
"title": "PostgresqlInputOptionColumn",
"type": "object",
"description": "取り込みデータ型指定\n",
"properties": {
"column_name": {
"type": "string",
"description": "interval型など、TROCCOでサポートされていないデータ型のカラム名",
"example": "duration"
},
"column_value_type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "変換可能なデータ型",
"example": "string"
}
},
"required": [
"column_name",
"column_value_type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"postgresql_connection_id",
"input_option_columns"
]
}
]
},
"sqlserver_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SQLServerInputOptionInput",
"type": "object",
"description": "転送元sqlserverでの入力オプション\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"nullable": true,
"description": "スキーマ名。未指定の場合は接続ユーザーのデフォルトスキーマ (通常は dbo) が使用されます。\n"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"default_time_zone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n",
"default": "UTC"
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"sqlserver_connection_id": {
"type": "integer",
"description": "SQL Server接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_column_options": {
"description": "取り込みデータ型指定(作成順)\n",
"allOf": [
{
"title": "SqlserverInputOptionColumn",
"type": "object",
"description": "取り込みデータ型指定\n",
"properties": {
"column_name": {
"type": "string",
"description": "TROCCOでサポートされていないデータ型のカラム名",
"example": "created_at"
},
"column_value_type": {
"type": "string",
"enum": [
"string"
],
"description": "変換可能なデータ型。現在は string のみ指定できます。",
"example": "string"
}
},
"required": [
"column_name",
"column_value_type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"sqlserver_connection_id",
"input_option_columns"
]
}
]
},
"bigquery_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BigqueryInputOptionCreateInput",
"type": "object",
"description": "転送元bigqueryでの入力オプション\n",
"properties": {
"bigquery_connection_id": {
"description": "Bigqueryの接続情報のID\n",
"type": "integer"
},
"gcs_uri": {
"type": "string",
"description": "一時データエクスポート先Google Cloud Storage URI\n"
},
"gcs_uri_format": {
"type": "string",
"nullable": true,
"default": "bucket",
"description": "一時データエクスポート指定\nbucket: gcs_uriにGoogle BigQueryのデータを一時的にエクスポートするGoogle Cloud Storageバケットを指定してください。\ncustom_path: gcs_uriにGoogle BigQueryのデータを一時的にエクスポートするGoogle Cloud Storageバケット・フォルダを指定してください。必ず、転送設定ごとに固有のバケット・フォルダを指定してください。\n",
"enum": [
"bucket",
"custom_path"
]
},
"query": {
"type": "string",
"description": "SQL\n"
},
"temp_dataset": {
"type": "string",
"description": "一時テーブル作成先データセット\n"
},
"is_standard_sql": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "SQLタイプ\ntrue: 標準SQL\nfalse: レガシーSQL\n"
},
"cleanup_gcs_files": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "一時データの削除ポリシー\ntrueに設定した場合、一時データエクスポート先Google Cloud Storage URIに指定したディレクトリ内のすべてのファイルが削除されます。\n"
},
"file_format": {
"type": "string",
"nullable": true,
"default": "CSV",
"description": "一時データのファイル形式\nCSV: 通常はこちらを選択してください。クエリ結果にRECORD型を含む場合は転送できません。\nNEWLINE_DELIMITED_JSON: RECORD型を含む場合、こちらを選択してください。カラムのすべての値がNULLの場合、データ自動設定でカラムが表示されない場合があります。\n",
"enum": [
"CSV",
"NEWLINE_DELIMITED_JSON"
]
},
"location": {
"type": "string",
"description": "データセットのロケーション\nGoogle BigQueryデータセットのロケーションを指定します。デフォルトはUSリージョンです。\n東京リージョンを指定する場合はasia-northeast1をご入力ください。\nロケーションの詳細は公式ドキュメントをご参照ください。\n",
"default": "US"
},
"cache": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "クエリキャッシュを利用する\n"
},
"bigquery_job_wait_second": {
"type": "integer",
"nullable": true,
"default": 600,
"description": "ジョブ待機タイムアウト(秒)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"title": "ColumnSetting",
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"bigquery_connection_id",
"gcs_uri",
"query",
"temp_dataset"
]
}
]
},
"databricks_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "DatabricksInputOptionInput",
"type": "object",
"description": "転送元Databricksでの入力オプション\n",
"properties": {
"databricks_connection_id": {
"type": "integer",
"description": "Databricks接続情報ID\n"
},
"catalog_name": {
"type": "string",
"description": "カタログ名\n"
},
"schema_name": {
"type": "string",
"description": "スキーマ名\n"
},
"query": {
"type": "string",
"description": "実行するSQLクエリ\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"databricks_connection_id",
"catalog_name",
"schema_name",
"query",
"input_option_columns"
]
}
]
},
"s3_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "S3InputOptionInput",
"type": "object",
"description": "転送元S3での入力オプション\n",
"properties": {
"s3_connection_id": {
"description": "S3の接続情報のID",
"type": "integer"
},
"bucket": {
"description": "S3のバケット名\n",
"type": "string"
},
"path_prefix": {
"description": "パスプレフィックス\n未入力の場合、バケット配下の全てのファイルが対象になります\n",
"type": "string",
"default": ""
},
"path_match_pattern": {
"description": "パスの正規表現\n未入力の場合、パスプレフィックスにマッチする全てのファイルが対象になります\n",
"type": "string",
"default": ""
},
"region": {
"description": "リージョン\n",
"type": "string",
"default": "ap-northeast-1"
},
"incremental_loading_enabled": {
"description": "差分転送するかどうかのフラグ\n",
"type": "boolean",
"default": false
},
"last_path": {
"description": "差分転送の場合、最後に転送されたパスを指定。 差分更新時はここで指定されたパスより辞書順で後ろのデータを転送します。 フォームが空欄の場合は最初から転送します。 特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。",
"type": "string",
"nullable": true
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうかのフラグ\nヘッダー行を含まないCSV/TSVファイルの場合、TROCCO側で生成した仮のヘッダー名を割り当てます。\n",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか",
"type": "boolean",
"default": false
},
"decompression_type": {
"description": "圧縮形式\n`default`を指定した場合、解凍の設定は行われません。TROCCOの画面上で自動データ設定を実行した場合のみ、bzip2/gzipが自動で判別され設定されます。\n画面操作を行わずにgzip/bzip2ファイルを転送する場合は、`gzip`または`bzip2`を明示的に指定してください。\n",
"type": "string",
"enum": [
"default",
"zip",
"targz",
"gzip",
"bzip2"
],
"nullable": true,
"default": "default"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderInput",
"type": "object",
"properties": {
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
}
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersResponse",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"delimiter",
"quote",
"escape",
"null_string_enabled",
"skip_header_lines",
"trim_if_not_quoted",
"quotes_in_quoted_fields",
"allow_optional_columns",
"allow_extra_columns",
"max_quoted_size_limit",
"stop_on_invalid_record",
"default_time_zone",
"default_date",
"newline",
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"stop_on_invalid_record",
"default_time_zone",
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"newline",
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"default_time_zone",
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
],
"required": [
"column_name",
"charset",
"max_size_bytes",
"stop_on_oversize"
]
}
}
}
],
"required": [
"bucket",
"s3_connection_id"
]
}
]
},
"google_analytics4_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GA4InputOptionInput",
"type": "object",
"description": "転送元Google Analytics 4での入力オプション\n",
"properties": {
"google_analytics4_connection_id": {
"description": "Google Analytics 4の接続情報のID",
"type": "integer"
},
"property_id": {
"description": "プロパティID\n",
"type": "string"
},
"time_series": {
"description": "タイムスタンプの形式\n",
"type": "string",
"enum": [
"dateHour",
"date",
"yearMonth",
"year",
"isoYear"
]
},
"start_date": {
"description": "データ取得期間の開始日\n例: 2021-01-01, NdaysAgo, yesterday, today\n",
"type": "string"
},
"end_date": {
"description": "データ取得期間の終了日\n例: 2021-01-01, NdaysAgo, yesterday, today\n",
"type": "string"
},
"incremental_loading_enabled": {
"description": "転送方式。差分転送するかどうかのフラグ\n",
"type": "boolean",
"default": false
},
"last_record_time": {
"description": "最新のレコード更新日時。\n差分転送の場合、最後に転送されたデータの時間を指定。\n差分更新時はここで指定された時間より後のデータを転送します。\nフォームが空欄の場合は最初から転送します。\n特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。\n",
"type": "string"
},
"google_analytics4_input_option_dimensions": {
"description": "ディメンション\n",
"type": "array",
"items": {
"type": "object",
"maxItems": 8,
"properties": {
"name": {
"description": "ディメンション名\n",
"type": "string"
},
"expression": {
"description": "ディメンション式\n",
"type": "string"
}
}
}
},
"google_analytics4_input_option_metrics": {
"description": "メトリクス\n",
"type": "array",
"items": {
"type": "object",
"maxItems": 10,
"properties": {
"name": {
"description": "メトリクス名\n",
"type": "string"
},
"expression": {
"description": "メトリクス式\n",
"type": "string"
}
}
}
},
"retry_limit": {
"description": "最大リトライ回数\n",
"type": "integer",
"default": 5
},
"retry_sleep": {
"description": "リトライ間隔(秒)\n",
"type": "integer",
"default": 2
},
"raise_on_other_row": {
"description": "「(other)」行が使用されている場合のステータス\nfalse: Succeededにする\ntrue: Errorにする\n",
"type": "boolean",
"default": true
},
"limit_of_rows": {
"description": "一回のリクエストで取得する行数\n",
"type": "integer",
"default": 10000
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"google_analytics4_connection_id",
"property_id",
"time_series",
"raise_on_other_row",
"limit_of_rows",
"google_analytics4_input_option_dimensions",
"google_analytics4_input_option_metrics"
]
}
]
},
"kintone_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "KintoneInputOptionInput",
"type": "object",
"description": "転送元Kintoneでの入力オプション\n",
"properties": {
"kintone_connection_id": {
"type": "integer",
"description": "Kintone接続情報ID\n"
},
"app_id": {
"type": "string",
"description": "アプリID\n"
},
"guest_space_id": {
"type": "string",
"description": "ゲストスペースID\n",
"nullable": true
},
"expand_subtable": {
"type": "boolean",
"default": true,
"description": "テーブル行単位で転送する\n"
},
"query": {
"type": "string",
"description": "クエリ\n",
"nullable": true
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"app_id",
"kintone_connection_id",
"input_option_columns",
"expand_subtable"
]
}
]
},
"http_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "HttpInputOptionInput",
"type": "object",
"description": "転送元HTTPでの入力オプション\n",
"properties": {
"url": {
"description": "URL\n",
"type": "string"
},
"method": {
"description": "HTTPメソッド\n",
"type": "string",
"enum": [
"get",
"post"
],
"default": "get"
},
"user_agent": {
"description": "ユーザーエージェント\n",
"type": "string",
"nullable": true
},
"charset": {
"description": "文字エンコーディング\n",
"type": "string",
"nullable": true,
"default": "UTF-8"
},
"pager_type": {
"description": "ページング設定\n",
"type": "string",
"enum": [
"disable",
"offset",
"cursor"
],
"default": "disable"
},
"pager_from_param": {
"description": "オフセット開始パラメータ名(from)。ページング設定で`offset`を指定した場合必須です。\n",
"type": "string",
"nullable": true
},
"pager_to_param": {
"description": "オフセット終了パラメータ名(to)\n",
"type": "string",
"nullable": true
},
"pager_pages": {
"description": "ページネーションリクエスト回数。ページング設定で`offset`を指定した場合必須です。\n",
"type": "integer",
"nullable": true
},
"pager_start": {
"description": "オフセット初期値。ページング設定で`offset`を指定した場合必須です。\n",
"type": "integer",
"nullable": true
},
"pager_step": {
"description": "1リクエストで進めるオフセット増加値。ページング設定で`offset`を指定した場合必須です。\n",
"type": "integer",
"nullable": true
},
"cursor_request_parameter_cursor_name": {
"description": "カーソルをセットするパラメータ名。ページング設定で`cursor`を指定した場合必須です。\n",
"type": "string",
"nullable": true
},
"cursor_response_parameter_cursor_json_path": {
"description": "レスポンスからカーソルを取得するためのJSONPath。ページング設定で`cursor`を指定した場合必須です。\n",
"type": "string",
"nullable": true
},
"cursor_request_parameter_limit_name": {
"description": "1リクエストで取得するレコードの最大件数をセットするパラメータ名\n",
"type": "string",
"nullable": true
},
"cursor_request_parameter_limit_value": {
"description": "1リクエストで取得するレコードの最大件数\n",
"type": "integer",
"nullable": true
},
"request_params": {
"description": "リクエストパラメータ\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "パラメータ名\n",
"type": "string"
},
"value": {
"description": "パラメータ値\n",
"type": "string"
},
"masking": {
"description": "`true`の場合、画面上での表示がマスキングされます。\n",
"type": "boolean"
}
},
"required": [
"key",
"value"
]
}
},
"request_body": {
"description": "リクエストボディ。POSTメソッドの場合のみ有効です。`request_params`がある場合は無視されます。\n",
"type": "string",
"nullable": true
},
"request_headers": {
"description": "リクエストヘッダ\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "ヘッダ名\n",
"type": "string"
},
"value": {
"description": "ヘッダ値\n",
"type": "string"
},
"masking": {
"description": "`true`の場合、画面上での表示がマスキングされます。\n",
"type": "boolean"
}
},
"required": [
"key",
"value"
]
}
},
"success_code": {
"description": "転送データ取得時に正常系と判定するステータスコード\n",
"type": "string",
"nullable": true,
"default": "200"
},
"open_timeout": {
"description": "接続時にタイムアウトするまでのミリ秒数\n",
"type": "integer",
"nullable": true,
"default": 2000
},
"read_timeout": {
"description": "読み取り時にタイムアウトするまでのミリ秒数\n",
"type": "integer",
"nullable": true,
"default": 10000
},
"max_retries": {
"description": "最大リトライ回数\n",
"type": "integer",
"nullable": true,
"default": 5
},
"retry_interval": {
"description": "リトライ間隔(ミリ秒)\n",
"type": "integer",
"nullable": true,
"default": 10000
},
"request_interval": {
"description": "リクエスト間隔(ミリ秒)\n",
"type": "integer",
"nullable": true,
"default": 0
},
"ssl_ca": {
"description": "SSL CA証明書(PEM形式)。設定すると、HTTPS接続時にサーバー証明書の検証に使用されます。\nnullを指定すると設定済みの証明書をクリアします。\n",
"type": "string",
"nullable": true
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
]
}
},
"required": [
"url",
"method"
]
}
]
},
"google_ads_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleAdsInputOptionInput",
"type": "object",
"description": "転送元Google Adsでの入力オプション\n",
"properties": {
"customer_id": {
"type": "string",
"description": "Google Adsのお客様ID(10桁の数字)\n"
},
"resource_type": {
"type": "string",
"description": "取得するリソースタイプ\n例: customer, campaign, ad_group, ad_group_ad など\n"
},
"start_date": {
"type": "string",
"nullable": true,
"description": "データ取得開始日(YYYY-MM-DD形式)\nリソースタイプによっては指定できない場合があります。\n"
},
"end_date": {
"type": "string",
"nullable": true,
"description": "データ取得終了日(YYYY-MM-DD形式)\nリソースタイプによっては指定できない場合があります。\n"
},
"google_ads_connection_id": {
"type": "integer",
"description": "Google Ads接続情報ID\n"
},
"input_option_columns": {
"type": "array",
"description": "取得するフィールドの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィールド名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "タイムスタンプ型の場合のフォーマット\n",
"nullable": true
}
}
}
},
"conditions": {
"type": "array",
"description": "検索条件の一覧\n",
"items": {
"type": "string",
"description": "WHERE句の条件式\n"
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"customer_id",
"resource_type",
"google_ads_connection_id",
"input_option_columns"
]
}
]
},
"yahoo_ads_api_yss_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "YahooAdsApiYssInput",
"type": "object",
"description": "転送元yahoo_ads_api_yssでの入力オプション",
"properties": {
"yahoo_ads_api_connection_id": {
"type": "integer",
"description": "YahooAdsApiYss接続情報ID"
},
"base_account_id": {
"type": "string",
"description": "ベースアカウントID"
},
"account_id": {
"type": "string",
"description": "アカウントID"
},
"service": {
"type": "string",
"description": "サービス",
"default": "report_definition_service",
"enum": [
"report_definition_service",
"campaign_export_service"
]
},
"start_date": {
"type": "string",
"description": "開始日",
"nullable": true
},
"end_date": {
"type": "string",
"description": "終了日",
"nullable": true
},
"report_type": {
"type": "string",
"description": "レポート種別",
"enum": [
"ACCOUNT",
"CAMPAIGN",
"ADGROUP",
"AD",
"KEYWORDS",
"SEARCH_QUERY",
"GEO",
"GEO_TARGET",
"SCHEDULE_TARGET",
"BID_STRATEGY",
"ADGROUP_TARGET_LIST",
"CAMPAIGN_TARGET_LIST",
"LANDING_PAGE_URL",
"KEYWORDLESS_QUERY",
"WEBPAGE_CRITERION",
"BID_MODIFIER",
"CAMPAIGN_ASSET",
"ADGROUP_ASSET",
"RESPONSIVE_ADS_FOR_SEARCH_ASSET",
"ASSET_COMBINATIONS"
],
"nullable": true
},
"exclude_zero_impressions": {
"type": "boolean",
"description": "フィルター設定",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"yahoo_ads_api_connection_id",
"base_account_id",
"account_id",
"service",
"input_option_columns"
]
}
]
},
"yahoo_ads_api_ydn_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "YahooAdsApiYdnInput",
"type": "object",
"description": "転送元yahoo_ads_api_ydnでの入力オプション",
"properties": {
"yahoo_ads_api_connection_id": {
"type": "integer",
"description": "Yahoo!広告 API接続情報"
},
"target": {
"type": "string",
"description": "取得方法",
"enum": [
"report",
"stats"
]
},
"base_account_id": {
"type": "string",
"description": "ベースアカウントID"
},
"account_id": {
"type": "string",
"description": "アカウントID"
},
"report_type": {
"type": "string",
"description": "タイプ。targetがstatsの場合のみ指定する",
"enum": [
"CAMPAIGN",
"ADGROUP",
"AD"
],
"nullable": true
},
"report_type_condition": {
"type": "string",
"description": "レポート種別。targetがreportの場合のみ指定する。未指定の場合は通常の広告レポートを取得する",
"enum": [
"REACH",
"CONVERSION_PATH",
"CROSS_CAMPAIGN_REACHES",
"MODEL_COMPARISON"
],
"nullable": true
},
"report_date_range_type": {
"type": "string",
"description": "集計対象期間。targetがreportの場合のみ指定する。省略した場合はCUSTOM_DATEとなる。 CUSTOM_DATEの場合はstart_date・end_dateが必須となる。 report_type_conditionがREACHの場合はCUSTOM_DATEを指定できない。 GUARANTEED_CAMPAIGN_PERIOD (通期) はreport_type_conditionがREACHの場合のみ指定でき、frequency_rangeもGUARANTEED_CAMPAIGN_PERIODにする必要がある",
"enum": [
"CUSTOM_DATE",
"TODAY",
"YESTERDAY",
"LAST_7_DAYS",
"LAST_14_DAYS",
"LAST_30_DAYS",
"LAST_WEEK",
"LAST_BUSINESS_WEEK",
"LAST_MONTH",
"THIS_MONTH",
"THIS_MONTH_EXCEPT_TODAY",
"GUARANTEED_CAMPAIGN_PERIOD"
],
"nullable": true
},
"frequency_range": {
"type": "string",
"description": "リーチ頻度の計測単位。report_type_conditionがREACHの場合は必須",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"GUARANTEED_CAMPAIGN_PERIOD"
],
"nullable": true
},
"lookback_window": {
"type": "integer",
"description": "ルックバック期間 (日数)。report_type_conditionがCONVERSION_PATHまたはMODEL_COMPARISONの場合は必須",
"minimum": 0,
"maximum": 90,
"nullable": true
},
"include_view_interaction": {
"type": "boolean",
"description": "ビューインタラクションを含めるかどうか。report_type_conditionがCONVERSION_PATHまたはMODEL_COMPARISONの場合のみ指定する",
"nullable": true
},
"include_video_interaction": {
"type": "boolean",
"description": "動画インタラクションを含めるかどうか。report_type_conditionがMODEL_COMPARISONの場合のみ指定する",
"nullable": true
},
"base_model": {
"type": "string",
"description": "比較元モデル。report_type_conditionがMODEL_COMPARISONの場合は必須",
"enum": [
"LAST",
"FIRST",
"LINEAR",
"POSITION_BASED"
],
"nullable": true
},
"comparative_model": {
"type": "string",
"description": "比較先モデル。report_type_conditionがMODEL_COMPARISONの場合は必須",
"enum": [
"LAST",
"FIRST",
"LINEAR",
"POSITION_BASED"
],
"nullable": true
},
"cross_campaign_type": {
"type": "string",
"description": "組み合わせ種別。report_type_conditionがCROSS_CAMPAIGN_REACHESの場合は必須",
"enum": [
"CAMPAIGN_ID",
"CAMPAIGN_GOAL",
"CAMPAIGN_BUYING_TYPE"
],
"nullable": true
},
"cross_campaign_values": {
"type": "array",
"description": "組み合わせ対象。report_type_conditionがCROSS_CAMPAIGN_REACHESの場合は必須で、2〜3個指定する。 cross_campaign_typeがCAMPAIGN_IDの場合はキャンペーンID、CAMPAIGN_GOALの場合はキャンペーン目的 (WEBSITE_TRAFFIC / VIDEO_VIEW / APP_PROMOTION / CONVERSION / ITEM_LIST / BRAND_AWARENESS / STORE_VISIT / PAYPAY_GIFT / GAIN_FRIENDS)、CAMPAIGN_BUYING_TYPEの場合は購入タイプ (AUCTION / GUARANTEED) を指定する(指定順)",
"items": {
"type": "string"
},
"nullable": true
},
"conversion_path_filters": {
"type": "array",
"description": "コンバージョン経路レポートの絞り込み条件。report_type_conditionがCONVERSION_PATHの場合のみ指定できる。 省略した場合はアカウント配下のすべてのキャンペーン・コンバージョンが対象となる。 valuesを複数指定した場合はOR条件、条件を複数指定した場合はAND条件となる。 指定した場合は既存の絞り込み条件をすべて置き換える",
"items": {
"type": "object",
"properties": {
"filter_type": {
"type": "string",
"description": "絞り込み対象の項目",
"enum": [
"CAMPAIGN_ID",
"CAMPAIGN_NAME",
"CONVERSION_ID",
"ADGROUP_ID",
"ADGROUP_NAME"
]
},
"filter_operator": {
"type": "string",
"description": "絞り込み条件の演算子",
"enum": [
"EQUALS",
"NOT_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"START_WITH",
"END_WITH"
]
},
"values": {
"type": "array",
"description": "絞り込みに使用する値。複数指定した場合はOR条件となる",
"items": {
"type": "string"
}
}
},
"required": [
"filter_type",
"filter_operator",
"values"
]
},
"nullable": true
},
"start_date": {
"type": "string",
"description": "開始日。targetがstatsの場合、またはreport_date_range_typeがCUSTOM_DATEの場合は必須",
"nullable": true
},
"end_date": {
"type": "string",
"description": "終了日。targetがstatsの場合、またはreport_date_range_typeがCUSTOM_DATEの場合は必須",
"nullable": true
},
"include_deleted": {
"type": "boolean",
"description": "削除済み広告を含める",
"nullable": true
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"yahoo_ads_api_connection_id",
"target",
"base_account_id",
"account_id",
"input_option_columns"
]
}
]
},
"mongodb_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MongodbInputOptionInput",
"type": "object",
"description": "転送元MongoDBでの入力オプション\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"collection": {
"type": "string",
"description": "コレクション名\n"
},
"query": {
"type": "string",
"description": "クエリ。incremental_loading_enabledがfalseの場合は必須です。\n",
"nullable": true
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。\n"
},
"last_record": {
"type": "object",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": false
},
"mongodb_connection_id": {
"type": "integer",
"description": "MongoDB接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"collection",
"mongodb_connection_id",
"input_option_columns"
]
}
]
},
"sftp_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SftpInputOptionInput",
"type": "object",
"description": "転送元SFTPでの入力オプション\n",
"properties": {
"sftp_connection_id": {
"description": "SFTPの接続情報のID\n",
"type": "integer"
},
"path_prefix": {
"description": "パスプレフィックス\n",
"type": "string"
},
"path_match_pattern": {
"description": "パスの正規表現\n",
"type": "string"
},
"incremental_loading_enabled": {
"description": "転送方法\n",
"type": "boolean",
"default": false
},
"last_path": {
"description": "最後に転送されたパス\n",
"type": "string"
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうかのフラグ\nヘッダー行を含まないCSV/TSVファイルの場合、TROCCO側で生成した仮のヘッダー名を割り当てます。\n",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか\n",
"type": "boolean",
"default": false
},
"decompression_type": {
"description": "解凍形式\n",
"type": "string",
"enum": [
"guess",
"zip",
"targz"
],
"default": "guess"
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderInput",
"type": "object",
"properties": {
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersCreateInputs",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
]
}
}
}
],
"required": [
"sftp_connection_id",
"path_prefix",
"decompression_type",
"incremental_loading_enabled",
"stop_when_file_not_found"
]
}
]
},
"hubspot_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "HubspotInputOptionInput",
"type": "object",
"description": "転送元HubSpotでの入力オプション\n",
"properties": {
"hubspot_connection_id": {
"type": "integer",
"description": "HubSpot接続情報ID\n"
},
"target": {
"type": "string",
"description": "取得対象の種類\n",
"enum": [
"object",
"association",
"engagement",
"engagement_association",
"email_event",
"pipeline",
"pipeline_stage",
"owner"
]
},
"from_object_type": {
"type": "string",
"nullable": true,
"description": "連携元オブジェクトタイプ(targetがassociationの場合に必須)\n"
},
"to_object_type": {
"type": "string",
"nullable": true,
"description": "連携先オブジェクトタイプ(targetがassociation, engagement_association, pipeline, pipeline_stageの場合に必須)\n"
},
"object_type": {
"type": "string",
"nullable": true,
"description": "オブジェクトタイプ(targetがobject, pipeline, pipeline_stageの場合に必須)\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "差分読み込みの有効化(targetがobjectの場合のみ有効)\n",
"default": false
},
"last_record_time": {
"type": "string",
"nullable": true,
"description": "最後に読み込んだレコードの時刻(差分読み込みが有効な場合に使用)\n"
},
"email_event_type": {
"type": "string",
"nullable": true,
"description": "メールイベントのタイプ(targetがemail_eventの場合に必須)\n"
},
"start_timestamp": {
"type": "string",
"nullable": true,
"description": "開始タイムスタンプ(targetがemail_eventの場合に使用)\n"
},
"end_timestamp": {
"type": "string",
"nullable": true,
"description": "終了タイムスタンプ(targetがemail_eventの場合に使用)\n"
},
"properties": {
"type": "string",
"nullable": true,
"description": "取得するプロパティのカンマ区切り文字列(targetがobjectの場合に使用)。未指定の場合は全プロパティを取得します。\n"
},
"input_option_columns": {
"type": "array",
"description": "取得するカラムの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "タイムスタンプ型の場合のフォーマット\n",
"nullable": true
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"hubspot_connection_id",
"target",
"input_option_columns"
]
}
]
},
"marketo_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MarketoInputOptionInput",
"type": "object",
"description": "転送元Adobe Marketo Engageでの入力オプション\n",
"properties": {
"marketo_connection_id": {
"type": "integer",
"description": "Marketo接続情報ID\n"
},
"target": {
"type": "string",
"description": "取得対象データタイプ。リード、アクティビティ、プログラムメンバーのいずれかを選択した場合、データプレビューでは実際のデータではなくサンプルデータが出力されます。\n",
"enum": [
"lead",
"activity",
"campaign",
"all_lead_with_list_id",
"program",
"program_members",
"custom_object",
"list",
"activity_type",
"folder"
]
},
"from_date": {
"type": "string",
"nullable": true,
"description": "取得開始日時(ISO 8601形式)。target: lead/activityのみ有効。デフォルトはUTCタイムゾーンが適用されます。日本時間など任意のタイムゾーンを指定する場合は、yyyy-MM-dd'T'HH:mm:ssXXX形式で入力してください(例:2025-05-27T00:00:00+0900)。\n"
},
"end_date": {
"type": "string",
"nullable": true,
"description": "取得終了日時(ISO 8601形式)。target: lead/activityのみ有効。\n"
},
"use_updated_at": {
"type": "boolean",
"nullable": true,
"description": "更新日時をベースに取得するか、作成日時をベースに取得するかの選択。データ取得期間でデータの絞り込みを行う際に、作成日(createdAt)を用いるか、更新日(updatedAt)を用いるかをお選びいただけます。target: leadのみ有効。\n",
"default": false
},
"activity_type_ids": {
"type": "array",
"nullable": true,
"description": "アクティビティタイプID配列。指定したアクティビティタイプで絞り込みを行います。target: activityのみ有効。STEP2のデータプレビューでは実際のデータではなくサンプルデータが出力されます。\n",
"items": {
"type": "integer"
}
},
"polling_interval_second": {
"type": "integer",
"nullable": true,
"description": "ポーリング間隔(秒)。target: lead/activityのみ有効。\n",
"default": 60
},
"bulk_job_timeout_second": {
"type": "integer",
"nullable": true,
"description": "バルクジョブタイムアウト(秒)。target: lead/activityのみ有効。\n",
"default": 3600
},
"custom_object_api_name": {
"type": "string",
"nullable": true,
"description": "カスタムオブジェクトAPIName。取得したいカスタムオブジェクトのAPI名を指定してください。通常、カスタムオブジェクト名に_cが付いた形式になっています。target: custom_objectのみ有効。\n"
},
"custom_object_filter_type": {
"type": "string",
"nullable": true,
"description": "カスタムオブジェクトフィルタタイプ。フィルターに用いることのできる値は整数値のみです。target: custom_objectのみ有効。\n"
},
"custom_object_filter_from_value": {
"type": "integer",
"nullable": true,
"description": "カスタムオブジェクトフィルタFrom値。開始値のデフォルト値は1です。target: custom_objectのみ有効。\n"
},
"custom_object_filter_to_value": {
"type": "integer",
"nullable": true,
"description": "カスタムオブジェクトフィルタTo値。終了値を指定しなかった場合は開始値よりも値が大きいデータを取得します。target: custom_objectのみ有効。\n"
},
"custom_object_fields": {
"type": "array",
"nullable": true,
"description": "カスタムオブジェクトフィールド配列。target: custom_objectのみ有効。\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィールド名\n"
}
},
"required": [
"name"
]
}
},
"list_ids": {
"type": "string",
"nullable": true,
"description": "リストID(カンマ区切り)。取得したいデータのリストIDをカンマ区切りで入力してください。未入力の場合、全てのリスト配下のリードが対象になります。target: all_lead_with_list_idのみ有効。\n"
},
"program_ids": {
"type": "string",
"nullable": true,
"description": "プログラムID(カンマ区切り)。取得したいデータのプログラムIDをカンマ区切りで入力してください。未入力の場合、全てのプログラム配下のメンバーが対象になります。target: program_membersのみ有効。\n"
},
"root_id": {
"type": "integer",
"nullable": true,
"description": "ルートフォルダ/プログラムID。データを取得する際の起点となるルートフォルダーのIDを指定してください。未入力の場合、ワークスペース名のフォルダがルートフォルダーとなります。target: folderのみ有効。\n"
},
"root_type": {
"type": "string",
"nullable": true,
"description": "ルートタイプ。データを取得する際の起点となるルートフォルダーの種類を選択してください。デフォルト値はフォルダーです。target: folderのみ有効、必須。\n",
"enum": [
"folder",
"program"
]
},
"max_depth": {
"type": "integer",
"nullable": true,
"description": "取得したいデータの最大のフォルダー階層を指定してください。デフォルト値は2です。target: folderのみ有効。\n",
"default": 2
},
"workspace": {
"type": "string",
"nullable": true,
"description": "ワークスペース名。取得したいデータのワークスペースを指定してください。未入力の場合、全てのワークスペース配下のフォルダーが対象になります。target: folderのみ有効。\n"
},
"input_option_columns": {
"type": "array",
"description": "取得するカラムの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
}
},
"required": [
"name",
"type"
]
}
},
"marketo_input_option_filter_columns": {
"type": "array",
"description": "フィルター列配列。「カラムを指定する」を選択した場合、指定したカラムのみを取得対象とします。target: lead/all_lead_with_list_idのみ有効。\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィルター列名\n"
}
},
"required": [
"name"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"marketo_connection_id",
"target"
]
}
]
},
"google_drive_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleDriveInputOptionCreateInput",
"type": "object",
"description": "転送元Google Driveでの入力オプション\n",
"properties": {
"google_drive_connection_id": {
"description": "Google Driveの接続情報のID",
"type": "integer"
},
"folder_id": {
"description": "フォルダID\n",
"type": "string"
},
"file_match_pattern": {
"description": "ファイル名のマッチパターン\n",
"type": "string"
},
"decompression_type": {
"description": "圧縮形式 圧縮されていないファイルの場合はnullを指定するか項目自体省略可能です。",
"type": "string",
"enum": [
"bzip2",
"gzip",
"targz",
"zip"
],
"nullable": true
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうか\n",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか",
"type": "boolean",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderInput",
"type": "object",
"properties": {
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
}
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersCreateInputs",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
]
}
}
}
],
"required": [
"folder_id",
"file_match_pattern",
"google_drive_connection_id"
]
}
]
},
"redshift_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "RedshiftInputOptionInput",
"type": "object",
"description": "転送元redshiftでの入力オプション\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n",
"default": "public"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"redshift_connection_id": {
"type": "integer",
"description": "Redshift接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"database",
"schema",
"query",
"fetch_rows",
"connect_timeout",
"socket_timeout",
"redshift_connection_id"
]
}
]
},
"oracle_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "OracleInputOptionInput",
"type": "object",
"description": "転送元oracleでの入力オプション\n",
"properties": {
"oracle_connection_id": {
"type": "integer",
"description": "Oracle接続情報ID\n"
},
"database": {
"type": "string",
"nullable": true,
"description": "データベース名 (SID または サービス名)。接続情報でTNSネーミング (tns_admin_ora) を使用している場合は不要です。\n"
},
"connection_type": {
"type": "string",
"enum": [
"sid",
"service_name"
],
"description": "databaseの解釈方法。sid: SID として解釈, service_name: サービス名として解釈。接続情報でTNSネーミングを使用している場合は無視されます。\n",
"default": "sid"
},
"net_service_name": {
"type": "string",
"nullable": true,
"description": "接続情報でTNSネーミング (tns_admin_ora) を使用している場合の接続識別子 (tnsnames.ora内のエントリ名)\n"
},
"schema": {
"type": "string",
"nullable": true,
"description": "スキーマ名。差分転送の場合に指定します。未指定の場合はデフォルトスキーマが参照されます。\n"
},
"query": {
"type": "string",
"nullable": true,
"description": "クエリ。クエリを使用して転送する場合に指定します。\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\n複数カラムが指定されている場合はカンマ区切りで指定してください (例: `123,2026-01-01T00:00:00.000000`)。\nDATE型・TIMESTAMP型のカラムの値は `yyyy-MM-ddTHH:mm:ss.SSSSSS` の形式で指定してください。\nNUMBER型のカラムを増分データを判別するカラムに使う場合は、input_option_column_options で該当カラムを string に指定してください。\n空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。\n"
},
"source_time_zone": {
"type": "string",
"nullable": true,
"description": "取り込み時のデフォルトタイムゾーン。列がタイムゾーン情報を持たない場合(例:DATE型・TIMESTAMP型)、どのタイムゾーンの日時として取り込むかを指定します。未指定の場合は、転送を実行するマシンのタイムゾーンとして解釈されます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_column_options": {
"allOf": [
{
"title": "OracleInputOptionColumnOption",
"type": "object",
"description": "取り込みデータ型指定 (NUMBER型など、精度が高くdouble/longで扱うと有効桁数を超えるカラムをstring型として取り込むための設定)\n",
"properties": {
"column_name": {
"type": "string",
"description": "対象のカラム名",
"example": "amount"
},
"column_value_type": {
"type": "string",
"enum": [
"string"
],
"description": "変換後のデータ型",
"example": "string"
}
},
"required": [
"column_name",
"column_value_type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "OracleInputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
},
"format": {
"type": "string",
"nullable": true,
"description": "カラムのフォーマット (type が timestamp の場合に指定)",
"example": "%Y/%m/%d %H:%M:%S"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "カラムのタイムゾーン (type が timestamp の場合に指定)",
"example": "Asia/Tokyo"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"oracle_connection_id",
"input_option_columns"
]
}
]
},
"facebook_ads_insights_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "FacebookAdsInsightsInputOptionInput",
"type": "object",
"description": "転送元Facebook Ad Insightsでの入力オプション\n",
"properties": {
"facebook_ads_insights_connection_id": {
"description": "Facebook Ad Insightsの接続情報のID\n",
"type": "integer"
},
"ad_account_id": {
"description": "Facebook広告アカウントID\n",
"type": "string"
},
"level": {
"description": "データ取得レベル\n",
"type": "string",
"enum": [
"account",
"campaign",
"adset",
"ad"
]
},
"time_range_since": {
"description": "期間開始日付(YYYY-MM-DD形式)\n",
"type": "string"
},
"time_range_until": {
"description": "期間終了日付(YYYY-MM-DD形式)\n",
"type": "string"
},
"use_unified_attribution_setting": {
"description": "統一アトリビューション設定の使用\n",
"type": "boolean",
"default": true
},
"fields": {
"description": "メトリクス・フィールド配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "フィールド名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"breakdowns": {
"description": "ブレークダウン配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "ブレークダウン名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"action_attribution_windows": {
"description": "アクション・アトリビューション・ウィンドウ配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "アトリビューション・ウィンドウ名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"action_breakdowns": {
"description": "アクション・ブレークダウン配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "アクション・ブレークダウン名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"facebook_ads_insights_connection_id",
"ad_account_id",
"level",
"time_range_since",
"time_range_until",
"fields"
]
}
]
},
"custom_connector_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "CustomConnectorInputOptionInput",
"type": "object",
"description": "転送元カスタムコネクタでの入力オプション。\nurl・認証情報・エンドポイントパス・ページネーション設定等は custom_connector_endpoint_id が参照する\nコネクタ定義からのスナップショットとして自動設定されるため、リクエストで指定することはできません。\n作成・更新のたびに最新の定義内容で再スナップショットされます。\n",
"properties": {
"custom_connector_endpoint_id": {
"description": "参照するカスタムコネクタのエンドポイントID\n",
"type": "integer"
},
"custom_connector_connection_id": {
"description": "接続情報ID\n",
"type": "integer"
},
"query_parameters": {
"description": "クエリパラメータの値。エンドポイント定義で編集可能と設定されたパラメータのみ指定できます。\n未知の名前、または編集不可のパラメータを指定した場合はエラーになります。\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"description": "パラメータ名\n",
"type": "string"
},
"value": {
"description": "パラメータ値\n",
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"headers": {
"description": "リクエストヘッダの値。エンドポイント定義で編集可能と設定されたヘッダのみ指定できます。\n未知の名前、または編集不可のヘッダを指定した場合はエラーになります。\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"description": "ヘッダ名\n",
"type": "string"
},
"value": {
"description": "ヘッダ値\n",
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"path_parameters": {
"description": "パスパラメータの値。名前はエンドポイントのパスに含まれるプレースホルダ名と一致させる必要があります。\n未入力の場合URLパスにプレースホルダがそのまま残りリクエストが失敗するため、\nエンドポイントのパスに含まれる全てのプレースホルダについて値の指定が必須です。\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"description": "パスパラメータ名(エンドポイントパスのプレースホルダ名)\n",
"type": "string"
},
"value": {
"description": "パスパラメータ値\n",
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"request_body_parameters": {
"description": "リクエストボディパラメータの値。エンドポイント定義で編集可能と設定されたパラメータのみ指定できます。\n未知の名前、または編集不可のパラメータを指定した場合はエラーになります。\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"description": "パラメータ名\n",
"type": "string"
},
"value": {
"description": "パラメータ値\n",
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"jsonpath_parser": {
"description": "JsonPathのパース設定。`root`はエンドポイント定義から自動設定されるため、指定しても無視されます。\n",
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"custom_connector_endpoint_id",
"custom_connector_connection_id",
"jsonpath_parser"
]
}
]
},
"backlog_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BacklogInputOptionInput",
"type": "object",
"description": "転送元Backlogの入力オプション\n",
"properties": {
"backlog_connection_id": {
"type": "integer",
"description": "Backlog接続情報"
},
"path": {
"type": "string",
"description": "取得対象エンドポイント\n\nAvailable values (12):\n - api/v2/space/activities: 最近の更新\n - api/v2/users: ユーザー一覧\n - api/v2/projects: プロジェクト一覧\n - api/v2/projects/path_parameter__project_id_or_key/users: プロジェクトユーザー一覧\n - api/v2/projects/path_parameter__project_id_or_key/administrators: プロジェクト管理者一覧\n - api/v2/projects/path_parameter__project_id_or_key/webhooks: Webhook一覧\n - api/v2/issues: 課題一覧\n - api/v2/issues/path_parameter__issue_id_or_key/comments: 課題コメント\n - api/v2/wikis: Wikiページ一覧\n - api/v2/projects/path_parameter__project_id_or_key/git/repositories: Gitリポジトリ一覧\n - api/v2/projects/path_parameter__project_id_or_key/git/repositories/path_parameter__repo_id_or_name/pullRequests: プルリクエスト一覧\n - api/v2/teams: チーム一覧\n",
"example": "api/v2/space/activities"
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
},
"parameter__activityTypeId": {
"type": "array",
"nullable": true,
"description": "活動の種別(複数指定可)\n1=課題の追加, 2=課題の更新, 3=課題にコメント, 4=課題の削除, 5=Wikiを追加,\n6=Wikiを更新, 7=Wikiを削除, 8=共有ファイルを追加, 9=共有ファイルを更新,\n10=共有ファイルを削除, 11=Subversionコミット, 12=GITプッシュ, 13=GITリポジトリ作成,\n14=課題をまとめて更新, 15=プロジェクトに参加, 16=プロジェクトから脱退,\n17=コメントにお知らせを追加, 18=プルリクエストの追加, 19=プルリクエストの更新,\n20=プルリクエストにコメント, 21=プルリクエストの削除, 22=マイルストーンの追加,\n23=マイルストーンの更新, 24=マイルストーンの削除, 25=グループがプロジェクトに参加,\n26=グループがプロジェクトから脱退\n\n適用エンドポイント:\n - api/v2/space/activities: 最近の更新(任意)\n",
"items": {
"type": "string",
"pattern": "^[0-9]+$"
}
},
"path_parameter__project_id_or_key": {
"type": "string",
"description": "プロジェクトのIDまたはプロジェクトキー\n\n適用エンドポイント:\n - api/v2/projects/path_parameter__project_id_or_key/users: プロジェクトユーザー一覧(必須)\n - api/v2/projects/path_parameter__project_id_or_key/administrators: プロジェクト管理者一覧(必須)\n - api/v2/projects/path_parameter__project_id_or_key/webhooks: Webhook一覧(必須)\n - api/v2/projects/path_parameter__project_id_or_key/git/repositories: Gitリポジトリ一覧(必須)\n - api/v2/projects/path_parameter__project_id_or_key/git/repositories/path_parameter__repo_id_or_name/pullRequests: プルリクエスト一覧(必須)\n",
"pattern": "[A-Z0-9_]+",
"example": "1"
},
"parameter__projectId": {
"type": "array",
"nullable": true,
"description": "プロジェクトID(複数指定可)\n\n適用エンドポイント:\n - api/v2/issues: 課題一覧(任意)\n",
"items": {
"type": "string",
"pattern": "^[0-9]+$"
},
"example": [
"123"
]
},
"parameter__createdSince": {
"type": "string",
"nullable": true,
"description": "登録日(開始)\n\n適用エンドポイント:\n - api/v2/issues: 課題一覧(任意)\n",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"example": "2020-04-15"
},
"parameter__createdUntil": {
"type": "string",
"nullable": true,
"description": "登録日(終了)\n\n適用エンドポイント:\n - api/v2/issues: 課題一覧(任意)\n",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"example": "2020-04-30"
},
"parameter__updatedSince": {
"type": "string",
"nullable": true,
"description": "更新日(開始)\n\n適用エンドポイント:\n - api/v2/issues: 課題一覧(任意)\n",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"example": "2020-04-15"
},
"parameter__updatedUntil": {
"type": "string",
"nullable": true,
"description": "更新日(終了)\n\n適用エンドポイント:\n - api/v2/issues: 課題一覧(任意)\n",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"example": "2020-04-30"
},
"path_parameter__issue_id_or_key": {
"type": "string",
"description": "課題のIDまたは課題キー\n\n適用エンドポイント:\n - api/v2/issues/path_parameter__issue_id_or_key/comments: 課題コメント(必須)\n",
"pattern": "[0-9]+",
"example": "6586"
},
"parameter__project_id_or_key": {
"type": "string",
"description": "プロジェクトのIDまたはプロジェクトキー\n\n適用エンドポイント:\n - api/v2/wikis: Wikiページ一覧(必須)\n",
"pattern": "[A-Z0-9_]+",
"example": "1"
},
"path_parameter__repo_id_or_name": {
"type": "string",
"description": "リポジトリのIDまたはリポジトリ名\n\n適用エンドポイント:\n - api/v2/projects/path_parameter__project_id_or_key/git/repositories/path_parameter__repo_id_or_name/pullRequests: プルリクエスト一覧(必須)\n",
"example": "5"
}
},
"required": [
"backlog_connection_id",
"path"
]
}
]
},
"kaonavi_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "KaonaviInputOptionInput",
"type": "object",
"description": "転送元カオナビの入力オプション\n",
"properties": {
"kaonavi_connection_id": {
"type": "integer",
"description": "カオナビ接続情報"
},
"path": {
"type": "string",
"description": "取得対象エンドポイント\n\nAvailable values (10):\n - api/v2/member_layouts: メンバー情報レイアウト設定\n - api/v2/sheet_layouts: シート情報レイアウト設定\n - api/v2/members: メンバー情報\n - api/v2/sheets/path_parameter__sheet_id: シート情報\n - api/v2/departments: 所属ツリー\n - api/v2/users: ユーザー情報\n - api/v2/roles: ロール情報\n - api/v2/advanced_permissions/path_parameter__advanced_type: 拡張アクセス設定\n - api/v2/enum_options: マスター情報\n - api/v2/webhook: Webhook設定\n",
"example": "api/v2/member_layouts"
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
},
"path_parameter__sheet_id": {
"type": "string",
"description": "シートID\n\n適用エンドポイント:\n - api/v2/sheets/path_parameter__sheet_id: シート情報(必須)\n",
"pattern": "[0-9]+",
"example": "1"
},
"path_parameter__advanced_type": {
"type": "string",
"description": "拡張アクセス設定の種別\n\n適用エンドポイント:\n - api/v2/advanced_permissions/path_parameter__advanced_type: 拡張アクセス設定(必須)\n",
"pattern": "^(member|department)$"
}
},
"required": [
"kaonavi_connection_id",
"path"
]
}
]
},
"smart_hr_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SmartHrInputOptionInput",
"type": "object",
"description": "転送元SmartHRの入力オプション\n",
"properties": {
"smart_hr_connection_id": {
"type": "integer",
"description": "SmartHR接続情報"
},
"path": {
"type": "string",
"description": "取得対象エンドポイント\n\nAvailable values (15):\n - api/v1/crews: 従業員一覧\n - api/v1/biz_establishments: 事業所一覧\n - api/v1/employment_types: 雇用形態一覧\n - api/v1/grades: 等級一覧\n - api/v1/job_categories: 職種一覧\n - api/v1/payment_periods: 給与支給形態一覧\n - api/v1/job_titles: 役職一覧\n - api/v1/crews/path_parameter__crew_id/maternity_childcare_leaves: 産休育休情報一覧\n - api/v1/departments: 部署一覧\n - api/v1/users: ユーザー一覧\n - api/v1/companies: 会社情報一覧\n - api/v1/payrolls: 給与一覧\n - api/v1/payrolls/path_parameter__payroll_id/payslips: 給与明細一覧\n - api/v1/tax_withholdings: 源泉徴収一覧\n - api/v1/tax_withholdings/path_parameter__tax_withholding_id/tax_withholding_slips: 源泉徴収票一覧\n",
"example": "api/v1/crews"
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
},
"path_parameter__crew_id": {
"type": "string",
"description": "従業員ID\n\n適用エンドポイント:\n - api/v1/crews/path_parameter__crew_id/maternity_childcare_leaves: 産休育休情報一覧(必須)\n"
},
"path_parameter__payroll_id": {
"type": "string",
"description": "給与ID\n\n適用エンドポイント:\n - api/v1/payrolls/path_parameter__payroll_id/payslips: 給与明細一覧(必須)\n"
},
"path_parameter__tax_withholding_id": {
"type": "string",
"description": "源泉徴収ID\n\n適用エンドポイント:\n - api/v1/tax_withholdings/path_parameter__tax_withholding_id/tax_withholding_slips: 源泉徴収票一覧(必須)\n"
}
},
"required": [
"smart_hr_connection_id",
"path"
]
}
]
},
"bakuraku_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BakurakuInputOptionInput",
"type": "object",
"description": "転送元バクラクの入力オプション\n",
"properties": {
"bakuraku_connection_id": {
"type": "integer",
"description": "バクラク接続情報"
},
"path": {
"type": "string",
"description": "取得対象エンドポイント\n\nAvailable values (6):\n - rest/v1/workflow/requests: 申請一覧\n - rest/v1/workflow/requests/path_parameter__id: 申請詳細\n - rest/v1/id/user_affiliations: 所属一覧\n - rest/v1/id/users: ユーザー情報一覧\n - rest/v1/id/positions: 役職一覧\n - rest/v1/id/groups: チーム一覧\n",
"example": "rest/v1/workflow/requests"
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
},
"parameter__approvedAtFrom": {
"type": "string",
"nullable": true,
"description": "承認日時(開始)\n\n適用エンドポイント:\n - rest/v1/workflow/requests: 申請一覧(任意)\n",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[+-]\\d{2}:\\d{2}$",
"example": "2019-12-31T15:00:00+00:00"
},
"parameter__approvedAtTo": {
"type": "string",
"nullable": true,
"description": "承認日時(終了)\n\n適用エンドポイント:\n - rest/v1/workflow/requests: 申請一覧(任意)\n",
"pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[+-]\\d{2}:\\d{2}$",
"example": "2019-12-31T15:00:00+00:00"
},
"path_parameter__id": {
"type": "string",
"description": "ID\n\n適用エンドポイント:\n - rest/v1/workflow/requests/path_parameter__id: 申請詳細(必須)\n",
"example": "01J1S6169GTP0QS6F6MHHNVSP3"
}
},
"required": [
"bakuraku_connection_id",
"path"
]
}
]
},
"pagerduty_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "PagerdutyInputOptionInput",
"type": "object",
"description": "転送元PagerDutyの入力オプション\n",
"properties": {
"pagerduty_connection_id": {
"type": "integer",
"description": "PagerDuty接続情報"
},
"path": {
"type": "string",
"description": "取得対象エンドポイント\n\nAvailable values (9):\n - oncalls: オンコール担当\n - incidents: インシデント\n - users: ユーザー\n - schedules: スケジュール\n - teams: チーム\n - services: サービス\n - log_entries: ログエントリー\n - escalation_policies: エスカレーションポリシー\n - priorities: プライオリティー\n",
"example": "oncalls"
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
},
"parameter__earliest": {
"type": "boolean",
"nullable": true,
"description": "最も早い時間\n\n適用エンドポイント:\n - oncalls: オンコール担当(任意)\n"
},
"parameter__since": {
"type": "string",
"nullable": true,
"description": "開始日時\n\n適用エンドポイント:\n - oncalls: オンコール担当(任意)\n - incidents: インシデント(任意)\n - log_entries: ログエントリー(任意)\n",
"example": "2023-01-01T00:00:00Z"
},
"parameter__until": {
"type": "string",
"nullable": true,
"description": "終了日時\n\n適用エンドポイント:\n - oncalls: オンコール担当(任意)\n - incidents: インシデント(任意)\n - log_entries: ログエントリー(任意)\n",
"example": "2023-01-31T23:59:59Z"
}
},
"required": [
"pagerduty_connection_id",
"path"
]
}
]
}
}
}
]
},
"output_option_type": {
"description": "転送先の種別\n作成可能なコネクタには限りがあります。詳しくはenum部分を参照ください。\n",
"type": "string",
"enum": [
"bigquery",
"braze",
"snowflake",
"salesforce",
"google_spreadsheets",
"google_ads_customer_match",
"databricks",
"kintone",
"s3",
"sftp",
"yahoo_display_ads_audience_list",
"postgresql",
"mysql",
"hubspot",
"google_drive",
"gcs",
"facebook_custom_audience",
"redshift",
"custom_connector"
]
},
"output_option": {
"type": "object",
"allOf": [
{
"title": "OutputOptionCreateInput",
"type": "object",
"description": "転送先の設定内容\n",
"properties": {
"bigquery_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BigQueryInputOption",
"type": "object",
"description": "転送先BigQueryの設定内容\n",
"properties": {
"dataset": {
"type": "string",
"description": "データセット名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"mode": {
"type": "string",
"enum": [
"append",
"append_direct",
"replace",
"delete_in_advance",
"merge"
],
"description": "転送モード\n",
"default": "append"
},
"location": {
"type": "string",
"description": "データセットのロケーション\n",
"default": "US"
},
"auto_create_dataset": {
"type": "boolean",
"description": "データセットの自動生成オプション\n",
"default": false
},
"open_timeout_sec": {
"type": "integer",
"description": "接続開始までのタイムアウト (秒)\n",
"default": 300
},
"timeout_sec": {
"type": "integer",
"description": "タイムアウト (秒)\n",
"default": 300
},
"send_timeout_sec": {
"type": "integer",
"description": "送信タイムアウト (秒)\n",
"default": 300
},
"read_timeout_sec": {
"type": "integer",
"description": "読込タイムアウト (秒)\n",
"default": 300
},
"retries": {
"type": "integer",
"description": "再試行回数\n",
"default": 5
},
"partitioning_type": {
"type": "string",
"enum": [
"ingestion_time",
"time_unit_column"
],
"description": "パーティショニング\nnull: パーティションなし\ningestion_time: 取り込み時間により分割\ntime_unit_column: フィールドにより分割\n",
"nullable": true
},
"time_partitioning_type": {
"type": "string",
"enum": [
"HOUR",
"DAY",
"MONTH",
"YEAR"
],
"description": "パーティションタイプ\n",
"nullable": true
},
"time_partitioning_field": {
"type": "string",
"description": "パーティションフィールド\n分割の基準として用いるフィールドを、DATE, TIMESTAMP, DATETIMEのいずれかの型のフィールドから指定してください。\n",
"nullable": true
},
"time_partitioning_expiration_ms": {
"type": "integer",
"description": "パーティションの存続期間\nパーティションの存続期間 (ミリ秒) です。最小値はありません。パーティションの日付にこの整数値を足した値が有効期限になります。デフォルト値は指定なし (永久に保存) です。\n",
"nullable": true
},
"template_table": {
"type": "string",
"description": "スキーマ情報をテンプレートとして参照するテーブル\nこのテーブルのスキーマ情報からGoogle BigQueryへの取り込み時のスキーマ情報を生成します\n",
"nullable": true
},
"retain_column_descriptions": {
"type": "boolean",
"description": "転送モードで全件洗い替え (REPLACE)を選択したときにテーブル再作成時にカラムの説明(Description)を保持するかどうか\n",
"nullable": true
},
"retain_column_policy_tags": {
"type": "boolean",
"description": "転送モードで全件洗い替え (REPLACE)を選択したときにテーブル再作成時にカラムのポリシータグ(Policy Tag)を保持するかどうか\n",
"nullable": true
},
"bigquery_connection_id": {
"type": "string",
"description": "BigQuery接続情報ID\n"
},
"bigquery_output_option_column_options": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BOOLEAN",
"INTEGER",
"FLOAT",
"STRING",
"TIMESTAMP",
"DATETIME",
"DATE",
"RECORD",
"NUMERIC",
"JSON"
],
"description": "データ型\n"
},
"mode": {
"type": "string",
"enum": [
"NULLABLE",
"REQUIRED",
"REPEATED"
],
"description": "モード\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
},
"description": {
"nullable": true,
"type": "string",
"description": "説明\n"
},
"fields": {
"type": "array",
"nullable": true,
"description": "ネストされたフィールド定義(typeがRECORDの場合に指定)。最大3レベルまでネスト可能。\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィールド名\n"
},
"type": {
"type": "string",
"enum": [
"BOOLEAN",
"INTEGER",
"FLOAT",
"STRING",
"TIMESTAMP",
"DATETIME",
"DATE",
"RECORD",
"NUMERIC",
"JSON"
],
"description": "データ型\n"
},
"mode": {
"type": "string",
"enum": [
"NULLABLE",
"REQUIRED",
"REPEATED"
],
"description": "モード\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
},
"description": {
"type": "string",
"nullable": true,
"description": "説明\n"
},
"fields": {
"type": "array",
"nullable": true,
"description": "さらにネストされたフィールド定義(最大3レベル)\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"name",
"type",
"mode"
]
}
},
"bigquery_output_option_clustering_fields": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "クラスタリング化列\nクラスタリングはテーブル新規作成時のみ設定できます。クラスタ化列は最大で4つ指定できます。\n"
},
"bigquery_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"dataset",
"table",
"bigquery_connection_id"
]
}
]
},
"braze_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BrazeOutputOption",
"type": "object",
"description": "転送先Brazeの設定内容\n",
"properties": {
"braze_connection_id": {
"type": "integer",
"description": "Braze接続情報ID\n"
},
"object_type": {
"type": "string",
"description": "オブジェクト\n- `attributes`: user attributes\n- `events`: events\n- `purchases`: purchases\n",
"enum": [
"attributes",
"events",
"purchases"
]
}
},
"required": [
"braze_connection_id",
"object_type"
]
}
]
},
"snowflake_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SnowflakeInputOption",
"type": "object",
"description": "転送先Snowflakeの設定内容\n",
"properties": {
"warehouse": {
"type": "string",
"description": "ウェアハウス名\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge"
],
"description": "転送モード\n",
"default": "insert"
},
"empty_field_as_null": {
"type": "boolean",
"description": "空文字をNULLに置換するかどうか\n",
"default": true
},
"delete_stage_on_error": {
"type": "boolean",
"description": "エラー時に一時ステージを削除するかどうか\n",
"default": false
},
"escape_with_enclosing": {
"type": "boolean",
"description": "データ内の改行・タブ文字を保持するかどうか\n",
"default": false
},
"batch_size": {
"type": "integer",
"description": "バッチサイズ (MB)\n",
"default": 50
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n",
"default": 12
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n",
"default": 1000
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n再試行時の待ち時間の上限\n",
"default": 1800000
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "UTC"
},
"snowflake_connection_id": {
"type": "integer",
"description": "Snowflake接続情報ID\n"
},
"snowflake_output_option_column_options": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BIGINT",
"INTEGER",
"VARCHAR",
"STRING",
"BOOLEAN",
"DOUBLE",
"DOUBLE PRECISION",
"DATE",
"DATETIME",
"TIMESTAMP",
"TIME",
"VARIANT",
"OBJECT",
"ARRAY",
"NUMBER"
],
"description": "データ型\n"
},
"value_type": {
"type": "string",
"enum": [
"byte",
"short",
"int",
"long",
"double",
"float",
"boolean",
"string",
"nstring",
"date",
"time",
"timestamp",
"decimal",
"json",
"null"
],
"description": "value type\nもし、デフォルト値を設定したい場合、value_typeは設定しないでください。\n詳細: https://documents.trocco.io/docs/data-destination-snowflake\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
},
"snowflake_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"warehouse",
"database",
"schema",
"table",
"snowflake_connection_id"
]
}
]
},
"salesforce_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SalesforceOutputOption",
"type": "object",
"description": "転送先Salesforceの設定内容\n",
"properties": {
"object": {
"type": "string",
"description": "オブジェクト名\n"
},
"action_type": {
"type": "string",
"description": "転送モード\n",
"enum": [
"insert",
"upsert",
"update",
"delete"
],
"default": "insert"
},
"api_version": {
"type": "string",
"description": "Salesforce APIバージョン\n",
"default": "64.0"
},
"upsert_key": {
"type": "string",
"description": "Upsertキー\n転送モードにUPSERTを選択した場合はキーとなるカラム名を入力してください。\n"
},
"update_key": {
"type": "string",
"description": "更新キー\n転送モードにUPDATEを選択した場合はキーとなるカラム名を入力してください。\n"
},
"delete_key": {
"type": "string",
"description": "削除キー\n転送モードにDELETEを選択した場合、削除対象を特定するキーとなる転送元データのカラム名を入力してください。\n「Id」(デフォルト)の場合はそのカラムの値をSalesforceレコードId(SFID)として直接削除します。\nそれ以外のSalesforceフィールド名を指定した場合は、その値をキーにSOQLでレコードIdを解決してから削除します。\n未指定の場合は「Id」カラムが使用されます。\n"
},
"ignore_nulls": {
"type": "boolean",
"description": "NULLを含む場合の更新処理\ntrueの場合更新をスキップします\nfalseの場合、NULLで更新します\n",
"default": false
},
"throw_if_failed": {
"type": "boolean",
"description": "送信できなかったレコードがある場合のステータス\ntrueの場合、Errorにします\nfalseの場合、Succeededにします。\n",
"default": true
},
"batch_size": {
"type": "integer",
"description": "1回のAPIコールあたりのレコード数(1〜200)\n",
"default": 200,
"minimum": 1,
"maximum": 200
},
"salesforce_connection_id": {
"type": "integer",
"description": "Salesforce接続情報ID\n"
},
"associations": {
"type": "array",
"description": "他オブジェクトへの関連付け設定\n\n参照関係フィールドに外部IDを使ってレコードを関連付けるための設定です\n",
"items": {
"type": "object",
"required": [
"reference_field",
"referenced_object",
"unique_key",
"source_column"
],
"properties": {
"reference_field": {
"type": "string",
"description": "参照関係フィールド名(例: AccountId)\n"
},
"referenced_object": {
"type": "string",
"description": "参照先オブジェクト名(例: Account)\n"
},
"unique_key": {
"type": "string",
"description": "参照先オブジェクトのユニークキー(例: External_Id__c)\n"
},
"source_column": {
"type": "string",
"description": "転送データ側のカラム名(例: account_code)\n"
}
}
}
},
"auto_remove_deleted_columns": {
"type": "boolean",
"description": "転送先から削除されたカラムをSTEP2から自動削除するか\n",
"default": false
}
},
"required": [
"object",
"salesforce_connection_id"
]
}
]
},
"google_spreadsheets_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleSpreadsheetsOutputOption",
"type": "object",
"description": "転送先Google Spreadsheetsの設定内容\n",
"properties": {
"google_spreadsheets_connection_id": {
"type": "string",
"description": "Google Spreadsheets接続情報ID\n"
},
"spreadsheets_id": {
"type": "string",
"description": "シートID\n"
},
"worksheet_title": {
"type": "string",
"description": "シート名\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"example": "Asia/Tokyo"
},
"value_input_option": {
"type": "string",
"description": "値の入力方法\n- `RAW`: セルの書式設定を適用しない\n- `USER_ENTERED`: セルの書式設定を適用する\n",
"enum": [
"RAW",
"USER_ENTERED"
]
},
"mode": {
"type": "string",
"description": "転送モード\n- `replace`: 全件洗い替え (シート作り直し)\n- `append`: 追記 (APPEND)\n- `truncate_insert`: 全件洗い替え (既存シート引き継ぎ)\n",
"enum": [
"replace",
"append",
"truncate_insert"
]
},
"start_row": {
"type": "integer",
"default": 1,
"description": "出力開始行。\n見出しを書き込む最初の行を入力してください。データはその次の行から書き込まれます。\n"
},
"start_column": {
"type": "string",
"default": "A",
"description": "出力開始列。\n書き込みを開始する列をアルファベットで入力してください。\n"
},
"google_spreadsheets_output_option_sorts": {
"type": "array",
"description": "データ順序\n",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string",
"description": "ソートキー名\n"
},
"order": {
"type": "string",
"description": "ソート順\n",
"enum": [
"ascending",
"descending"
]
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"google_spreadsheets_connection_id",
"spreadsheets_id",
"timezone",
"value_input_option",
"mode"
]
}
]
},
"google_ads_customer_match_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleAdsCustomerMatchInputOption",
"type": "object",
"description": "転送先Google Ads Customer Matchの設定内容\n",
"properties": {
"google_ads_connection_id": {
"type": "integer",
"description": "Google Ads接続情報ID\n"
},
"app_id": {
"type": "string",
"nullable": true,
"description": "モバイル デバイス ID\nupload_key_type が mobile_advertising_id の場合は必須\n"
},
"customer_id": {
"type": "string",
"description": "お客様 ID\n"
},
"upload_key_type": {
"type": "string",
"enum": [
"contact_info",
"crm_id",
"mobile_advertising_id"
],
"description": "データの種類\n",
"default": "contact_info"
},
"user_list_name": {
"type": "string",
"description": "顧客リスト名\n"
},
"description": {
"type": "string",
"nullable": true,
"description": "説明文\n"
},
"operation": {
"type": "string",
"enum": [
"insert",
"truncate_insert"
],
"description": "転送モード\n",
"default": "insert"
},
"wait_for_completion": {
"type": "boolean",
"description": "カスタマーマッチの作成および更新完了まで待つ\n",
"default": false
},
"member_ship_duration": {
"type": "integer",
"description": "有効期間(日)\n"
},
"ad_user_data_consent": {
"type": "string",
"enum": [
"unspecified",
"granted",
"denied"
],
"description": "広告ユーザーデータに関する同意\n",
"default": "granted"
},
"ad_personalization_consent": {
"type": "string",
"enum": [
"unspecified",
"granted",
"denied"
],
"description": "広告のパーソナライズに対する同意\n",
"default": "granted"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"google_ads_connection_id",
"customer_id",
"user_list_name"
]
}
]
},
"yahoo_display_ads_audience_list_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "YahooDisplayAdsAudienceListInputOption",
"type": "object",
"description": "転送先Yahoo!広告 ディスプレイ広告 オーディエンスリストの設定内容\n",
"properties": {
"yahoo_ads_api_connection_id": {
"type": "integer",
"description": "Yahoo!広告 API接続情報ID\n"
},
"base_account_id": {
"type": "string",
"description": "ベースアカウントID\n"
},
"account_id": {
"type": "string",
"description": "アカウントID\n"
},
"audience_list_name": {
"type": "string",
"description": "オーディエンスリスト名\n"
},
"description": {
"type": "string",
"nullable": true,
"description": "オーディエンスリストの説明\n"
},
"upload_type": {
"type": "string",
"enum": [
"mail_address_and_phone_number",
"idfa",
"aaid"
],
"description": "連携データタイプ\n",
"default": "mail_address_and_phone_number"
},
"mode": {
"type": "string",
"enum": [
"insert",
"truncate_insert"
],
"description": "転送モード\n",
"default": "insert"
},
"wait_for_completion": {
"type": "boolean",
"description": "データのアップロード完了まで待つ\n",
"default": false
},
"data_duration": {
"type": "integer",
"description": "データの有効期間(日)\n",
"default": 60
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"yahoo_ads_api_connection_id",
"base_account_id",
"account_id",
"audience_list_name",
"upload_type",
"mode",
"wait_for_completion",
"data_duration"
]
}
]
},
"s3_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "S3OutputOption",
"type": "object",
"description": "転送先Amazon S3の設定内容\n",
"properties": {
"s3_connection_id": {
"type": "integer",
"description": "Amazon S3接続情報\n"
},
"region": {
"type": "string",
"enum": [
"ap-east-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"me-south-1",
"sa-east-1",
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2"
],
"description": "リージョン\n",
"default": "ap-northeast-1"
},
"bucket": {
"type": "string",
"description": "バケット\n"
},
"path_prefix": {
"type": "string",
"description": "パスプレフィックス\n"
},
"file_ext": {
"type": "string",
"description": "出力ファイルの拡張子\n",
"default": ".csv"
},
"canned_acl": {
"type": "string",
"enum": [
"NOT_SET",
"Private",
"PublicRead",
"PublicReadWrite",
"AwsExecRead",
"AuthenticatedRead",
"BucketOwnerRead",
"BucketOwnerFullControl",
"LogDeliveryWrite"
],
"description": "アクセスコントロールリスト\n",
"default": "NOT_SET"
},
"formatter_type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "出力ファイル形式(csv または jsonl)\n新規作成時には必須です。\n`formatter_type: csv` の場合、`csv_formatter` を必ず指定し、`jsonl_formatter` は指定しないでください。\n`formatter_type: jsonl` の場合、`jsonl_formatter` を必ず指定し、`csv_formatter` は指定しないでください。\n更新時に `formatter_type` が省略された場合、既存の設定が引き継がれます。\n"
},
"encoder_type": {
"type": "string",
"enum": [
"",
"gzip",
"bzip2",
"zip"
],
"description": "ファイル圧縮\n新規作成時は必須です。\n`\"gzip\"`、`\"bzip2\"`、`\"zip\"` を指定すると各圧縮形式が使用されます。\n空文字(`\"\"`)の場合は、圧縮なしとして扱われます。\n"
},
"is_minimum_output_tasks": {
"type": "boolean",
"description": "出力ファイル数抑制モード\ntrueの場合出力ファイル数抑制転送、falseの場合並列転送になります。\n出力ファイル数抑制転送を選択した場合、内部的には並列処理を抑えてファイル生成を行います。転送元が1ファイルの場合、転送先には1ファイルで生成されます。\n",
"default": false
},
"multipart_upload_enabled": {
"type": "boolean",
"description": "マルチパートアップロード\n5GB以上のファイルを転送する場合は、マルチパートアップロードを有効にしてください。\n有効にする場合、稀に不完全なパートファイルがS3に残ることがあります。そのため、バケットライフサイクル設定を行うことを推奨します。\n",
"default": false
},
"sequence_format": {
"type": "string",
"description": "複数ファイル出力時の命名規則\n",
"default": "%03d.%02d"
},
"csv_formatter": {
"type": "object",
"nullable": true,
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
"jsonl_formatter": {
"type": "object",
"nullable": true,
"description": "JSON Lines出力設定\n`formatter_type` が `\"jsonl\"` の場合にのみ指定できます。\n`formatter_type` が `\"jsonl\"` の場合、この項目は **新規作成時に必須**です。\n`formatter_type` が `\"csv\"` の場合は指定しないでください。\n",
"properties": {
"encoding": {
"type": "string",
"description": "文字エンコーディング\n",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"default": "UTF-8"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字\n",
"default": "LF"
},
"date_format": {
"type": "string",
"description": "日付のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"s3_connection_id",
"bucket",
"path_prefix",
"file_ext",
"canned_acl",
"is_minimum_output_tasks",
"multipart_upload_enabled",
"encoder_type",
"formatter_type"
]
}
]
},
"sftp_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SftpOutputOption",
"type": "object",
"description": "転送先Amazon Sftpの設定内容\n",
"properties": {
"sftp_connection_id": {
"type": "integer",
"description": "Amazon Sftp接続情報\n"
},
"path_prefix": {
"type": "string",
"description": "パスプレフィックス\n"
},
"file_ext": {
"type": "string",
"description": "出力ファイルの拡張子\n",
"default": ".csv"
},
"formatter_type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "出力ファイル形式(csv または jsonl)\n新規作成時には必須です。\n`formatter_type: csv` の場合、`csv_formatter` を必ず指定し、`jsonl_formatter` は指定しないでください。\n`formatter_type: jsonl` の場合、`jsonl_formatter` を必ず指定し、`csv_formatter` は指定しないでください。\n更新時に `formatter_type` が省略された場合、既存の設定が引き継がれます。\n"
},
"encoder_type": {
"type": "string",
"enum": [
"",
"gzip",
"bzip2",
"zip"
],
"description": "ファイル圧縮\n新規作成時は必須です。\n`\"gzip\"`、`\"bzip2\"`、`\"zip\"` を指定すると各圧縮形式が使用されます。\n空文字(`\"\"`)の場合は、圧縮なしとして扱われます。\n"
},
"is_minimum_output_tasks": {
"type": "boolean",
"description": "出力ファイル数抑制モード\ntrueの場合出力ファイル数抑制転送、falseの場合並列転送になります。\n出力ファイル数抑制転送を選択した場合、内部的には並列処理を抑えてファイル生成を行います。転送元が1ファイルの場合、転送先には1ファイルで生成されます。\n",
"default": false
},
"sequence_format": {
"type": "string",
"description": "複数ファイル出力時の命名規則\n",
"default": "%03d.%02d"
},
"csv_formatter": {
"allOf": [
{
"title": "CsvFormatter",
"type": "object",
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"bom": {
"type": "boolean",
"description": "BOM\n",
"default": false
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
{
"nullable": true
}
]
},
"jsonl_formatter": {
"allOf": [
{
"title": "JsonlFormatter",
"type": "object",
"description": "JSON Lines出力設定\n`formatter_type` が `\"jsonl\"` の場合にのみ指定できます。\n`formatter_type` が `\"jsonl\"` の場合、この項目は **新規作成時に必須**です。\n`formatter_type` が `\"csv\"` の場合は指定しないでください。\n",
"properties": {
"encoding": {
"type": "string",
"description": "文字エンコーディング\n",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"default": "UTF-8"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字\n",
"default": "LF"
},
"date_format": {
"type": "string",
"description": "日付のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"sftp_connection_id",
"path_prefix",
"file_ext",
"is_minimum_output_tasks",
"encoder_type",
"formatter_type"
]
}
]
},
"databricks_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "DatabricksOutputOption",
"type": "object",
"description": "転送先Databricksの設定内容\n",
"properties": {
"databricks_connection_id": {
"type": "integer",
"description": "Databricks接続情報\n"
},
"catalog_name": {
"type": "string",
"description": "カタログ名\n"
},
"schema_name": {
"type": "string",
"description": "スキーマ名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"batch_size": {
"type": "integer",
"description": "バッチサイズ\n",
"default": 10000
},
"mode": {
"type": "string",
"description": "転送モード\n- `insert`: 追記 (APPEND)\n- `insert_direct`: 即時挿入(バッファなしのダイレクト INSERT)\n- `truncate_insert`: 全件洗い替え (既存シート引き継ぎ)\n- `replace`: 全件洗い替え (シート作り直し)\n- `merge`: マージ (UPSERT: 既存は更新、未存在は挿入)\n",
"enum": [
"replace",
"insert",
"insert_direct",
"truncate_insert",
"merge"
]
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "Etc/UTC"
},
"escape_with_enclosing": {
"type": "boolean",
"description": "データ内の改行・タブ・二重引用符を保持するかどうか\n",
"default": false
},
"databricks_output_option_column_options": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BIGINT",
"INT",
"SMALLINT",
"TINYINT",
"STRING",
"BOOLEAN",
"FLOAT",
"DOUBLE",
"DATE",
"TIMESTAMP"
],
"description": "データ型\n"
},
"value_type": {
"type": "string",
"enum": [
"byte",
"short",
"int",
"long",
"double",
"float",
"boolean",
"string",
"nstring",
"date",
"time",
"timestamp",
"decimal",
"json",
"null"
],
"description": "value type\nもし、デフォルト値を設定したい場合、value_typeは設定しないでください。\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
},
"databricks_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"databricks_connection_id",
"catalog_name",
"schema_name",
"table",
"mode"
]
}
]
},
"kintone_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "KintoneOutputOption",
"type": "object",
"description": "転送先kintoneの設定内容\n",
"properties": {
"kintone_connection_id": {
"type": "integer",
"description": "kintone接続情報ID\n"
},
"app_id": {
"type": "string",
"description": "アプリID\n"
},
"guest_space_id": {
"type": "string",
"nullable": true,
"description": "ゲストスペースID\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"update",
"upsert"
],
"description": "転送モード\n",
"default": "insert"
},
"update_key": {
"type": "string",
"nullable": true,
"description": "更新キー\nmode: update or upsertの場合のみ設定できます。\n"
},
"ignore_nulls": {
"type": "boolean",
"description": "NULL値を無視するかどうか\n",
"default": false
},
"reduce_key": {
"type": "string",
"nullable": true,
"description": "重複排除キー\n"
},
"chunk_size": {
"type": "integer",
"description": "チャンクサイズ\n",
"default": 100
},
"kintone_output_option_column_options": {
"type": "array",
"nullable": true,
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"field_code": {
"type": "string",
"description": "フィールドコード\n"
},
"type": {
"type": "string",
"enum": [
"SINGLE_LINE_TEXT",
"MULTI_LINE_TEXT",
"RICH_TEXT",
"NUMBER",
"CHECK_BOX",
"RADIO_BUTTON",
"MULTI_SELECT",
"DROP_DOWN",
"USER_SELECT",
"ORGANIZATION_SELECT",
"GROUP_SELECT",
"DATE",
"TIME",
"DATETIME",
"LINK",
"SUBTABLE"
],
"description": "フィールドタイプ\n"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\ntype: DATE, TIMEの場合のみ設定できます。\n"
},
"sort_column": {
"type": "string",
"nullable": true,
"description": "ソートカラム\ntype: SUBTABLEの場合のみ設定できます。\n"
}
},
"required": [
"name",
"field_code",
"type"
]
}
}
},
"required": [
"kintone_connection_id",
"app_id",
"mode",
"chunk_size",
"ignore_nulls"
]
}
]
},
"postgresql_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "PostgresqlOutputOption",
"type": "object",
"description": "転送先PostgreSQLの設定内容\n",
"properties": {
"postgresql_connection_id": {
"type": "integer",
"description": "PostgreSQL接続情報\n"
},
"database": {
"type": "string",
"description": "データベース\n"
},
"schema": {
"type": "string",
"description": "スキーマ\n",
"default": "public"
},
"table": {
"type": "string",
"description": "テーブル\n入力したテーブルが存在しない場合、自動的に生成されます。\n"
},
"mode": {
"type": "string",
"description": "転送モード\n- `insert`: 追記 (INSERT)\n- `insert_direct`: 追記 (INSERT DIRECT)\n- `truncate_insert`: 全件洗い替え (TRUNCATE INSERT)\n- `replace`: 全件洗い替え (REPLACE)\n- `merge`: UPSERT (MERGE)\n",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge"
]
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\ntimestamp形式のカラムがあった場合は、タイムゾーンを指定可能です。\n",
"default": "UTC"
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n再試行の回数\n",
"default": 12
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n初回再試行時の待ち時間(ミリ秒)\n※再実行が繰り返される度に待ち時間は倍になる\n",
"default": 1000
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n再試行時の待ち時間の上限(ミリ秒)\n",
"default": 1800000
},
"before_load": {
"type": "string",
"description": "ロード前に実行するSQL\n転送前に実行されるクエリ\n※replaceモード以外\n",
"nullable": true
},
"after_load": {
"type": "string",
"description": "ロード後に実行するSQL\n転送後に実行されるクエリ\n",
"nullable": true
},
"merge_keys": {
"type": "array",
"description": "マージキー\nここで指定したカラムの値が転送先テーブルに存在する場合、レコードが上書かれます。\n未指定の場合、転送先テーブル側のプライマリーキーが利用されます。\nmodeが'merge'の場合は必須(空配列も可)\n",
"items": {
"type": "string"
},
"default": []
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"postgresql_connection_id",
"database",
"schema",
"table",
"mode"
]
}
]
},
"mysql_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MysqlInputOption",
"type": "object",
"description": "転送先MySQLの設定内容\n",
"properties": {
"mysql_connection_id": {
"type": "integer",
"description": "MySQL接続情報ID\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge",
"merge_direct"
],
"description": "転送モード\ninsert: 挿入\ninsert_direct: 直接挿入\ntruncate_insert: 切り捨て挿入\nreplace: 置換\nmerge: マージ\nmerge_direct: 直接マージ\n",
"default": "insert"
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n",
"default": 12
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n",
"default": 1000
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n再試行時の待ち時間の上限\n",
"default": 1800000
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "UTC"
},
"before_load": {
"type": "string",
"nullable": true,
"description": "転送前に実行するSQL文\nデータ転送の前に実行するSQL文を指定できます\n"
},
"after_load": {
"type": "string",
"nullable": true,
"description": "転送後に実行するSQL文\nデータ転送の後に実行するSQL文を指定できます\n"
},
"mysql_output_option_column_options": {
"type": "array",
"description": "カラム設定\nカラムごとの型を指定できます\n",
"nullable": true,
"items": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"TINYTEXT",
"TEXT",
"MEDIUMTEXT",
"LONGTEXT",
"DECIMAL",
"DATE",
"DATETIME",
"TIMESTAMP",
"TIME"
],
"description": "カラムの型\nTINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT, DECIMAL, DATE, DATETIME, TIMESTAMP, TIMEから選択\n"
},
"scale": {
"type": "integer",
"description": "DECIMAL型の小数点以下の桁数\ntypeがDECIMALの場合に必須\n0以上の値を指定してください\n",
"minimum": 0
},
"precision": {
"type": "integer",
"description": "DECIMAL型の全体の桁数\ntypeがDECIMALの場合に必須\n0以上の値を指定してください\nprecisionはscaleより大きい値である必要があります\n",
"minimum": 0
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"mysql_connection_id",
"database",
"table",
"mode",
"retry_limit",
"retry_wait",
"max_retry_wait",
"default_time_zone"
]
}
]
},
"hubspot_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "HubspotOutputOption",
"type": "object",
"description": "転送先HubSpotの設定内容\n",
"properties": {
"hubspot_connection_id": {
"type": "integer",
"description": "HubSpot接続情報ID (auth_method が oauth のものに限る)\n"
},
"object_type": {
"type": "string",
"description": "オブジェクトタイプ\ncontact, company, deal, product, ticket, line_item, quote, orders, subscription, call, email, meeting, note, postal_mail, task, またはカスタムオブジェクト\n"
},
"mode": {
"type": "string",
"description": "転送モード\n- `merge`: マージ (UPSERT: 既存は更新、未存在は挿入)\n- `insert`: 追記 (INSERT)\n\n注意: `subscription` オブジェクトの場合、modeは常に `merge` になります\n",
"enum": [
"merge",
"insert"
],
"default": "merge"
},
"upsert_key": {
"type": "string",
"nullable": true,
"description": "マージキー\n\n- modeが `merge` かつ object_typeが `subscription` 以外の場合は必須\n- modeが `insert` の場合は不要(nullに設定されます)\n- object_typeが `subscription` の場合は不要(nullに設定されます)\n"
},
"number_of_parallels": {
"type": "integer",
"description": "並列処理数\n1から10の範囲で指定してください\n",
"minimum": 1,
"maximum": 10,
"default": 1
},
"associations": {
"type": "array",
"description": "アソシエーション設定\n\nエンゲージメントオブジェクト (`call`, `email`, `meeting`, `note`, `postal_mail`, `task`) でのみ使用可能です。\n各オブジェクトタイプがサポートするアソシエーション先:\n- `call`: contact, company, deal, ticket\n- `email`: contact, company, deal, ticket\n- `meeting`: contact, company, deal, ticket\n- `note`: contact, company, deal, ticket\n- `postal_mail`: contact, company, deal, ticket\n- `task`: contact, company, deal, ticket, quote\n",
"items": {
"type": "object",
"required": [
"to_object_type",
"from_object_key",
"to_object_key"
],
"properties": {
"to_object_type": {
"type": "string",
"description": "関連付け先のオブジェクトタイプ\n"
},
"from_object_key": {
"type": "string",
"description": "関連付け元のキー(転送データ内のカラム名)\n"
},
"to_object_key": {
"type": "string",
"description": "関連付け先のキー(HubSpot側のプロパティ名)\n"
}
}
}
},
"auto_remove_deleted_columns": {
"type": "boolean",
"description": "転送先から削除されたカラムをSTEP2から自動削除するか\n",
"default": false
}
},
"required": [
"hubspot_connection_id",
"object_type",
"mode",
"number_of_parallels"
]
}
]
},
"google_drive_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleDriveOutputOption",
"type": "object",
"description": "転送先Google Driveの設定内容\n",
"properties": {
"google_drive_connection_id": {
"type": "integer",
"description": "Google Drive接続情報\n"
},
"main_folder_id": {
"type": "string",
"description": "メインフォルダID\n"
},
"child_folder_name": {
"type": "string",
"nullable": true,
"description": "子フォルダ名\n"
},
"file_name": {
"type": "string",
"description": "ファイル名\n"
},
"formatter_type": {
"type": "string",
"enum": [
"csv"
],
"description": "出力ファイル形式(csv のみ対応)\n新規作成時には必須です。\n更新時に `formatter_type` が省略された場合、既存の設定が引き継がれます。\n"
},
"csv_formatter": {
"allOf": [
{
"title": "CsvFormatter",
"type": "object",
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"bom": {
"type": "boolean",
"description": "BOM\n",
"default": false
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"google_drive_connection_id",
"main_folder_id",
"file_name",
"formatter_type"
]
}
]
},
"gcs_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GcsOutputOption",
"type": "object",
"description": "転送先Google Cloud Storageの設定内容\n",
"properties": {
"gcs_connection_id": {
"type": "integer",
"description": "Google Cloud Storage接続情報\n"
},
"bucket": {
"type": "string",
"description": "バケット\n"
},
"path_prefix": {
"type": "string",
"description": "パスプレフィックス\n"
},
"file_ext": {
"type": "string",
"description": "出力ファイルの拡張子\n"
},
"formatter_type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "出力ファイル形式(csv または jsonl)\n新規作成時には必須です。\n`formatter_type: csv` の場合、`csv_formatter` を必ず指定し、`jsonl_formatter` は指定しないでください。\n`formatter_type: jsonl` の場合、`jsonl_formatter` を必ず指定し、`csv_formatter` は指定しないでください。\n更新時に `formatter_type` が省略された場合、既存の設定が引き継がれます。\n"
},
"encoder_type": {
"type": "string",
"enum": [
"",
"gzip",
"bzip2",
"zip"
],
"description": "ファイル圧縮\n新規作成時は必須です。\n`\"gzip\"`、`\"bzip2\"`、`\"zip\"` を指定すると各圧縮形式が使用されます。\n空文字(`\"\"`)の場合は、圧縮なしとして扱われます。\n"
},
"is_minimum_output_tasks": {
"type": "boolean",
"description": "出力ファイル数抑制モード\ntrueの場合出力ファイル数抑制転送、falseの場合並列転送になります。\n出力ファイル数抑制転送を選択した場合、内部的には並列処理を抑えてファイル生成を行います。転送元が1ファイルの場合、転送先には1ファイルで生成されます。\n",
"default": false
},
"sequence_format": {
"type": "string",
"description": "複数ファイル出力時の命名規則\n",
"default": "%03d.%02d"
},
"csv_formatter": {
"allOf": [
{
"title": "CsvFormatter",
"type": "object",
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"bom": {
"type": "boolean",
"description": "BOM\n",
"default": false
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
{
"nullable": true
}
]
},
"jsonl_formatter": {
"allOf": [
{
"title": "JsonlFormatter",
"type": "object",
"description": "JSON Lines出力設定\n`formatter_type` が `\"jsonl\"` の場合にのみ指定できます。\n`formatter_type` が `\"jsonl\"` の場合、この項目は **新規作成時に必須**です。\n`formatter_type` が `\"csv\"` の場合は指定しないでください。\n",
"properties": {
"encoding": {
"type": "string",
"description": "文字エンコーディング\n",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"default": "UTF-8"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字\n",
"default": "LF"
},
"date_format": {
"type": "string",
"description": "日付のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"gcs_connection_id",
"bucket",
"path_prefix",
"file_ext",
"is_minimum_output_tasks",
"formatter_type"
]
}
]
},
"facebook_custom_audience_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "FacebookCustomAudienceOutputOption",
"type": "object",
"description": "転送先Facebook Custom Audienceの設定内容\n",
"properties": {
"facebook_ads_insights_connection_id": {
"type": "integer",
"description": "Facebook Ads Insights接続情報ID\n"
},
"ad_account_id": {
"type": "string",
"description": "広告アカウントID\n"
},
"custom_audience_name": {
"type": "string",
"description": "カスタムオーディエンス名\n"
},
"wait_for_completion": {
"type": "boolean",
"description": "アップロード完了待機フラグ\n",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"facebook_ads_insights_connection_id",
"ad_account_id",
"custom_audience_name"
]
}
]
},
"redshift_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "RedshiftOutputOption",
"type": "object",
"description": "転送先Redshiftの設定内容\n",
"properties": {
"redshift_connection_id": {
"type": "integer",
"description": "Redshift接続情報ID\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"create_table_constraint": {
"type": "string",
"nullable": true,
"description": "テーブル作成時に付与する制約\n"
},
"create_table_option": {
"type": "string",
"nullable": true,
"description": "テーブル作成時のオプション\n"
},
"s3_bucket": {
"type": "string",
"description": "S3バケット名\nデータをRedshiftにCOPYする際に使用する一時バケット\n"
},
"s3_key_prefix": {
"type": "string",
"description": "S3キープレフィックス\n一時ファイルのS3キープレフィックス\n"
},
"delete_s3_temp_file": {
"type": "boolean",
"description": "S3一時ファイルを削除するかどうか\n",
"default": true
},
"copy_iam_role_name": {
"type": "string",
"nullable": true,
"description": "COPYコマンドで使用するIAMロール名\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge"
],
"description": "転送モード\n- `insert`: 追記 (INSERT)\n- `insert_direct`: 追記 (INSERT DIRECT)\n- `truncate_insert`: 全件洗い替え (TRUNCATE INSERT)\n- `replace`: 全件洗い替え (REPLACE)\n- `merge`: UPSERT (MERGE)\n",
"default": "insert"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "UTC"
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n",
"default": 12
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n初回再試行時の待ち時間\n",
"default": 1000
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n再試行時の待ち時間の上限\n",
"default": 1800000
},
"before_load": {
"type": "string",
"nullable": true,
"description": "ロード前に実行するSQL\n転送前に実行されるクエリ\n※replaceモード以外\n"
},
"after_load": {
"type": "string",
"nullable": true,
"description": "ロード後に実行するSQL\n転送後に実行されるクエリ\n"
},
"batch_size": {
"type": "integer",
"description": "バッチサイズ (KB)\n",
"default": 16384
},
"redshift_output_option_column_options": {
"type": "array",
"nullable": true,
"description": "カラム設定\n",
"items": {
"type": "object",
"required": [
"name",
"type"
],
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BIGINT",
"VARCHAR",
"BOOLEAN",
"DOUBLE PRECISION",
"CLOB",
"TIMESTAMP",
"TIME",
"DATE"
],
"description": "データ型\n"
},
"value_type": {
"type": "string",
"enum": [
"byte",
"short",
"int",
"long",
"double",
"float",
"boolean",
"string",
"nstring",
"date",
"time",
"timestamp",
"decimal",
"json",
"null",
"pass",
"coalesce"
],
"description": "value type\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n"
}
}
}
},
"redshift_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"redshift_connection_id",
"database",
"schema",
"table",
"s3_bucket",
"s3_key_prefix",
"mode"
]
}
]
},
"custom_connector_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "CustomConnectorOutputOption",
"type": "object",
"description": "転送先カスタムコネクタでの出力オプション。\nurl・認証情報・エンドポイントパス等は各endpoint_idが参照するコネクタ定義からのスナップショットとして\n自動設定されるため、リクエストで指定することはできません。\n作成・更新のたびに最新の定義内容で再スナップショットされます。\n",
"properties": {
"custom_connector_connection_id": {
"description": "接続情報ID\n",
"type": "integer"
},
"mode": {
"description": "転送モード。`upsert`の場合、`update_key`と`update_custom_connector_output_endpoint_id`が必須です。\n`insert`の場合、`update_key`および`update_custom_connector_output_endpoint_id`を明示的に指定するとエラーになります\n(値の省略、または`null`・空文字によるクリアは許容します)。\n",
"type": "string",
"enum": [
"insert",
"upsert"
],
"default": "insert"
},
"update_key": {
"description": "更新キー。`mode`が`upsert`の場合必須です。`mode`が`insert`の場合は明示的に指定できません。\n",
"type": "string"
},
"create_custom_connector_output_endpoint_id": {
"description": "作成(新規行の送信)に使用するカスタムコネクタのエンドポイントID\n",
"type": "integer"
},
"update_custom_connector_output_endpoint_id": {
"description": "更新(既存行の更新)に使用するカスタムコネクタのエンドポイントID。`mode`が`upsert`の場合必須です。\n`mode`が`insert`の場合は明示的に指定できません。\n",
"type": "integer"
},
"create_endpoint_settings": {
"description": "作成用エンドポイントの値。エンドポイント定義で編集可能と設定されたヘッダー・クエリパラメータのみ指定できます。\n未知の名前、または編集不可の項目を指定した場合はエラーになります。パスパラメータは未入力を許容します。\n",
"type": "object",
"nullable": true,
"properties": {
"headers": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"path_parameters": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"query_parameters": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
}
}
},
"update_endpoint_settings": {
"description": "更新用エンドポイントの値。`create_endpoint_settings`と同じ形式です。`mode`が`upsert`の場合のみ使用されます。\n",
"type": "object",
"nullable": true,
"properties": {
"headers": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"path_parameters": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
},
"query_parameters": {
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"required": [
"name",
"value"
]
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"custom_connector_connection_id",
"create_custom_connector_output_endpoint_id"
]
}
]
}
}
}
]
},
"filter_columns": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterColumn",
"type": "object",
"description": "カラム定義。\n列の絞り込みや追加を行います。ここで指定した列のみ転送されます。\n転送元のカラムに変更があった場合は、カラム定義の再読み込みを実行することで最新の定義に更新することができます。\n詳細はTROCCO Docs「カラム定義を再読み込み」をご覧ください。\n",
"properties": {
"name": {
"description": "列の絞り込みや追加を行います。ここで指定した列のみプレビュー・転送されます。\n転送元のカラムに変更があった場合は、カラム定義の再読み込みを実行することで最新の定義に更新することができます。\n詳細はTROCCO Docs「カラム定義を再読み込み」をご覧ください。\n",
"type": "string"
},
"src": {
"description": "元カラム\n",
"type": "string"
},
"type": {
"description": "データ型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"default": {
"description": "デフォルト値。既存カラムの場合、inputがnullの場合のみこちらの值が挿入されます。新規力ラムの場合、すべてにこちらの值が挿入されます。\n",
"type": "string",
"nullable": true
},
"format": {
"description": "日時フォーマット\n",
"type": "string",
"nullable": true
},
"json_expand_enabled": {
"description": "JSONカラムを展開するかどうか\n",
"type": "boolean",
"nullable": true,
"default": false
},
"json_expand_keep_base_column": {
"description": "展開前のJSONカラムも転送する",
"type": "boolean",
"nullable": true,
"default": false
},
"json_expand_columns": {
"description": "JSONカラムの展開対象をどう展開するか\n",
"type": "array",
"items": {
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"json_path": {
"description": "JSONパス。{\"id\": 10, \"person\": {\"age\": 30}}のようなJSONカラムから id, ageを抜き出す場合、JSONパスにそれぞれ id, person.age と指定します。\n",
"type": "string"
},
"type": {
"description": "データ型\n",
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"string"
]
},
"format": {
"description": "日付フォーマット。typeがtimestampの場合のみ有効です。\n",
"type": "string",
"nullable": true
},
"timezone": {
"description": "タイムゾーン。typeがtimestampの場合のみ有効です。\n",
"type": "string",
"nullable": true
}
},
"required": [
"name",
"json_path",
"type"
]
}
}
},
"required": [
"name",
"src",
"type"
]
}
]
}
},
"filter_rows": {
"type": "object",
"allOf": [
{
"title": "FilterRow",
"type": "object",
"description": "条件に応じた行の絞り込み (フィルター) を行います。\n「条件を追加」ボタンで複数の条件を設定することが可能です。その際、AND条件かOR条件かを選択する必要があります。\n",
"properties": {
"condition": {
"description": "条件。and条件で絞り込むかor条件で絞り込むかを指定します。\n",
"type": "string",
"enum": [
"and",
"or"
]
},
"filter_row_conditions": {
"description": "絞り込み条件のリスト。\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"description": "対象カラム名。フィルター条件に利用するカラム名(カラム定義における元カラム)を入力してください。\n",
"type": "string"
},
"operator": {
"description": "演算子。フィルター条件に利用する演算子を入力してください。\n",
"type": "string",
"enum": [
"greater",
"greater_equal",
"less",
"less_equal",
"equal",
"not_equal",
"start_with",
"end_with",
"include",
"is_null",
"is_not_null",
"regexp"
]
},
"argument": {
"description": "フィルター条件の引数。\n",
"type": "string"
}
},
"required": [
"column",
"operator",
"argument"
]
}
}
},
"required": [
"condition",
"filter_row_conditions"
]
}
],
"nullable": true
},
"filter_masks": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterMask",
"type": "object",
"description": "マスキング設定。\n指定した列の値を「*」でマスキングします。\n",
"properties": {
"name": {
"description": "マスキング対象の列名。転送先カラム名を指定してください。\n",
"type": "string"
},
"mask_type": {
"description": "マスクの種類。\n全文字列: すべて「*」で置換します\nメールアドレス: @マークまでを「*」で置換します\n正規表現: 正規表現パターンにマッチした箇所を「*」で置換します\n部分文字列: 開始位置・終了位置を指定して、「*」で置換します\n",
"type": "string",
"enum": [
"all",
"email",
"regex",
"substring"
]
},
"length": {
"description": "マスクの長さ。「*」でマスクする文字列の長さを指定できます。\n",
"type": "integer",
"nullable": true
},
"pattern": {
"description": "マスクのパターン。マスクの種類がregexの場合に指定してください。\n",
"type": "string",
"nullable": true
},
"start_index": {
"description": "マスクの開始位置。マスクの種類がsubstringの場合に指定してください。\n",
"type": "integer",
"nullable": true
},
"end_index": {
"description": "マスクの終了位置。マスクの種類がsubstringの場合に指定してください。\n",
"type": "integer",
"nullable": true
}
},
"required": [
"name",
"mask_type"
]
}
]
}
},
"filter_add_time": {
"type": "object",
"allOf": [
{
"title": "FilterAddTime",
"type": "object",
"description": "転送時に、転送実行日時を記録するカラムを追加します。\n",
"properties": {
"column_name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "日時の型\n",
"type": "string",
"enum": [
"timestamp",
"string"
]
},
"timestamp_format": {
"description": "タイムスタンプのフォーマット。typeがstring場合に指定できます。\n",
"type": "string",
"example": "%Y-%m-%d %H:%M:%S.%N %Z",
"nullable": true
},
"time_zone": {
"description": "タイムゾーン。\n",
"type": "string",
"nullable": true
}
},
"required": [
"column_name",
"type"
]
}
],
"nullable": true
},
"filter_gsub": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterGsub",
"type": "object",
"description": "文字列 正規表現置換。\n各列内の文字列を、正規表現にマッチした部分だけ別の文字列に置換します。\n詳しいご利用方法は、TROCCO Docs「文字列置換機能について」をご覧ください。\n",
"properties": {
"column_name": {
"description": "対象カラム。\n",
"type": "string"
},
"pattern": {
"description": "正規表現のパターン。\n",
"type": "string"
},
"to": {
"description": "合致したパターンを置換させる文字列。\n",
"type": "string"
}
},
"required": [
"column_name",
"pattern",
"to"
]
}
]
}
},
"filter_string_transforms": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterStringTransform",
"type": "object",
"description": "各列内の文字列を、変換方法に従って変換します。string 型のみでご利用いただけます。\n",
"properties": {
"column_name": {
"description": "対象カラム\n",
"type": "string"
},
"type": {
"description": "変換方法\n正規化 (NFKC)\n例: normalize_nfkc: 全角英数 → 半角 (ABC123 → ABC123) 、半角カナ → 全角 (アイ → アイ) など\n",
"type": "string",
"enum": [
"normalize_nfkc"
],
"default": "normalize_nfkc"
}
},
"required": [
"column_name"
]
}
]
}
},
"filter_hashes": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterHash",
"type": "object",
"description": "カラムハッシュ化\n設定したカラム内の文字列を、SHA-256でハッシュ化したものに置換します。\n",
"properties": {
"name": {
"description": "対象カラム\n",
"type": "string"
}
},
"required": [
"name"
]
}
]
}
},
"filter_unixtime_conversions": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterUnixTimeConversion",
"type": "object",
"description": "UNIX時間から日時フォーマット(TIMESTAMP型、STRING型)への変換、もしくは日時フォーマット(TIMESTAMP型、STRING型)からUNIX時間への変換を設定します。\n",
"properties": {
"column_name": {
"description": "対象カラム\ntype: string\n"
},
"kind": {
"description": "変換方法\n",
"type": "string",
"enum": [
"unixtime_to_timestamp",
"unixtime_to_string",
"timestamp_to_unixtime",
"string_to_unixtime"
]
},
"unixtime_unit": {
"description": "変換前、変換後のUNIX時間の単位\n",
"type": "string",
"enum": [
"second",
"millisecond",
"microsecond",
"nanosecond"
]
},
"datetime_format": {
"description": "変換前、変換後の日時フォーマット\n",
"type": "string"
},
"datetime_timezone": {
"description": "変換前、変換後の日時のタイムゾーン\n"
}
},
"required": [
"column_name",
"kind",
"unixtime_unit",
"datetime_format",
"datetime_timezone"
]
}
]
}
},
"labels": {
"description": "ラベル設定を指定します。\n",
"type": "array",
"minItems": 0,
"maxItems": 40,
"items": {
"type": "string",
"description": "ラベル名を指定します。"
}
},
"schedules": {
"type": "array",
"minItems": 0,
"maxItems": 24,
"items": {
"title": "Schedule",
"type": "object",
"properties": {
"frequency": {
"description": "スケジュールの頻度です。
\nhourly: 毎時
\ndaily: 毎日
\nweekly: 毎週
\nmonthly: 毎月\n",
"type": "string",
"enum": [
"hourly",
"daily",
"weekly",
"monthly"
]
},
"minute": {
"description": "分の値を示します。",
"type": "integer",
"format": "int64"
},
"hour": {
"description": "時間の値を示します。",
"type": "integer",
"format": "int64"
},
"day": {
"description": "日にちの値を示します。",
"type": "integer",
"format": "int64"
},
"day_of_week": {
"description": "曜日の値を示します。",
"type": "integer",
"format": "int64"
},
"time_zone": {
"description": "日時のタイムゾーンです。",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"frequency",
"time_zone"
]
}
},
"notifications": {
"type": "array",
"minItems": 0,
"maxItems": 20,
"items": {
"title": "JobDefinitionNotification",
"type": "object",
"properties": {
"id": {
"description": "通知設定のIDです。
\nnotification_type の中で一意です。slack と email が同じ親レコードから派生する場合は同じ id を持つため、destination_type を併用して識別してください。\n",
"type": "integer",
"format": "int64",
"readOnly": true
},
"destination_type": {
"description": "通知先です。",
"type": "string",
"enum": [
"slack",
"email",
"http"
]
},
"slack_channel_id": {
"description": "slack channel IDです。
\ndestination_typeがslackのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"email_id": {
"description": "Email IDです。
\ndestination_typeがemailのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"http_notification_destination_id": {
"description": "通知先HTTPのIDです。
\ndestination_typeがhttpのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"notification_type": {
"description": "通知タイプです。
\njob: ジョブ実行(終了/エラー)通知
\nrecord: レコード条件(超過/過不足)通知
\nexec_time: 実行時間経過通知\n",
"type": "string",
"enum": [
"job",
"record",
"exec_time"
]
},
"notify_when": {
"description": "通知条件です。
\njobタイプのとき必須です。\n",
"type": "string",
"enum": [
"finished",
"failed"
]
},
"message": {
"description": "通知内容です。
\ndestination_typeがhttpのときは、HTTPリクエストボディとして送信される文字列を指定します(メタ変数・カスタム変数の展開に対応。job通知はJSON形式が必須)。\n",
"type": "string"
},
"record_count": {
"description": "閾値のレコード数
\nrecordタイプのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"record_operator": {
"description": "レコード数の比較演算子です
\nrecordタイプのとき必須
\nabove: 以上
\nbelow: 以下\n",
"type": "string",
"enum": [
"above",
"below"
]
},
"record_type": {
"description": "通知するレコード数条件
\nrecordタイプのとき必須
\ntransfer: 転送した
\nskipped: スキップされた\n"
},
"minutes": {
"description": "実行時間の閾値(分)
\nexec_timeタイプのとき必須です。\n",
"type": "integer",
"format": "int64"
}
},
"required": [
"destination_type",
"notification_type",
"message"
]
}
}
}
}
],
"required": [
"name",
"input_option_type",
"input_option",
"output_option_type",
"filter_columns"
]
}
}
}
},
"responses": {
"201": {
"description": "作成した転送設定詳細を返します。",
"content": {
"application/json": {
"schema": {
"title": "JobDefinitionResponse",
"type": "object",
"allOf": [
{
"title": "JobDefinitionGeneral",
"type": "object",
"properties": {
"name": {
"description": "転送設定名",
"type": "string"
},
"description": {
"description": "転送設定メモ",
"type": "string"
},
"resource_group_id": {
"description": "リソースグループID。リソースグループに追加すると、他のユーザーに設定を共有できるようになります。",
"type": "integer",
"nullable": true
},
"self_hosted_runner_cluster_id": {
"description": "Self-Hosted Runnerクラスタ ID。指定すると、指定したクラスタ上でジョブを実行します。未指定の場合はTROCCOがホストする実行基盤で実行されます。
\nSelf-Hosted Runnerが利用可能なアカウントでのみ指定できます。利用できないアカウントで指定した場合や、実行権限のないクラスタを指定した場合はエラーになります。\n",
"type": "integer",
"nullable": true
},
"is_runnable_concurrently": {
"description": "終了していないジョブが存在するとき、並列でジョブが起動することを許可するかどうかを設定します。\n",
"type": "boolean",
"default": false
},
"retry_limit": {
"description": "1以上を設定すると、転送が途中で失敗した場合に転送処理を最初からやり直します。転送処理が冪等でない場合、レコード重複等が発生する場合があります。\n",
"type": "integer",
"default": 0
},
"resource_enhancement": {
"description": "※このパラメーターはプロフェッショナルプランでのみご利用いただけます。
\nジョブ実行時に利用するリソースサイズを指定できます。指定しなかった場合、転送設定側で指定されているリソースサイズが適用されます。
\nまた、コネクタによって指定できる値が異なります。
\n- 通常のコネクタ: `medium`, `large`, `xlarge`
\n- 一部例外的なコネクタ: `custom_spec`, `xlarge`
\n指定できる各値のスペックや、一部例外的なコネクタの種類など、詳しくは[リソース増強オプションの種類およびスペック](https://documents.trocco.io/docs/professional-plan#%E3%83%AA%E3%82%BD%E3%83%BC%E3%82%B9%E5%A2%97%E5%BC%B7%E3%82%AA%E3%83%97%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E7%A8%AE%E9%A1%9E%E3%81%8A%E3%82%88%E3%81%B3%E3%82%B9%E3%83%9A%E3%83%83%E3%82%AF)を参照ください。
\n",
"type": "string",
"enum": [
"medium",
"custom_spec",
"large",
"xlarge"
],
"nullable": true
}
}
},
{
"properties": {
"id": {
"description": "転送設定定義ID",
"type": "integer"
},
"input_option_type": {
"description": "転送元の種別",
"type": "string",
"enum": [
"backlog",
"bakuraku",
"bigquery",
"custom_connector",
"databricks",
"facebook_ads_insights",
"gcs",
"google_ads",
"google_analytics4",
"google_drive",
"google_spreadsheets",
"http",
"hubspot",
"kaonavi",
"kintone",
"marketo",
"mongodb",
"mysql",
"oracle",
"pagerduty",
"postgresql",
"redshift",
"s3",
"salesforce",
"sftp",
"smart_hr",
"snowflake",
"sqlserver",
"yahoo_ads_api_ydn",
"yahoo_ads_api_yss"
]
},
"input_option": {
"description": "転送元の設定の詳細",
"type": "object",
"allOf": [
{
"title": "InputOption",
"type": "object",
"description": "転送元の設定内容\n",
"properties": {
"gcs_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GcsInputOptionResponse",
"type": "object",
"description": "転送元gcsでの入力オプション\n",
"properties": {
"gcs_connection_id": {
"description": "GCSの接続情報のID",
"type": "integer"
},
"bucket": {
"description": "GCSのバケット名\n",
"type": "string"
},
"path_prefix": {
"description": "パスプレフィックス\n",
"type": "string"
},
"incremental_loading_enabled": {
"description": "差分転送するかどうかのフラグ\n",
"type": "boolean",
"default": false
},
"last_path": {
"description": "差分転送の場合、最後に転送されたパスを指定。 差分更新時はここで指定されたパスより辞書順で後ろのデータを転送します。 フォームが空欄の場合は最初から転送します。 特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。",
"type": "string",
"nullable": true
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうかのフラグ ヘッダー行を含まないCSV/TSVファイルの場合、TROCCO側で生成した仮のヘッダー名を割り当てます。",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか",
"type": "boolean",
"default": false
},
"decompression_type": {
"description": "圧縮形式",
"type": "string",
"enum": [
"bzip2",
"gzip",
"targz",
"zip"
],
"nullable": true
},
"nul_character_removal_enabled": {
"description": "ファイル内のNUL文字 (0x00) をパース前に除去するかどうかのフラグ。 入力ファイル形式がCSVで、かつ文字コードがASCII互換 (UTF-8 / Shift_JIS / EUC-JP / US-ASCII / ISO-8859系) の場合のみ適用されます。",
"type": "boolean",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderResponse",
"type": "object",
"properties": {
"decoder_type": {
"type": "string",
"description": "解凍方式\n"
},
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
},
"required": [
"decoder_type"
]
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersResponse",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"delimiter",
"quote",
"escape",
"null_string_enabled",
"skip_header_lines",
"trim_if_not_quoted",
"quotes_in_quoted_fields",
"allow_optional_columns",
"allow_extra_columns",
"max_quoted_size_limit",
"stop_on_invalid_record",
"default_time_zone",
"default_date",
"newline",
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"stop_on_invalid_record",
"default_time_zone",
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"newline",
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"default_time_zone",
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
],
"required": [
"column_name",
"charset",
"max_size_bytes",
"stop_on_oversize"
]
}
}
}
],
"required": [
"bucket",
"path_prefix",
"gcs_connection_id",
"is_skip_header_line"
]
}
]
},
"mysql_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MysqlInputOptionResponse",
"type": "object",
"description": "転送元gcsでの入力オプション\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"query": {
"type": "string",
"description": "クエリ。incremental_loading_enabledがfalseの場合は必須です。\n",
"nullable": true
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"default_time_zone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n"
},
"use_legacy_datetime_code": {
"type": "boolean",
"nullable": true,
"description": "レガシーな時刻コード設定\n",
"default": false
},
"mysql_connection_id": {
"type": "integer",
"description": "MySQL接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"incremental_loading_enabled",
"fetch_rows",
"connect_timeout",
"socket_timeout",
"mysql_connection_id",
"use_legacy_datetime_code",
"input_option_columns"
]
}
]
},
"snowflake_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SnowflakeInputOptionResponse",
"type": "object",
"description": "転送元snowflakeのプロパティ\n",
"properties": {
"warehouse": {
"type": "string",
"description": "ウェアハウス名\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n",
"default": "PUBLIC"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"snowflake_connection_id": {
"type": "integer",
"description": "Snowflake接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"warehouse",
"database",
"schema",
"query",
"fetch_rows",
"connect_timeout",
"socket_timeout",
"snowflake_connection_id",
"input_option_columns"
]
}
]
},
"salesforce_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SalesforceInputOptionResponse",
"type": "object",
"description": "転送元Salesforceのプロパティ\n",
"properties": {
"soql": {
"type": "string",
"description": "SOQL\nオブジェクト取得方法(object_acquisition_method)がオブジェクトの項目を全転送(all_columns)の場合、この項目は返却しません。\nsoqlの場合のみ返却します。\n"
},
"api_version": {
"type": "string",
"description": "APIバージョン\n",
"default": "64.0"
},
"object": {
"type": "string",
"description": "オブジェクト名\n"
},
"object_acquisition_method": {
"type": "string",
"description": "オブジェクト取得方法\nall_columns: オブジェクトの項目を全転送。指定したオブジェクトの項目を、すべて転送します。あとで「クエリ(SOQL) を記述して転送」に変更することもできます。\nsoql: クエリ (SOQL) を記述して転送。指定したオブジェクトに対し、SOQLを記述して転送します。転送項目をカスタマイズしたい場合に適しています。\nincremental: オブジェクトの項目を差分転送。前回転送時からの増分データのみ転送します。\n",
"enum": [
"all_columns",
"soql",
"incremental"
],
"default": "all_columns"
},
"is_convert_type_custom_columns": {
"type": "boolean",
"description": "型変換モード\nfalse: カスタムカラム(columns)を元に転送をします。\ntrue: カスタムカラム(columns)をSTRING型に変更。カスタムカラムをSTRING型に変更を選択した場合、BOOLEAN型以外のすべてのカスタムカラムの型をSTRINGに変更します。\n",
"default": false
},
"include_deleted_or_archived_records": {
"type": "boolean",
"description": "削除済み・アーカイブ済みレコードの抽出\n",
"default": false
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。\nオブジェクト取得方法(object_acquisition_method)がincrementalの場合のみ返却します。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nオブジェクト取得方法(object_acquisition_method)がincrementalの場合のみ返却します。\n"
},
"salesforce_connection_id": {
"type": "integer",
"description": "Salesforce接続情報ID\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"salesforce_connection_id",
"api_version",
"object",
"object_acquisition_method",
"is_convert_type_custom_columns",
"include_deleted_or_archived_records",
"columns"
]
}
]
},
"google_spreadsheets_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleSpreadsheetsInputOptionResponse",
"type": "object",
"description": "転送元Google Spreadsheetsでのプロパティ\n",
"properties": {
"google_spreadsheets_connection_id": {
"type": "integer",
"description": "Google Spreadsheets接続情報ID\n"
},
"spreadsheets_url": {
"type": "string",
"description": "シートのURL\n"
},
"worksheet_title": {
"type": "string",
"description": "シート名\n"
},
"start_row": {
"type": "integer",
"description": "取り込み開始行番号\n"
},
"start_column": {
"type": "integer",
"description": "取り込み開始列番号\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n"
},
"null_string": {
"type": "string",
"description": "NULL文字列\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"google_spreadsheets_connection_id",
"spreadsheets_url",
"worksheet_title",
"start_row",
"start_column",
"default_time_zone",
"input_option_columns"
]
}
]
},
"postgresql_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "PostgreSQLInputOptionResponse",
"type": "object",
"description": "転送元postgresqlのプロパティ\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n",
"default": "public"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"default_time_zone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n",
"default": "UTC"
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"postgresql_connection_id": {
"type": "integer",
"description": "PostgreSQL接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_column_options": {
"allOf": [
{
"title": "PostgresqlInputOptionColumn",
"type": "object",
"description": "取り込みデータ型指定\n",
"properties": {
"column_name": {
"type": "string",
"description": "interval型など、TROCCOでサポートされていないデータ型のカラム名",
"example": "duration"
},
"column_value_type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "変換可能なデータ型",
"example": "string"
}
},
"required": [
"column_name",
"column_value_type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"schema",
"default_time_zone",
"connect_timeout",
"socket_timeout",
"fetch_rows",
"postgresql_connection_id",
"input_option_columns",
"incremental_loading_enabled"
]
}
]
},
"sqlserver_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SQLServerInputOptionResponse",
"type": "object",
"description": "転送元sqlserverのプロパティ\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"nullable": true,
"description": "スキーマ名。未指定の場合は接続ユーザーのデフォルトスキーマ (通常は dbo) が使用されます。\n"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"default_time_zone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n",
"default": "UTC"
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"sqlserver_connection_id": {
"type": "integer",
"description": "SQL Server接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_column_options": {
"description": "取り込みデータ型指定(作成順)\n",
"allOf": [
{
"title": "SqlserverInputOptionColumn",
"type": "object",
"description": "取り込みデータ型指定\n",
"properties": {
"column_name": {
"type": "string",
"description": "TROCCOでサポートされていないデータ型のカラム名",
"example": "created_at"
},
"column_value_type": {
"type": "string",
"enum": [
"string"
],
"description": "変換可能なデータ型。現在は string のみ指定できます。",
"example": "string"
}
},
"required": [
"column_name",
"column_value_type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"database",
"default_time_zone",
"connect_timeout",
"socket_timeout",
"fetch_rows",
"sqlserver_connection_id",
"input_option_columns",
"incremental_loading_enabled"
]
}
]
},
"bigquery_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BigqueryInputOptionResponse",
"type": "object",
"description": "転送元bigqueryでの入力オプション\n",
"properties": {
"bigquery_connection_id": {
"description": "Bigqueryの接続情報のID\n",
"type": "integer"
},
"gcs_uri": {
"type": "string",
"description": "一時データエクスポート先Google Cloud Storage URI\n"
},
"gcs_uri_format": {
"type": "string",
"nullable": true,
"default": "bucket",
"description": "一時データエクスポート指定\n"
},
"query": {
"type": "string",
"description": "SQL\n"
},
"temp_dataset": {
"type": "string",
"description": "一時テーブル作成先データセット\n"
},
"is_standard_sql": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "SQLタイプ"
},
"cleanup_gcs_files": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "一時データの削除ポリシー\n"
},
"file_format": {
"type": "string",
"nullable": true,
"default": "CSV",
"description": "一時データのファイル形式\n"
},
"location": {
"type": "string",
"description": "データセットのロケーション\n",
"default": "US"
},
"cache": {
"type": "boolean",
"nullable": true,
"default": true,
"description": "クエリキャッシュを利用する\n"
},
"bigquery_job_wait_second": {
"type": "integer",
"nullable": true,
"default": 600,
"description": "ジョブ待機タイムアウト(秒)\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersCreateInputs",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
]
}
}
}
],
"required": [
"bigquery_connection_id",
"gcs_uri",
"gcs_uri_format",
"query",
"temp_dataset",
"is_standard_sql",
"cleanup_gcs_files",
"file_format",
"location",
"cache",
"bigquery_job_wait_second"
]
}
]
},
"databricks_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "DatabricksInputOptionResponse",
"type": "object",
"description": "転送元Databricksでの入力オプション\n",
"properties": {
"databricks_connection_id": {
"type": "integer",
"description": "Databricks接続情報ID\n"
},
"catalog_name": {
"type": "string",
"description": "カタログ名\n"
},
"schema_name": {
"type": "string",
"description": "スキーマ名\n"
},
"query": {
"type": "string",
"description": "実行するSQLクエリ\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"databricks_connection_id",
"catalog_name",
"schema_name",
"query",
"input_option_columns"
]
}
]
},
"s3_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "S3InputOptionResponse",
"type": "object",
"description": "転送元S3での入力オプション\n",
"properties": {
"s3_connection_id": {
"description": "S3の接続情報のID",
"type": "integer"
},
"bucket": {
"description": "S3のバケット名\n",
"type": "string"
},
"path_prefix": {
"description": "パスプレフィックス\n未入力の場合、バケット配下の全てのファイルが対象になります\n",
"type": "string",
"default": ""
},
"path_match_pattern": {
"description": "パスの正規表現\n未入力の場合、パスプレフィックスにマッチする全てのファイルが対象になります\n",
"type": "string",
"default": ""
},
"region": {
"description": "リージョン\n",
"type": "string",
"default": "ap-northeast-1"
},
"incremental_loading_enabled": {
"description": "差分転送するかどうかのフラグ\n",
"type": "boolean",
"default": false
},
"last_path": {
"description": "差分転送の場合、最後に転送されたパスを指定。 差分更新時はここで指定されたパスより辞書順で後ろのデータを転送します。 フォームが空欄の場合は最初から転送します。 特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。",
"type": "string",
"nullable": true
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうかのフラグ\nヘッダー行を含まないCSV/TSVファイルの場合、TROCCO側で生成した仮のヘッダー名を割り当てます。\n",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか",
"type": "boolean",
"default": false
},
"decompression_type": {
"description": "圧縮形式\n`default`は解凍の設定が行われていないことを表します。TROCCOの画面上で自動データ設定を実行した場合、bzip2/gzipが自動で判別されますが、その場合も`default`を返却します。\n",
"type": "string",
"enum": [
"default",
"zip",
"targz",
"gzip",
"bzip2"
],
"nullable": true,
"default": "default"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderResponse",
"type": "object",
"properties": {
"decoder_type": {
"type": "string",
"description": "解凍方式\n"
},
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
},
"required": [
"decoder_type"
]
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersResponse",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"delimiter",
"quote",
"escape",
"null_string_enabled",
"skip_header_lines",
"trim_if_not_quoted",
"quotes_in_quoted_fields",
"allow_optional_columns",
"allow_extra_columns",
"max_quoted_size_limit",
"stop_on_invalid_record",
"default_time_zone",
"default_date",
"newline",
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"stop_on_invalid_record",
"default_time_zone",
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"newline",
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"default_time_zone",
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
],
"required": [
"column_name",
"charset",
"max_size_bytes",
"stop_on_oversize"
]
}
}
}
],
"required": [
"bucket",
"region",
"incremental_loading_enabled",
"is_skip_header_line",
"stop_when_file_not_found",
"s3_connection_id",
"decompression_type"
]
}
]
},
"google_analytics4_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GA4InputOptionResponse",
"type": "object",
"description": "転送元Google Analytics 4での入力オプション\n",
"properties": {
"google_analytics4_connection_id": {
"description": "Google Analytics 4の接続情報のID",
"type": "integer"
},
"property_id": {
"description": "プロパティID\n",
"type": "string"
},
"time_series": {
"description": "タイムスタンプの形式\n",
"type": "string",
"enum": [
"dateHour",
"date",
"yearMonth",
"year",
"isoYear"
]
},
"start_date": {
"description": "データ取得期間の開始日\n例: 2021-01-01, NdaysAgo, yesterday, today\n",
"type": "string"
},
"end_date": {
"description": "データ取得期間の終了日\n例: 2021-01-01, NdaysAgo, yesterday, today\n",
"type": "string"
},
"incremental_loading_enabled": {
"description": "転送方式。差分転送するかどうかのフラグ\n",
"type": "boolean",
"default": false
},
"last_record_time": {
"description": "最新のレコード更新日時。\n差分転送の場合、最後に転送されたデータの時間を指定。\n差分更新時はここで指定された時間より後のデータを転送します。\nフォームが空欄の場合は最初から転送します。\n特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。\n",
"type": "string"
},
"google_analytics4_input_option_dimensions": {
"description": "ディメンション\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "ディメンション名\n",
"type": "string"
},
"expression": {
"description": "ディメンション式\n",
"type": "string"
}
}
}
},
"google_analytics4_input_option_metrics": {
"description": "メトリクス\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "メトリクス名\n",
"type": "string"
},
"expression": {
"description": "メトリクス式\n",
"type": "string"
}
}
}
},
"retry_limit": {
"description": "最大リトライ回数\n",
"type": "integer",
"default": 5
},
"retry_sleep": {
"description": "リトライ間隔(秒)\n",
"type": "integer",
"default": 2
},
"raise_on_other_row": {
"description": "「(other)」行が使用されている場合のステータス\nfalse: Succeededにする\ntrue: Errorにする\n",
"type": "boolean",
"default": true
},
"limit_of_rows": {
"description": "一回のリクエストで取得する行数\n",
"type": "integer",
"default": 10000
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"google_analytics4_connection_id",
"property_id",
"time_series",
"google_analytics4_input_option_dimensions",
"google_analytics4_input_option_metrics",
"retry_limit",
"retry_sleep",
"raise_on_other_row",
"limit_of_rows",
"input_option_columns"
]
}
]
},
"kintone_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "KintoneInputOptionResponse",
"type": "object",
"description": "転送元kintoneのプロパティ\n",
"properties": {
"kintone_connection_id": {
"type": "integer",
"description": "Kintone接続情報ID\n"
},
"app_id": {
"type": "string",
"description": "アプリID\n"
},
"guest_space_id": {
"type": "string",
"description": "ゲストスペースID\n",
"nullable": true
},
"expand_subtable": {
"type": "boolean",
"default": true,
"description": "テーブル行単位で転送する\n"
},
"query": {
"type": "string",
"description": "クエリ\n",
"nullable": true
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"kintone_connection_id",
"app_id",
"guest_space_id",
"expand_subtable",
"query",
"input_option_columns"
]
}
]
},
"http_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "HttpInputOptionResponse",
"type": "object",
"description": "転送元HTTPでの入力オプション\n",
"properties": {
"url": {
"description": "URL\n",
"type": "string"
},
"method": {
"description": "HTTPメソッド\n",
"type": "string",
"enum": [
"get",
"post"
],
"default": "get"
},
"user_agent": {
"description": "ユーザーエージェント\n",
"type": "string",
"nullable": true
},
"charset": {
"description": "文字エンコーディング\n",
"type": "string",
"nullable": true,
"default": "UTF-8"
},
"pager_type": {
"description": "ページング設定\n",
"type": "string",
"enum": [
"disable",
"offset",
"cursor"
],
"default": "disable"
},
"pager_from_param": {
"description": "オフセット開始パラメータ名(from)\n",
"type": "string",
"nullable": true
},
"pager_to_param": {
"description": "オフセット終了パラメータ名(to)\n",
"type": "string",
"nullable": true
},
"pager_pages": {
"description": "ページネーションリクエスト回数\n",
"type": "integer",
"nullable": true
},
"pager_start": {
"description": "オフセット初期値\n",
"type": "integer",
"nullable": true
},
"pager_step": {
"description": "1リクエストで進めるオフセット増加値\n",
"type": "integer",
"nullable": true
},
"cursor_request_parameter_cursor_name": {
"description": "カーソルをセットするパラメータ名\n",
"type": "string",
"nullable": true
},
"cursor_response_parameter_cursor_json_path": {
"description": "レスポンスからカーソルを取得するためのJSONPath\n",
"type": "string",
"nullable": true
},
"cursor_request_parameter_limit_name": {
"description": "1リクエストで取得するレコードの最大件数をセットするパラメータ名\n",
"type": "string",
"nullable": true
},
"cursor_request_parameter_limit_value": {
"description": "1リクエストで取得するレコードの最大件数\n",
"type": "integer",
"nullable": true
},
"request_params": {
"description": "リクエストパラメータ\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "パラメータ名\n",
"type": "string"
},
"value": {
"description": "パラメータ値。マスキングされている場合、'***'と表示されます。\n",
"type": "string"
}
}
}
},
"request_body": {
"description": "リクエストボディ\n",
"type": "string",
"nullable": true
},
"request_headers": {
"description": "リクエストヘッダ\n",
"type": "array",
"nullable": true,
"items": {
"type": "object",
"properties": {
"key": {
"description": "ヘッダ名\n",
"type": "string"
},
"value": {
"description": "ヘッダ値。マスキングされている場合、'***'と表示されます。\n",
"type": "string"
}
}
}
},
"success_code": {
"description": "転送データ取得時に正常系と判定するステータスコード\n",
"type": "string",
"nullable": true,
"default": "200"
},
"open_timeout": {
"description": "接続時にタイムアウトするまでのミリ秒数\n",
"type": "integer",
"nullable": true,
"default": 2000
},
"read_timeout": {
"description": "読み取り時にタイムアウトするまでのミリ秒数\n",
"type": "integer",
"nullable": true,
"default": 10000
},
"max_retries": {
"description": "最大リトライ回数\n",
"type": "integer",
"nullable": true,
"default": 5
},
"retry_interval": {
"description": "リトライ間隔(ミリ秒)\n",
"type": "integer",
"nullable": true,
"default": 10000
},
"request_interval": {
"description": "リクエスト間隔(ミリ秒)\n",
"type": "integer",
"nullable": true,
"default": 0
},
"has_ssl_ca": {
"description": "SSL CA証明書が設定されているかどうかを示します。\n",
"type": "boolean"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"delimiter",
"quote",
"escape",
"null_string_enabled",
"skip_header_lines",
"trim_if_not_quoted",
"quotes_in_quoted_fields",
"allow_optional_columns",
"allow_extra_columns",
"max_quoted_size_limit",
"stop_on_invalid_record",
"default_time_zone",
"default_date",
"newline",
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"stop_on_invalid_record",
"default_time_zone",
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"newline",
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"default_time_zone",
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
],
"required": [
"column_name",
"charset",
"max_size_bytes",
"stop_on_oversize"
]
}
},
"required": [
"url",
"method",
"charset",
"pager_type",
"success_code",
"open_timeout",
"read_timeout",
"max_retries",
"retry_interval",
"request_interval",
"has_ssl_ca"
]
}
]
},
"google_ads_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleAdsInputOptionResponse",
"type": "object",
"description": "転送元Google Adsでの入力オプション\n",
"properties": {
"customer_id": {
"type": "string",
"description": "Google Adsのお客様ID(10桁の数字)\n"
},
"resource_type": {
"type": "string",
"description": "取得するリソースタイプ\n例: customer, campaign, ad_group, ad_group_ad など\n"
},
"start_date": {
"type": "string",
"nullable": true,
"description": "データ取得開始日(YYYY-MM-DD形式)\nリソースタイプによっては指定できない場合があります。\n"
},
"end_date": {
"type": "string",
"nullable": true,
"description": "データ取得終了日(YYYY-MM-DD形式)\nリソースタイプによっては指定できない場合があります。\n"
},
"google_ads_connection_id": {
"type": "integer",
"description": "Google Ads接続情報ID\n"
},
"input_option_columns": {
"type": "array",
"description": "取得するフィールドの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィールド名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "タイムスタンプ型の場合のフォーマット\n",
"nullable": true
}
},
"required": [
"name",
"type"
]
}
},
"conditions": {
"type": "array",
"description": "検索条件の一覧\n",
"items": {
"type": "string",
"description": "WHERE句の条件式\n"
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"customer_id",
"resource_type",
"google_ads_connection_id",
"input_option_columns",
"conditions"
]
}
]
},
"yahoo_ads_api_yss_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "YahooAdsApiYssInputOptionResponse",
"type": "object",
"description": "転送元yahoo_ads_api_yssのプロパティ",
"properties": {
"yahoo_ads_api_connection_id": {
"type": "integer",
"description": "YahooAdsApiYss接続情報ID"
},
"base_account_id": {
"type": "string",
"description": "ベースアカウントID"
},
"account_id": {
"type": "string",
"description": "アカウントID"
},
"service": {
"type": "string",
"description": "サービス",
"default": "report_definition_service",
"enum": [
"report_definition_service",
"campaign_export_service"
]
},
"start_date": {
"type": "string",
"description": "開始日",
"nullable": true
},
"end_date": {
"type": "string",
"description": "終了日",
"nullable": true
},
"report_type": {
"type": "string",
"description": "レポート種別",
"enum": [
"ACCOUNT",
"CAMPAIGN",
"ADGROUP",
"AD",
"KEYWORDS",
"SEARCH_QUERY",
"GEO",
"GEO_TARGET",
"SCHEDULE_TARGET",
"BID_STRATEGY",
"ADGROUP_TARGET_LIST",
"CAMPAIGN_TARGET_LIST",
"LANDING_PAGE_URL",
"KEYWORDLESS_QUERY",
"WEBPAGE_CRITERION",
"BID_MODIFIER",
"CAMPAIGN_ASSET",
"ADGROUP_ASSET",
"RESPONSIVE_ADS_FOR_SEARCH_ASSET",
"ASSET_COMBINATIONS"
],
"nullable": true
},
"exclude_zero_impressions": {
"type": "boolean",
"description": "フィルター設定",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"yahoo_ads_api_connection_id",
"base_account_id",
"account_id",
"service",
"input_option_columns"
]
}
]
},
"yahoo_ads_api_ydn_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "YahooAdsApiYdnInputOptionResponse",
"type": "object",
"description": "転送元yahoo_ads_api_ydnのプロパティ",
"properties": {
"yahoo_ads_api_connection_id": {
"type": "integer",
"description": "Yahoo!広告 API接続情報"
},
"target": {
"type": "string",
"description": "取得方法",
"enum": [
"report",
"stats"
]
},
"base_account_id": {
"type": "string",
"description": "ベースアカウントID",
"nullable": true
},
"account_id": {
"type": "string",
"description": "アカウントID"
},
"report_type": {
"type": "string",
"description": "タイプ。targetがstatsの場合のみ返却する",
"enum": [
"CAMPAIGN",
"ADGROUP",
"AD"
],
"nullable": true
},
"report_type_condition": {
"type": "string",
"description": "レポート種別。未設定の場合は通常の広告レポート",
"enum": [
"REACH",
"CONVERSION_PATH",
"CROSS_CAMPAIGN_REACHES",
"MODEL_COMPARISON"
],
"nullable": true
},
"report_date_range_type": {
"type": "string",
"description": "集計対象期間。targetがreportの場合のみ返却する",
"enum": [
"CUSTOM_DATE",
"TODAY",
"YESTERDAY",
"LAST_7_DAYS",
"LAST_14_DAYS",
"LAST_30_DAYS",
"LAST_WEEK",
"LAST_BUSINESS_WEEK",
"LAST_MONTH",
"THIS_MONTH",
"THIS_MONTH_EXCEPT_TODAY",
"GUARANTEED_CAMPAIGN_PERIOD"
],
"nullable": true
},
"frequency_range": {
"type": "string",
"description": "リーチ頻度の計測単位。report_type_conditionがREACHの場合のみ返却する",
"enum": [
"DAILY",
"WEEKLY",
"MONTHLY",
"GUARANTEED_CAMPAIGN_PERIOD"
],
"nullable": true
},
"lookback_window": {
"type": "integer",
"description": "ルックバック期間 (日数)。report_type_conditionがCONVERSION_PATHまたはMODEL_COMPARISONの場合のみ返却する",
"nullable": true
},
"include_view_interaction": {
"type": "boolean",
"description": "ビューインタラクションを含めるかどうか。report_type_conditionがCONVERSION_PATHまたはMODEL_COMPARISONの場合のみ返却する",
"nullable": true
},
"include_video_interaction": {
"type": "boolean",
"description": "動画インタラクションを含めるかどうか。report_type_conditionがMODEL_COMPARISONの場合のみ返却する",
"nullable": true
},
"base_model": {
"type": "string",
"description": "比較元モデル。report_type_conditionがMODEL_COMPARISONの場合のみ返却する",
"enum": [
"LAST",
"FIRST",
"LINEAR",
"POSITION_BASED"
],
"nullable": true
},
"comparative_model": {
"type": "string",
"description": "比較先モデル。report_type_conditionがMODEL_COMPARISONの場合のみ返却する",
"enum": [
"LAST",
"FIRST",
"LINEAR",
"POSITION_BASED"
],
"nullable": true
},
"cross_campaign_type": {
"type": "string",
"description": "組み合わせ種別。report_type_conditionがCROSS_CAMPAIGN_REACHESの場合のみ返却する",
"enum": [
"CAMPAIGN_ID",
"CAMPAIGN_GOAL",
"CAMPAIGN_BUYING_TYPE"
],
"nullable": true
},
"cross_campaign_values": {
"type": "array",
"description": "組み合わせ対象。report_type_conditionがCROSS_CAMPAIGN_REACHESの場合のみ返却する(設定した順)",
"items": {
"type": "string"
},
"nullable": true
},
"conversion_path_filters": {
"type": "array",
"description": "コンバージョン経路レポートの絞り込み条件。report_type_conditionがCONVERSION_PATHで、 かつ絞り込み条件が設定されている場合のみ返却する(作成順)",
"items": {
"type": "object",
"properties": {
"filter_type": {
"type": "string",
"description": "絞り込み対象の項目",
"enum": [
"CAMPAIGN_ID",
"CAMPAIGN_NAME",
"CONVERSION_ID",
"ADGROUP_ID",
"ADGROUP_NAME"
]
},
"filter_operator": {
"type": "string",
"description": "絞り込み条件の演算子",
"enum": [
"EQUALS",
"NOT_EQUALS",
"CONTAINS",
"NOT_CONTAINS",
"START_WITH",
"END_WITH"
]
},
"values": {
"type": "array",
"description": "絞り込みに使用する値。複数指定した場合はOR条件となる",
"items": {
"type": "string"
}
}
}
},
"nullable": true
},
"start_date": {
"type": "string",
"description": "開始日。targetがstatsの場合、またはreport_date_range_typeがCUSTOM_DATEの場合のみ返却する",
"nullable": true
},
"end_date": {
"type": "string",
"description": "終了日。targetがstatsの場合、またはreport_date_range_typeがCUSTOM_DATEの場合のみ返却する",
"nullable": true
},
"include_deleted": {
"type": "boolean",
"description": "削除済み広告を含める",
"nullable": true
},
"custom_variable_settings": {
"description": "カスタム変数の設定",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"yahoo_ads_api_connection_id",
"target",
"base_account_id",
"account_id",
"input_option_columns"
]
}
]
},
"mongodb_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MongodbInputOptionResponse",
"type": "object",
"description": "転送元MongoDBのプロパティ\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"collection": {
"type": "string",
"description": "コレクション名\n"
},
"query": {
"type": "string",
"description": "クエリ\n",
"nullable": true
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。\n"
},
"last_record": {
"type": "object",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\nフォームが空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。\nデータの重複が起こる可能性があります。\n"
},
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": false
},
"mongodb_connection_id": {
"type": "integer",
"description": "MongoDB接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"type": "array",
"description": "取得するカラムの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "タイムスタンプ型の場合のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムスタンプ型の場合のタイムゾーン\n",
"nullable": true
}
}
}
}
},
"required": [
"database",
"collection",
"mongodb_connection_id",
"input_option_columns",
"incremental_loading_enabled"
]
}
]
},
"sftp_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SftpInputOptionResponse",
"type": "object",
"description": "転送元SFTPの入力オプション\n",
"properties": {
"sftp_connection_id": {
"description": "SFTPの接続情報のID\n",
"type": "integer"
},
"path_prefix": {
"description": "パスプレフィックス\n",
"type": "string"
},
"path_match_pattern": {
"description": "パスの正規表現\n",
"type": "string"
},
"incremental_loading_enabled": {
"description": "転送方法\n",
"type": "boolean",
"default": false
},
"last_path": {
"description": "最後に転送されたパス\n",
"type": "string"
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうかのフラグ\nヘッダー行を含まないCSV/TSVファイルの場合、TROCCO側で生成した仮のヘッダー名を割り当てます。\n",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか\n",
"type": "boolean",
"default": false
},
"decompression_type": {
"description": "解凍形式\n",
"type": "string",
"enum": [
"guess",
"zip",
"targz"
],
"default": "guess"
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderResponse",
"type": "object",
"properties": {
"decoder_type": {
"type": "string",
"description": "解凍方式\n"
},
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
},
"required": [
"decoder_type"
]
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersResponse",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"delimiter",
"quote",
"escape",
"null_string_enabled",
"skip_header_lines",
"trim_if_not_quoted",
"quotes_in_quoted_fields",
"allow_optional_columns",
"allow_extra_columns",
"max_quoted_size_limit",
"stop_on_invalid_record",
"default_time_zone",
"default_date",
"newline",
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"stop_on_invalid_record",
"default_time_zone",
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"newline",
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"default_time_zone",
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
],
"required": [
"column_name",
"charset",
"max_size_bytes",
"stop_on_oversize"
]
}
}
}
],
"required": [
"sftp_connection_id",
"path_prefix",
"incremental_loading_enabled",
"is_skip_header_line",
"stop_when_file_not_found",
"decompression_type"
]
}
]
},
"hubspot_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "HubspotInputOptionResponse",
"type": "object",
"description": "転送元HubSpotでの入力オプション\n",
"properties": {
"hubspot_connection_id": {
"type": "integer",
"description": "HubSpot接続情報ID\n"
},
"target": {
"type": "string",
"description": "取得対象の種類\n",
"enum": [
"object",
"association",
"engagement",
"engagement_association",
"email_event",
"pipeline",
"pipeline_stage",
"owner"
]
},
"from_object_type": {
"type": "string",
"nullable": true,
"description": "連携元オブジェクトタイプ(targetがassociationの場合に必須)\n"
},
"to_object_type": {
"type": "string",
"nullable": true,
"description": "連携先オブジェクトタイプ(targetがassociation, engagement_association, pipeline, pipeline_stageの場合に必須)\n"
},
"object_type": {
"type": "string",
"nullable": true,
"description": "オブジェクトタイプ(targetがobject, pipeline, pipeline_stageの場合に必須)\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "差分読み込みの有効化(targetがobjectの場合のみ有効)\n"
},
"last_record_time": {
"type": "string",
"nullable": true,
"description": "最後に読み込んだレコードの時刻(差分読み込みが有効な場合に使用)\n"
},
"email_event_type": {
"type": "string",
"nullable": true,
"description": "メールイベントのタイプ(targetがemail_eventの場合に必須)\n"
},
"start_timestamp": {
"type": "string",
"nullable": true,
"description": "開始タイムスタンプ(targetがemail_eventの場合に使用)\n"
},
"end_timestamp": {
"type": "string",
"nullable": true,
"description": "終了タイムスタンプ(targetがemail_eventの場合に使用)\n"
},
"properties": {
"type": "string",
"nullable": true,
"description": "取得するプロパティのカンマ区切り文字列(targetがobjectの場合に使用)。未指定の場合は全プロパティを取得します。\n"
},
"input_option_columns": {
"type": "array",
"description": "取得するカラムの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "タイムスタンプ型の場合のフォーマット\n",
"nullable": true
}
},
"required": [
"name",
"type"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"hubspot_connection_id",
"target",
"input_option_columns",
"incremental_loading_enabled"
]
}
]
},
"marketo_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MarketoInputOptionResponse",
"type": "object",
"description": "転送元Adobe Marketo Engageでの入力オプション\n",
"properties": {
"marketo_connection_id": {
"type": "integer",
"description": "Marketo接続情報ID\n"
},
"target": {
"type": "string",
"description": "取得対象データタイプ。リード、アクティビティ、プログラムメンバーのいずれかを選択した場合、データプレビューでは実際のデータではなくサンプルデータが出力されます。\n",
"enum": [
"lead",
"activity",
"campaign",
"all_lead_with_list_id",
"program",
"program_members",
"custom_object",
"list",
"activity_type",
"folder"
]
},
"from_date": {
"type": "string",
"nullable": true,
"description": "取得開始日時(ISO 8601形式)。target: lead/activityのみ有効。\n"
},
"end_date": {
"type": "string",
"nullable": true,
"description": "取得終了日時(ISO 8601形式)。target: lead/activityのみ有効。\n"
},
"use_updated_at": {
"type": "boolean",
"nullable": true,
"description": "更新日時をベースに取得するか、作成日時をベースに取得するか。target: leadのみ有効。\n"
},
"activity_type_ids": {
"type": "array",
"nullable": true,
"description": "アクティビティタイプID配列。指定したアクティビティタイプで絞り込みを行います。target: activityのみ有効。\n",
"items": {
"type": "integer"
}
},
"polling_interval_second": {
"type": "integer",
"nullable": true,
"description": "ポーリング間隔(秒)。target: lead/activityのみ有効。\n"
},
"bulk_job_timeout_second": {
"type": "integer",
"nullable": true,
"description": "バルクジョブタイムアウト(秒)。target: lead/activityのみ有効。\n"
},
"custom_object_api_name": {
"type": "string",
"nullable": true,
"description": "カスタムオブジェクトAPIName。通常、カスタムオブジェクト名に_cが付いた形式になっています。target: custom_objectのみ有効。\n"
},
"custom_object_filter_type": {
"type": "string",
"nullable": true,
"description": "カスタムオブジェクトフィルタタイプ。フィルターに用いることのできる値は整数値のみです。target: custom_objectのみ有効。\n"
},
"custom_object_filter_from_value": {
"type": "integer",
"nullable": true,
"description": "カスタムオブジェクトフィルタFrom値。開始値のデフォルト値は1です。target: custom_objectのみ有効。\n"
},
"custom_object_filter_to_value": {
"type": "integer",
"nullable": true,
"description": "カスタムオブジェクトフィルタTo値。終了値を指定しなかった場合は開始値よりも値が大きいデータを取得します。target: custom_objectのみ有効。\n"
},
"custom_object_fields": {
"type": "array",
"nullable": true,
"description": "カスタムオブジェクトフィールド配列。target: custom_objectのみ有効。\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィールド名\n"
}
},
"required": [
"name"
]
}
},
"list_ids": {
"type": "string",
"nullable": true,
"description": "リストID(カンマ区切り)。未入力の場合、全てのリスト配下のリードが対象になります。target: all_lead_with_list_idのみ有効。\n"
},
"program_ids": {
"type": "string",
"nullable": true,
"description": "プログラムID(カンマ区切り)。未入力の場合、全てのプログラム配下のメンバーが対象になります。target: program_membersのみ有効。\n"
},
"root_id": {
"type": "integer",
"nullable": true,
"description": "ルートフォルダ/プログラムID。未入力の場合、ワークスペース名のフォルダがルートフォルダーとなります。target: folderのみ有効。\n"
},
"root_type": {
"type": "string",
"nullable": true,
"description": "ルートタイプ。デフォルト値はフォルダーです。target: folderのみ有効。\n",
"enum": [
"folder",
"program"
]
},
"max_depth": {
"type": "integer",
"nullable": true,
"description": "取得したいデータの最大のフォルダー階層。デフォルト値は2です。target: folderのみ有効。\n"
},
"workspace": {
"type": "string",
"nullable": true,
"description": "ワークスペース名。未入力の場合、全てのワークスペース配下のフォルダーが対象になります。target: folderのみ有効。\n"
},
"input_option_columns": {
"type": "array",
"description": "取得するカラムの一覧\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"description": "データ型\n",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
}
},
"required": [
"name",
"type"
]
}
},
"marketo_input_option_filter_columns": {
"type": "array",
"nullable": true,
"description": "フィルター列配列。「カラムを指定する」を選択した場合、指定したカラムのみを取得対象とします。target: lead/all_lead_with_list_idのみ有効。\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィルター列名\n"
}
},
"required": [
"name"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"marketo_connection_id",
"target",
"input_option_columns"
]
}
]
},
"google_drive_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleDriveInputOptionResponse",
"type": "object",
"description": "転送元Google Driveでの入力オプション\n",
"properties": {
"google_drive_connection_id": {
"description": "Google Driveの接続情報のID",
"type": "integer"
},
"folder_id": {
"description": "フォルダID\n",
"type": "string"
},
"file_match_pattern": {
"description": "ファイル名のマッチパターン\n",
"type": "string"
},
"decompression_type": {
"description": "圧縮形式",
"type": "string",
"enum": [
"bzip2",
"gzip",
"targz",
"zip"
],
"nullable": true
},
"is_skip_header_line": {
"description": "ヘッダー行をスキップするかどうか\n",
"type": "boolean",
"default": false
},
"stop_when_file_not_found": {
"description": "指定のパスにファイルが存在しなかった場合に転送を続行するか",
"type": "boolean",
"default": false
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"decoder": {
"description": "解凍方式の指定\n",
"allOf": [
{
"title": "DecoderResponse",
"type": "object",
"properties": {
"decoder_type": {
"type": "string",
"description": "解凍方式\n"
},
"match_name": {
"type": "string",
"nullable": true,
"description": "解凍後の相対パス。未入力の場合、圧縮ファイル内のすべてのデータが転送対象になります。\n"
}
},
"required": [
"decoder_type"
]
},
{
"nullable": true
}
]
}
},
"allOf": [
{
"title": "ParsersResponse",
"type": "object",
"properties": {
"csv_parser": {
"allOf": [
{
"title": "CsvParser",
"type": "object",
"description": "CSV形式のファイルをパースするための設定。\n",
"properties": {
"delimiter": {
"description": "区切り文字\n",
"type": "string",
"default": ","
},
"quote": {
"description": "クォート文字\n",
"type": "string",
"default": "\""
},
"escape": {
"description": "エスケープ文字\n",
"type": "string",
"nullable": true,
"default": "\\"
},
"skip_header_lines": {
"description": "スキップするヘッダー行数\n",
"type": "integer",
"default": 0
},
"null_string_enabled": {
"description": "NULLに置換される文字列\n",
"type": "boolean",
"default": false
},
"null_string": {
"description": "置換元の文字列。未入力の場合、空文字がNULLに置換されます。\n",
"type": "string"
},
"trim_if_not_quoted": {
"description": "引用符がない場合に値から空白を取り除くかどうか\n",
"type": "boolean",
"default": false
},
"quotes_in_quoted_fields": {
"description": "イレギュラーなクオートの処理方式。クオート付きフィールド内で、イレギュラーなクオートが存在した場合の処理方法\n",
"type": "string",
"enum": [
"ACCEPT_ONLY_RFC4180_ESCAPED",
"ACCEPT_STRAY_QUOTES_ASSUMING_NO_DELIMITERS_IN_FIELDS"
],
"default": "ACCEPT_ONLY_RFC4180_ESCAPED"
},
"comment_line_marker": {
"description": "コメントラインマーカー。この文字が行の始めにあったらスキップします\n",
"type": "string"
},
"allow_optional_columns": {
"description": "カラム数が減っている行の処理。true: 足りないカラムをNULL補完する。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"allow_extra_columns": {
"description": "カラム数が増えている行の処理。 true: カラムを無視して処理。 false: 不正なレコードとして処理する\n",
"type": "boolean",
"default": false
},
"max_quoted_size_limit": {
"description": "引用符で囲める最大データ量\n",
"type": "integer",
"default": 131072
},
"stop_on_invalid_record": {
"description": "不正なレコードが存在した場合に転送を中止するかどうか。\n",
"type": "boolean",
"default": true
},
"default_time_zone": {
"description": "デフォルトのタイムゾーン\n",
"type": "string",
"default": "UTC"
},
"default_date": {
"description": "日付初期設定。時刻部分のみの値(例: 12:34:56)があった場合に設定される、日付部分のデフォルト値\n",
"type": "string",
"default": "1970-01-01"
},
"newline": {
"description": "改行コード\n",
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"default": "CRLF"
},
"charset": {
"description": "文字コード\n",
"type": "string"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"delimiter",
"quote",
"escape",
"null_string_enabled",
"skip_header_lines",
"trim_if_not_quoted",
"quotes_in_quoted_fields",
"allow_optional_columns",
"allow_extra_columns",
"max_quoted_size_limit",
"stop_on_invalid_record",
"default_time_zone",
"default_date",
"newline",
"columns"
]
},
"jsonl_parser": {
"allOf": [
{
"title": "JsonlParser",
"type": "object",
"description": "Jsonl形式のファイルをパースするための設定。\n",
"properties": {
"stop_on_invalid_record": {
"type": "boolean",
"description": "不正なレコードが存在した場合に転送を中止するかどうか\n",
"default": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"stop_on_invalid_record",
"default_time_zone",
"columns"
]
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"ltsv_parser": {
"allOf": [
{
"title": "LtsvParser",
"type": "object",
"description": "LTSV形式のファイルをパースするための設定。\n",
"properties": {
"newline": {
"type": "string",
"nullable": true,
"description": "改行コード\n",
"default": "CRLF"
},
"charset": {
"type": "string",
"nullable": true,
"description": "文字エンコーディング\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
],
"required": [
"newline",
"columns"
]
},
"excel_parser": {
"allOf": [
{
"title": "ExcelParser",
"type": "object",
"description": "Excel形式のファイルをパースするための設定。\n",
"properties": {
"default_time_zone": {
"type": "string",
"description": "日時カラムのタイムゾーン\n"
},
"sheet_name": {
"type": "string",
"description": "シート名\n"
},
"skip_header_lines": {
"type": "integer",
"description": "スキップするヘッダー行数\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"formula_handling": {
"type": "string"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"default_time_zone",
"sheet_name",
"skip_header_lines",
"columns"
]
},
"xml_parser": {
"allOf": [
{
"title": "XmlParser",
"type": "object",
"description": "XML形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルートのパス(XPath形式)\n"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。typeがtimestampのときに指定することができます。\n"
},
"path": {
"type": "string",
"description": "パス(XPath形式)\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン。typeがtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type",
"path"
]
}
}
},
"required": [
"root",
"columns"
]
},
{
"nullable": true
}
]
},
"parquet_parser": {
"allOf": [
{
"title": "ParquetParser",
"type": "object",
"description": "Parquet形式のファイルをパースするための設定。\n",
"properties": {
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"columns"
]
},
{
"nullable": true
}
]
},
"raw_parser": {
"allOf": [
{
"title": "RawParser",
"type": "object",
"description": "ファイル全体を1レコード(単一カラム)として読み込むための設定。\n改行やデリミタで分割しないため、ヘッダーの無い複数行の生ログを「1ファイル = 1レコード」で取り込む用途に利用します。\nカラムはこの設定で指定する単一カラムのみとなるため、columns の指定はありません。\n",
"properties": {
"column_name": {
"description": "ファイル全体の内容を格納するカラム名\n",
"type": "string",
"default": "record",
"minLength": 1,
"maxLength": 255
},
"charset": {
"description": "文字コード。\n注意: UTF-16(バイトオーダー未指定)を指定すると、JDK のデコーダが先頭の BOM を\nバイトオーダー指定として消費するため、取り込んだ値に BOM が残りません。\nバイト列を厳密に保持したい場合は UTF-16BE / UTF-16LE を指定してください。\n",
"type": "string",
"default": "UTF-8",
"enum": [
"UTF-8",
"UTF-16BE",
"UTF-16LE",
"UTF-16",
"Shift_JIS",
"US-ASCII",
"ISO-8859-1"
]
},
"max_size_bytes": {
"description": "1ファイルあたりに読み込む最大バイト数。\n超過した場合の挙動は stop_on_oversize で指定します。\n切り詰めはバイト単位で行われるため、末尾のマルチバイト文字が途中で切れる場合があります\n(切れた文字は出力に含まれません)。切り詰め時は末尾にマーカーが付与されるため、\n出力される値はこのバイト数をわずかに超えます。\n注意: ファイル内容を単一レコードとしてメモリ上に展開するため、1タスクあたりのピークメモリは\nこの値の約10倍になります(例: 上限の 256 MiB を指定すると 1 タスクあたり数 GiB のヒープを要します)。\nEmbulk は既定でコア数×2 タスクを並列実行するため、既定の 32 MiB を大きく超える値を設定する場合は\nworker のメモリサイジングに十分注意してください。\n",
"type": "integer",
"format": "int64",
"minimum": 1,
"maximum": 268435456,
"default": 33554432
},
"stop_on_oversize": {
"description": "max_size_bytes を超過した場合に転送を中止するかどうか。\nfalse の場合は超過分を切り詰め、切り詰めたことを示すマーカーを末尾に付与します。\n切り詰めても転送は成功扱いになり、データが欠けたことに気づけないため、既定は true です。\n",
"type": "boolean",
"default": true
}
}
},
{
"nullable": true
}
],
"required": [
"column_name",
"charset",
"max_size_bytes",
"stop_on_oversize"
]
}
}
}
],
"required": [
"folder_id",
"file_match_pattern",
"google_drive_connection_id"
]
}
]
},
"redshift_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "RedshiftInputOptionResponse",
"type": "object",
"description": "転送元redshiftのプロパティ\n",
"properties": {
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n",
"default": "public"
},
"query": {
"type": "string",
"description": "クエリ\n"
},
"fetch_rows": {
"type": "integer",
"description": "カーソルが一度に処理するレコード数\n",
"default": 10000
},
"connect_timeout": {
"type": "integer",
"description": "接続タイムアウト (秒)\n",
"default": 300
},
"socket_timeout": {
"type": "integer",
"description": "ソケットタイムアウト (秒)\n",
"default": 1800
},
"redshift_connection_id": {
"type": "integer",
"description": "Redshift接続情報ID\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"database",
"schema",
"query",
"fetch_rows",
"connect_timeout",
"socket_timeout",
"redshift_connection_id"
]
}
]
},
"oracle_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "OracleInputOptionResponse",
"type": "object",
"description": "転送元oracleのプロパティ\n",
"properties": {
"oracle_connection_id": {
"type": "integer",
"description": "Oracle接続情報ID\n"
},
"database": {
"type": "string",
"nullable": true,
"description": "データベース名 (SID または サービス名)。接続情報でTNSネーミング (tns_admin_ora) を使用している場合は不要です。\n"
},
"connection_type": {
"type": "string",
"enum": [
"sid",
"service_name"
],
"description": "databaseの解釈方法。sid: SID として解釈, service_name: サービス名として解釈。接続情報でTNSネーミングを使用している場合は無視されます。\n",
"default": "sid"
},
"net_service_name": {
"type": "string",
"nullable": true,
"description": "接続情報でTNSネーミング (tns_admin_ora) を使用している場合の接続識別子 (tnsnames.ora内のエントリ名)\n"
},
"schema": {
"type": "string",
"nullable": true,
"description": "スキーマ名。差分転送の場合に指定します。未指定の場合はデフォルトスキーマが参照されます。\n"
},
"query": {
"type": "string",
"nullable": true,
"description": "クエリ。クエリを使用して転送する場合に指定します。\n"
},
"incremental_loading_enabled": {
"type": "boolean",
"description": "転送方法。\ntrue: 差分転送 (前回転送時からの増分データのみ転送)\nfalse: クエリを使用して転送\n",
"default": false
},
"table": {
"type": "string",
"nullable": true,
"description": "テーブル名。差分転送の場合必須です。\n"
},
"incremental_columns": {
"type": "string",
"nullable": true,
"description": "増分データを判別するカラム。\nここで指定したカラムの値が、転送の度に「最後に転送されたレコード」に保存されます。\n2回目以降の転送時は、「増分データを判別するカラム」の値が前回転送時の値 (=「最後に転送されたレコード」) より大きいレコードのみ転送します。\n複数カラム指定したい場合はカンマ区切りで指定してください。未指定の場合、プライマリーキーが利用されます。\n"
},
"last_record": {
"type": "string",
"nullable": true,
"description": "最後に転送されたレコード\n差分更新時はここで指定された値より新しいデータを転送します。\n複数カラムが指定されている場合はカンマ区切りで指定してください (例: `123,2026-01-01T00:00:00.000000`)。\nDATE型・TIMESTAMP型のカラムの値は `yyyy-MM-ddTHH:mm:ss.SSSSSS` の形式で指定してください。\nNUMBER型のカラムを増分データを判別するカラムに使う場合は、input_option_column_options で該当カラムを string に指定してください。\n空欄の場合は最初から転送します。特別な理由がない限り、この値を変更しないでください。データの重複が起こる可能性があります。\n"
},
"source_time_zone": {
"type": "string",
"nullable": true,
"description": "取り込み時のデフォルトタイムゾーン。列がタイムゾーン情報を持たない場合(例:DATE型・TIMESTAMP型)、どのタイムゾーンの日時として取り込むかを指定します。未指定の場合は、転送を実行するマシンのタイムゾーンとして解釈されます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
},
"input_option_column_options": {
"allOf": [
{
"title": "OracleInputOptionColumnOption",
"type": "object",
"description": "取り込みデータ型指定 (NUMBER型など、精度が高くdouble/longで扱うと有効桁数を超えるカラムをstring型として取り込むための設定)\n",
"properties": {
"column_name": {
"type": "string",
"description": "対象のカラム名",
"example": "amount"
},
"column_value_type": {
"type": "string",
"enum": [
"string"
],
"description": "変換後のデータ型",
"example": "string"
}
},
"required": [
"column_name",
"column_value_type"
]
},
{
"nullable": true
}
]
},
"input_option_columns": {
"allOf": [
{
"title": "OracleInputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
},
"format": {
"type": "string",
"nullable": true,
"description": "カラムのフォーマット (type が timestamp の場合に指定)",
"example": "%Y/%m/%d %H:%M:%S"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "カラムのタイムゾーン (type が timestamp の場合に指定)",
"example": "Asia/Tokyo"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"oracle_connection_id",
"connection_type",
"incremental_loading_enabled",
"source_time_zone",
"input_option_columns"
]
}
]
},
"facebook_ads_insights_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "FacebookAdsInsightsInputOptionResponse",
"type": "object",
"description": "転送元Facebook Ad Insightsでの入力オプション\n",
"properties": {
"facebook_ads_insights_connection_id": {
"description": "Facebook Ad Insightsの接続情報のID\n",
"type": "integer"
},
"ad_account_id": {
"description": "Facebook広告アカウントID\n",
"type": "string"
},
"level": {
"description": "データ取得レベル\n",
"type": "string",
"enum": [
"account",
"campaign",
"adset",
"ad"
]
},
"time_range_since": {
"description": "期間開始日付(YYYY-MM-DD形式)\n",
"type": "string"
},
"time_range_until": {
"description": "期間終了日付(YYYY-MM-DD形式)\n",
"type": "string"
},
"use_unified_attribution_setting": {
"description": "統一アトリビューション設定の使用\n",
"type": "boolean",
"default": true
},
"fields": {
"description": "メトリクス・フィールド配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "フィールド名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"breakdowns": {
"description": "ブレークダウン配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "ブレークダウン名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"action_attribution_windows": {
"description": "アクション・アトリビューション・ウィンドウ配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "アトリビューション・ウィンドウ名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"action_breakdowns": {
"description": "アクション・ブレークダウン配列\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "アクション・ブレークダウン名\n",
"type": "string"
}
},
"required": [
"name"
]
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"facebook_ads_insights_connection_id",
"ad_account_id",
"level",
"time_range_since",
"time_range_until",
"use_unified_attribution_setting",
"fields",
"breakdowns",
"action_attribution_windows",
"action_breakdowns"
]
}
]
},
"custom_connector_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "CustomConnectorInputOptionResponse",
"type": "object",
"description": "転送元カスタムコネクタでの入力オプション。\nurl以下の項目はコネクタ定義からのスナップショットであり、read-onlyです(作成・更新のリクエストでは指定できません)。\n",
"properties": {
"custom_connector_endpoint_id": {
"description": "参照するカスタムコネクタのエンドポイントID\n",
"type": "integer",
"nullable": true
},
"custom_connector_connection_id": {
"description": "接続情報ID\n",
"type": "integer",
"nullable": true
},
"url": {
"description": "URL(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"auth_type": {
"description": "認証方式(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"auth_header_name": {
"description": "認証ヘッダ名(コネクタ定義からのスナップショット)\n",
"type": "string",
"nullable": true
},
"auth_header_scheme": {
"description": "認証ヘッダのスキーム(コネクタ定義からのスナップショット)\n",
"type": "string",
"nullable": true
},
"endpoint_path": {
"description": "エンドポイントパス(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"endpoint_method": {
"description": "HTTPメソッド(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"endpoint_request_body": {
"description": "リクエストボディ(コネクタ定義からのスナップショット)\n",
"type": "string",
"nullable": true
},
"success_codes": {
"description": "正常系と判定するステータスコード(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"not_retryable_codes": {
"description": "リトライ対象外のステータスコード(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"request_timeout_sec": {
"description": "レスポンス待機のタイムアウト秒(コネクタ定義からのスナップショット)。\nこの項目の導入前に作成された転送設定では null になり、その場合は 30 秒として扱われます\n",
"type": "integer",
"nullable": true
},
"query_parameters": {
"description": "クエリパラメータの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"headers": {
"description": "リクエストヘッダの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"path_parameters": {
"description": "パスパラメータの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"request_body_parameters": {
"description": "リクエストボディパラメータの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"paginator": {
"description": "ページネーション設定(コネクタ定義からのスナップショット)。ページネーションが設定されていない場合は`null`。\n未設定の項目はキー自体を省略します。\n",
"type": "object",
"nullable": true,
"properties": {
"inject_into": {
"description": "ページング用パラメータの注入先\n",
"type": "string",
"enum": [
"query",
"request_body"
]
},
"pagination_strategy": {
"description": "ページネーション戦略です。type により保持する属性が異なります。\n",
"oneOf": [
{
"type": "object",
"title": "OffsetIncrementStrategy",
"properties": {
"type": {
"type": "string",
"enum": [
"offset_increment"
]
},
"page_size": {
"type": "integer"
},
"start_from_offset": {
"type": "integer",
"nullable": true
},
"first_offset": {
"type": "integer",
"nullable": true
},
"inject_on_first_request": {
"type": "boolean",
"nullable": true
},
"last_page_size": {
"type": "integer",
"nullable": true
},
"total_records": {
"type": "integer",
"nullable": true
},
"stop_on_offset": {
"type": "integer",
"nullable": true
},
"max_request_count": {
"type": "integer",
"nullable": true
}
},
"required": [
"type"
]
},
{
"type": "object",
"title": "PageIncrementStrategy",
"properties": {
"type": {
"type": "string",
"enum": [
"page_increment"
]
},
"page_size": {
"type": "integer"
},
"start_from_page": {
"type": "integer",
"nullable": true
},
"first_page": {
"type": "integer",
"nullable": true
},
"inject_on_first_request": {
"type": "boolean",
"nullable": true
},
"last_page_size": {
"type": "integer",
"nullable": true
},
"total_pages": {
"type": "integer",
"nullable": true
},
"stop_on_page": {
"type": "integer",
"nullable": true
},
"max_request_count": {
"type": "integer",
"nullable": true
}
},
"required": [
"type"
]
},
{
"type": "object",
"title": "CursorBasedStrategy",
"properties": {
"type": {
"type": "string",
"enum": [
"cursor_based"
]
},
"page_size": {
"type": "integer"
},
"cursor_value": {
"type": "string",
"nullable": true
},
"last_page_size": {
"type": "integer",
"nullable": true
},
"stop_on_blank": {
"type": "boolean",
"nullable": true
}
},
"required": [
"type"
]
}
]
},
"page_size_option": {
"type": "object",
"nullable": true,
"properties": {
"field_name": {
"type": "string"
}
}
},
"page_token_option": {
"type": "object",
"nullable": true,
"properties": {
"field_name": {
"type": "string"
}
}
},
"page_end_option": {
"type": "object",
"nullable": true,
"properties": {
"field_name": {
"type": "string"
}
}
}
}
},
"jsonpath_parser": {
"allOf": [
{
"title": "JsonpathParser",
"type": "object",
"description": "JsonPath形式のファイルをパースするための設定。\n",
"properties": {
"root": {
"type": "string",
"description": "ルート\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"columns": {
"description": "カラム設定\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"format": {
"type": "string",
"description": "フォーマット。型がtimestampのときに指定することができます。\n"
},
"time_zone": {
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
}
}
},
{
"nullable": true
}
],
"required": [
"root",
"default_time_zone",
"columns"
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"url",
"endpoint_path",
"endpoint_method",
"success_codes",
"not_retryable_codes"
]
}
]
},
"backlog_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BacklogInputOptionResponse",
"type": "object",
"description": "転送元Backlogの入力オプション(レスポンス)\n",
"properties": {
"backlog_connection_id": {
"description": "Backlog接続情報のID\n",
"type": "integer",
"example": 123
},
"path": {
"description": "APIエンドポイントのパス\n\nエンドポイントにより、以下のオプショナルフィールドも含まれます:\n- path_parameter__*: パスパラメータ(例: path_parameter__project_id_or_key)\n- parameter__*: クエリパラメータ(例: parameter__activityTypeId)\n",
"type": "string",
"example": "api/v2/issues"
},
"input_option_columns": {
"description": "レスポンスデータのカラム定義\n",
"type": "array",
"items": {
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
},
"nullable": true,
"example": [
{
"name": "id",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "created",
"type": "timestamp",
"format": "%Y-%m-%d %H:%M:%S"
}
]
},
"custom_variable_settings": {
"description": "カスタム変数一覧です。\n",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"backlog_connection_id",
"path"
],
"additionalProperties": true
}
]
},
"kaonavi_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "KaonaviInputOptionResponse",
"type": "object",
"description": "転送元カオナビの入力オプション(レスポンス)\n",
"properties": {
"kaonavi_connection_id": {
"description": "カオナビ接続情報のID\n",
"type": "integer",
"example": 123
},
"path": {
"description": "APIエンドポイントのパス\n\nエンドポイントにより、以下のオプショナルフィールドも含まれます:\n- path_parameter__*: パスパラメータ(例: path_parameter__sheet_id)\n",
"type": "string",
"example": "api/v2/member_layouts"
},
"input_option_columns": {
"description": "レスポンスデータのカラム定義\n",
"type": "array",
"items": {
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
},
"nullable": true,
"example": [
{
"name": "id",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "created",
"type": "timestamp",
"format": "%Y-%m-%d %H:%M:%S"
}
]
},
"custom_variable_settings": {
"description": "カスタム変数一覧です。\n",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"kaonavi_connection_id",
"path"
],
"additionalProperties": true
}
]
},
"smart_hr_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SmartHrInputOptionResponse",
"type": "object",
"description": "転送元SmartHRの入力オプション(レスポンス)\n",
"properties": {
"smart_hr_connection_id": {
"description": "SmartHR接続情報のID\n",
"type": "integer",
"example": 123
},
"path": {
"description": "APIエンドポイントのパス\n\nエンドポイントにより、以下のオプショナルフィールドも含まれます:\n- path_parameter__*: パスパラメータ(例: path_parameter__crew_id)\n",
"type": "string",
"example": "api/v1/crews"
},
"input_option_columns": {
"description": "レスポンスデータのカラム定義\n",
"type": "array",
"items": {
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
},
"nullable": true,
"example": [
{
"name": "id",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "created",
"type": "timestamp",
"format": "%Y-%m-%d %H:%M:%S"
}
]
},
"custom_variable_settings": {
"description": "カスタム変数一覧です。\n",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"smart_hr_connection_id",
"path"
],
"additionalProperties": true
}
]
},
"bakuraku_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BakurakuInputOptionResponse",
"type": "object",
"description": "転送元バクラクの入力オプション(レスポンス)\n",
"properties": {
"bakuraku_connection_id": {
"description": "バクラク接続情報のID\n",
"type": "integer",
"example": 123
},
"path": {
"description": "APIエンドポイントのパス\n\nエンドポイントにより、以下のオプショナルフィールドも含まれます:\n- path_parameter__*: パスパラメータ(例: path_parameter__id)\n- parameter__*: クエリパラメータ(例: parameter__approvedAtFrom)\n",
"type": "string",
"example": "rest/v1/workflow/requests"
},
"input_option_columns": {
"description": "レスポンスデータのカラム定義\n",
"type": "array",
"items": {
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
},
"nullable": true,
"example": [
{
"name": "id",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "created",
"type": "timestamp",
"format": "%Y-%m-%d %H:%M:%S"
}
]
},
"custom_variable_settings": {
"description": "カスタム変数一覧です。\n",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"bakuraku_connection_id",
"path"
],
"additionalProperties": true
}
]
},
"pagerduty_input_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "PagerdutyInputOptionResponse",
"type": "object",
"description": "転送元PagerDutyの入力オプション(レスポンス)\n",
"properties": {
"pagerduty_connection_id": {
"description": "PagerDuty接続情報のID\n",
"type": "integer",
"example": 123
},
"path": {
"description": "APIエンドポイントのパス\n\nエンドポイントにより、以下のオプショナルフィールドも含まれます:\n- parameter__*: クエリパラメータ(例: parameter__earliest)\n",
"type": "string",
"example": "oncalls"
},
"input_option_columns": {
"description": "レスポンスデータのカラム定義\n",
"type": "array",
"items": {
"title": "InputOptionColumn",
"type": "object",
"description": "カラム情報\n",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"type": {
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"double",
"string",
"json"
],
"description": "カラムの型"
}
},
"required": [
"name",
"type"
]
},
"nullable": true,
"example": [
{
"name": "id",
"type": "string"
},
{
"name": "name",
"type": "string"
},
{
"name": "created",
"type": "timestamp",
"format": "%Y-%m-%d %H:%M:%S"
}
]
},
"custom_variable_settings": {
"description": "カスタム変数一覧です。\n",
"nullable": true,
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
}
]
}
},
"required": [
"pagerduty_connection_id",
"path"
],
"additionalProperties": true
}
]
}
}
}
]
},
"output_option_type": {
"description": "転送先の種別",
"type": "string",
"enum": [
"bigquery",
"snowflake",
"salesforce",
"google_spreadsheets",
"google_ads_customer_match",
"databricks",
"kintone",
"postgresql",
"mysql",
"s3",
"sftp",
"yahoo_display_ads_audience_list",
"hubspot",
"google_drive",
"gcs",
"facebook_custom_audience",
"braze",
"redshift",
"custom_connector"
]
},
"output_option": {
"description": "転送先の設定の詳細",
"type": "object",
"allOf": [
{
"title": "OutputOption",
"type": "object",
"description": "転送元の設定内容\n",
"properties": {
"bigquery_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BigQueryResponse",
"type": "object",
"description": "転送先BigQueryの設定内容\n",
"properties": {
"dataset": {
"type": "string",
"description": "データセット名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"mode": {
"type": "string",
"enum": [
"append",
"append_direct",
"replace",
"delete_in_advance",
"merge"
],
"description": "転送モード\n",
"default": "append"
},
"location": {
"type": "string",
"description": "データセットのロケーション\n",
"default": "US"
},
"auto_create_dataset": {
"type": "boolean",
"description": "データセットの自動生成オプション\n",
"default": false
},
"open_timeout_sec": {
"type": "integer",
"description": "接続開始までのタイムアウト (秒)\n",
"default": 300
},
"timeout_sec": {
"type": "integer",
"description": "タイムアウト (秒)\n",
"default": 300
},
"send_timeout_sec": {
"type": "integer",
"description": "送信タイムアウト (秒)\n",
"default": 300
},
"read_timeout_sec": {
"type": "integer",
"description": "読込タイムアウト (秒)\n",
"default": 300
},
"retries": {
"type": "integer",
"description": "再試行回数\n",
"default": 5
},
"partitioning_type": {
"type": "string",
"enum": [
"ingestion_time",
"time_unit_column"
],
"description": "パーティショニング\nnull: パーティションなし\ningestion_time: 取り込み時間により分割\ntime_unit_column: フィールドにより分割\n",
"nullable": true
},
"time_partitioning_type": {
"type": "string",
"enum": [
"HOUR",
"DAY",
"MONTH",
"YEAR"
],
"description": "パーティションタイプ\n",
"nullable": true
},
"time_partitioning_field": {
"type": "string",
"description": "パーティションフィールド\n分割の基準として用いるフィールドを、DATE, TIMESTAMP, DATETIMEのいずれかの型のフィールドから指定してください。\n",
"nullable": true
},
"time_partitioning_expiration_ms": {
"type": "integer",
"description": "パーティションの存続期間\nパーティションの存続期間 (ミリ秒) です。最小値はありません。パーティションの日付にこの整数値を足した値が有効期限になります。デフォルト値は指定なし (永久に保存) です。\n",
"nullable": true
},
"template_table": {
"type": "string",
"description": "スキーマ情報をテンプレートとして参照するテーブル\nこのテーブルのスキーマ情報からGoogle BigQueryへの取り込み時のスキーマ情報を生成します\n",
"nullable": true
},
"retain_column_descriptions": {
"type": "boolean",
"description": "転送モードで全件洗い替え (REPLACE)を選択したときにテーブル再作成時にカラムの説明(Description)を保持するかどうか\n",
"nullable": true
},
"retain_column_policy_tags": {
"type": "boolean",
"description": "転送モードで全件洗い替え (REPLACE)を選択したときにテーブル再作成時にカラムのポリシータグ(Policy Tag)を保持するかどうか\n",
"nullable": true
},
"bigquery_connection_id": {
"type": "string",
"description": "BigQuery接続情報ID\n"
},
"bigquery_output_option_column_options": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BOOLEAN",
"INTEGER",
"FLOAT",
"STRING",
"TIMESTAMP",
"DATETIME",
"DATE",
"RECORD",
"NUMERIC",
"JSON"
],
"description": "データ型\n"
},
"mode": {
"type": "string",
"enum": [
"NULLABLE",
"REQUIRED",
"REPEATED"
],
"description": "モード\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
},
"description": {
"nullable": true,
"type": "string",
"description": "説明\n"
},
"fields": {
"type": "array",
"nullable": true,
"description": "ネストされたフィールド定義(typeがRECORDの場合)。最大3レベルまでネスト可能。\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "フィールド名\n"
},
"type": {
"type": "string",
"enum": [
"BOOLEAN",
"INTEGER",
"FLOAT",
"STRING",
"TIMESTAMP",
"DATETIME",
"DATE",
"RECORD",
"NUMERIC",
"JSON"
],
"description": "データ型\n"
},
"mode": {
"type": "string",
"enum": [
"NULLABLE",
"REQUIRED",
"REPEATED"
],
"description": "モード\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
},
"description": {
"type": "string",
"nullable": true,
"description": "説明\n"
},
"fields": {
"type": "array",
"nullable": true,
"description": "さらにネストされたフィールド定義(最大3レベル)\n"
}
},
"required": [
"name",
"type"
]
}
}
},
"required": [
"name",
"type",
"mode"
]
}
},
"bigquery_output_option_clustering_fields": {
"type": "array",
"items": {
"type": "string"
},
"description": "クラスタリング化列\nクラスタリングはテーブル新規作成時のみ設定できます。クラスタ化列は最大で4つ指定できます。\n"
},
"bigquery_output_option_merge_keys": {
"type": "array",
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"dataset",
"table",
"mode",
"auto_create_dataset",
"open_timeout_sec",
"timeout_sec",
"send_timeout_sec",
"read_timeout_sec",
"retries",
"location",
"bigquery_connection_id",
"bigquery_output_option_column_options",
"bigquery_output_option_clustering_fields",
"bigquery_output_option_merge_keys"
]
}
]
},
"braze_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "BrazeOutputOptionResponse",
"type": "object",
"description": "転送先Brazeの設定内容\n",
"properties": {
"braze_connection_id": {
"type": "integer",
"description": "Braze接続情報ID\n"
},
"object_type": {
"type": "string",
"description": "オブジェクト\n- `attributes`: user attributes\n- `events`: events\n- `purchases`: purchases\n",
"enum": [
"attributes",
"events",
"purchases"
]
}
},
"required": [
"braze_connection_id",
"object_type"
]
}
]
},
"snowflake_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SnowflakeResponse",
"type": "object",
"description": "転送先Snowflakeの設定内容\n",
"properties": {
"warehouse": {
"type": "string",
"description": "ウェアハウス名\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge"
],
"description": "転送モード\n",
"default": "insert"
},
"empty_field_as_null": {
"type": "boolean",
"description": "空文字をNULLに置換するかどうか\n",
"default": true
},
"delete_stage_on_error": {
"type": "boolean",
"description": "エラー時に一時ステージを削除するかどうか\n",
"default": false
},
"escape_with_enclosing": {
"type": "boolean",
"description": "データ内の改行・タブ文字を保持するかどうか\n",
"default": false
},
"batch_size": {
"type": "integer",
"description": "バッチサイズ (MB)\n",
"default": 50
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n",
"default": 12
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n",
"default": 1000
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n再試行時の待ち時間の上限\n",
"default": 1800000
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "UTC"
},
"snowflake_connection_id": {
"type": "integer",
"description": "Snowflake接続情報ID\n"
},
"snowflake_output_option_column_options": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BIGINT",
"INTEGER",
"VARCHAR",
"STRING",
"BOOLEAN",
"DOUBLE",
"DOUBLE PRECISION",
"DATE",
"DATETIME",
"TIMESTAMP",
"TIME",
"VARIANT",
"OBJECT",
"ARRAY",
"NUMBER"
],
"description": "データ型\n"
},
"value_type": {
"type": "string",
"enum": [
"byte",
"short",
"int",
"long",
"double",
"float",
"boolean",
"string",
"nstring",
"date",
"time",
"timestamp",
"decimal",
"json",
"null"
],
"description": "value type\nもし、デフォルト値を設定したい場合、value_typeは設定しないでください。\n詳細: https://documents.trocco.io/docs/data-destination-snowflake\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
},
"snowflake_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"warehouse",
"database",
"schema",
"table",
"mode",
"delete_stage_on_error",
"default_time_zone",
"retry_limit",
"retry_wait",
"max_retry_wait",
"empty_field_as_null",
"batch_size",
"snowflake_connection_id"
]
}
]
},
"salesforce_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SalesforceResponse",
"type": "object",
"description": "転送先Salesforceの設定内容\n",
"properties": {
"object": {
"type": "string",
"description": "オブジェクト名\n"
},
"action_type": {
"type": "string",
"description": "転送モード\n",
"enum": [
"insert",
"upsert",
"update",
"delete"
],
"default": "insert"
},
"api_version": {
"type": "string",
"description": "Salesforce APIバージョン\n",
"default": "64.0"
},
"upsert_key": {
"type": "string",
"description": "Upsertキー\n転送モードにUPSERTを選択した場合はキーとなるカラム名を入力してください。\n"
},
"update_key": {
"type": "string",
"description": "更新キー\n転送モードにUPDATEを選択した場合はキーとなるカラム名を入力してください。\n"
},
"delete_key": {
"type": "string",
"description": "削除キー\n転送モードにDELETEを選択した場合、削除対象を特定するキーとなる転送元データのカラム名を入力してください。\n「Id」(デフォルト)の場合はそのカラムの値をSalesforceレコードId(SFID)として直接削除します。\nそれ以外のSalesforceフィールド名を指定した場合は、その値をキーにSOQLでレコードIdを解決してから削除します。\n未指定の場合は「Id」カラムが使用されます。\n"
},
"ignore_nulls": {
"type": "boolean",
"description": "NULLを含む場合の更新処理\ntrueの場合更新をスキップします\nfalseの場合、NULLで更新します\n",
"default": false
},
"throw_if_failed": {
"type": "boolean",
"description": "送信できなかったレコードがある場合のステータス\ntrueの場合、Errorにします\nfalseの場合、Succeededにします。\n",
"default": true
},
"batch_size": {
"type": "integer",
"description": "1回のAPIコールあたりのレコード数(1〜200)\n",
"default": 200,
"minimum": 1,
"maximum": 200
},
"salesforce_connection_id": {
"type": "integer",
"description": "Salesforce接続情報ID\n"
},
"associations": {
"type": "array",
"description": "他オブジェクトへの関連付け設定\n\n参照関係フィールドに外部IDを使ってレコードを関連付けるための設定です\n",
"items": {
"type": "object",
"properties": {
"reference_field": {
"type": "string",
"description": "参照関係フィールド名(例: AccountId)\n"
},
"referenced_object": {
"type": "string",
"description": "参照先オブジェクト名(例: Account)\n"
},
"unique_key": {
"type": "string",
"description": "参照先オブジェクトのユニークキー(例: External_Id__c)\n"
},
"source_column": {
"type": "string",
"description": "転送データ側のカラム名(例: account_code)\n"
}
}
}
},
"auto_remove_deleted_columns": {
"type": "boolean",
"description": "転送先から削除されたカラムをSTEP2から自動削除するか\n"
}
},
"required": [
"object",
"action_type",
"api_version",
"ignore_nulls",
"throw_if_failed",
"batch_size",
"salesforce_connection_id"
]
}
]
},
"google_spreadsheets_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleSpreadsheetsResponse",
"type": "object",
"description": "転送先Google Spreadsheetsの設定内容\n",
"properties": {
"google_spreadsheets_connection_id": {
"type": "string",
"description": "Google Spreadsheets接続情報ID\n"
},
"spreadsheets_id": {
"type": "string",
"description": "シートID\n"
},
"worksheet_title": {
"type": "string",
"description": "シート名\n"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"example": "Asia/Tokyo"
},
"value_input_option": {
"type": "string",
"description": "値の入力方法\n- `RAW`: セルの書式設定を適用しない\n- `USER_ENTERED`: セルの書式設定を適用する\n",
"enum": [
"RAW",
"USER_ENTERED"
]
},
"mode": {
"type": "string",
"description": "転送モード\n- `replace`: 全件洗い替え (シート作り直し)\n- `append`: 追記 (APPEND)\n- `truncate_insert`: 全件洗い替え (既存シート引き継ぎ)\n",
"enum": [
"replace",
"append",
"truncate_insert"
]
},
"start_row": {
"type": "integer",
"default": 1,
"description": "出力開始行。\n見出しを書き込む最初の行を入力してください。データはその次の行から書き込まれます。\n"
},
"start_column": {
"type": "string",
"default": "A",
"description": "出力開始列。\n書き込みを開始する列をアルファベットで入力してください。\n"
},
"google_spreadsheets_output_option_sorts": {
"type": "array",
"description": "データ順序\n",
"items": {
"type": "object",
"properties": {
"column": {
"type": "string",
"description": "ソートキー名\n"
},
"order": {
"type": "string",
"description": "ソート順\n",
"enum": [
"ascending",
"descending"
]
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"google_spreadsheets_connection_id",
"spreadsheets_id",
"timezone",
"value_input_option",
"mode"
]
}
]
},
"google_ads_customer_match_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleAdsCustomerMatchResponse",
"type": "object",
"description": "転送先Google Ads Customer Matchの設定内容\n",
"properties": {
"google_ads_connection_id": {
"type": "integer",
"description": "Google Ads接続情報ID\n"
},
"app_id": {
"type": "string",
"nullable": true,
"description": "モバイル デバイス ID\nupload_key_type が mobile_advertising_id の場合は必須\n"
},
"customer_id": {
"type": "string",
"description": "お客様 ID\n"
},
"upload_key_type": {
"type": "string",
"enum": [
"contact_info",
"crm_id",
"mobile_advertising_id"
],
"description": "データの種類\n",
"default": "contact_info"
},
"user_list_name": {
"type": "string",
"description": "顧客リスト名\n"
},
"description": {
"type": "string",
"nullable": true,
"description": "説明文\n"
},
"operation": {
"type": "string",
"enum": [
"insert",
"truncate_insert"
],
"description": "転送モード\n",
"default": "insert"
},
"wait_for_completion": {
"type": "boolean",
"description": "カスタマーマッチの作成および更新完了まで待つ\n"
},
"member_ship_duration": {
"type": "integer",
"description": "有効期間(日)\n"
},
"ad_user_data_consent": {
"type": "string",
"enum": [
"unspecified",
"granted",
"denied"
],
"description": "広告ユーザーデータに関する同意\n",
"default": "granted"
},
"ad_personalization_consent": {
"type": "string",
"enum": [
"unspecified",
"granted",
"denied"
],
"description": "広告のパーソナライズに対する同意\n",
"default": "granted"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"google_ads_connection_id",
"customer_id",
"upload_key_type",
"member_ship_duration",
"operation",
"wait_for_completion",
"ad_user_data_consent",
"ad_personalization_consent"
]
}
]
},
"yahoo_display_ads_audience_list_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "YahooDisplayAdsAudienceListResponse",
"type": "object",
"description": "転送先Yahoo!広告 ディスプレイ広告 オーディエンスリストの設定内容\n",
"properties": {
"yahoo_ads_api_connection_id": {
"type": "integer",
"description": "Yahoo!広告 API接続情報ID\n"
},
"base_account_id": {
"type": "string",
"description": "ベースアカウントID\n"
},
"account_id": {
"type": "string",
"description": "アカウントID\n"
},
"audience_list_name": {
"type": "string",
"description": "オーディエンスリスト名\n"
},
"description": {
"type": "string",
"nullable": true,
"description": "オーディエンスリストの説明\n"
},
"upload_type": {
"type": "string",
"enum": [
"mail_address_and_phone_number",
"idfa",
"aaid"
],
"description": "連携データタイプ\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"truncate_insert"
],
"description": "転送モード\n"
},
"wait_for_completion": {
"type": "boolean",
"description": "データのアップロード完了まで待つ\n"
},
"data_duration": {
"type": "integer",
"description": "データの有効期間(日)\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"yahoo_ads_api_connection_id",
"base_account_id",
"account_id",
"audience_list_name",
"upload_type",
"mode",
"wait_for_completion",
"data_duration"
]
}
]
},
"s3_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "S3OutputOption",
"type": "object",
"description": "転送先Amazon S3の設定内容\n",
"properties": {
"s3_connection_id": {
"type": "integer",
"description": "Amazon S3接続情報\n"
},
"bucket": {
"type": "string",
"description": "バケット\n"
},
"path_prefix": {
"type": "string",
"description": "パスプレフィックス\n"
},
"region": {
"type": "string",
"enum": [
"ap-east-1",
"ap-northeast-1",
"ap-northeast-2",
"ap-northeast-3",
"ap-south-1",
"ap-southeast-1",
"ap-southeast-2",
"ca-central-1",
"eu-central-1",
"eu-north-1",
"eu-west-1",
"eu-west-2",
"eu-west-3",
"me-south-1",
"sa-east-1",
"us-east-1",
"us-east-2",
"us-west-1",
"us-west-2"
],
"description": "リージョン\n"
},
"file_ext": {
"type": "string",
"description": "出力ファイルの拡張子\n"
},
"sequence_format": {
"type": "string",
"description": "複数ファイル出力時の命名規則\n"
},
"canned_acl": {
"type": "string",
"enum": [
"NOT_SET",
"Private",
"PublicRead",
"PublicReadWrite",
"AwsExecRead",
"AuthenticatedRead",
"BucketOwnerRead",
"BucketOwnerFullControl",
"LogDeliveryWrite"
],
"description": "アクセスコントロールリスト\n"
},
"is_minimum_output_tasks": {
"type": "boolean",
"description": "転送モード\n出力ファイル数抑制転送を選択した場合、内部的には並列処理を抑えてファイル生成を行います。転送元が1ファイルの場合、転送先には1ファイルで生成されます。\n"
},
"multipart_upload_enabled": {
"type": "boolean",
"description": "マルチパートアップロード\n5GB以上のファイルを転送する場合は、マルチパートアップロードを有効にしてください。\n有効にする場合、稀に不完全なパートファイルがS3に残ることがあります。そのため、バケットライフサイクル設定を行うことを推奨します。\n"
},
"encoder_type": {
"type": "string",
"enum": [
"",
"gzip",
"bzip2",
"zip"
],
"nullable": true,
"description": "ファイル圧縮\n`\"gzip\"`、`\"bzip2\"`、`\"zip\"` を指定すると各圧縮形式が使用されます。\n空文字(`\"\"`)の場合は、圧縮なしとして扱われます。\n"
},
"formatter": {
"type": "object",
"nullable": true,
"description": "出力フォーマッタ設定\ntype が `csv` の場合は `csv_formatter` が、type が `jsonl` の場合は `jsonl_formatter` が含まれます。\n",
"properties": {
"type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "フォーマットタイプ。csv_formatter または jsonl_formatter のどちらが有効かを表します。\n\"csv\" の場合は `csv_formatter` が必ず存在し、`jsonl_formatter` は null です。\n\"jsonl\" の場合は `jsonl_formatter` が必ず存在し、`csv_formatter` は null です。\n"
},
"csv_formatter": {
"type": "object",
"nullable": true,
"description": "CSV/TSV出力設定。\ntype が `csv` の場合にのみ、この項目が含まれます。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字"
},
"quote": {
"type": "string",
"description": "クオート文字"
},
"escape": {
"type": "string",
"description": "エスケープ文字"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー"
},
"charset": {
"type": "string",
"description": "文字エンコーディング"
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字"
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換するか"
},
"null_string": {
"type": "string",
"nullable": true,
"description": "置換後の文字列"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名"
},
"format": {
"type": "string",
"description": "日付フォーマット"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン"
}
}
}
}
}
},
"jsonl_formatter": {
"type": "object",
"nullable": true,
"description": "JSON Lines出力設定。\ntype が `jsonl` の場合にのみ、この項目が含まれます。\n",
"properties": {
"encoding": {
"type": "string",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"description": "文字エンコーディング"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字"
},
"date_format": {
"type": "string",
"nullable": true,
"description": "日付のフォーマット"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン"
}
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"s3_connection_id",
"bucket",
"path_prefix",
"file_ext",
"canned_acl",
"is_minimum_output_tasks",
"multipart_upload_enabled",
"formatter"
]
}
]
},
"sftp_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "SftpOutputOption",
"type": "object",
"description": "転送先Amazon Sftpの設定内容\n",
"properties": {
"sftp_connection_id": {
"type": "integer",
"description": "Amazon Sftp接続情報\n"
},
"path_prefix": {
"type": "string",
"description": "パスプレフィックス\n"
},
"file_ext": {
"type": "string",
"description": "出力ファイルの拡張子\n"
},
"is_minimum_output_tasks": {
"type": "boolean",
"description": "転送モード\n出力ファイル数抑制転送を選択した場合、内部的には並列処理を抑えてファイル生成を行います。転送元が1ファイルの場合、転送先には1ファイルで生成されます。\n"
},
"encoder_type": {
"type": "string",
"enum": [
"",
"gzip",
"bzip2",
"zip"
],
"nullable": true,
"description": "ファイル圧縮\n`\"gzip\"`、`\"bzip2\"`、`\"zip\"` を指定すると各圧縮形式が使用されます。\n空文字(`\"\"`)の場合は、圧縮なしとして扱われます。\n"
},
"sequence_format": {
"type": "string",
"description": "複数ファイル出力時の命名規則\n",
"default": "%03d.%02d"
},
"formatter": {
"allOf": [
{
"title": "FormatterResponse",
"type": "object",
"description": "出力フォーマッタ設定\ntype が `csv` の場合は `csv_formatter` が、type が `jsonl` の場合は `jsonl_formatter` が含まれます。\n",
"properties": {
"type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "フォーマットタイプ。csv_formatter または jsonl_formatter のどちらが有効かを表します。\n\"csv\" の場合は `csv_formatter` が必ず存在し、`jsonl_formatter` は null です。\n\"jsonl\" の場合は `jsonl_formatter` が必ず存在し、`csv_formatter` は null です。\n"
},
"csv_formatter": {
"allOf": [
{
"title": "CsvFormatter",
"type": "object",
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"bom": {
"type": "boolean",
"description": "BOM\n",
"default": false
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
{
"nullable": true
}
]
},
"jsonl_formatter": {
"allOf": [
{
"title": "JsonlFormatter",
"type": "object",
"description": "JSON Lines出力設定\n`formatter_type` が `\"jsonl\"` の場合にのみ指定できます。\n`formatter_type` が `\"jsonl\"` の場合、この項目は **新規作成時に必須**です。\n`formatter_type` が `\"csv\"` の場合は指定しないでください。\n",
"properties": {
"encoding": {
"type": "string",
"description": "文字エンコーディング\n",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"default": "UTF-8"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字\n",
"default": "LF"
},
"date_format": {
"type": "string",
"description": "日付のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
},
{
"nullable": true
}
]
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"sftp_connection_id",
"path_prefix",
"file_ext",
"is_minimum_output_tasks"
]
}
]
},
"databricks_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "DatabricksOutputOptionResponse",
"type": "object",
"description": "転送先Databricksの設定内容\n",
"properties": {
"databricks_connection_id": {
"type": "integer",
"description": "Databricks接続情報\n"
},
"catalog_name": {
"type": "string",
"description": "カタログ名\n"
},
"schema_name": {
"type": "string",
"description": "スキーマ名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"batch_size": {
"type": "integer",
"description": "バッチサイズ\n"
},
"mode": {
"type": "string",
"description": "転送モード\n- `insert`: 追記 (APPEND)\n- `insert_direct`: 即時挿入(バッファなしのダイレクト INSERT)\n- `truncate_insert`: 全件洗い替え (既存シート引き継ぎ)\n- `replace`: 全件洗い替え (シート作り直し)\n- `merge`: マージ (UPSERT: 既存は更新、未存在は挿入)\n",
"enum": [
"replace",
"insert",
"insert_direct",
"truncate_insert",
"merge"
]
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "Etc/UTC"
},
"escape_with_enclosing": {
"type": "boolean",
"description": "データ内の改行・タブ・二重引用符を保持するかどうか\n",
"default": false
},
"databricks_output_option_column_options": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BIGINT",
"INT",
"SMALLINT",
"TINYINT",
"STRING",
"BOOLEAN",
"FLOAT",
"DOUBLE",
"DATE",
"TIMESTAMP"
],
"description": "データ型\n"
},
"value_type": {
"type": "string",
"enum": [
"byte",
"short",
"int",
"long",
"double",
"float",
"boolean",
"string",
"nstring",
"date",
"time",
"timestamp",
"decimal",
"json",
"null"
],
"description": "value type\nもし、デフォルト値を設定したい場合、value_typeは設定しないでください。\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"nullable": true,
"type": "string",
"description": "タイムゾーン\n"
}
},
"required": [
"name",
"type"
]
}
},
"databricks_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"databricks_connection_id",
"catalog_name",
"schema_name",
"table",
"batch_size",
"mode",
"default_time_zone"
]
}
]
},
"kintone_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "KintoneResponse",
"type": "object",
"description": "転送先kintoneの設定内容\n",
"properties": {
"kintone_connection_id": {
"type": "integer",
"description": "kintone接続情報ID\n"
},
"app_id": {
"type": "string",
"description": "アプリID\n"
},
"guest_space_id": {
"type": "string",
"nullable": true,
"description": "ゲストスペースID\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"update",
"upsert"
],
"description": "転送モード\n",
"default": "insert"
},
"update_key": {
"type": "string",
"nullable": true,
"description": "更新キー\nmode: update or upsertの場合のみ設定できます。\n"
},
"ignore_nulls": {
"type": "boolean",
"description": "NULL値を無視するかどうか\n",
"default": false
},
"reduce_key": {
"type": "string",
"nullable": true,
"description": "重複排除キー\n"
},
"chunk_size": {
"type": "integer",
"description": "チャンクサイズ\n",
"default": 100
},
"kintone_output_option_column_options": {
"type": "array",
"nullable": true,
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"field_code": {
"type": "string",
"description": "フィールドコード\n"
},
"type": {
"type": "string",
"enum": [
"SINGLE_LINE_TEXT",
"MULTI_LINE_TEXT",
"RICH_TEXT",
"NUMBER",
"CHECK_BOX",
"RADIO_BUTTON",
"MULTI_SELECT",
"DROP_DOWN",
"USER_SELECT",
"ORGANIZATION_SELECT",
"GROUP_SELECT",
"DATE",
"TIME",
"DATETIME",
"LINK",
"SUBTABLE"
],
"description": "フィールドタイプ\n"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\ntype: DATE, TIMEの場合のみ設定できます。\n"
},
"sort_column": {
"type": "string",
"nullable": true,
"description": "ソートカラム\ntype: SUBTABLEの場合のみ設定できます。\n"
}
},
"required": [
"name",
"field_code",
"type"
]
}
}
},
"required": [
"kintone_connection_id",
"app_id",
"mode",
"chunk_size",
"ignore_nulls"
]
}
]
},
"postgresql_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "PostgresqlOutputOptionResponse",
"type": "object",
"description": "転送先PostgreSQLの設定内容\n",
"properties": {
"postgresql_connection_id": {
"type": "integer",
"description": "PostgreSQL接続情報\n"
},
"database": {
"type": "string",
"description": "データベース\n"
},
"schema": {
"type": "string",
"description": "スキーマ\n"
},
"table": {
"type": "string",
"description": "テーブル\n入力したテーブルが存在しない場合、自動的に生成されます。\n"
},
"mode": {
"type": "string",
"description": "転送モード\n- `insert`: 追記 (INSERT)\n- `insert_direct`: 追記 (INSERT DIRECT)\n- `truncate_insert`: 全件洗い替え (TRUNCATE INSERT)\n- `replace`: 全件洗い替え (REPLACE)\n- `merge`: UPSERT (MERGE)\n",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge"
]
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\ntimestamp形式のカラムがあった場合は、タイムゾーンを指定可能です。\n"
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n"
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n"
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n"
},
"before_load": {
"type": "string",
"description": "ロード前に実行するSQL\n",
"nullable": true
},
"after_load": {
"type": "string",
"description": "ロード後に実行するSQL\n",
"nullable": true
},
"merge_keys": {
"type": "array",
"description": "マージキー\nここで指定したカラムの値が転送先テーブルに存在する場合、レコードが上書かれます。\n未指定の場合、転送先テーブル側のプライマリーキーが利用されます。\n",
"items": {
"type": "string"
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"postgresql_connection_id",
"database",
"schema",
"table",
"mode",
"default_time_zone",
"retry_limit",
"retry_wait",
"max_retry_wait",
"merge_keys"
]
}
]
},
"mysql_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "MysqlResponse",
"type": "object",
"description": "転送先MySQLの設定内容\n",
"properties": {
"mysql_connection_id": {
"type": "integer",
"description": "MySQL接続情報ID\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge",
"merge_direct"
],
"description": "転送モード\ninsert: 挿入\ninsert_direct: 直接挿入\ntruncate_insert: 切り捨て挿入\nreplace: 置換\nmerge: マージ\nmerge_direct: 直接マージ\n"
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n",
"default": 12
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n",
"default": 1000
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n再試行時の待ち時間の上限\n",
"default": 1800000
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n",
"default": "UTC"
},
"before_load": {
"type": "string",
"nullable": true,
"description": "転送前に実行するSQL文\nデータ転送の前に実行するSQL文を指定できます\n"
},
"after_load": {
"type": "string",
"nullable": true,
"description": "転送後に実行するSQL文\nデータ転送の後に実行するSQL文を指定できます\n"
},
"mysql_output_option_column_options": {
"type": "array",
"description": "カラム設定\nカラムごとの型を指定できます\n",
"nullable": true,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"TINYTEXT",
"TEXT",
"MEDIUMTEXT",
"LONGTEXT",
"DECIMAL",
"DATE",
"DATETIME",
"TIMESTAMP",
"TIME"
],
"description": "カラムの型\nTINYTEXT, TEXT, MEDIUMTEXT, LONGTEXT, DECIMAL, DATE, DATETIME, TIMESTAMP, TIMEから選択\n"
},
"scale": {
"type": "integer",
"nullable": true,
"description": "DECIMAL型の小数点以下の桁数\ntypeがDECIMALの場合に含まれます\n"
},
"precision": {
"type": "integer",
"nullable": true,
"description": "DECIMAL型の全体の桁数\ntypeがDECIMALの場合に含まれます\n"
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"mysql_connection_id",
"database",
"table",
"mode",
"retry_limit",
"retry_wait",
"max_retry_wait",
"default_time_zone"
]
}
]
},
"hubspot_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "HubspotOutputOptionResponse",
"type": "object",
"description": "転送先HubSpotの設定内容\n",
"properties": {
"hubspot_connection_id": {
"type": "integer",
"description": "HubSpot接続情報ID (auth_method が oauth のものに限る)\n"
},
"object_type": {
"type": "string",
"description": "オブジェクトタイプ\ncontact, company, deal, product, ticket, line_item, quote, orders, subscription, call, email, meeting, note, postal_mail, task, またはカスタムオブジェクト\n"
},
"mode": {
"type": "string",
"description": "転送モード\n- `merge`: マージ (UPSERT: 既存は更新、未存在は挿入)\n- `insert`: 追記 (INSERT)\n",
"enum": [
"merge",
"insert"
]
},
"upsert_key": {
"type": "string",
"nullable": true,
"description": "マージキー\n\nmodeが `merge` かつ object_typeが `subscription` 以外の場合に設定されます\n"
},
"number_of_parallels": {
"type": "integer",
"description": "並列処理数\n",
"minimum": 1,
"maximum": 10
},
"associations": {
"type": "array",
"description": "アソシエーション設定\n\nエンゲージメントオブジェクトの場合のみ存在します\n",
"items": {
"type": "object",
"properties": {
"to_object_type": {
"type": "string",
"description": "関連付け先のオブジェクトタイプ\n"
},
"from_object_key": {
"type": "string",
"description": "関連付け元のキー(転送データ内のカラム名)\n"
},
"to_object_key": {
"type": "string",
"description": "関連付け先のキー(HubSpot側のプロパティ名)\n"
}
}
}
},
"auto_remove_deleted_columns": {
"type": "boolean",
"description": "転送先から削除されたカラムをSTEP2から自動削除するか\n"
}
},
"required": [
"hubspot_connection_id",
"object_type",
"mode",
"number_of_parallels"
]
}
]
},
"google_drive_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GoogleDriveOutputOption",
"type": "object",
"description": "転送先Google Driveの設定内容\n",
"properties": {
"google_drive_connection_id": {
"type": "integer",
"description": "Google Drive接続情報\n"
},
"main_folder_id": {
"type": "string",
"description": "メインフォルダID\n"
},
"child_folder_name": {
"type": "string",
"nullable": true,
"description": "子フォルダ名\n"
},
"file_name": {
"type": "string",
"description": "ファイル名\n"
},
"formatter": {
"allOf": [
{
"title": "FormatterResponse",
"type": "object",
"description": "出力フォーマッタ設定\ntype が `csv` の場合は `csv_formatter` が、type が `jsonl` の場合は `jsonl_formatter` が含まれます。\n",
"properties": {
"type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "フォーマットタイプ。csv_formatter または jsonl_formatter のどちらが有効かを表します。\n\"csv\" の場合は `csv_formatter` が必ず存在し、`jsonl_formatter` は null です。\n\"jsonl\" の場合は `jsonl_formatter` が必ず存在し、`csv_formatter` は null です。\n"
},
"csv_formatter": {
"allOf": [
{
"title": "CsvFormatter",
"type": "object",
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"bom": {
"type": "boolean",
"description": "BOM\n",
"default": false
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
{
"nullable": true
}
]
},
"jsonl_formatter": {
"allOf": [
{
"title": "JsonlFormatter",
"type": "object",
"description": "JSON Lines出力設定\n`formatter_type` が `\"jsonl\"` の場合にのみ指定できます。\n`formatter_type` が `\"jsonl\"` の場合、この項目は **新規作成時に必須**です。\n`formatter_type` が `\"csv\"` の場合は指定しないでください。\n",
"properties": {
"encoding": {
"type": "string",
"description": "文字エンコーディング\n",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"default": "UTF-8"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字\n",
"default": "LF"
},
"date_format": {
"type": "string",
"description": "日付のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
},
{
"nullable": true
}
]
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"google_drive_connection_id",
"main_folder_id",
"file_name"
]
}
]
},
"gcs_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "GcsOutputOption",
"type": "object",
"description": "転送先Google Cloud Storageの設定内容\n",
"properties": {
"gcs_connection_id": {
"type": "integer",
"description": "Google Cloud Storage接続情報\n"
},
"bucket": {
"type": "string",
"description": "バケット\n"
},
"path_prefix": {
"type": "string",
"description": "パスプレフィックス\n"
},
"file_ext": {
"type": "string",
"description": "出力ファイルの拡張子\n"
},
"is_minimum_output_tasks": {
"type": "boolean",
"description": "転送モード\n出力ファイル数抑制転送を選択した場合、内部的には並列処理を抑えてファイル生成を行います。転送元が1ファイルの場合、転送先には1ファイルで生成されます。\n"
},
"encoder_type": {
"type": "string",
"enum": [
"",
"gzip",
"bzip2",
"zip"
],
"nullable": true,
"description": "ファイル圧縮\n`\"gzip\"`、`\"bzip2\"`、`\"zip\"` を指定すると各圧縮形式が使用されます。\n空文字(`\"\"`)の場合は、圧縮なしとして扱われます。\n"
},
"sequence_format": {
"type": "string",
"description": "複数ファイル出力時の命名規則\n",
"default": "%03d.%02d"
},
"formatter": {
"allOf": [
{
"title": "FormatterResponse",
"type": "object",
"description": "出力フォーマッタ設定\ntype が `csv` の場合は `csv_formatter` が、type が `jsonl` の場合は `jsonl_formatter` が含まれます。\n",
"properties": {
"type": {
"type": "string",
"enum": [
"csv",
"jsonl"
],
"description": "フォーマットタイプ。csv_formatter または jsonl_formatter のどちらが有効かを表します。\n\"csv\" の場合は `csv_formatter` が必ず存在し、`jsonl_formatter` は null です。\n\"jsonl\" の場合は `jsonl_formatter` が必ず存在し、`csv_formatter` は null です。\n"
},
"csv_formatter": {
"allOf": [
{
"title": "CsvFormatter",
"type": "object",
"description": "CSV/TSV出力設定。\n`formatter_type` が `\"csv\"` の場合にのみ指定できます。\n`formatter_type` が `\"csv\"` の場合、この項目は新規作成時に必須です。\n`formatter_type` が `\"jsonl\"` の場合は指定しないでください。\n",
"properties": {
"delimiter": {
"type": "string",
"description": "区切り文字\n",
"default": ","
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "改行文字\n",
"default": "CRLF"
},
"newline_in_field": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR"
],
"description": "フィールド内での改行文字\n",
"default": "LF"
},
"charset": {
"type": "string",
"description": "文字エンコーディング\n",
"default": "UTF-8"
},
"bom": {
"type": "boolean",
"description": "BOM\n",
"default": false
},
"quote_policy": {
"type": "string",
"enum": [
"ALL",
"MINIMAL",
"NONE"
],
"description": "クオート付与方法\n",
"default": "MINIMAL"
},
"escape": {
"type": "string",
"description": "エスケープ文字\n",
"default": "\\"
},
"header_line": {
"type": "boolean",
"description": "ヘッダー\n",
"default": true
},
"null_string_enabled": {
"type": "boolean",
"description": "NULLを置換する文字列\n",
"default": false
},
"null_string": {
"type": "string",
"description": "置換後の文字列\n",
"nullable": true
},
"default_time_zone": {
"type": "string",
"description": "デフォルトのタイムゾーン\n",
"default": "UTC"
},
"csv_formatter_column_options_attributes": {
"type": "array",
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"format": {
"type": "string",
"description": "日付フォーマット\n",
"default": "%Y-%m-%d %H:%M:%S.%6N %z"
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
}
}
}
},
{
"nullable": true
}
]
},
"jsonl_formatter": {
"allOf": [
{
"title": "JsonlFormatter",
"type": "object",
"description": "JSON Lines出力設定\n`formatter_type` が `\"jsonl\"` の場合にのみ指定できます。\n`formatter_type` が `\"jsonl\"` の場合、この項目は **新規作成時に必須**です。\n`formatter_type` が `\"csv\"` の場合は指定しないでください。\n",
"properties": {
"encoding": {
"type": "string",
"description": "文字エンコーディング\n",
"enum": [
"UTF-8",
"UTF-16LE",
"UTF-32BE",
"UTF-32LE"
],
"default": "UTF-8"
},
"newline": {
"type": "string",
"enum": [
"CRLF",
"LF",
"CR",
"NUL",
"NO"
],
"description": "改行文字\n",
"default": "LF"
},
"date_format": {
"type": "string",
"description": "日付のフォーマット\n",
"nullable": true
},
"timezone": {
"type": "string",
"description": "タイムゾーン\n",
"nullable": true
}
}
},
{
"nullable": true
}
]
}
}
},
{
"nullable": true
}
]
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"gcs_connection_id",
"bucket",
"path_prefix",
"file_ext",
"is_minimum_output_tasks"
]
}
]
},
"facebook_custom_audience_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "FacebookCustomAudienceResponse",
"type": "object",
"description": "転送先Facebook Custom Audienceの設定内容\n",
"properties": {
"facebook_ads_insights_connection_id": {
"type": "integer",
"nullable": true,
"description": "Facebook Ads Insights接続情報ID\n"
},
"ad_account_id": {
"type": "string",
"description": "広告アカウントID\n"
},
"custom_audience_name": {
"type": "string",
"description": "カスタムオーディエンス名\n"
},
"wait_for_completion": {
"type": "boolean",
"description": "アップロード完了待機フラグ\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"facebook_ads_insights_connection_id",
"ad_account_id",
"custom_audience_name",
"wait_for_completion"
]
}
]
},
"redshift_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "RedshiftOutputOptionResponse",
"type": "object",
"description": "転送先Redshiftの設定内容\n",
"properties": {
"redshift_connection_id": {
"type": "integer",
"description": "Redshift接続情報ID\n"
},
"database": {
"type": "string",
"description": "データベース名\n"
},
"schema": {
"type": "string",
"description": "スキーマ名\n"
},
"table": {
"type": "string",
"description": "テーブル名\n"
},
"create_table_constraint": {
"type": "string",
"nullable": true,
"description": "テーブル作成時に付与する制約\n"
},
"create_table_option": {
"type": "string",
"nullable": true,
"description": "テーブル作成時のオプション\n"
},
"s3_bucket": {
"type": "string",
"description": "S3バケット名\nデータをRedshiftにCOPYする際に使用する一時バケット\n"
},
"s3_key_prefix": {
"type": "string",
"description": "S3キープレフィックス\n一時ファイルのS3キープレフィックス\n"
},
"delete_s3_temp_file": {
"type": "boolean",
"description": "S3一時ファイルを削除するかどうか\n"
},
"copy_iam_role_name": {
"type": "string",
"nullable": true,
"description": "COPYコマンドで使用するIAMロール名\n"
},
"mode": {
"type": "string",
"enum": [
"insert",
"insert_direct",
"truncate_insert",
"replace",
"merge"
],
"description": "転送モード\n- `insert`: 追記 (INSERT)\n- `insert_direct`: 追記 (INSERT DIRECT)\n- `truncate_insert`: 全件洗い替え (TRUNCATE INSERT)\n- `replace`: 全件洗い替え (REPLACE)\n- `merge`: UPSERT (MERGE)\n"
},
"default_time_zone": {
"type": "string",
"description": "デフォルトタイムゾーン\n"
},
"retry_limit": {
"type": "integer",
"description": "最大リトライ回数\n"
},
"retry_wait": {
"type": "integer",
"description": "リトライ待ち時間(ミリ秒)\n"
},
"max_retry_wait": {
"type": "integer",
"description": "リトライ待ち時間の最大値(ミリ秒)\n"
},
"before_load": {
"type": "string",
"nullable": true,
"description": "ロード前に実行するSQL\n転送前に実行されるクエリ\n"
},
"after_load": {
"type": "string",
"nullable": true,
"description": "ロード後に実行するSQL\n転送後に実行されるクエリ\n"
},
"batch_size": {
"type": "integer",
"description": "バッチサイズ (KB)\n"
},
"redshift_output_option_column_options": {
"type": "array",
"nullable": true,
"description": "カラム設定\n",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "カラム名\n"
},
"type": {
"type": "string",
"enum": [
"BIGINT",
"VARCHAR",
"BOOLEAN",
"DOUBLE PRECISION",
"CLOB",
"TIMESTAMP",
"TIME",
"DATE"
],
"description": "データ型\n"
},
"value_type": {
"type": "string",
"nullable": true,
"enum": [
"byte",
"short",
"int",
"long",
"double",
"float",
"boolean",
"string",
"nstring",
"date",
"time",
"timestamp",
"decimal",
"json",
"null",
"pass",
"coalesce"
],
"description": "value type\n"
},
"timestamp_format": {
"type": "string",
"nullable": true,
"description": "日付フォーマット\n"
},
"timezone": {
"type": "string",
"nullable": true,
"description": "タイムゾーン\n"
}
}
}
},
"redshift_output_option_merge_keys": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "マージキー\nmode: mergeの場合のみ設定できます。\n"
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"redshift_connection_id",
"database",
"schema",
"table",
"s3_bucket",
"s3_key_prefix",
"delete_s3_temp_file",
"mode"
]
}
]
},
"custom_connector_output_option": {
"type": "object",
"nullable": true,
"allOf": [
{
"title": "CustomConnectorOutputOptionResponse",
"type": "object",
"description": "転送先カスタムコネクタでの出力オプション。\nurl以下の項目はコネクタ定義からのスナップショットであり、read-onlyです(作成・更新のリクエストでは指定できません)。\n",
"properties": {
"custom_connector_connection_id": {
"description": "接続情報ID\n",
"type": "integer",
"nullable": true
},
"mode": {
"description": "転送モード\n",
"type": "string",
"enum": [
"insert",
"upsert"
]
},
"update_key": {
"description": "更新キー\n",
"type": "string",
"nullable": true
},
"create_custom_connector_output_endpoint_id": {
"description": "作成に使用するカスタムコネクタのエンドポイントID\n",
"type": "integer",
"nullable": true
},
"update_custom_connector_output_endpoint_id": {
"description": "更新に使用するカスタムコネクタのエンドポイントID\n",
"type": "integer",
"nullable": true
},
"url": {
"description": "URL(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"auth_type": {
"description": "認証方式(コネクタ定義からのスナップショット)\n",
"type": "string"
},
"auth_header_name": {
"description": "認証ヘッダ名(コネクタ定義からのスナップショット)\n",
"type": "string",
"nullable": true
},
"auth_header_scheme": {
"description": "認証ヘッダのスキーム(コネクタ定義からのスナップショット)\n",
"type": "string",
"nullable": true
},
"endpoints": {
"description": "作成用・更新用それぞれのエンドポイント設定のスナップショット(作成順)。\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"operation": {
"description": "作成用(create)か更新用(update)かの区別\n",
"type": "string",
"enum": [
"create",
"update"
]
},
"request_type": {
"description": "リクエスト方式\n",
"type": "string",
"enum": [
"single",
"multiple"
]
},
"batch_size": {
"type": "integer"
},
"method": {
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"PATCH"
]
},
"path": {
"type": "string"
},
"payload_type": {
"type": "string",
"enum": [
"json"
]
},
"success_codes": {
"type": "string"
},
"not_retryable_codes": {
"type": "string"
},
"request_timeout_sec": {
"type": "integer"
},
"template": {
"type": "string",
"nullable": true
},
"headers": {
"description": "ヘッダーの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"path_parameters": {
"description": "パスパラメータの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"query_parameters": {
"description": "クエリパラメータの値(作成順)\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"custom_variable_settings": {
"description": "カスタム変数の設定\n",
"allOf": [
{
"title": "CustomVariableSetting",
"type": "object",
"properties": {
"name": {
"description": "カスタム変数の変数名を指定します。
\n変数名を`$`で囲ってください。
\n",
"type": "string",
"example": "$start_time$"
},
"type": {
"description": "カスタム変数タイプです。
\nstring: 文字列
\ntimestamp: 時刻・日付(キューイング時)
\ntimestamp_runtime: 時刻・日付(実行時)\n",
"type": "string",
"enum": [
"string",
"timestamp",
"timestamp_runtime"
],
"example": "timestamp_runtime"
},
"value": {
"description": "カスタム変数名を展開する値を指定します。
\nカスタム変数タイプがstringのときのみ有効です。\n",
"type": "string",
"example": "jobs"
},
"quantity": {
"type": "integer",
"format": "int64",
"description": "unit 時間の数を指定します。
\nカスタム変数タイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": 1
},
"unit": {
"description": "時間の単位を指定します。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。
\nmonth_start: 当月月初、month_end: 当月月末、prev_month_end: 前月末 を指定した場合、quantity・direction は不要です。\n",
"type": "string",
"enum": [
"minute",
"hour",
"date",
"month",
"month_start",
"month_end",
"prev_month_end"
],
"example": "hour"
},
"direction": {
"description": "時間軸の方向です。
\nago: 前
\nlater: 後
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"enum": [
"ago",
"later"
],
"example": "ago"
},
"format": {
"type": "string",
"description": "日付フォーマットです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"example": "%Y-%m-%d %H:%M:%S"
},
"time_zone": {
"description": "日付フォーマットの日時を解釈するタイムゾーンです。
\nタイプがtimestampかtimestamp_runtime のときのみ有効です。\n",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"name",
"type"
]
},
{
"nullable": true
}
]
}
},
"required": [
"mode",
"url"
]
}
]
}
}
}
]
},
"filter_columns": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterColumn",
"type": "object",
"description": "カラム定義。\n列の絞り込みや追加を行います。ここで指定した列のみ転送されます。\n転送元のカラムに変更があった場合は、カラム定義の再読み込みを実行することで最新の定義に更新することができます。\n詳細はTROCCO Docs「カラム定義を再読み込み」をご覧ください。\n",
"properties": {
"name": {
"description": "列の絞り込みや追加を行います。ここで指定した列のみプレビュー・転送されます。\n転送元のカラムに変更があった場合は、カラム定義の再読み込みを実行することで最新の定義に更新することができます。\n詳細はTROCCO Docs「カラム定義を再読み込み」をご覧ください。\n",
"type": "string"
},
"src": {
"description": "元カラム\n",
"type": "string"
},
"type": {
"description": "データ型\n",
"type": "string",
"enum": [
"string",
"long",
"timestamp",
"double",
"boolean",
"json"
]
},
"default": {
"description": "デフォルト値。既存カラムの場合、inputがnullの場合のみこちらの值が挿入されます。新規力ラムの場合、すべてにこちらの值が挿入されます。\n",
"type": "string",
"nullable": true
},
"format": {
"description": "日時フォーマット\n",
"type": "string",
"nullable": true
},
"json_expand_enabled": {
"description": "JSONカラムを展開するかどうか\n",
"type": "boolean",
"nullable": true,
"default": false
},
"json_expand_keep_base_column": {
"description": "展開前のJSONカラムも転送する",
"type": "boolean",
"nullable": true,
"default": false
},
"json_expand_columns": {
"description": "JSONカラムの展開対象をどう展開するか\n",
"type": "array",
"items": {
"properties": {
"name": {
"description": "カラム名\n",
"type": "string"
},
"json_path": {
"description": "JSONパス。{\"id\": 10, \"person\": {\"age\": 30}}のようなJSONカラムから id, ageを抜き出す場合、JSONパスにそれぞれ id, person.age と指定します。\n",
"type": "string"
},
"type": {
"description": "データ型\n",
"type": "string",
"enum": [
"boolean",
"long",
"timestamp",
"string"
]
},
"format": {
"description": "日付フォーマット。typeがtimestampの場合のみ有効です。\n",
"type": "string",
"nullable": true
},
"timezone": {
"description": "タイムゾーン。typeがtimestampの場合のみ有効です。\n",
"type": "string",
"nullable": true
}
},
"required": [
"name",
"json_path",
"type"
]
}
}
},
"required": [
"name",
"src",
"type"
]
}
]
}
},
"filter_rows": {
"type": "object",
"allOf": [
{
"title": "FilterRow",
"type": "object",
"description": "条件に応じた行の絞り込み (フィルター) を行います。\n「条件を追加」ボタンで複数の条件を設定することが可能です。その際、AND条件かOR条件かを選択する必要があります。\n",
"properties": {
"condition": {
"description": "条件。and条件で絞り込むかor条件で絞り込むかを指定します。\n",
"type": "string",
"enum": [
"and",
"or"
]
},
"filter_row_conditions": {
"description": "絞り込み条件のリスト。\n",
"type": "array",
"items": {
"type": "object",
"properties": {
"column": {
"description": "対象カラム名。フィルター条件に利用するカラム名(カラム定義における元カラム)を入力してください。\n",
"type": "string"
},
"operator": {
"description": "演算子。フィルター条件に利用する演算子を入力してください。\n",
"type": "string",
"enum": [
"greater",
"greater_equal",
"less",
"less_equal",
"equal",
"not_equal",
"start_with",
"end_with",
"include",
"is_null",
"is_not_null",
"regexp"
]
},
"argument": {
"description": "フィルター条件の引数。\n",
"type": "string"
}
},
"required": [
"column",
"operator",
"argument"
]
}
}
},
"required": [
"condition",
"filter_row_conditions"
]
}
],
"nullable": true
},
"filter_masks": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterMask",
"type": "object",
"description": "マスキング設定。\n指定した列の値を「*」でマスキングします。\n",
"properties": {
"name": {
"description": "マスキング対象の列名。転送先カラム名を指定してください。\n",
"type": "string"
},
"mask_type": {
"description": "マスクの種類。\n全文字列: すべて「*」で置換します\nメールアドレス: @マークまでを「*」で置換します\n正規表現: 正規表現パターンにマッチした箇所を「*」で置換します\n部分文字列: 開始位置・終了位置を指定して、「*」で置換します\n",
"type": "string",
"enum": [
"all",
"email",
"regex",
"substring"
]
},
"length": {
"description": "マスクの長さ。「*」でマスクする文字列の長さを指定できます。\n",
"type": "integer",
"nullable": true
},
"pattern": {
"description": "マスクのパターン。マスクの種類がregexの場合に指定してください。\n",
"type": "string",
"nullable": true
},
"start_index": {
"description": "マスクの開始位置。マスクの種類がsubstringの場合に指定してください。\n",
"type": "integer",
"nullable": true
},
"end_index": {
"description": "マスクの終了位置。マスクの種類がsubstringの場合に指定してください。\n",
"type": "integer",
"nullable": true
}
},
"required": [
"name",
"mask_type"
]
}
]
}
},
"filter_add_time": {
"type": "object",
"allOf": [
{
"title": "FilterAddTime",
"type": "object",
"description": "転送時に、転送実行日時を記録するカラムを追加します。\n",
"properties": {
"column_name": {
"description": "カラム名\n",
"type": "string"
},
"type": {
"description": "日時の型\n",
"type": "string",
"enum": [
"timestamp",
"string"
]
},
"timestamp_format": {
"description": "タイムスタンプのフォーマット。typeがstring場合に指定できます。\n",
"type": "string",
"example": "%Y-%m-%d %H:%M:%S.%N %Z",
"nullable": true
},
"time_zone": {
"description": "タイムゾーン。\n",
"type": "string",
"nullable": true
}
},
"required": [
"column_name",
"type"
]
}
],
"nullable": true
},
"filter_gsub": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterGsub",
"type": "object",
"description": "文字列 正規表現置換。\n各列内の文字列を、正規表現にマッチした部分だけ別の文字列に置換します。\n詳しいご利用方法は、TROCCO Docs「文字列置換機能について」をご覧ください。\n",
"properties": {
"column_name": {
"description": "対象カラム。\n",
"type": "string"
},
"pattern": {
"description": "正規表現のパターン。\n",
"type": "string"
},
"to": {
"description": "合致したパターンを置換させる文字列。\n",
"type": "string"
}
},
"required": [
"column_name",
"pattern",
"to"
]
}
]
}
},
"filter_string_transforms": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterStringTransform",
"type": "object",
"description": "各列内の文字列を、変換方法に従って変換します。string 型のみでご利用いただけます。\n",
"properties": {
"column_name": {
"description": "対象カラム\n",
"type": "string"
},
"type": {
"description": "変換方法\n正規化 (NFKC)\n例: normalize_nfkc: 全角英数 → 半角 (ABC123 → ABC123) 、半角カナ → 全角 (アイ → アイ) など\n",
"type": "string",
"enum": [
"normalize_nfkc"
],
"default": "normalize_nfkc"
}
},
"required": [
"column_name"
]
}
]
}
},
"filter_hashes": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterHash",
"type": "object",
"description": "カラムハッシュ化\n設定したカラム内の文字列を、SHA-256でハッシュ化したものに置換します。\n",
"properties": {
"name": {
"description": "対象カラム\n",
"type": "string"
}
},
"required": [
"name"
]
}
]
}
},
"filter_unixtime_conversions": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"title": "FilterUnixTimeConversion",
"type": "object",
"description": "UNIX時間から日時フォーマット(TIMESTAMP型、STRING型)への変換、もしくは日時フォーマット(TIMESTAMP型、STRING型)からUNIX時間への変換を設定します。\n",
"properties": {
"column_name": {
"description": "対象カラム\ntype: string\n"
},
"kind": {
"description": "変換方法\n",
"type": "string",
"enum": [
"unixtime_to_timestamp",
"unixtime_to_string",
"timestamp_to_unixtime",
"string_to_unixtime"
]
},
"unixtime_unit": {
"description": "変換前、変換後のUNIX時間の単位\n",
"type": "string",
"enum": [
"second",
"millisecond",
"microsecond",
"nanosecond"
]
},
"datetime_format": {
"description": "変換前、変換後の日時フォーマット\n",
"type": "string"
},
"datetime_timezone": {
"description": "変換前、変換後の日時のタイムゾーン\n"
}
},
"required": [
"column_name",
"kind",
"unixtime_unit",
"datetime_format",
"datetime_timezone"
]
}
]
}
},
"labels": {
"description": "ラベル設定を指定します。\n",
"type": "array",
"minItems": 0,
"maxItems": 40,
"items": {
"title": "Label",
"type": "object",
"properties": {
"id": {
"description": "ラベルIDです",
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"description": "ラベル名です。",
"type": "string",
"example": "favorite"
},
"description": {
"description": "メモです。",
"type": "string",
"example": "お気に入り",
"nullable": true
},
"color": {
"description": "ラベルの色です。",
"type": "string",
"example": "#e86115"
},
"created_at": {
"description": "ラベル作成日時です。",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
},
"updated_at": {
"description": "ラベルの更新日時です。",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
}
},
"required": [
"id",
"name",
"color",
"created_at",
"updated_at"
]
}
},
"schedules": {
"description": "スケジュール設定を指定します。\n",
"type": "array",
"minItems": 0,
"items": {
"title": "Schedule",
"type": "object",
"properties": {
"frequency": {
"description": "スケジュールの頻度です。
\nhourly: 毎時
\ndaily: 毎日
\nweekly: 毎週
\nmonthly: 毎月\n",
"type": "string",
"enum": [
"hourly",
"daily",
"weekly",
"monthly"
]
},
"minute": {
"description": "分の値を示します。",
"type": "integer",
"format": "int64"
},
"hour": {
"description": "時間の値を示します。",
"type": "integer",
"format": "int64"
},
"day": {
"description": "日にちの値を示します。",
"type": "integer",
"format": "int64"
},
"day_of_week": {
"description": "曜日の値を示します。",
"type": "integer",
"format": "int64"
},
"time_zone": {
"description": "日時のタイムゾーンです。",
"type": "string",
"example": "Etc/UTC"
}
},
"required": [
"frequency",
"time_zone"
]
}
},
"notifications": {
"description": "通知設定です。
\n配列の順序は以下の規則で固定されます。
\n- notification_type の順: job → record → exec_time
\n- 同一 notification_type 内は destination_type の順: slack → email
\n- 同一 notification_type かつ同一 destination_type 内は id 昇順\n",
"type": "array",
"minItems": 0,
"maxItems": 20,
"items": {
"title": "JobDefinitionNotification",
"type": "object",
"properties": {
"id": {
"description": "通知設定のIDです。
\nnotification_type の中で一意です。slack と email が同じ親レコードから派生する場合は同じ id を持つため、destination_type を併用して識別してください。\n",
"type": "integer",
"format": "int64",
"readOnly": true
},
"destination_type": {
"description": "通知先です。",
"type": "string",
"enum": [
"slack",
"email",
"http"
]
},
"slack_channel_id": {
"description": "slack channel IDです。
\ndestination_typeがslackのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"email_id": {
"description": "Email IDです。
\ndestination_typeがemailのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"http_notification_destination_id": {
"description": "通知先HTTPのIDです。
\ndestination_typeがhttpのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"notification_type": {
"description": "通知タイプです。
\njob: ジョブ実行(終了/エラー)通知
\nrecord: レコード条件(超過/過不足)通知
\nexec_time: 実行時間経過通知\n",
"type": "string",
"enum": [
"job",
"record",
"exec_time"
]
},
"notify_when": {
"description": "通知条件です。
\njobタイプのとき必須です。\n",
"type": "string",
"enum": [
"finished",
"failed"
]
},
"message": {
"description": "通知内容です。
\ndestination_typeがhttpのときは、HTTPリクエストボディとして送信される文字列を指定します(メタ変数・カスタム変数の展開に対応。job通知はJSON形式が必須)。\n",
"type": "string"
},
"record_count": {
"description": "閾値のレコード数
\nrecordタイプのとき必須です。\n",
"type": "integer",
"format": "int64"
},
"record_operator": {
"description": "レコード数の比較演算子です
\nrecordタイプのとき必須
\nabove: 以上
\nbelow: 以下\n",
"type": "string",
"enum": [
"above",
"below"
]
},
"record_type": {
"description": "通知するレコード数条件
\nrecordタイプのとき必須
\ntransfer: 転送した
\nskipped: スキップされた\n"
},
"minutes": {
"description": "実行時間の閾値(分)
\nexec_timeタイプのとき必須です。\n",
"type": "integer",
"format": "int64"
}
},
"required": [
"destination_type",
"notification_type",
"message"
]
}
},
"environment": {
"description": "アタッチされている環境\n",
"allOf": [
{
"title": "Environment",
"type": "object",
"properties": {
"id": {
"description": "環境ID",
"type": "integer",
"format": "int64",
"example": 1
},
"environment_group_id": {
"description": "環境グループID",
"type": "integer",
"format": "int64",
"example": 1
},
"name": {
"description": "環境名",
"type": "string",
"example": "本番環境"
},
"memo": {
"description": "メモ",
"type": "string",
"nullable": true,
"example": "# 環境のメモ\n\nこの環境は本番用です。"
},
"created_at": {
"description": "環境の作成日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
},
"updated_at": {
"description": "環境の更新日時",
"type": "string",
"example": "2023-08-22T18:00:00+00:00"
}
},
"required": [
"id",
"environment_group_id",
"name",
"created_at",
"updated_at"
]
}
],
"nullable": true
}
}
}
],
"required": [
"id",
"name",
"resource_enhancement",
"is_runnable_concurrently",
"retry_limit",
"input_option_type",
"input_option",
"output_option_type",
"filter_columns"
]
}
}
}
},
"400": {
"description": "Bad request.
\n不正なリクエストです。\n"
},
"401": {
"description": "Not authenticated.
\n認証エラーです。API KEYをご確認ください。\n"
}
}
}
}
},
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "認証キーとなるAPI KEYをAuthorization: Token {{API KEY}}の形式でヘッダーにセットします。
\nAPI KEYがabc123の場合は、Authorization: Token abc123とします。
\nAPI KEYの作成方法は、TROCCO API KEYの作成を参照ください。\n"
}
}
}
}
````