分析规范

指定分析运行者运行分析所需的所有信息，包括要使用的模板、要传递给模板的表以及模板使用的任何变量值。如果不使用自由格式 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

所使用的 Collaboration API 的版本。必须是 2.0.0

spec_type

规范类型标识符。必须是 analysis

template: template_id

用于此分析的模板 ID。这必须是注册模板时获取的模板 ID，而不是模板名称。

``name``（可选）

此分析的唯一且用户友好名称。必须遵循 Snowflake 标识符规则，长度最多 75 个字符，并且在您的 Snowflake Data Clean Room 账户中是唯一的。

``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 标识符规则。