分析仕様

使用するテンプレート、テンプレートに渡すテーブル、テンプレートで使用される変数値など、分析実行者が分析を実行するために必要なすべての情報を指定します。データをクエリするために自由形式の SQL を使用しない場合、分析を実行する分析実行者は、この仕様を使用してテンプレートと入力データを定義します。

スキーマ:

api_version: 2.0.0              # Required: Must be "2.0.0"
spec_type: analysis             # Required: Must be "analysis"
template: <template_id>         # Required: ID of the template to use
name: <analysis_name>           # Optional: Unique name (max 75 chars)
version: <version_string>       # Optional: Version identifier (max 20 chars)
description: <analysis_description>  # Optional: Description (max 1,000 chars)

template_configuration:         # Optional: Values used when running the template
  view_mappings:                # Optional: Mappings for shared data
    source_tables:              # Optional: Tables from data offerings. Populates the source_table array variable.
      - <source_table_name>     # One or more source table names from the TEMPLATE_VIEW_NAME column...
    <argument_name>: <view_name>  # Custom argument to template view name mapping
  local_view_mappings:          # Optional: Mappings for local data
    my_tables:                  # Optional: Tables from local data offerings. Populates the my_table array variable.
      - <my_table_name>         # One or more local table names...
    <argument_name>: <view_name>  # Custom argument to local template view name mapping
  arguments:                    # Optional: Template arguments as key-value pairs
    <argument_name>: <argument_value>  # One or more argument key-value pairs...
  activation:                   # Required for activation templates
    snowflake_collaborator: <alias>  # Collaborator alias for activation destination
    segment_name: <segment_name>     # Unique segment name for this activation
api_version

使用するコラボレーション API のバージョン。2.0.0 である必要があります。

spec_type

仕様タイプ識別子。analysis である必要があります。

template: template_id

この分析に使用するテンプレートのID。これはテンプレート名ではなく、テンプレートの登録時に取得したテンプレートIDであことが必要です。

``name``(オプション

この分析の一意でユーザーにわかりやすい名前。最大75文字で、Snowflakeデータクリーンルームアカウント内で一意である Snowflake識別子ルール に従う必要があります。

``version``(オプション

この分析仕様のバージョン識別子(最大20文字)。Snowflake識別子ルール に従い、この分析名のアカウント内で一意であることが必要です。使用に適した形式は*YYYY_MM_DD_V#*です。例: 2025_10_22_V1

``description``(オプション

この分析によって行われる内容についての概略的な説明(最大1,000文字)。

``template_configuration``(オプション

指定したテンプレートを実行するときに使用される値。

``view_mappings``(オプション

共有されているデータ提供機能の引数名からテンプレートビュー名へのマッピング。

``source_tables``(オプション

``source_table``テンプレート変数を入力するビュー名のリスト。データ提供仕様で指定されたテーブルのエイリアスを使用します。VIEW_DATA_OFFERINGSを呼び出すと、使用可能なビューのリストを取得できます。TEMPLATE_VIEW_NAME列のビュー名を使用します。各エントリの形式は、collaborator_alias.data_offering_ID.dataset_alias です。

argument_name: view_name

引数名からテンプレートビュー名へのカスタムマッピング(それぞれ最大255文字)。

``local_view_mappings``(オプション

プライベートデータセットのローカルテンプレートビュー名への引数名のマッピング。

``my_tables``(オプション

my_table テンプレート変数を入力するテーブル名のリスト。これは LINK_LOCAL_DATA_OFFERING を呼び出すことでリンクしたプライベートデータセットでのみ利用できます。各エントリの形式は、collaborator_alias.data_offering_ID.dataset_alias です。

argument_name: view_name

引数名からローカルテンプレートビュー名へのカスタムマッピング(それぞれ最大255文字)。

``arguments``(オプション

キーと値のペアとしてのテンプレート引数。引数の値は、テンプレートの要件に応じて、文字列、数値、ブール値、配列、またはオブジェクトのいずれかです。

``activation``(アクティベーションテンプレートに必須

アクティベーションテンプレートを実行する際に必須のアクティベーション固有の構成。

snowflake_collaborator

アクティベーション先のコラボレーターのエイリアス(最大25文字)。コラボレーション仕様の collaborator_identifier_aliases セクションで定義されているエイリアスと一致するとともに、コラボレーターが activation_destinations セクションにリストされている必要があります。

segment_name

このアクティベーションの一意のセグメント名(最大255文字)。アクティベーション結果の識別と追跡に使用されます。Snowflake識別子ルール に従う必要があります。