Referenz zum Freigabeangebots-Manifest

Für das programmgesteuerte Erstellen von Snowflake-Freigabeangeboten ist eine Manifest erforderlich, das in YAML (https://yaml.org/spec/) geschrieben ist. Nutzen Sie die hier bereitgestellten Informationen, um sich über das Format des Manifests und seine einzelnen Abschnitte zu informieren.

Siehe auch:

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

Bemerkung

Felder können Folgendes sein:

  • Optional – Optional entweder für Marketplace-Angebote oder private Angebote.

  • Erforderlich – Erforderlich entweder für Marketplace-Angebote oder private Angebote.

  • Qualifiziert – Anforderungen unterscheiden sich für Marketplace-Angebote und private Angebote, und optional vs. erforderlich ist je nach Angebotstyp unterschiedlich. Zum Beispiel optional für private Angebote, aber erforderlich für Marketplace-Angebote.

Das allgemeine Format einer Angebots-Manifest-Datei ist wie folgt:

#
# 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

In den folgenden Abschnitten werden die einzelnen Felder und das untergeordnete Feld des Angebots-Manifests ausführlich beschrieben und mit Beispielen versehen.

Angebots-Präfix

Jedes Angebots-Manifest beginnt mit den folgenden Feldern:

  • title (String, erforderlich, max. 110 Zeichen): Titel des Freigabeangebots.

  • subtitle (String, optional für privat, erforderlich für Marketplace, max. 110 Zeichen): Untertitel des Freigabeangebots.

  • description (String, erforderlich, max. 7.500 Zeichen): Beschreibung des Freigabeangebots. Die Markdown-Syntax wird unterstützt.

  • custom_contact (String, optional): E-Mail-Adresse. Muss eine gültige, wohlgeformte E-Mail-Adresse sein.

  • profile (String, optional für private, erforderlich für Marketplace-Angebote): Name eines genehmigten Anbieterprofils.

Weitere Informationen dazu finden Sie unter: Basisinformationen zum Anbieter.

Bemerkung

Werte für profile können durch Ausführung von show profiles in data exchange SNOWFLAKE_DATA_MARKETPLACE; ermittelt werden.

Beispiel für ein Angebots-Präfix

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

Das Feld required listing_terms (erforderlich) enthält die folgenden Namen-Wert-Paare:

  • listing_terms.type (enum, erforderlich): Muss einer der Folgenden sein:

    • STANDARD – Verweist auf Standardvereinbarung für Marketplace-Produkte

    • OFFLINE – Zeigt an, dass die Bedingungen von den Parteien offline ausgehandelt werden.

    • CUSTOM – Wenn angegeben, muss ein Wert für listing_terms.link spezifiziert werden.

  • listing_terms.link (erforderlich bei Typ CUSTOM): Ein vollqualifizierter Link zu den Angebotsbedingungen des Anbieters. Muss mit http oder https beginnen.

Weitere Informationen finden Sie im Abschnitt Nutzungsbedingungen in der Tabelle unter `Basisinformationen `_.

Bemerkung

Verbraucher können Bedingungen für Freigabeangebote programmgesteuert akzeptieren. Weitere Informationen dazu erhalten Sie vom Snowflake-Support.

listing_terms-Beispiel

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

targets

Bemerkung

Dieses Feld kann nur mit V1-Freigabeangeboten verwendet werden.

Das Feld targets ist für Marketplace- und private Angebote erforderlich.

Enthält eine Liste mit maximal 100 Elementen:

  • targets.accounts (erforderlich, wenn targets.region nicht vorhanden ist): Liste der Konten, für die das Angebot freigegeben werden soll.

    Jedes Zielkonto muss im Format <OrgName>.<AccountName> vorliegen, wobei

oder

  • targets.regions (erforderlich, wenn targets.accounts nicht vorhanden ist):

    Liste der Regionen, für die das Angebot freigegeben werden soll.

    Jede Zielregion muss das Format „Regionsgruppentyp.Snowflake-Region“ haben. Darüber hinaus wird „ALL“ unterstützt, um alle Regionen einzubeziehen.

    Beispiel: „PUBLIC.AWS_US_EAST_1“.

    Um eine vollständige Liste der Regionsgruppen-Typen und Snowflake-Regionen zu erhalten, führen Sie Folgendes aus:

    SHOW REGIONS IN DATA EXCHANGE SNOWFLAKE_DATA_MARKETPLACE;
    
    Copy

Weitere Informationen dazu finden Sie unter Geschäftsanforderungen.

targets-Beispiele

Definieren Sie eine Menge von Zielkonten für dieses Freigabeangebot.

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

Definieren Sie eine Menge von Zielregionen für dieses Freigabeangebot.

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

auto_fulfillment

Die Cloud-übergreifende automatische Ausführung ermöglicht es, das mit einem Angebot verknüpfte Datenprodukt automatisch in anderen Snowflake-Regionen bereitzustellen. Das Feld auto_fulfillment definiert, wie diese automatische Auftragsausführung erfolgen soll.

Weitere Informationen zur Cloud-übergreifenden automatische Ausführung finden Sie unter Automatische Ausführung für Freigabeangebote

Automatische Ausführung ist nur erforderlich, wenn Sie Daten für mehrere Regionen freigeben. Aktivieren Sie diese nicht, wenn Sie Konten in derselben Region freigeben.

Wenn Sie Daten über mehrere Regionen hinweg freigeben, ist auto_fulfillment:

  • Erforderlich, wenn Ihr Datenprodukt ein Anwendungspaket ist.

  • Erforderlich, wenn Ihr Datenprodukt über ein privates Freigabeangebot geteilt wird.

  • Empfohlen, wenn Ihr Datenprodukt über ein öffentliches Freigabeangebot geteilt wird.

Enthält die folgenden Name/Wert-Paare:

  • auto_fulfillment.refresh_schedule

    • <num> MINUTE – Anzahl der Minuten. Minimal 10 Minuten, maximal 8 Tage (11.520 Minuten).

      Wenn refresh_type den Wert SUB_DATABASE_WITH_REFERENCE_USAGE hat, nehmen Sie diese Einstellung nicht vor. Der Aktualisierungszeitplan für Anwendungspakete muss auf Kontoebene definiert werden und nicht auf Ebene des Freigabeangebots.

      Weitere Informationen dazu finden Sie unter Aktualisierungsintervall auf Kontoebene festlegen.

  • USING CRON <expression> – Legt den Zeitplan für die automatische Aktualisierung von Produkten fest.

    Die Syntax für USING CRON und REPLICATION SCHEDULE ist die gleiche. Siehe Parameter.

  • auto_fulfillment.refresh_type (erforderlich bei Verwendung von auto_fulfillment): Muss einer der folgenden Werte sein:

    • SUB_DATABASE – Replikation von Datenbanken (Objektebene) – empfohlen.

    • SUB_DATABASE_WITH_REFERENCE_USAGE – Anwendungspaket.

    • FULL_DATABASE – Replikation der Datenbank (für die gesamte Datenbank)

  • auto_fulfillment.refresh_schedule_override (optional): Setzt die definierte Aktualisierungsfrequenz für alle Freigabeangebote außer Kraft, die dieselbe Datenbank verwenden. Wenn dieser Wert FALSE ist, schlägt die Aktualisierung von Freigabeangeboten fehl, wenn mehrere Freigabeangeboten, die sich dieselbe Datenbank teilen, unterschiedliche Aktualisierungsfrequenzen haben.

    • TRUE – aktiviert die Überschreibung der Aktualisierungsfrequenz.

    • FALSE – (Standard) deaktiviert die Überschreibung der Aktualisierungsfrequenz.

Siehe auch Automatische Ausführung für Freigabeangebote.

auto_fulfillment.refresh_schedule-Beispiele

Das folgende Beispiel aktualisiert das mit einem Freigabeangebot verbundene Datenprodukt alle 10 Minuten:

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

Das folgende Beispiel aktualisiert das mit einem Freigabeangebot verbundene Datenprodukt an bestimmten Tagen und zu bestimmten Zeiten in bestimmten Regionen:

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

Das folgende Beispiel aktiviert die Überschreibung der Aktualisierungsfrequenz für Freigabeangebote, die dieselbe Datenbank nutzen, aber unterschiedliche Aktualisierungsfrequenzen haben:

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

Snowflake Native App auto_fulfillment-Beispiel

SUB_DATABASE_WITH_REFERENCE_USAGE kann nur mit Anwendungspaketen verwendet werden und kann nicht mit auto_fulfillment.refresh_schedule kombiniert werden.

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

Beispiel auf Objektebene auto_fulfillment

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

business_needs

Freigabeangebote sind nach Geschäftsanforderungen gruppiert, um die Suche zu erleichtern. Eine Geschäftsanforderung beschreibt, wie ein bestimmtes Angebot einem bestimmten Geschäftsbedarf entspricht. Weitere Informationen dazu finden Sie unter Geschäftsanforderungen.

STANDARD-Geschäftsanforderungen

  • business_needs.name (erforderlich bei Verwendung von business_needs):

    Gültige Werte:

    • „360-Degree Customer View“

    • „Supply Chain“

    • „Personalize Customer Experiences“

    • „Inventory Management“

    • „Accelerating Advertising Revenue“

    • „Attribution Analysis“

    • „Contact Data Enrichment“

    • „Foot Traffic Analytics“

    • „Audience Segmentation“

    • „Sentiment Analysis“

    • „ESG Investment Analysis“

    • „Fundamental Analysis“

    • „Quantitative Analysis“

    • „Risk Analysis“

    • „Fraud Remediation“

    • „Customer Onboarding“

    • „Identity Resolution“

    • „Asset Valuation“

    • „Economic Impact Analysis“

    • „Demand Forecasting“

    • „Population Health Management“

    • „Real World Data (RWD)“

    • „Location Planning“

    • „Regulatory Reporting“

    • „Subscriber Acquisition and Retention“

    • „Life Sciences Commercialization“

    • „Patient 360“

    • „Blockchain Analysis“

    • „Customer Acquisition“

    • „Data Quality and Cleansing“

    • „Location Data Enrichment“

    • „Location Geocoding“

    • „Machine Learning“

    • „Market Analysis“

    • „Pricing Analysis“

    • „Audience Activation“

business_needs[].description (erforderlich bei Verwendung von business_needs): Beschreibung des zugehörigen „business_needs.name“, max. 1.000 Zeichen.

business_needs[].type: STANDARD (optional).

CUSTOM-Geschäftsanforderungen

Kundenspezifischen Geschäftsanforderungen umfassen ein benutzerdefinierte Wert für name und description sowie ein erforderliches Feld type mit dem Wert CUSTOM.

business_needs.name (erforderlich bei Verwendung von business_needs): Vom Benutzer definierter Name.

business_needs[].description (erforderlich bei Verwendung von business_needs): Beschreibung des zugehörigen „business_needs.name“, max. 1.000 Zeichen.

business_needs[].type: CUSTOM (erforderlich bei der Definition kundenspezifischer Geschäftsanforderungen).

business_needs-Beispiele

Standard ohne optionalem type

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

Standard mit optionalem type

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

Kundenspezifisch mit erforderlichem type

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

categories

Das Feld categories gibt die Kategorie oder den Bereich an, zu dem das Angebot gehört. Kategorien sind optional für private Angebote, aber erforderlich für Marketplace-Angebote.

Kategorien werden in Snowflake Marketplace verwendet, um Angebote nach Bereichen zu durchsuchen und Verbrauchern das Auffinden Ihrer Daten zu erleichtern.

Das Feld categories ist eine Liste, kann aber nur einen einzigen Eintrag aus der folgenden Liste enthalten:

  • BUSINESS

  • CONNECTORS

  • DEMOGRAPHICS

  • ECONOMY

  • ENERGY

  • ENVIRONMENT

  • FINANCIAL

  • GOVERNMENT

  • HEALTH

  • IDENTITY

  • LEGAL

  • LOCAL

  • LOOKUP_TABLES

  • MARKETING

  • MEDIA

  • SECURITY

  • SPORTS

  • TRANSPORTATION

  • TRAVEL

  • WEATHER

categories-Beispiel

. . .
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

Das Feld compliances_badges wird verwendet, um anzuzeigen, dass ein Freigabeangebot von einem externen Wirtschaftsprüfer überprüft und als konform mit einem bestimmten Standard oder einer bestimmten Vorschrift zertifiziert wurde.

Wenn Sie ein Konformitätsabzeichen konfigurieren, können Sie bis zu drei Typen angeben. Geben Sie das Ablaufdatum für jedes Abzeichen und die dazugehörigen Zertifizierungsdokumente von Drittanbietern an.

Die folgenden Felder werden verwendet, um ein Konformitätsabzeichen zu konfigurieren:

  • compliance_badges: Dient zum Deklarieren und Konfigurieren eines Konformitätsabzeichens für ein Freigabeangebot. Anbieter können mehrere Compliance-Zertifizierungen innerhalb der Eigenschaft compliance_badges erklären.

    • type: Die angeforderte Konformitätszertifizierung. Die folgende Liste zeigt die möglichen Werte:

      • SOC2

      • HIPAA

      • ISO27001

    • expiry: Das Datum, an dem die Compliance-Zertifizierung abläuft.

    • files: Die Auflistung der Dateien, die zur Überprüfung der Konformitätszertifizierung verwendet werden.

Weitere Informationen dazu finden Sie unter Compliance-Abzeichen für Freigabeangebote.

compliance_badges-Beispiel

. . .
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

Datenattribute geben Verbrauchern Einblick in Informationen zu einem Freigabeangebot, wie z. B. die Aktualisierungshäufigkeit und andere Eigenschaften.

Das Feld data_attributes ist optional für private Angebote, aber erforderlich für Marketplace-Angebote.

Weitere Informationen zu Datenproduktattributen finden Sie unter Datenprodukt – Attribute.

Enthält die folgenden Name/Wert-Paare:

  • data_attributes.refresh_rate (erforderlich für Datenangebote; optional für App-Angebote)

    Gibt die Häufigkeit an, mit der Ihr Datenprodukt in Snowflake aktualisiert wird.

    Eine der folgenden Optionen:

    • CONTINUOUSLY

    • HOURLY

    • DAILY

    • WEEKLY

    • MONTHLY

    • QUARTERLY

    • ANNUALLY

    • STATIC

  • data_attributes.geography (erforderlich):

    Gibt die geografische Regionen an, für die Ihr Datenprodukt eine Abdeckung bietet.

    • granularity (string, erforderlich)

      Geografische Abdeckung Ihres Datensets.

      Eine der folgenden Optionen:

      • LATITUDE_LONGITUDE

      • ADDRESS

      • POSTAL_CODE

      • CITY

      • COUNTY

      • STATE

      • COUNTRY

      • REGION_CONTINENT

    • geo_option (string, erforderlich)

      Eine der folgenden Optionen:

      • NOT_APPLICABLE

      • GLOBAL

      • COUNTRIES

    • coverage (erforderlich auf Basis der Auswahl von geo_option), ist entweder:

      • states (Liste mit Statusangaben) – enthält eine beliebige Liste gültiger Namen von US-Bundesstaaten.

      Or

      • continents (Liste der Kontinente):

        Eine der folgenden Optionen:

        • ASIA

        • EUROPE

        • AFRICA

        • NORTH AMERICA

        • SOUTH AMERICA

        • OCEANIA

        • ANTARCTICA

    • time (erforderlich):

      Gibt den Zeitraum an, den Ihr Datenprodukt abdeckt.

      • granularity (erforderlich)

      Eine der folgenden Optionen:

      • EVENT_BASED

      • HOURLY

      • DAILY

      • WEEKLY

      • MONTHLY

      • YEARLY

      • time_range (erforderlich) enthält die folgenden Name/Wert-Paare:

        • time_frame (erforderlich)

          Eine der folgenden Optionen:

          • NEXT

          • LAST

          • BETWEEN

        • unit (erforderlich)

          Eine der folgenden Optionen:

          • DAYS

          • WEEKS

          • MONTHS

          • YEARS

        • value (erforderlich, wenn time_frame NEXT/LAST ist, integer), Bereich 1-100.

        • start_time (erforderlich, wenn time_frame BETWEEN ist, String date), Format MM-DD-YYYY.

        • end_time (erforderlich, wenn time_frame BETWEEN ist, String date), Format MM-DD-YYYY.

data_attributes-Beispiel

. . .
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

Das Feld data_dictionary bietet Verbrauchern einen Einblick in Inhalt und Struktur eines Freigabeangebots, bevor sie dieses in ihrem Konto installieren. Erforderlich für öffentliche Freigabeangebote, optional für alle anderen Typen von Freigabeangeboten.

Das Feld data_dictionary enthält eine Liste von bis zu fünf Data Dictionary-Einträgen:

  • data_dictionary.featured (erforderlich bei Verwendung von data_dictionary): muss „featured“ (empfohlen) sein.

  • data_dictionary.featured.database (erforderlich bei Verwendung von data_dictionary): Name der Datenbank.

  • data_dictionary.featured.objects (erforderlich bei Verwendung von data_dictionary): Liste von Name/Wert-Paaren:

    • name (string, erforderlich): Objektname

    • schema (string, erforderlich): Schema

    • domain (erforderlich):

      Eine der folgenden Optionen:

      • DATABASE

      • SCHEMA

      • TABLE

      • VIEW

      • EXTERNAL_TABLE

      • MATERIALIZED_VIEW

      • DIRECTORY_TABLE

      • FUNCTION

      • COLUMN

Siehe auch Datenprodukt – Datenwörterbuch.

data_dictionary-Beispiel

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

data_preview

Das Feld data_preview ermöglicht es Anbietern, persönlich identifizierbare Informationen (PII) in den aus den Angebotsdaten generierten Datenvorschau-Mustern zu identifizieren und zu verbergen. PII-Daten sind Daten, die direkt oder indirekt die Identität einer Person offenbaren könnten. Erforderlich für öffentliche Freigabeangebote und optional für alle anderen Typen von Freigabeangeboten.

Das Feld data_preview enthält die folgenden Einträge:

  • data_preview.has_pii (erforderlich bei Verwendung von data_preview): gibt an, ob PII in den Angebotsdaten enthalten sind.

    • TRUE - PII sind in den Angebotsdaten enthalten.

    • FALSE - PII sind nicht in den Angebotsdaten enthalten.

  • data_preview.metadata_overrides (empfohlen, wenn data_preview.has_pii TRUE ist): identifiziert den Speicherort der PII-Angebotsdaten und die Objekte innerhalb dieses Datensets, die PII enthalten, um sie zu verbergen oder freizulegen.

    • database (Zeichenfolge, erforderlich): Name der Datenbank.

    • objects (Liste, erforderlich): Die Objekte, deren Spalten in den Datenvorschau-Beispielen ein- oder ausgeblendet werden sollen:

      • schema (Zeichenfolge, erforderlich): Name des Schemas.

      • domain (Zeichenfolge, erforderlich): Domänenname.

      • name (Zeichenfolge, erforderlich): Objektname

      • pii_columns (Liste, optional): Die Spalten, die PII enthalten.

      • overridden_pii_columns (Liste, optional): Die Spalten der Snowflake-Klassifizierung, die als PII enthaltend identifiziert wurden, die jedoch in den mit den Verbrauchern geteilten Datenvorschau-Mustern verfügbar sein sollten.

        Snowflake führt in regelmäßigen Abständen Klassifizierungen an den generierten Datenvorschauen durch. Alle Spalten, die PII enthalten, werden in classified_pii_columns definiert, wenn die SHOW-Befehle ausgeführt werden.

        Spalten, die von Snowflake als PII enthaltend identifiziert werden, werden nur in der Datenvorschau vor den Verbrauchern der Angebotsfreigabe verborgen. Wenn ein Anbieter eines Freigabeangebots feststellt, dass die Spalten fälschlicherweise als PII enthaltend identifiziert werden, kann er die spezifischen Spalten, die er in die Datenvorschau-Beispiele aufnehmen möchte, unter overridden_pii_columns angeben.

data_preview-Beispiel

. . .
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

Gibt an, wie der Zugriff auf einen Entwurf eines Freigabeangebots kontrolliert wird.

Bemerkung

Für „Auf Anfrage“-Listen müssen Sie „draft_access_type:“ im Manifest auf „BY_REQUEST“ festlegen.

Dieses Feld bestimmt das Zugriffsmodell für das im Entwurfsstatus befindliche Freigabeangebot. Dies ist besonders relevant für -Konformitätsabzeichen, da Anbietende auf die Genehmigung einzelner oder mehrerer Abfrageabzeichen durch das Snowflake-Compliance-Team warten.

Die zulässigen Werte für draft_access_type sind:

  • UNKNOWN

  • FREE

  • PAID

  • LIMITED_TRIAL

  • BY_REQUEST

draft_access_type-Beispiele

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

external_targets

Das Feld external_targets wird zur Freigabe von öffentlichen oder privaten V2-Freigabeangeboten verwendet.

Bemerkung

Dieses Feld kann nur mit V2-Freigabeangeboten verwendet werden.

Das access-Feld ist erforderlich, wenn external_targets angegeben ist, und muss eines der folgenden Unterfelder enthalten:

  • organization: Geben Sie beim Erstellen eines privaten Freigabeangebots den Namen der Organisation und die Konten an, die auf das Freigabeangebot zugreifen können.

  • account: Geben Sie beim Erstellen eines privaten Freigabeangebots optional die Rollen innerhalb eines Kontos an, die auf das Freigabeangebot zugreifen können.

  • all_organizations: Wenn Sie ein öffentliches Freigabeangebot erstellen, legen Sie dies auf true fest.

external_targets-Beispiele

Das folgende Beispiel zeigt, wie Sie mit external targets private Freigabeangebote freigeben.

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

Das folgende Beispiel zeigt, wie Sie mit external targets öffentliche Freigabeangebote freigeben.

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

locations

Gibt die optionalen locations an, die das Freigabeangebot entdecken oder darauf zugreifen können.

Bemerkung

Dieses Feld kann nur mit V2-Freigabeangeboten verwendet werden.

Das access_regions-Feld ist erforderlich, wenn locations angegeben ist, und muss eines der folgenden Unterfelder enthalten:

  • ALL: Alle Regionen können das Freigabeangebot entdecken oder darauf zugreifen.

  • name: Ein Array von Regionen im Format „region_groups_type.snowflake_region“, die das Freigabeangebot erkennen oder darauf zugreifen können. Beispiel access_regions: - name: PUBLIC.AWS_US_WEST_2.

Verfügbare Regionsgruppierungen für VPS-Bereitstellungen umfassen Folgendes:

  • AWS_US_EAST_1 („US East (N. Virginia)“)

  • AWS_US_EAST_2 („US East (Ohio)“)

  • AWS_US_WEST_2 („US West (Oregon)“)

  • AWS_EU_WEST_1 („EU (Ireland)“)

  • AWS_EU_WEST_2 („EU (London)“)

  • AZURE_EASTUS2 („East US 2 (Virginia)“)

  • AZURE_CENTRALUS („Central US (Iowa)“)

locations-Beispiel

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

Eine vollständige Liste der Regionen finden Sie unter SHOW REGIONS.

monetization_display_order

Das optionale monetization_display_order-Feld gibt die Reihenfolge an, in der die Preistarife den Verbrauchenden in Snowflake Marketplace angezeigt werden.

Bemerkung

Dieses Feld kann nur mit V2-Freigabeangeboten verwendet werden.

monetization_display_order-Beispiel

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

offers

Bemerkung

Dieses Feld kann nur mit V2-Freigabeangeboten verwendet werden.

Das optionale Feld :code:`offers`enthält eine Liste von bis zu acht Angeboten, die mit dem Freigabeangebot verbunden sind. Das Feld :code:`offers`enthält die folgenden Name/Wert-Paare:

  • name (Zeichenfolge, erforderlich): Der benutzerdefinierte Name des Angebots. Der Name muss komplett in Großbuchstaben formatiert sein.

  • type (Zeichenfolge, erforderlich): Muss einer der folgenden Typen sein:

    • FILE: Zeigt an, dass das Angebot in einer lokalen YAML-Datei definiert ist.

    • URL: Zeigt an, dass das Angebot in einer Remote-URL-Datei definiert ist.

  • path (Zeichenfolge, erforderlich): Der Pfad zur lokalen oder externen -Angebots-YAML.

offers-Beispiel

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

pricing_plans

Bemerkung

Dieses Feld kann nur mit V2-Freigabeangeboten verwendet werden.

Das optionale Feld pricing_plans enthält eine Liste der Preistarife, die mit dem Freigabeangebot verbunden sind. Das Feld :code:`pricing_plans`enthält die folgenden Name/Wert-Paare:

  • name (Zeichenfolge, erforderlich): Der benutzerdefinierte Name des Preistarifs. Der Name muss komplett in Großbuchstaben formatiert sein.

  • type (Zeichenfolge, erforderlich): Muss einer der folgenden Typen sein:

    • FILE: Zeigt an, dass das Angebot in einer lokalen YAML-Datei definiert ist.

    • URL: Zeigt an, dass das Angebot in einer Remote-URL-Datei definiert ist.

  • path (Zeichenfolge, erforderlich): Der Pfad zur lokalen oder externen Preistarif-YAML.

pricing_plans-Beispiel

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

resources

Die Ressourcen enthalten Informationen zu dem Freigabeangebot, einschließlich Links zur Dokumentation und zu einem Video.

Das Feld resources ist optional für private Angebote, aber erforderlich für Marketplace-Angebote.

Enthält die folgenden Name/Wert-Paare:

  • resources.documentation (String, erforderlich): Ein vollqualifizierter Link zu einer Seite auf Ihrer Website, wo eine detailliertere Dokumentation zu Ihrem Angebot zu finden ist. Muss mit http oder https beginnen.

  • resources.media (Zeichenfolge, optional): Ein vollqualifizierter Link zu einem nicht aufgelisteten oder öffentlichen YouTube-Video zu dem Freigabeangebot.

Weitere Informationen dazu finden Sie unter Details.

resources-Beispiel

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

trial_details

Das optionale Feld trial_details erfasst Testdetails, die mit dem Freigabeangebot verbunden sind, und enthält die folgenden Name/Wert-Paare:

  • trial_type (Zeichenfolge, erforderlich): Gibt den Typ des Tests an. Muss einer der folgenden Typen sein:

    • TIME

    • USAGE

    • LIMITED

    • LIMITED_TIME

  • trial_time_limit (Ganzzahl, optional): Gibt die Anzahl der Tage an, die das Freigabeangebot als Testversion zulässig ist, danach müssen die Verbrauchenden das vollständige Produkt anfordern. Der Wert 0 bedeutet, dass es sich bei dem Angebot um eine zeitlich unbegrenzte Testversion handelt. Entweder trial_time_limit oder trial_usage_limit muss angegeben werden.

  • trial_usage_limit (Ganzzahl, optional): Gibt an, wie häufig die Verbrauchenden das Produkt im Rahmen dieses Freigabeangebots kostenlos nutzen könnten, bis sie ein Upgrade durchführen müssten. Entweder trial_time_limit oder trial_usage_limit muss angegeben werden.

  • trial_usage_unit (Lang, optional): Gibt die Einheit (z. B. Abfragen oder Zeilen) für die Testnutzung an. Abhängig von dieser Nutzungseinheit wird die Nutzungsanzahl entsprechend erhöht. Dieses Feld kann nur mit trial-usage_limit verwendet werden.

  • description (String, optional): Zeichenfolge, die die Details der Testversion beschreibt. Die maximale Länge beträgt 4.096 Zeichen.

trial_details-Beispiel

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

usage_examples

Das Feld usage_examples ist optional für private Angebote, aber erforderlich für Marketplace-Angebote.

Enthält eine Liste der folgenden Name/Wert-Paare:

  • usage.title (Zeichenfolge, erforderlich): Titel des Verwendungsbeispiels, max. 110 Zeichen.

  • usage.description (String, optional): Zugehörige Beschreibung, max. 300 Zeichen.

  • usage.query (Zeichenfolge, erforderlich): Abfrage im Zusammenhang mit dem Verwendungsbeispiel, max. 30,000 Zeichen.

Weitere Informationen dazu finden Sie unter SQL-Beispielabfragen.

usage_examples-Beispiel

. . .
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

Vollständiges YAML-Beispiel für ein V1-Datenfreigabeangebot

V1-Freigabeangebote nutzen targets zur Definition der Konten, die auf das Freigabeangebot zugreifen können.

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

Vollständiges YAML-Beispiel für ein V2-Datenfreigabeangebot

V2-Freigabeangebote nutzen external_targets zur Definition der Organisationen und Rollen, die auf das Freigabeangebot zugreifen können. Mit V2-Freigabeangeboten können Benutzende auch Preistarife und Angebote definieren.

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