スケジュール設定されたプランを取得する

バージョン 4.0.23.2

スケジュール設定されたプランに関する情報の取得

管理者は、他のユーザーのスケジュール プランに関する情報を取得できます。

リクエスト

GET /scheduled_plans/{scheduled_plan_id}
Datatype
説明
リクエスト
HTTPRequest
パス
HTTPPath
HTTPPath 定義を展開...
scheduled_plan_id
文字列
スケジュール設定されたプラン ID
クエリ
HTTPQuery
HTTPQuery の定義を展開...
fields
文字列
必須フィールド。

レスポンス

200: スケジュールされたプラン

Datatype
説明
（オブジェクト）
name
文字列
このスケジュールされたプランの名前
user_id
文字列
このスケジュールされたプランを所有するユーザー ID
run_as_recipient
ブール値
スケジュールを受信者として実行するかどうか（メール受信者のみ）
有効
ブール値
ScheduledPlan が有効かどうか
look_id
文字列
Look の ID
dashboard_id
文字列
ダッシュボードの ID
lookml_dashboard_id
文字列
LookML ダッシュボードの ID
filters_string
文字列
Look またはダッシュボードを実行するためのクエリ文字列
dashboard_filters
文字列
（非推奨）filters_string フィールドのエイリアス
require_results
ブール値
ダッシュボードを実行または結果が返されると、配信が行われる
require_no_results
ブール値
ダッシュボードの表示が結果を返さない場合に配信が行われる
require_change
ブール値
前回の実行以降にデータが変更された場合、配信が行われる
send_all_results
ブール値
無制限のクエリを実行し、すべての結果を送信します。
crontab
文字列
Vixie スタイルの crontab 仕様の実行タイミング
データグループ
文字列
データグループの名前。指定すると、datagroup がトリガーされたときに実行されます（cron 文字列では使用できません）
タイムゾーン
文字列
指定された crontab を解釈するためのタイムゾーン（デフォルトは Looker インスタンスのタイムゾーン）
query_id
文字列
クエリ ID
scheduled_plan_destination
ScheduledPlanDestination の定義を展開...
id
文字列
一意の ID
scheduled_plan_id
文字列
所有しているスケジュール済みプランの ID
形式
文字列
指定された送信先に送信するデータ形式。サポートされている形式はリンク先によって異なりますが、「txt」、「csv」、「inline_json」、「json」、「json_detail」、「xlsx」、「html」、「wysiwyg_pdf」、「wasiwyg_png」などが該当します。
apply_formatting
ブール値
値は書式設定されていますか？（通貨記号、数字区切り記号など
apply_vis
ブール値
可視化オプションを結果に適用するかどうか。
送ることもできます。
文字列
受信者のアドレス。メールアドレス: 「user@example.com」。Webhook の場合（例: 「https://examle.domain/path」）。Amazon S3 の場合（例: 「s3://bucket-name/path/」）。SFTP の場合（例: 「sftp://host-name/path/」）。
looker_recipient
ブール値
受信者が現在のインスタンスの Looker ユーザーであるかどうか（メール受信者のみ）
タイプ
文字列
アドレスのタイプ（「email」、「webhook」、「s3」、「sftp」）
パラメータ
文字列
外部スケジューリングのパラメータを含む JSON オブジェクト。Amazon S3 の場合、access_key_id とリージョンにキーと値が必要です。SFTP では、ユーザー名とキーと値が必要になります。
secret_parameters
文字列
（書き込みのみ）外部スケジューリング用のシークレット パラメータを含む JSON オブジェクト。Amazon S3 では、secret_access_key のキーと値が必要です。SFTP では、パスワードにキーと値が必要です。
クリックします。
文字列
スケジュールされたメールに含めるオプションのメッセージ
run_once
ブール値
問題のプランを 1 回だけ実行すべきかどうか（通常はテスト用）
include_links
ブール値
Looker へのリンクをこの ScheduledPlan に含めるかどうか
custom_url_base
文字列
スケジュールされたエンティティのカスタム URL ドメイン
custom_url_params
文字列
スケジュールされたエンティティのカスタム URL パスとパラメータ
custom_url_label
文字列
スケジュールされたエンティティのカスタム URL ラベル
show_custom_url
ブール値
標準の Looker リンクではなくカスタムリンクを表示するかどうか
pdf_paper_size
文字列
PDF のサイズはこのサイズに合わせる必要があります。有効な値は、「letter」、「legal」、「tabloid」、「a0」、「a1」、「a2」、「a3」、「a4」、「a5」です。
pdf_landscape
ブール値
PDF を横向き用にフォーマットする必要があるかどうか
埋め込む
ブール値
このスケジュールが埋め込みコンテキストにあるかどうか
color_theme
文字列
ダッシュボードのカラーパターン（該当する場合）
long_tables
ブール値
表データをフルレングスに拡張するかどうか
inline_table_width
整数
インライン テーブルをレンダリングするピクセルの幅
id
文字列
一意の ID
created_at
文字列
ScheduledPlan が作成された日時
updated_at
文字列
ScheduledPlan が最後に更新された日時
title
文字列
役職
ユーザー
この ScheduledPlan を所有しているユーザー
UserPublic の定義を展開...
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション
id
文字列
一意の ID
first_name
文字列
First Name
last_name
文字列
姓
display_name
文字列
表示用の完全名（first_name と last_name の両方が設定されている場合にのみ使用可能）
avatar_url
文字列
アバター画像の URL（汎用）
URL
文字列
このアイテムを取得するためのリンク
next_run_at
文字列
ScheduledPlan が次回実行されるタイミング（1 回だけ実行する場合は null）
last_run_at
文字列
ScheduledPlan が最後に実行された日時
データ プロダクト
オブジェクト
現在のユーザーがこのオブジェクトに対して実行できるオペレーション

400: Bad Request

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

404: 見つかりません

Datatype
説明
（オブジェクト）
クリックします。
文字列
エラーの詳細
documentation_url
文字列
ドキュメント リンク

例