Référence au manifeste d’annonce

La création d’annonces Snowflake de manière programmatique nécessite un manifeste, écrit au format YAML (https://yaml.org/spec/). Utilisez les informations fournies ici pour en savoir plus sur le format du manifeste et ses sections individuelles.

Voir aussi :

CREATE LISTING, ALTER LISTING, DESCRIBE LISTING, SHOW LISTINGS, DROP LISTING

Note

Les champs peuvent être n’importe lequel des éléments suivants :

  • Facultatif - Facultatif pour les annonces marketplace ou les annonces privées.

  • Obligatoire - Obligatoire pour les annonces marketplace ou les annonces privées.

  • Qualifié - Les exigences varient selon qu’il s’agit d’annonces marketplace ou d’annonces privées, et la distinction entre facultatif et obligatoire est qualifiée par le (dépend du) type d’annonce. Par exemple, facultatif pour les annonces privées, mais obligatoire pour les annonces marketplace.

Le format général d’un manifeste d’annonce est le suivant :

#
# Listing prefix
#
title: <listing title>
subtitle: <Optional listing subtitle>
description: <listing description>
profile : <Optional name of the provider profile>

listing_terms:
  - # Required listing terms that the consumer must sign.
targets:
  - # Required <List> Consumer accounts to target with this private listing.
auto_fulfillment:
  - # Required when the target accounts are outside the provider's region, otherwise optional.
business_needs:
  - # Optional <List> BusinessNeed elements; maximum 6.
categories:
  - # Optional <List> The category or area the listing belongs to, maximum 1.
cke_content_protection:
  - # Optional <List> CKE content protection elements; maximum 1.
compliance_badges:
  - # Optional <List> Compliance badges; maximum 3.
data_attributes:
  - # Optional <Name Value pairs> DataAttributes elements; maximum 1.
data_dictionary:
  - # Required for public listings and optional for all other listing types.
data_preview:
  - # Required for public listings and optional for all other listing types.
draft_access_type:
  - # Required <String> for "by request" listings.
locations:
  - # Optional list of regions to share into.
monetization_display_order:
  - # Optional <List> MonetizationDisplayOrder elements.
offers:
  - # Optional <List> Offer elements; maximum 100.
pricing_plans:
  - # Optional <List> PricingPlan elements; maximum 100.
resources:
  - # Optional for private listings; required for marketplace listings, <Name Value pairs> Resources elements such as documentation and media.
trial_details:
  - # Optional <Name Value pairs> Provides details about a trial listing.
usage_examples:
  - # Optional <List> UsageExample elements; maximum 10.
Copy

Les sections suivantes détaillent chaque champ de manifeste d’annonce, les champs enfants et fournissent des exemples associés.

Préfixe d’annonce

Chaque manifeste d’annonce commence par les champs suivants :

  • title (Chaîne, obligatoire, longueur maximale 110) : titre de l’annonce.

  • subtitle (Chaîne, facultative pour les annonces privées, obligatoire pour les annonces marketplace, longueur maximale 110) : sous-titre de l’annonce.

  • description (Chaîne, obligatoire, longueur maximale 7 500) : description de l’annonce. La syntaxe Markdown est prise en charge.

  • custom_contact (Chaîne, facultative) : e-mail. Il doit s’agir d’une adresse e-mail valide et correctement formée.

  • profile (Chaîne, facultative pour les annonces privées, obligatoire pour les annonces marketplace) : nom d’un profil de fournisseur approuvé.

Pour plus d’informations, reportez-vous à : Informations de base sur le fournisseur.

Note

Les valeurs de profile peuvent être trouvées via l’exécution de show profiles in data exchange SNOWFLAKE_DATA_MARKETPLACE;.

Exemple de préfixe d’annonce

title: Weather information
subtitle: Historical weather by postcode.
description: This listing includes historical weather data by post code.
profile: My provider profile
Copy

listing_terms

Le champ obligatoire listing_terms contient les paires de valeurs suivantes :

  • listing_terms.type (énumération, obligatoire) : doit être l’un des éléments suivants :

    • STANDARD - Fait référence à l’Accord standard pour les produits Marketplace.

    • OFFLINE - Indique que les conditions sont négociées hors ligne par les parties.

    • CUSTOM - Lorsque cette option est spécifiée, vous devez fournir une valeur pour listing_terms.link.

  • listing_terms.link (obligatoire lorsque le type est CUSTOM) : lien complet vers les conditions de l’annonce du fournisseur, qui doit commencer par http ou par https.

Pour plus d’informations, veuillez vous reporter à la section Conditions d’utilisation dans le tableau des Informations de base.

Note

Les consommateurs peuvent accepter les conditions des annonces par programmation. Pour plus d’informations, contactez l’Assistance de Snowflake.

Exemple listing_terms

. . .
listing_terms:
  type: "CUSTOM"
  link: "http://example.com/my/listing/terms"
. . .
Copy

targets

Note

Ce champ ne peut être utilisé qu’avec les annonces V1.

Le champ targets est obligatoire pour les annonces marketplace et les annonces privées.

Contient une liste de 100 éléments maximum :

  • targets.accounts (obligatoire si targets.region n’est pas présent) : liste des comptes avec lesquels partager l’annonce.

    Chaque compte cible doit être au format <OrgName>.<AccountName>, où :

ou

  • targets.regions (obligatoire si targets.accounts n’est pas présent) :

    Liste des régions avec lesquelles partager l’annonce.

    Chaque région cible doit se présenter au format « region_groups_type.snowflake_region ». En outre, « ALL » est pris en charge pour inclure toutes les régions.

    Par exemple « PUBLIC.AWS_US_EAST_1 ».

    Pour une liste complète des types de groupe de régions et des régions Snowflake, exécutez :

    SHOW REGIONS IN DATA EXCHANGE SNOWFLAKE_DATA_MARKETPLACE;
    Copy

Pour plus d’informations, voir Besoins commerciaux.

Exemples targets

Définissez un ensemble de comptes cibles pour cette annonce.

. . .
targets:
   accounts: ["Org1.Account1", "Org2.Account2"]
. . .
Copy

Définissez un ensemble de régions cibles pour cette annonce.

. . .
targets:
   regions: ["PUBLIC.AWS_US_EAST_1", "PUBLIC.AZURE_WESTUS2"]
. . .
Copy

auto_fulfillment

L’exécution automatique inter-Cloud permet au produit de données associé à une annonce d’être automatiquement exécuté dans d’autres régions Snowflake. Le champ auto_fulfillment définit les modalités de cette exécution automatique.

Pour plus d’informations sur l’exécution automatique inter-Cloud, voir Réplication automatique pour les annonces.

L’exécution automatique n’est obligatoire que si vous partagez des données avec plusieurs régions. Ne l’activez pas si vous partagez des données avec des comptes situés dans la même région.

Si vous partagez des données entre plusieurs régions, l”auto_fulfillment est :

  • Obligatoire si votre produit de données est un paquet d’application.

  • Obligatoire si votre produit de données est partagé via une annonce privée.

  • Recommandée si votre produit de données est partagé via une annonce publique.

Contient les paires nom/valeur suivantes :

  • auto_fulfillment.refresh_schedule

    • <num> MINUTE - Nombre de minutes. Minimum 10 minutes, maximum 8 jours, ou 11 520 minutes.

      Si refresh_type est spécifié comme SUB_DATABASE_WITH_REFERENCE_USAGE, n’incluez pas ce paramètre. La planification d’actualisation des paquets d’application doit être défini au niveau du compte et ne peut pas être spécifié au niveau de l’annonce.

      Pour plus d’informations, voir Définir l’intervalle d’actualisation au niveau du compte.

  • USING CRON <expression> - Définit le calendrier d’actualisation de l’exécution automatique du produit de données.

    La syntaxe pour USING CRON et REPLICATION SCHEDULE est la même. Voir Paramètres.

  • auto_fulfillment.refresh_type (obligatoire lors de l’utilisation de auto_fulfillment) : doit être l’un des éléments suivants -

    • SUB_DATABASE - réplication de base de données (au niveau de l’objet) - recommandée.

    • SUB_DATABASE_WITH_REFERENCE_USAGE - paquet d’application.

    • FULL_DATABASE - réplication de base de données (pour toute la base de données)

  • auto_fulfillment.refresh_schedule_override (facultatif) : remplace la fréquence d’actualisation de mise à jour définie pour toutes les annonces qui utilisent la même base de données. Lorsque cette valeur est FALSE, les mises à jour des annonces échouent lorsque plusieurs annonces partageant la même base de données ont des fréquences d’actualisation différentes.

    • TRUE - active le remplacement de la fréquence d’actualisation.

    • FALSE - (par défaut) désactive le remplacement de la fréquence d’actualisation.

Voir aussi Réplication automatique pour les annonces.

Exemples auto_fulfillment.refresh_schedule

L’exemple suivant actualise le produit de données associé à une annonce toutes les 10 minutes :

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_schedule: 10 MINUTE
  refresh_type: SUB_DATABASE
. . .
Copy

L’exemple suivant actualise le produit de données associé à une annonce à des jours et à des heures spécifiques dans des régions spécifiques :

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_schedule: USING CRON  0 17 * * MON-FRI Europe/London
  refresh_type: SUB_DATABASE
. . .
Copy

L’exemple suivant active le remplacement de la fréquence d’actualisation pour les annonces qui partagent la même base de données mais qui ont des fréquences d’actualisation différentes :

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_schedule: 10 MINUTE
  refresh_type: SUB_DATABASE
  refresh_schedule_override: TRUE
. . .
Copy

Exemple Snowflake Native App auto_fulfillment

SUB_DATABASE_WITH_REFERENCE_USAGE ne peut être utilisé qu’avec des paquets d’application et ne peut être combiné avec auto_fulfillment.refresh_schedule.

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_type: SUB_DATABASE_WITH_REFERENCE_USAGE
. . .
Copy

Exemple auto_fulfillment (au niveau de l’objet)

. . .
listing_terms: . . .
. . .
auto_fulfillment:
  refresh_type: SUB_DATABASE
. . .
Copy

business_needs

Les annonces sont regroupées par besoins commerciaux pour faciliter la recherche. Le besoin commercial est une description de la manière dont une annonce spécifique répond à un besoin commercial donné. Pour plus d’informations, voir Besoins commerciaux.

Besoins commerciaux STANDARD

  • business_needs.name (obligatoire lors de l’utilisation de business_needs) :

    Les valeurs valides incluent :

    • « Vision client à 360 degrés »

    • « Chaîne d’approvisionnement »

    • « Personnalisez les expériences client »

    • « Gestion des stocks »

    • « Accélération des revenus publicitaires »

    • « Analyse d’attribution »

    • « Enrichissement des données de contact »

    • « Analyse du flux piéton »

    • « Segmentation de l’audience »

    • « Analyse des sentiments »

    • « Analyse des investissements ESG »

    • « Analyses fondamentales »

    • « Analyses quantitatives »

    • « Analyse des risques »

    • « Lutte contre la fraude »

    • « Intégration client »

    • « Résolution d’identité »

    • « Évaluation des actifs »

    • « Analyse des conséquences économiques »

    • « Prévision des demandes »

    • « Gestion de la santé publique »

    • « Données réelles (RWD) »

    • « Planification d’emplacement »

    • « Rapports réglementaires »

    • « Acquisition et fidélisation des abonnés »

    • « Commercialisation des sciences de la vie »

    • « Vue patient à 360° »

    • « Analyse des blockchains »

    • « Acquisition de clients »

    • « Qualité et nettoyage des données »

    • « Enrichissement des données d’emplacement »

    • « Géocodage d’emplacement »

    • « Machine Learning »

    • « Analyse des marchés »

    • « Analyse des prix »

    • « Activation de l’audience »

business_needs[].description (obligatoire lors de l’utilisation de business_needs) : description des besoins commerciaux associés au format business_needs.name, longueur maximale 1 000.

business_needs[].type : STANDARD (facultatif).

Besoins commerciaux CUSTOM

Les besoins commerciaux personnalisés comprennent un champ défini par l’utilisateur name, description, et un champ obligatoire type avec la valeur CUSTOM.

business_needs.name (obligatoire lors de l’utilisation de business_needs) : nom défini par l’utilisateur.

business_needs[].description (obligatoire lors de l’utilisation de business_needs) : description des besoins commerciaux associés au format business_needs.name, longueur maximale 1 000.

business_needs[].type : CUSTOM (obligatoire lors de la définition de besoins commerciaux personnalisés).

Exemples business_needs

Standard sans type facultatif

. . .
business_needs:
 - name: "Real World Data (RWD)"
   description: "Global weather data"
. . .
Copy

Standard avec type facultatif

. . .
business_needs:
 - name: "Real World Data (RWD)"
   description: "Global weather data"
   type: STANDARD
. . .
Copy

Personnalisé avec type obligatoire

. . .
business_needs:
 - name: "Machinery Maintenance"
   description: "Repair and maintenance data for machinery"
   type: CUSTOM
. . .
Copy

categories

Le champ categories spécifie la catégorie ou le domaine de l’annonce. Les catégories sont facultatives pour les annonces privées, mais obligatoires pour les annonces marketplace.

Les catégories sont utilisées dans Snowflake Marketplace pour parcourir les annonces par domaine et aider les consommateurs à trouver vos données.

Le champ categories est une liste, mais ne peut contenir qu’une seule entrée, parmi l’ensemble ci-dessous :

  • BUSINESS

  • CONNECTORS

  • DEMOGRAPHICS

  • ECONOMY

  • ENERGY

  • ENVIRONMENT

  • FINANCIAL

  • GOVERNMENT

  • HEALTH

  • IDENTITY

  • LEGAL

  • LOCAL

  • LOOKUP_TABLES

  • MARKETING

  • MEDIA

  • SECURITY

  • SPORTS

  • TRANSPORTATION

  • TRAVEL

  • WEATHER

Exemple categories

. . .
categories:
 - ECONOMY
. . .
Copy

cke_content_protection

The cke_content_protection field is used to protect the content of a Cortex Knowledge Extension (CKE). Using this field, providers can restrict the amount of content a consumer can access. The threshold limits the percentage of the indexed corpus that a consumer can retrieve within a rolling 24-hour period. When a consumer exceeds the configured threshold, subsequent queries to the CKE are blocked until the window resets, and the consumer receives an error indicating that they’ve reached the content protection threshold.

The cke_content_protection field contains the following entries:

  • enable: Indicates whether content protection is enabled.

    • TRUE - Content protection is enabled.

    • FALSE - Content protection is disabled.

  • threshold: The threshold for content protection when content protection is enabled. This indicates the percentage of the indexed corpus that any one consumer can retrieve within a rolling 24-hour period. This can be a value between 0 and 1.

cke_content_protection example

. . .
cke_content_protection:
  enable: TRUE
  threshold: 0.2
. . .
Copy

compliance_badges

Le champ compliances_badges est utilisé pour indiquer qu’une liste a été examinée par un auditeur tiers et certifiée conforme à une norme ou à une réglementation spécifique.

Lorsque vous configurer un badge de conformité, vous pouvez spécifier jusqu’à trois types. Veuillez inclure la date d’expiration de chaque badge et les documents de certification tiers qui l’accompagnent.

Les champs suivants sont utilisés pour configurer un badge de conformité :

  • compliance_badges : Utilisé pour déclarer et configurer un badge de conformité pour une annonce. Les fournisseurs peuvent déclarer plusieurs certifications de conformité dans la propriété compliance_badges.

    • type : Certification de conformité demandée. La liste suivante présente les valeurs possibles :

      • SOC2

      • HIPAA

      • ISO27001

    • expiry : Date d’expiration de la certification de conformité.

    • files : Liste des fichiers utilisés pour vérifier la certification de conformité.

Pour plus d’informations, voir Badges de conformité des annonces.

Exemple compliance_badges

. . .
compliance_badges:
  - type: SOC2
    expiry: 12-25-2026
    files:
      - soc2_compliance_verification.pdf
  - type: HIPAA
    expiry: 06-07-2026
    files:
      - hipaa_compliance_verification.pdf
. . .
Copy

data_attributes

Les attributs de données fournissent aux consommateurs des indices sur les informations concernant l’annonce, comme que le taux d’actualisation et d’autres caractéristiques.

Le champ data_attributes est facultatif pour les annonces privées, mais obligatoire pour les annonces marketplace.

Pour des informations supplémentaires sur les attributs des produits de données, consultez Produit de données - Attributs.

Contient les paires nom/valeur suivantes :

  • data_attributes.refresh_rate (obligatoire pour les annonces de données ; facultatif pour les annonces d’applications)

    Spécifie la fréquence à laquelle votre produit de données est mis à jour dans Snowflake.

    Une des options :

    • CONTINUOUSLY

    • HOURLY

    • DAILY

    • WEEKLY

    • MONTHLY

    • QUARTERLY

    • ANNUALLY

    • STATIC

  • data_attributes.geography (obligatoire), contenant :

    Spécifie les régions géographiques couvertes par votre produit de données.

    • granularity (chaîne, obligatoire)

      Couverture géographique de votre ensemble de données.

      Une des options :

      • LATITUDE_LONGITUDE

      • ADDRESS

      • POSTAL_CODE

      • CITY

      • COUNTY

      • STATE

      • COUNTRY

      • REGION_CONTINENT

    • geo_option (chaîne, obligatoire)

      Une des options :

      • NOT_APPLICABLE

      • GLOBAL

      • COUNTRIES

    • coverage (obligatoire suivant la sélection de geo_option), contenant soit :

      • states (liste d’États) contenant n’importe quelle liste de noms d’États américains valides.

      Or

      • continents (liste des continents) :

        N’importe laquelle des valeurs suivantes :

        • ASIA

        • EUROPE

        • AFRICA

        • NORTH AMERICA

        • SOUTH AMERICA

        • OCEANIA

        • ANTARCTICA

    • time (obligatoire) contenant :

      Spécifie la période couverte par votre produit de données.

      • granularity (obligatoire)

      Une des options :

      • EVENT_BASED

      • HOURLY

      • DAILY

      • WEEKLY

      • MONTHLY

      • YEARLY

      • time_range (obligatoire) contenant les paires nom/valeur suivantes :

        • time_frame (obligatoire)

          Une des options :

          • NEXT

          • LAST

          • BETWEEN

        • unit (obligatoire)

          Une des options :

          • DAYS

          • WEEKS

          • MONTHS

          • YEARS

        • value (obligatoire lorsque time_frame est NEXT/LAST, entier), plage 1-100.

        • start_time (obligatoire lorsque time_frame est BETWEEN, date sous forme de chaîne), format MM-DD-YYYY.

        • end_time (obligatoire lorsque time_frame est BETWEEN, date sous forme de chaîne), format MM-DD-YYYY.

Exemple data_attributes

. . .
data_attributes:
  refresh_rate: DAILY
  geography:
    granularity:
      - REGION_CONTINENT
    geo_option: COUNTRIES
    coverage:
      continents:
        ASIA:
          - INDIA
          - CHINA
        NORTH AMERICA:
          - UNITED STATES
          - CANADA
        EUROPE:
          - UNITED KINGDOM
    time:
      granularity: MONTHLY
      time_range:
        time_frame: LAST
        unit: MONTHS
        value: 6
Copy

data_dictionary

Le champ data_dictionary fournit aux consommateurs des indices sur le contenu et la structure d’une annonce avant qu’ils ne l’installent dans leur compte. Obligatoire pour les annonces publiques, facultatif pour tous les autres types d’annonces.

Le champ data_dictionary contient une liste de cinq entrées de dictionnaire de données maximum :

  • data_dictionary.featured (obligatoire lors de l’utilisation de data_dictionary) : doit être « featured » (en vedette).

  • data_dictionary.featured.database (obligatoire lors de l’utilisation de data_dictionary) : nom de base de données.

  • data_dictionary.featured.objects (obligatoire lors de l’utilisation de data_dictionary) : liste de paires nom/valeur -

    • name (chaîne, obligatoire) : nom d’objet

    • schema (chaîne, obligatoire) : schéma

    • domain (obligatoire) :

      Une des options :

      • DATABASE

      • SCHEMA

      • TABLE

      • VIEW

      • EXTERNAL_TABLE

      • MATERIALIZED_VIEW

      • DIRECTORY_TABLE

      • FUNCTION

      • COLUMN

Voir aussi Produit de données - dictionnaire de données.

Exemple data_dictionary

. . .
data_dictionary:
 featured:
    database: "WEATHERDATA"
    objects:
       - name: "GLOBAL_WEATHER"
         schema: "PUBLIC"
         domain: "TABLE"
       - name: "GLOBAL_WEATHER_REPORT"
         schema: "PUBLIC"
         domain: "TABLE"
. . .
Copy

data_preview

Le champ data_preview permet aux fournisseurs d’identifier et de masquer les informations personnellement identifiables (PII) dans les échantillons d’aperçu des données générés à partir des données d’annonce. Les données PII sont des données susceptibles de révéler directement ou indirectement l’identité d’une personne. Obligatoire pour les annonces publiques, facultatif pour tous les autres types d’annonces.

Le champ data_preview comprend les entrées suivantes :

  • data_preview.has_pii (obligatoire lors de l’utilisation de data_preview) : indique si les données PII sont incluses dans les données de l’annonce.

    • TRUE - les données PII sont incluses dans les données de l’annonce.

    • FALSE - les données PII ne sont pas incluses dans les données de l’annonce.

  • data_preview.metadata_overrides (recommandé si data_preview.has_pii est TRUE) : identifie l’emplacement des données d’annonce PII et des objets de cet ensemble de données contenant les données PII à masquer ou à afficher.

    • database (chaîne, obligatoire) : nom de la base de données.

    • objects (liste, obligatoire) : les objets dont il faut masquer ou exposer les colonnes dans les échantillons d’aperçu des données :

      • schema (chaîne, obligatoire) : nom du schéma.

      • domain (chaîne, obligatoire) : nom du domaine.

      • name (chaîne, obligatoire) : nom de l’objet

      • pii_columns (liste, obligatoire) : les colonnes contenant les données PII.

      • overridden_pii_columns (liste, facultatif) : les colonnes que la classification Snowflake a identifiées comme contenant des données PII, mais qui doivent être disponibles dans les échantillons d’aperçu des données partagés avec les consommateurs.

        Périodiquement, Snowflake effectue des classifications sur les aperçus des données générées. Toutes les colonnes contenant des données PII sont définies dans classified_pii_columns lors de l’exécution des commandes SHOW.

        Les colonnes identifiées par Snowflake comme contenant des données PII sont masquées pour les consommateurs de l’annonce uniquement dans les échantillons d’aperçu des données. Si un fournisseur d’une annonce détermine que les colonnes sont identifiées par erreur comme contenant des données PII, il peut spécifier les colonnes spécifiques qu’il souhaite voir incluses dans les échantillons d’aperçu des données à l’aide de overridden_pii_columns.

Exemple data_preview

. . .
data_preview:
 has_pii: TRUE
 metadata_overrides:
    database: WEATHERDATA
    objects:
       - schema: PUBLIC
         domain: TABLE
         name: GLOBAL_WEATHER
         pii_columns: [ADDRESS, PHONE]
         overridden_pii_columns: [FIRST_NAME, LAST_NAME]
. . .
Copy

draft_access_type

Spécifie comment l’accès à un projet d’annonce est contrôlé.

Note

Pour les annonces « sur demande », vous devez définir draft_access_type: "BY_REQUEST" dans le manifeste.

Ce champ détermine le modèle d’accès pour l’annonce lorsqu’elle est en statut brouillon. Cela est particulièrement pertinent pour les badges de conformité, car les fournisseurs attendent l’approbation d’un ou plusieurs badges par l’équipe de conformité de Snowflake.

Les valeurs autorisées pour draft_access_type sont :

  • UNKNOWN

  • FREE

  • PAID

  • LIMITED_TRIAL

  • BY_REQUEST

Exemples draft_access_type

. . .
draft_access_type: "BY_REQUEST"
. . .
Copy

external_targets

Le champ external_targets est utilisé pour partager des annonces V2 publiques ou privées.

Note

Ce champ ne peut être utilisé qu’avec les annonces V2.

Le champ access est obligatoire lorsque external_targets est spécifié et doit inclure l’un des sous-champs suivants :

  • organization : Lors de la création d’une annonce privée, indiquez le nom de l’organisation et les comptes pouvant accéder à l’annonce.

  • account : Lors de la création d’une annonce privée, vous pouvez éventuellement spécifier les rôles au sein d’un compte qui peuvent accéder à l’annonce.

  • all_organizations : Lorsque vous créez une annonce publique, définissez ce paramètre sur true.

Exemples external_targets

L’exemple suivant montre comment utiliser external_targets pour partager des annonces privées.

. . .
external_targets:
  access:
    - organization: OrgName2
      accounts: [acc1, acc2]
    - account: acc2
      roles: [role1, role2]
. . .
Copy

L’exemple suivant montre comment utiliser external_targets pour partager des annonces publiques.

. . .
external_targets:
  access:
    - all_organizations: true
. . .
Copy

locations

Spécifie les locations facultatifs qui peuvent détecter l’annonce ou y accéder.

Note

Ce champ ne peut être utilisé qu’avec les annonces V2.

Le champ access_regions est obligatoire lorsque locations est spécifié et doit inclure l’un des sous-champs suivants :

  • ALL : Toutes les régions peuvent détecter l’annonce ou y accéder.

  • name : Un tableau de régions sous la forme « region_groups_type.snowflake_region » qui peut détecter l’annonce ou y accéder ; par exemple, access_regions : - name: PUBLIC.AWS_US_WEST_2.

Les groupements de régions disponibles pour les déploiements VPS comprennent les éléments suivants :

  • AWS_US_EAST_1 (« US Est (Virginie du Nord) »)

  • AWS_US_EAST_2 (« US Est (Ohio) »)

  • AWS_US_WEST_2 (« US Ouest (Oregon) »)

  • AWS_EU_WEST_1 (« EU (Irlande) »)

  • AWS_EU_WEST_2 (« EU (Londres) »)

  • AZURE_EASTUS2 (« Est US 2 (Virginie) »)

  • AZURE_CENTRALUS (« Central US (Iowa) »)

Exemple locations

. . .
locations:
  access_regions:
    - name: "PUBLIC.AWS_US_WEST_2"
. . .
Copy

Pour une liste complète des régions, voir SHOW REGIONS.

monetization_display_order

Le champ monetization_display_order facultatif spécifie l’ordre dans lequel les plans tarifaires sont présentés aux consommateurs dans Snowflake Marketplace.

Note

Ce champ ne peut être utilisé qu’avec les annonces V2.

Exemple monetization_display_order

. . .
monetization_display_order:
  - offer_id_1
  - offer_id_2
  - offer_id_3
. . .
Copy

offers

Note

Ce champ ne peut être utilisé qu’avec les annonces V2.

Le champ offers facultatif comprend une liste de huit offres maximum associées à l’annonce. Le champ offers comprend les paires nom/valeur suivantes :

  • name (chaîne, obligatoire) : lien complet vers une page de votre site Internet avec une documentation plus détaillée sur l’annonce. Nom de l’offre défini par l’utilisateur. Le nom doit être formaté en majuscules.

  • type (chaîne, obligatoire) : doit être l’un des types suivants :

    • FILE : Indique que l’offre est définie dans un fichier YAML local.

    • URL : Indique que l’offre est définie dans une URL distante.

  • path (chaîne, obligatoire) : Le chemin vers les offres YAML locales ou distantes.

Exemple offers

. . .
offers:
  - name: PRICING_PLAN_1_DEFAULT_OFFER
    type: FILE
    path: offers/PRICING_PLAN_1_DEFAULT_OFFER.yaml
. . .
Copy

pricing_plans

Note

Ce champ ne peut être utilisé qu’avec les annonces V2.

Le champ pricing_plans facultatif comprend une liste des plans tarifaires associés à l’annonce. Le champ pricing_plans comprend les paires nom/valeur suivantes :

  • name (chaîne, obligatoire) : Nom du plan tarifaire défini par l’utilisateur. Le nom doit être formaté en majuscules.

  • type (chaîne, obligatoire) : doit être l’un des types suivants :

    • FILE : Indique que l’offre est définie dans un fichier YAML local.

    • URL : Indique que l’offre est définie dans une URL distante.

  • path (chaîne, obligatoire) : Le chemin vers le plan tarifaire YAML local ou distant.

Exemple pricing_plans

. . .
pricing_plans:
  - name: PRICING_PLAN_1
    type: FILE
    path: pricingPlans/PRICING_PLAN_1.yaml
. . .
Copy

resources

Les ressources contiennent des informations sur l’annonce, notamment des liens vers la documentation et une vidéo.

Le champ resources est facultatif pour les annonces privées, mais obligatoire pour les annonces marketplace.

Contient les paires nom/valeur suivantes :

  • resources.documentation (chaîne, obligatoire) : lien complet vers une page de votre site Internet avec une documentation plus détaillée sur l’annonce. Doit commencer par http ou par https.

  • resources.media (chaîne, facultative) : lien complet vers une vidéo YouTube publique ou non officielle de l’annonce.

Pour plus d’informations, voir Détails.

Exemple resources

. . .
resources:
  documentation: https://www.example.com/documentation/
  media: https://www.youtube.com/watch?v=MEFlT3dc3uc
. . .
Copy

trial_details

Le champ trial_details facultatif capture les détails de l’essai associé à l’annonce et inclut les paires nom/valeur suivantes :

  • trial_type (chaîne, obligatoire) : lien complet vers une page de votre site Internet avec une documentation plus détaillée sur l’annonce. Spécifie le type de l’essai. Il doit s’agir de l’un des types suivants :

    • TIME

    • USAGE

    • LIMITED

    • LIMITED_TIME

  • trial_time_limit (entier, facultatif) : Indique le nombre de jours pendant lesquels l’annonce sera autorisée en tant qu’essai, après quoi le consommateur devra demander le produit complet. Une valeur nulle indique que l’annonce est de type essai illimité. Soit trial_time_limit ou trial_usage_limit doit être spécifié.

  • trial_usage_limit (entier, facultatif) : Indique le nombre d’utilisations gratuites autorisées avec cette annonce, après quoi le consommateur devra effectuer la mise à niveau. Soit trial_time_limit ou trial_usage_limit doit être spécifié.

  • trial_usage_unit (long, facultatif) : Indique l’unité (comme les requêtes ou les lignes) pour l’utilisation de l’essai. En fonction de cette unité d’utilisation, le nombre d’utilisations est incrémenté en conséquence. Ce champ ne peut être utilisé qu’avec trial-usage_limit.

  • description (chaîne, facultative) : chaîne décrivant les détails de l’essai. La longueur maximale est de 4 096 caractères.

Exemple trial_details

. . .
trial_details:
  trial_type: TIME
  trial_time_limit: 30
  description: "This is a 30-day free trial"
. . .
Copy

usage_examples

Le champ usage_examples est facultatif pour les annonces privées, mais obligatoire pour les annonces marketplace.

Contient une liste des paires nom/valeur suivantes :

  • usage.title (chaîne, obligatoire) : titre d’exemple d’utilisation ; longueur maximale 110 caractères.

  • usage.description (chaîne, facultative) : description associée ; longueur maximale 300 caractères.

  • usage.query (chaîne, obligatoire) : requête associée à l’exemple d’utilisation ; longueur maximale 30,000 caractères.

Pour plus d’informations, voir Exemple de requêtes SQL.

Exemple usage_examples

. . .
usage_examples:
  - title: "Return all weather for the US"
    description: "Example of how to select weather information for the United States"
    query: "select * from weather where country_code='USA'";
. . .
Copy

Exemple YAML complet d’annonce de partage de données V1

Les annonces V1 utilisent targets pour définir les comptes qui peuvent accéder à l’annonce.

title: "Covid data listing"
subtitle: "Listing about covid"
description: "Example covid manifest"
profile: "MyProfile"
listing_terms:
  type: "STANDARD"
targets:
  accounts: ["Org1.Account1", "Org2.Account2"]
auto_fulfillment:
  refresh_schedule: "120 MINUTE"
  refresh_type: "SUB_DATABASE"
business_needs:
  - name: "Life Sciences Commercialization"
    description: "COVID-19 Epidemiological Data"
usage_examples:
  - title: "Get total case count by country"
    description: "Calculates the total number of cases by country, aggregated over time."
    query: "SELECT  COUNTRY_REGION, SUM(CASES) AS Cases FROM ECDC_GLOBAL GROUP BY COUNTRY_REGION;"
data_attributes:
  refresh_rate: HOURLY
  geography:
    granularity:
      - ADDRESS
    geo_option: COUNTRIES
    coverage:
      continents:
        ASIA:
          - INDIA
          - CHINA
        NORTH AMERICA:
          - UNITED STATES
          - CANADA
        EUROPE:
          - UNITED KINGDOM
    time:
      granularity: MONTHLY
      time_range:
      time_frame: BETWEEN
      start_date: 12-24-2020
      end_date: 12-25-2021
data_preview:
  has_pii: TRUE
  metadata_overrides:
    database: WEATHERDATA
    objects:
      schema: PUBLIC
      domain: TABLE
      name: GLOBAL_WEATHER
      pii_columns: [ADDRESS, PHONE]
      overridden_pii_columns: [FIRST_NAME, LAST_NAME]
resources:
  documentation: https://www.example.com/documentation/
  media: https://www.youtube.com/watch?v=MEFlT3dc3uc
categories:
  - HEALTH
compliance_badges:
  - type: SOC2
    expiry: 12-25-2026
    files:
      - soc2_compliance_verification.pdf
  - type: HIPAA
    expiry: 06-07-2026
    files:
      - hipaa_compliance_verification.pdf
cke_content_protection:
  enable: TRUE
  threshold: 0.2
trial_details:
  trial_type: TIME
  trial_time_limit: 30
  description: "This is a 30-day free trial"
Copy

Exemple YAML complet d’annonce de partage de données V2

Les annonces V2 utilisent external_targets pour définir les organisations et les rôles qui peuvent accéder à l’annonce. Les annonces V2 permettent également aux utilisateurs de définir des plans et des offres tarifaires.

title: "Covid data listing"
subtitle: "Listing about covid"
description: "Example covid manifest"
profile: "MyProfile"
listing_terms:
  type: "STANDARD"
external_targets:
  access:
    - organization: OrgName2
      accounts: [acc1, acc2]
    - account: acc2
      roles: [role1, role2]
auto_fulfillment:
  refresh_schedule: "120 MINUTE"
  refresh_type: "SUB_DATABASE"
business_needs:
  - name: "Life Sciences Commercialization"
    description: "COVID-19 Epidemiological Data"
usage_examples:
  - title: "Get total case count by country"
    description: "Calculates the total number of cases by country, aggregated over time."
    query: "SELECT  COUNTRY_REGION, SUM(CASES) AS Cases FROM ECDC_GLOBAL GROUP BY COUNTRY_REGION;"
data_attributes:
  refresh_rate: HOURLY
  geography:
    granularity:
      - ADDRESS
    geo_option: COUNTRIES
    coverage:
      continents:
        ASIA:
          - INDIA
          - CHINA
        NORTH AMERICA:
          - UNITED STATES
          - CANADA
        EUROPE:
          - UNITED KINGDOM
    time:
      granularity: MONTHLY
      time_range:
      time_frame: BETWEEN
      start_date: 12-24-2020
      end_date: 12-25-2021
data_preview:
  has_pii: TRUE
  metadata_overrides:
    database: WEATHERDATA
    objects:
      schema: PUBLIC
      domain: TABLE
      name: GLOBAL_WEATHER
      pii_columns: [ADDRESS, PHONE]
      overridden_pii_columns: [FIRST_NAME, LAST_NAME]
locations:
  access_regions:
    - name: "PUBLIC.AWS_US_WEST_2"
monetization_display_order:
  - offer_id_1
pricing_plans:
  - name: PRICING_PLAN_1
    type: FILE
    path: pricingPlans/PRICING_PLAN_1.yaml
offers:
  - name: PRICING_PLAN_1_DEFAULT_OFFER
    type: FILE
    path: offers/PRICING_PLAN_1_DEFAULT_OFFER.yaml
resources:
  documentation: https://www.example.com/documentation/
  media: https://www.youtube.com/watch?v=MEFlT3dc3uc
categories:
  - HEALTH
compliance_badges:
  - type: SOC2
    expiry: 12-25-2026
    files:
      - soc2_compliance_verification.pdf
  - type: HIPAA
    expiry: 06-07-2026
    files:
      - hipaa_compliance_verification.pdf
draft_access_type: "BY_REQUEST"
cke_content_protection:
  enable: TRUE
  threshold: 0.2
trial_details:
  trial_type: TIME
  trial_time_limit: 30
  description: "This is a 30-day free trial"
Copy
Langage: Français