Configuring listings capabilities¶
This topic describes the fields for capabilities that you can configure for a listing. Depending on whether you offer a paid listing, a private listing, or a marketplace listing, you must complete different fields.
After you configure the listing, publish the listing. See Publishing a listing.
Basic information¶
The following table describes the available fields in the Basic Information section.
Field Name |
Description |
Example |
---|---|---|
Type |
The type of listing. After you create a listing and attach a share, you cannot change the listing type. |
Available Values: Free, Personalized, or Paid. |
Publishing as |
The provider profile used to publish the listing to consumers. You must create a provider profile before you can publish a listing. See Becoming a provider of listings. |
|
Title |
The title of the listing. The listing title cannot exceed 110 characters, but it is recommended that the title is between 40-60 characters. All major words should be capitalized (i.e. follow the title case format). The title appears below your company name on the listing tile, and it must be unique (i.e. different from any other listings you may have). If you decide to offer similar listings, such as a Free listing to showcase a subset of your data, and a Personalized listing to let consumers request the full dataset, use similar but distinct titles. In this example, you could append - Sample to the Free listing title. If you provide free listings to showcase other listings on the Snowflake Marketplace, use a - Demo or - Sample suffix. If you provide free listings for a limited time, use a - Trial suffix. This option is not available for free (or paid off-platform) private listings. |
Historical Weather by Postcode. |
Subtitle |
Subtitle for the listing. The subtitle cannot exceed 110 characters. Use sentence case for the subtitle and do not repeat the title. This option is not available for free (or paid off-platform) private listings. |
Historical weather data by location. |
Category |
Listings are categorized to make them easy to find on the Snowflake Marketplace. Select the desired category from the drop-down list of available values. This option is not available for free (or paid off-platform) private listings. |
|
Terms of Service |
Specifies a link to the Terms of Service agreement for the listing. Consumers must accept the terms before they can access the listing. Terms of Service agreements are required for free listings, and are optional for personalized listings. Select one of the following:
|
|
Details¶
The following table describes the available fields in the Details section.
Note
This section is optional for private listings.
Field Name |
Description |
Example |
---|---|---|
Description |
Description of the data product shared in the listing. Enter a description between 250 and 6000 characters, with line breaks between paragraphs. Use dashes instead of bullet points. The description must include the following: . - An introductory paragraph with information about the data product, such as the scope of the dataset. . - A description of included tables or views . - Key data fields . For listings that include services or secure functions, the description must include the expected workflow for consumers to access your services or secure functions. . The description can also include the data sources for your listing, or additional information not covered in other fields. |
ACME is the number one supplier of customized, pinpoint weather warnings to large enterprises, as well as a vital information source for worldwide weather forecasts, data and meteorological consulting services. This listing provides historical weather data for US zip codes that can be used to further enhance your existing data to provide deeper analytics. . Samples/tables included: . - Daily historical weather data from 2016-Present . - 15-day Daily Forecast weather data . - Daily 15-year climatology data (weather statistics, i.e. avg, std, freq, etc.) . Fields included: . - Date . - Zip Code . - Country . - Min, Max, Avg weather statistics (temperature, precipitation, wind, humidity, etc.) |
Link to Documentation |
A link to a page on your website with more detailed documentation for the listing. Documentation must be clear, and reference the correct schema objects present in the share associated with the listing. The link must be accessible on the internet, and not require authentication to access. |
|
Data product - Attributes¶
After specifying a data product, you can define additional attributes for a listing.
Note
This section is optional for private listings.
Field Name |
Description |
---|---|
Update Frequency |
How often your data product is updated in Snowflake |
Geographic Coverage |
What geographic area the data covers. |
Time Range |
The range of time that the data covers. |
Additional attributes (optional) |
Any additional information that you want to communicate to your consumers. For example, include a description of the scope and scale of your data, and why someone might find your data useful. |
Data product - Trial & pricing (paid listings only)¶
Add the pricing plan and trial for your listing in this section. This section is required for paid listings offered on the Snowflake Marketplace, but trials are optional for paid private listings.
Note
Only account administrators (users with the ACCOUNTADMIN role) or the listing owner (a role with OWNERSHIP privilege on the listing) can complete this section.
The following table describes the available fields in the Trial & Pricing section.
Field |
Description |
---|---|
Pricing Plan |
Choose the pricing plan for the listing. See Paid listings pricing models. Prices are in US dollars only. |
Free Trial |
Choose the trial type for the listing:
|
Data product - Data dictionaries¶
A data dictionary provides consumers insight into the contents and structure of a free or paid Marketplace listing before they install it into their account. Adding a data dictionary for a private listing is optional.
About data dictionaries¶
You can use a data dictionary to make the contents of your listing visible to consumers. A data dictionary is generated for tables and views within a listing.
Your data is visible in two ways:
Featured objects: they allow the consumer to quickly view the contents of the object. You can select up to five of the most important database objects within the listing.
All objects: this list allows the consumer to view all of the objects within a listing. It is auto-generated when you publish a listing.
Setting up a data dictionary for your listing¶
Before you can add a data dictionary, you must add a data share to the listing.
To set up a data dictionary for free and paid listings offered on the Snowflake Marketplace, do the following:
Sign in to Snowsight.
In the left navigation bar, select Data » Provider Studio » Listings.
Find and select the listing where you want to add a data dictionary.
Select Save and Create Data Dictionary.
Note
By saving this share, you agree that Snowflake is permitted to create a data dictionary for the share and display it to consumers when the listing is published.
After saving the listing the data dictionary displays, listing all of the tables, views, and functions within the listing.
Search for or select an object that you want to include as a featured object, then select Add to featured.
Optionally, repeat this step to add additional featured objects. You can have up to five featured objects in a listing.
Click Save.
You can edit column descriptions for tables in the Provider Studio. Moreover, you can use the COMMENT parameter in the CREATE <object> and ALTER <object> commands or the COMMENT command to add a comment describing an object or individual table columns.
Business needs¶
The following table describes the available fields in the Business Needs section.
Note
This section is optional for private listings.
Field Name |
Description |
---|---|
Business Need |
Listings are grouped by business needs to make them easy for consumers to discover on the Snowflake Marketplace. You can select up to six relevant business needs for your listing. If you do not see a relevant business need in the drop-down list, you can create a custom one. However, custom business needs that you create are only visible in your listing details. Consumers cannot filter by custom business needs on the Snowflake Marketplace. You can edit the list of business needs at any time without resubmitting the listing for approval. |
Description |
Description of how your listing addresses the selected business needs. |
Sample SQL queries¶
You can specify a valid sample SQL query that consumers can use to verify that your data product was successfully installed in their Snowflake account.
Note
A valid SQL query is required in order for you to publish a Marketplace listing. SQL queries are optional when publishing private listings.
The sample SQL has the following requirements:
The query must return at least one row.
The query must reference objects that are explicitly in the share.
Objects must be qualified using
SCHEMA.OBJECT
. Do not include the database name. For example,EXAMPLE_SCHEMA.TABLE_A
.
The following table describes the available fields in the Sample SQL Queries section.
Field Name |
Description |
Example |
---|---|---|
Title |
Descriptive title for the query to help consumers understand the data. You can add more than one example. |
Determine if an outdoor event could be affected by rain. |
Description (Optional) |
Description of the example with additional instructions, such as the name of the schema, sample tables, fields, or use cases. Use <schema>.<table> format when referencing tables and views in your SQL. Do not include the database name in the query, because customers can create custom database names when they get your listing. |
If you are hosting an outdoor event in the next 7 days, use our forecast data to determine if the event might be affected by rain. |
SQL Query |
Code for your sample SQL queries. Snowflake automatically validates your sample queries. To be valid, a sample query must return at least one row. If a query fails to validate, you can save the listing but the listing cannot be published until all sample queries are successfully validated. You must select a warehouse to use to validate the SQL query. |
Region availability (Marketplace listings only)¶
The following table describes the available fields in the Region Availability section.
Field Name |
Description |
---|---|
Region Availability |
By default, your listing is available in All regions. Choosing all regions ensures the availability of your listing in any future regions added by Snowflake. For paid listings, selecting this option makes the listing available in supported regions and any future supported regions added by Snowflake. If your listing has specific regional limitations, select All regions to change the region availability to Custom regions and select the regions in which you want to offer your data product. When you choose custom regions, your listing is still visible in all Snowflake Marketplace regions, but consumers can only get your data product in the regions you specify. |
Fulfillment method |
Automatic fulfillment is selected by default. With Cross-Cloud Auto-fulfillment, your data product is automatically fulfilled to a region and you incur costs only when there is consumer demand in that region. When you use auto-fulfillment, you must also select a refresh frequency at which to update the data product shared with consumers. You must select a refresh frequency of at least 8 days. For more details on auto-fulfillment, see Configuring Cross-Cloud Auto-fulfillment. If you can’t use auto-fulfillment, select Manual to manually replicate your data product. To fulfill requests, you must set up accounts in regions with consumer demand, manually replicate the product to each account, create secure shares in each account, and attach those shares to this listing. See Manually replicate data before fulfilling a listing request |
Consumer accounts (private listings only)¶
If you are configuring a private listing, you must configure the fields in the following table.
Field Name |
Description |
Example |
---|---|---|
Consumer Accounts |
Specifies the Snowflake accounts that you want to share your private listing with. You can use Snowflake account identifiers or URLs. See Finding the Organization and Account Name for an Account for details. |
|
If you’re sharing with a consumer account that is in a different region than your account, you must also set up auto-fulfillment:
Field Name |
Description |
---|---|
Auto-fulfillment |
Select the replication interval and frequency for your data product. For example, you can configure replication to occur every two hours. |
See Configuring Cross-Cloud Auto-fulfillment for more information.