Spécification de collaboration

Définit la collaboration de haut niveau. La spécification définit les gestionnaires d’analyses invités, et pour chaque gestionnaire d’analyses, les données et les modèles auxquels il peut accéder et qu’il peut exécuter. Les modèles ou les offres de données listés ici doivent être enregistrés avant d’être inclus dans la spécification de collaboration.

Le propriétaire soumet cette spécification en appelant INITIALIZE.

Schéma :

api_version: 2.0.0              # Required: Must be "2.0.0"
spec_type: collaboration        # Required: Must be "collaboration"
name: <collaboration_name>      # Required: Unique name (max 75 chars)
version: <version_string>       # Optional: Version identifier (max 20 chars)
description: <collaboration_description>  # Optional: Description (max 1,000 chars)
owner: <owner_alias>            # Required: Alias of owner

collaborator_identifier_aliases:  # Required: Map aliases to account identifiers
  <alias_1>: <account_identifier_1>  # One or more alias mappings...

analysis_runners:               # Required: Who can run analyses
  <analysis_runner_alias>:      # One or more analysis runner definitions...
    data_providers:             # Required: Data providers for this runner
      <provider_alias>:         # One or more provider definitions...
        data_offerings:         # Required: List of offerings (can be empty [])
          - id: <data_offering_id>  # Zero or more data offering IDs...
    templates:                  # Optional: Templates this runner can use
      - id: <template_id>       # One or more template IDs...
    activation_destinations:    # Optional: Where results can be sent
      snowflake_collaborators:  # Optional: Collaborators who can receive results
        - <collaborator_alias>  # One or more collaborator aliases...
api_version

Version de l’API de collaboration utilisée. Doit être 2.0.0.

spec_type

Identificateur du type de spécification. Doit être collaboration.

name: collaboration_name

Nom convivial pour cette collaboration. Doit être unique dans le compte du créateur et suivre les règles des identificateurs Snowflake (maximum 75 caractères).

version (Facultatif)

Identificateur de version pour cette collaboration (maximum 20 caractères). Doit suivre les règles des identificateurs Snowflake. Un bon format à utiliser est YYYY_MM_DD_V#. Par exemple : 2025_10_22_V1.

description: collaboration_description (Facultatif)

Description de la collaboration lisible par l’utilisateur (maximum 1 000 caractères), destinée aux collaborateurs.

owner: owner_alias

Alias du propriétaire de la collaboration, tel que défini dans collaborator_identifier_aliases.

collaborator_identifier_aliases

Mappage des alias de collaborateurs à leurs identificateurs de compte de partage de données. Seuls les utilisateurs listés ici peuvent participer à la collaboration. Utilisez les alias définis ici pour faire référence à tous les collaborateurs, plutôt que d’utiliser directement leur identificateur de compte de partage de données. Doit être unique dans la collaboration et suivre les règles des identificateurs Snowflake (maximum 25 caractères).

analysis_runners

Décrit qui peut exécuter une analyse dans cette collaboration. Chaque gestionnaire d’analyses est associé à un alias unique. Vous devez autoriser au moins un compte à exécuter une analyse dans cette collaboration.

<analysis_runner_alias>

Alias du compte qui peut exécuter une analyse dans cette collaboration. L’alias est défini dans la liste collaborator_identifier_aliases.

data_providers

Fournisseurs de données dont les données peuvent être accessibles à ce gestionnaire d’analyses. Chaque fournisseur est lié par l’alias défini dans collaborator_identifier_aliases.

data_offerings

Liste des offres de données de ce fournisseur de données auxquelles l’exécuteur d’analyses peut accéder, ou un tableau vide [] en tant qu’espace réservé afin que les offres de données puissent être ajoutées ultérieurement. Chaque offre de données est référencée par son ID, généré lorsque le fournisseur de données appelle REGISTER_DATA_OFFERING.

templates (Facultatif)

Modèles qui peuvent être utilisés par ce gestionnaire d’analyses. Chaque modèle est référencé par son ID. Vous pouvez omettre cela dans la spécification initiale, et quand même partager des modèles avec cet exécuteur d’analyses après la création de la collaboration.

activation_destinations (Facultatif)

Définit les paramètres d’activation pour les résultats de l’analyse.

snowflake_collaborators (Facultatif)

Liste des collaborateurs qui peuvent recevoir des résultats d’analyse activés. Utilisez l’alias depuis la liste collaborator_identifier_aliases dans cette spécification. Tous les collaborateurs listés ici doivent disposer des autorisations décrites dans Mise en œuvre de l’activation.

Exemples

api_version: 2.0.0
spec_type: collaboration
name: my_sample_collaboration
owner: Owner
collaborator_identifier_aliases:
  Owner: ENG.OWNER
  AnalysisRunner_1: ENG.CONSUMER_1
  DataProvider_1: ENG.PROVIDER_1
  DataProvider_2: ENG.PROVIDER_2
  AnalysisRunner_2: ENG.PROVIDER_3
analysis_runners:
  AnalysisRunner_1:
    data_providers:
      DataProvider_1:
        data_offerings:
        - id: DCR_PREPROD_CI_PROVIDER_ANY_NAME_ZUDFTMULHQ_iuDfn_v0
      DataProvider_2:
        data_offerings: []
    templates:
    - id: test_sca_three_party_template_JOaVG_v0
  AnalysisRunner_2:
    data_providers:
      DataProvider_2:
        data_offerings: []
    templates:
    - id: test_sca_three_party_template_JOaVG_v0