リストマニフェスト参照

プログラムでSnowflakeリストを作成するには、YAML(https://yaml.org/spec/)で記述されたマニフェストが必要です。ここで提供される情報を使用して、マニフェストの形式と個々のセクションについて学習します。

こちらもご参照ください。

CREATE LISTINGALTER LISTINGDESCRIBE LISTINGSHOW LISTINGSDROP LISTING

注釈

フィールドは以下のいずれかになります。

  • オプション - Marketplaceのリストまたはプライベートリストのいずれかで省略可。

  • 必須 - Marketplaceのリストまたはプライベートリストのいずれかで必要。

  • 有資格 - Marketplaceのリストまたはプライベートリストでは要件が異なり、オプションか必須かはリストタイプによって異なります。たとえば、プライベートリストでは オプション ですが、Marketplaceリストでは 必須 です。

リストのマニフェストの一般的な形式は次のとおりです。

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

以下のセクションでは、各リストのマニフェストフィールド、子フィールドの詳細を説明し、関連する例を示します。

リスト接頭辞

各リストのマニフェストは、以下のフィールドで始まります。

  • title (文字列、必須、最大長110): リストのタイトル。

  • subtitle (文字列、プライベートの場合はオプション、Marketplaceリストの場合は必須、最大長110): リストのサブタイトル。

  • description (文字列、必須、最大長7500): リストの説明。Markdown構文に対応しています。

  • custom_contact (文字列、オプション): メール。有効で正しい形式のメールアドレスである必要があります。

  • profile (文字列、プライベートリストではオプション、Marketplaceでは必須): 承認されたプロバイダープロファイルの名前。

詳細については、次をご参照ください。プロバイダーの基本情報

注釈

profile の値は show profiles in data exchange SNOWFLAKE_DATA_MARKETPLACE; を実行すると見つけることができます。

リスト接頭辞の例

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

必須 listing_terms (必須)フィールドには、以下の名前と値のペアが含まれています。

  • listing_terms.type (列挙型、必須): 以下のいずれかである必要があります。

    • STANDARD - Marketplace製品の標準契約をご参照ください。

    • OFFLINE - 規約は当事者によってオフラインで交渉されることを示します。

    • CUSTOM - 指定する場合は、 listing_terms.link の値を指定する必要があります。

  • listing_terms.link (タイプが CUSTOM の場合は必須): プロバイダーのリスト用語への完全修飾リンク。http または https で始まる必要があります。

詳しくは`基本情報`_ 内のテーブルにある 利用規約 をご参照ください。

注釈

コンシューマーはリストの条件をプログラム的に受け入れることができます。詳細については、 Snowflakeサポート にお問い合わせください。

listing_terms の例

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

targets

注釈

このフィールドは V1 のリスト でのみ使用できます。

targets フィールドは、Marketplaceとプライベートリストには必須です。

最大100要素のリストが含まれています:

  • targets.accountstargets.region が存在しない場合は必須): リストを共有するアカウントのリスト。

    各対象アカウントは、次を満たす <OrgName>.<AccountName> 形式でなければなりません。

or

  • targets.regionstargets.accounts が存在しない場合は必須):

    リストを共有するリージョンのリスト。

    各ターゲットリージョンは、"リージョン_グループ_タイプ.snowflake_リージョン" の形式でなければなりません。さらに、すべてのリージョンを含めるために、"ALL" がサポートされています。

    例: "PUBLIC.AWS_US_EAST_1"。

    リージョングループタイプおよびSnowflakeリージョンの完全なリストについては、以下を実行してください。

    SHOW REGIONS IN DATA EXCHANGE SNOWFLAKE_DATA_MARKETPLACE;
    
    Copy

詳細については、 ビジネスニーズ をご参照ください。

targets

このリストのターゲットアカウントのセットを定義します。

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

このリストのターゲットリージョンのセットを定義します。

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

auto_fulfillment

クロスクラウドの自動フルフィルメントは、リストに関連付けられたデータ製品を他のSnowflakeリージョンに自動的にフルフィルメントすることを可能にします。auto_fulfillment フィールドは、その自動履フルフィルメントがどのように行われるかを定義します。

クロスクラウドの自動フルフィルメントの詳細については、 リストの自動複製 をご参照ください

オート・フルフィルメントは、複数のリージョンにデータを共有する場合にのみ必要です。同じリージョンのアカウントに共有する場合は、有効にしないでください。

複数のリージョンでデータを共有する場合、 auto_fulfillment は以下です。

  • データ製品がアプリケーションパッケージの場合は必要です。

  • データ製品を非公開リストで共有する場合に必要です。

  • データ製品を公開リストで共有する場合に推奨します。

以下の名前と値のペアが含まれています:

  • auto_fulfillment.refresh_schedule

    • <num> MINUTE - 分の数最短10分、最長8日または11520分。

      refresh_typeSUB_DATABASE_WITH_REFERENCE_USAGE として指定されている場合は、この設定を含めないでください。アプリケーションパッケージのリフレッシュスケジュールはアカウントレベルで定義する必要があり、リストレベルでは指定できません。

      詳細については、 アカウントレベルの更新間隔を設定する をご参照ください。

  • USING CRON <expression> - データ製品の自動フルフィルメント更新スケジュールを定義します。

    USING CRON および REPLICATION SCHEDULE の構文は同じです。パラメーター をご参照ください。

  • auto_fulfillment.refresh_typeauto_fulfillment を使用する場合は必須): 以下のいずれかである必要があります。

    • SUB_DATABASE - データベースのレプリケーション(オブジェクトレベル) - 推奨。

    • SUB_DATABASE_WITH_REFERENCE_USAGE - アプリケーションパッケージ。

    • FULL_DATABASE - データベースのレプリケーション(データベース全体)

  • auto_fulfillment.refresh_schedule_override (オプション): 同じデータベースを使用するすべてのリストに対して定義された更新頻度を上書きします。この値が FALSE の場合、同じデータベースを共有する複数のリストの更新頻度が異なると、リストの更新に失敗します。

    • TRUE - 更新頻度の上書きを有効にします。

    • FALSE - (デフォルト)更新頻度の上書きを無効にします。

リストの自動複製 もご参照ください。

auto_fulfillment.refresh_schedule

次の例では、リストに関連付けられたデータ製品を10分ごとに更新します。

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

次の例では、特定の地域の特定の日時にリストに関連付けられたデータ製品を更新します。

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

次の例では、同じデータベースを共有しており、更新頻度が異なるリストの更新頻度の上書きを有効にします。

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

Snowflake Native App auto_fulfillment の例

SUB_DATABASE_WITH_REFERENCE_USAGE はアプリケーションパッケージでのみ使用でき、 auto_fulfillment.refresh_schedule と組み合わせることはできません。

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

オブジェクトレベル auto_fulfillment の例

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

business_needs

リストは、簡単に見つけられるようにビジネスニーズごとにグループ化されています。ビジネスニーズは、特定のリストがどのように指定したビジネスニーズを満たすかを説明します。詳細については、 ビジネスニーズ をご参照ください。

STANDARD ビジネスニーズ

  • business_needs.namebusiness_needs を使用する場合は必須):

    有効な値:

    • "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[].descriptionbusiness_needs を使用する場合は必須): 関連するbusiness_needs.nameの説明、最大長1000。

business_needs[].type: STANDARD (オプション)

CUSTOM ビジネスニーズ

カスタムのビジネスニーズには、ユーザー定義の namedescription、および値 CUSTOM を持つ必須の type フィールドが含まれます。

business_needs.namebusiness_needs を使用する場合は必須): ユーザー定義名。

business_needs[].descriptionbusiness_needs を使用する場合は必須): 関連するbusiness_needs.nameの説明、最大長1000。

business_needs[].type: CUSTOM (カスタムビジネスニーズを定義する場合は必要)。

business_needs

オプションの type なしの標準

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

オプションの type 付きの標準

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

必須の type 付きのカスタム

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

categories

categories フィールドは、リストが属するカテゴリまたはエリアを指定します。カテゴリはプライベートリストではオプションですが、Marketplaceリストでは必須です。

カテゴリは、エリア別にリストを閲覧し、コンシューマーがあなたのデータを見つけやすくするために Snowflake Marketplace で使用されます。

categories フィールドはリストですが、以下のセットからエントリを1つのみ含むことができます。

  • BUSINESS

  • CONNECTORS

  • DEMOGRAPHICS

  • ECONOMY

  • ENERGY

  • ENVIRONMENT

  • FINANCIAL

  • GOVERNMENT

  • HEALTH

  • IDENTITY

  • LEGAL

  • LOCAL

  • LOOKUP_TABLES

  • MARKETING

  • MEDIA

  • SECURITY

  • SPORTS

  • TRANSPORTATION

  • TRAVEL

  • WEATHER

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

その compliances_badges フィールドは、リストがサードパーティの監査人によってレビューされ、特定の基準や規制に準拠していると認定されたことを示すために使用されます。

コンプライアンスバッジを構成する場合は、最大3つのタイプを指定できます。各バッジの有効期限と、それに関連するサードパーティの認証ドキュメントを含めます。

以下のフィールドは、コンプライアンスバッジを構成するために使用されます。

  • compliance_badges:リストのコンプライアンスバッジを宣言および構成するために使用されます。プロバイダーは、compliance_badges プロパティ内で複数のコンプライアンス証明書を宣言できます。

    • type:リクエストされるコンプライアンス認証。次のリストは、可能な値を示しています。

      • SOC2

      • HIPAA

      • ISO27001

    • expiry:コンプライアンス証明書の有効期限が切れる日付。

    • files:コンプライアンス証明書の確認するために使用されるファイルのリスト。

詳細については、 リストコンプライアンスバッジ をご参照ください。

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

データ属性は、リフレッシュレートやその他の特性など、リストについての情報に関する洞察をコンシューマーに提供します。

data_attributes フィールドはプライベートリストではオプションですが、Marketplaceリストでは必須です。

データ製品の属性のその他の情報については、 データ製品 - 属性 をご参照ください。

以下の名前と値のペアが含まれています:

  • :code:`data_attributes.refresh_rate`(データ掲載の場合は必須、アプリ掲載の場合は任意)

    Snowflakeでデータ製品が更新される頻度を指定します。

    次のいずれか:

    • CONTINUOUSLY

    • HOURLY

    • DAILY

    • WEEKLY

    • MONTHLY

    • QUARTERLY

    • ANNUALLY

    • STATIC

  • data_attributes.geography (必須)、次が含まれます:

    データ製品の範囲対象となる地理的なリージョンを指定します。

    • granularity (文字列、必須)

      データセットの地理的範囲。

      次のいずれか:

      • LATITUDE_LONGITUDE

      • ADDRESS

      • POSTAL_CODE

      • CITY

      • COUNTY

      • STATE

      • COUNTRY

      • REGION_CONTINENT

    • geo_option (文字列、必須)

      次のいずれか:

      • NOT_APPLICABLE

      • GLOBAL

      • COUNTRIES

    • coveragegeo_option の選択に基づいて必須)、次のいずれかが含まれます:

      • states (文字列のリスト)、有効な米国の州名のリストが含まれます。

      Or

      • continents (大陸のリスト):

        次のいずれか:

        • ASIA

        • EUROPE

        • AFRICA

        • NORTH AMERICA

        • SOUTH AMERICA

        • OCEANIA

        • ANTARCTICA

    • time (必須)、次が含まれます。

      データ製品の対象期間を指定します。

      • granularity (必須)

      次のいずれか:

      • EVENT_BASED

      • HOURLY

      • DAILY

      • WEEKLY

      • MONTHLY

      • YEARLY

      • time_range (必須)、次の名前と値のペアを含まれます:

        • time_frame (必須)

          次のいずれか:

          • NEXT

          • LAST

          • BETWEEN

        • unit (必須)

          次のいずれか:

          • DAYS

          • WEEKS

          • MONTHS

          • YEARS

        • valuetime_frame が NEXT/LAST の場合は必須、整数)、範囲は1-100。

        • start_timetime_frame が BETWEEN の場合は必須、文字列日付)、フォーマット MM-DD-YYYY。

        • end_timetime_frame が BETWEEN の場合は必須、文字列日付)、フォーマット MM-DD-YYYY。

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

data_dictionary フィールドは、コンシューマーがアカウントにインストールする前に、リストのコンテンツと構造に関する洞察を提供します。公開リストでは必須ですが、その他のリストタイプでは任意です。

data_dictionary フィールドには、最大5つのデータディクショナリエントリのリストが含まれています:

  • data_dictionary.featureddata_dictionary を使用する場合は必須): 'featured' でなければなりません。

  • data_dictionary.featured.databasedata_dictionary を使用する場合は必須): データベース名。

  • data_dictionary.featured.objectsdata_dictionary を使用する場合は必須): 名前と値のペアのリスト。

    • name (文字列、必須): オブジェクト名

    • schema (文字列、必須): スキーマ

    • domain (必須):

      次のいずれか:

      • DATABASE

      • SCHEMA

      • TABLE

      • VIEW

      • EXTERNAL_TABLE

      • MATERIALIZED_VIEW

      • DIRECTORY_TABLE

      • FUNCTION

      • COLUMN

データ製品 - データディクショナリ もご覧ください。

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

data_preview フィールドを使用すると、プロバイダーは、リストデータから生成されたデータプレビューサンプルに含まれる個人識別情報 (PII) を識別して非表示にすることができます。PII データとは、直接的または間接的に個人のIDを明らかにする可能性のあるデータのことです。公開リストでは必須で、その他のリストタイプでは任意です。

data_preview フィールドには以下の項目があります。

  • data_preview.has_piidata_preview を使用する場合は必須): PII がリスト・データに含まれるかどうかを示します。

    • TRUE - PII はリストデータに含まれています。

    • FALSE - PII はリストデータに含まれません。

  • data_preview.metadata_overrides (data_preview.has_piiTRUE の場合に推奨): PII リスト・データの場所と、そのデータセット内の PII を含む、非表示または公開するオブジェクトを識別子として指定します。

    • database (文字列、必須):データベース名。

    • objects (リスト、必須):データプレビューサンプルで列を隠す、または公開するオブジェクト:

      • schema (文字列、必須):スキーマ名。

      • domain (文字列、必須):ドメイン名。

      • name (文字列、必須): オブジェクト名

      • pii_columns (リスト、オプション): PII を含む列。

      • overridden_pii_columns (リスト、オプション): PII を含むSnowflakeの分類で 、コンシューマーと共有されるデータプレビューサンプルで可用性である必要があります。

        Snowflakeは定期的に、生成されたデータのプレビューに対して分類を実行します。PII を含む列は、 SHOW コマンドが実行されると、 classified_pii_columns で定義されます。

        Snowflakeによって PII を含むと識別された列は、データプレビューサンプルでのみリストのコンシューマーから非表示になります。リストのプロバイダーが、列が誤って PII を含んでいると判断した場合、 overridden_pii_columns を使用して、データプレビューサンプルに含まれる特定の列を指定することができます。

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

ドラフトリストへのアクセス制御方法を指定します。

注釈

「by request」リスティングの場合、マニフェストで draft_access_type: "BY_REQUEST" を設定する必要があります。

このフィールドは、リストがドラフトステータスの間のアクセスモデルを決定します。プロバイダーは、Snowflakeコンプライアンスチームによるリスティングのバッジまたはバッジの承認を待つため、これは特に コンプライアンスバッジ に関連します。

codenowrap:draft_access_type に許可される値は次のとおりです。

  • UNKNOWN

  • FREE

  • PAID

  • LIMITED_TRIAL

  • BY_REQUEST

draft_access_type

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

external_targets

external_targets フィールドは、公開または非公開のV2リストを共有するために使用されます。

注釈

このフィールドは V2 リスティング でのみ使用できます。

external_targets が指定されている場合、access フィールドは 必須 であり、次のサブフィールドのいずれかが含まれている必要があります。

  • organization:非公開リストを作成する場合は、組織名とリストにアクセスできるアカウントを指定します。

  • account:非公開リストを作成する際、オプションで、リストにアクセスできるアカウント内のロールを指定します。

  • all_organizations:公開リストを作成する際は、true に設定してください。

external_targets

次の例では、非公開リストを共有するために external_targets を使用する方法を示しています。

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

次の例は、公開リストを共有するために external_targets を使用する方法を示しています。

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

locations

リストを検出またはアクセスできる オプション locations を指定します。

注釈

このフィールドは V2 リスティング でのみ使用できます。

locations が指定されている場合、access_regions フィールドは 必須 であり、次のサブフィールドのいずれかが含まれている必要があります。

  • ALL:すべての地域がリストを検出し、アクセスすることができる。

  • name:「region_groups_type.snowflake_region」の形式で、リスティングを発見またはアクセスできる地域の配列。例えば、access_regions: - name:PUBLIC.AWS_US_WEST_2

VPS デプロイメントで利用可能なリージョングループは次のとおりです。

  • AWS_US_EAST_1("US 東部(バージニア北部)")

  • AWS_US_EAST_2("US 東部(オハイオ)")

  • AWS_US_WEST_2("US 西部(オレゴン)")

  • AWS_EU_WEST_1("EU (アイルランド)")

  • AWS_EU_WEST_2("EU (ロンドン)")

  • AZURE_EASTUS 2("東部 US 2(バージニア)")

  • AZURE_CENTRALUS ("中部 US (アイオワ)")

locations の例

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

リージョンの全一覧は SHOW REGIONS をご覧ください。

monetization_display_order

オプションの monetization_display_order フィールドは、Snowflake Marketplace において消費者に料金プランを表示する順序を指定します。

注釈

このフィールドは V2 リスティング でのみ使用できます。

monetization_display_order の例

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

offers

注釈

このフィールドは V2 リスティング でのみ使用できます。

オプションの offers フィールドには、リストに関連する最大8件のオファーリストが含まれます。offers フィールドには以下の名前と値のペアがあります。

  • name (文字列、必須)オファーのユーザー定義名。名前はすべて大文字でフォーマットする必要があります。

  • :code:`type`(文字列、必須):以下のいずれかの型である必要があります。

    • FILE:オファーがローカルの YAML ファイルで定義されていることを示します。

    • URL:オファーがリモート URL で定義されていることを示します。

  • path (文字列、必須)ローカルまたはリモートの :doc:` へのパスはYAML </user-guide/collaboration/listings/pricing-plans-offers/offer-manifest-reference>` を提供します。

offers の例

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

pricing_plans

注釈

このフィールドは V2 リスティング でのみ使用できます。

オプションの pricing_plans フィールドには、リストに関連する料金プランのリストが含まれます。pricing_plans フィールドには以下の名前と値のペアがあります。

  • name (文字列、必須)料金プランのユーザー定義名。名前はすべて大文字でフォーマットする必要があります。

  • :code:`type`(文字列、必須):以下のいずれかの型である必要があります。

    • FILE:オファーがローカルの YAML ファイルで定義されていることを示します。

    • URL:オファーがリモート URL で定義されていることを示します。

  • path (文字列、必須)ローカルまたはリモートの 料金プランYAML へのパス 。

pricing_plans の例

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

resources

リソースには、ドキュメントや動画へのリンクなど、リストに関する情報が含まれています。

resources フィールドはプライベートリストではオプションですが、Marketplaceリストでは必須です。

以下の名前と値のペアが含まれています:

  • resources.documentation (文字列、必須): リストのより詳細なドキュメントがある会社ウェブサイトのページへの完全修飾されたリンク。 http または https で始まる必要があります。

  • resources.media (文字列、オプション):リストの非公開または公開 YouTube 動画への完全修飾されたリンク。

詳細については、 詳細 をご参照ください。

resources の例

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

trial_details

オプションの trial_details フィールドは、リスティングに関連するトライアルの詳細を取得し、以下の名前と値のペアを含みます。

  • trial_type (文字列、必須)トライアルの型を指定します。以下のいずれかにする必要があります。

    • TIME

    • USAGE

    • LIMITED

    • LIMITED_TIME

  • trial_time_limit (整数、オプション)リスティングがトライアルとして許可される日数を指定し、その後、消費者はフル製品をリクエストする必要があります。NULL値は、リストが時間無制限のトライアルであることを示します。trial_time_limittrial_usage_limit のどちらかを指定する必要があります。

  • trial_usage_limit (整数、オプション)このリストで許可される無料使用回数を指定し、それを過ぎると消費者はアップグレードする必要があります。trial_time_limittrial_usage_limit のどちらかを指定する必要があります。

  • trial_usage_unit (ロング、オプション):トライアル使用の単位(クエリや行など)を指定します。この使用単位に応じて、使用回数がインクリメントされます。このフィールドは trial-usage_limit でのみ使用できます。

  • :code:`description`(文字列、任意):トライアルの詳細を記述する文字列。最大長は4,096文字です。

trial_details の例

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

usage_examples

usage_examples フィールドはプライベートリストではオプションですが、Marketplaceリストでは必須です。

以下の名前と値のペアのリストが含まれています。

  • usage.title (文字列、必須):使用例としてタイトル、最大長110文字。

  • usage.description (文字列、オプション):関連する説明、最大長300文字。

  • usage.query (文字列、必須)使用例に関連するクエリ。最大長30,000文字。

詳細については、 サンプル SQL クエリ をご参照ください。

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

V1データ共有リストの完全な YAML の例

V1リスティング は、targets を使用して、リスティングにアクセスできるアカウントを定義します。

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

V2データ共有リストの完全な YAML の例

V2リスティング は、external_targets を使用して、リスティングにアクセスできる組織とロールを定義します。V2リスティングでは、ユーザーが料金プランやオファーを定義することもできます。

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