# The Listing object

## Attributes

- `id` (string)
- `summary` (object)
  - `name` (string)
  - `subtitle` (string)
  - `status` (string)
    Possible values: `DRAFT`, `PENDING`, `PUBLISHED`, `SUSPENDED`
  - `share` (object)
    - `name` (string)
    - `type` (string)
      Possible values: `SAMPLE`, `FULL`
  - `provider_region` (object)
    - `cloud` (string)
    - `region` (string)
  - `setting` (object)
    - `visibility` (string)
      Possible values: `PUBLIC`, `PRIVATE`
  - `created_at` (int64)
  - `created_by` (string)
  - `updated_at` (int64)
  - `updated_by` (string)
  - `published_at` (int64)
  - `published_by` (string)
  - `categories` (array of string)
    Possible values: `ADVERTISING_AND_MARKETING`, `CLIMATE_AND_ENVIRONMENT`, `COMMERCE`, `DEMOGRAPHICS`, `ECONOMICS`, `EDUCATION`, `ENERGY`, `FINANCIAL`, `GAMING`, `GEOSPATIAL`, `HEALTH`, `LOOKUP_TABLES`, `MANUFACTURING`, `MEDIA`, `OTHER`, `PUBLIC_SECTOR`, `RETAIL`, `SECURITY`, `SCIENCE_AND_RESEARCH`, `SPORTS`, `TRANSPORTATION_AND_LOGISTICS`, `TRAVEL_AND_TOURISM`
  - `listingType` (string)
    Possible values: `STANDARD`, `PERSONALIZED`
  - `created_by_id` (int64)
  - `updated_by_id` (int64)
  - `provider_id` (string)
  - `exchange_ids` (array of string)
  - `git_repo` (object)
    if a git repo is being created, a listing will be initialized with this field as opposed to a share
    - `git_repo_url` (string)
      the git repo url e.g. https://github.com/databrickslabs/dolly.git
- `detail` (object)
  - `description` (string)
  - `terms_of_service` (string)
  - `documentation_link` (string)
  - `support_link` (string)
  - `file_ids` (array of string)
  - `privacy_policy_link` (string)
  - `embedded_notebook_file_infos` (array of object)
    - `id` (string)
    - `marketplace_file_type` (string)
      Possible values: `PROVIDER_ICON`, `EMBEDDED_NOTEBOOK`, `APP`
    - `file_parent` (object)
      - `parent_id` (string)
      - `file_parent_type` (string)
        Possible values: `PROVIDER`, `LISTING`, `LISTING_RESOURCE`
    - `mime_type` (string)
    - `download_link` (string)
    - `created_at` (int64)
    - `updated_at` (int64)
    - `display_name` (string)
      Name displayed to users for applicable files, e.g. embedded notebooks
    - `status` (string)
      Possible values: `FILE_STATUS_PUBLISHED`, `FILE_STATUS_STAGING`, `FILE_STATUS_SANITIZING`, `FILE_STATUS_SANITIZATION_FAILED`
    - `status_message` (string)
      Populated if status is in a failed state with more information on reason for the failure.
  - `geographical_coverage` (string)
    Which geo region the listing data is collected from
  - `cost` (string)
    Whether the dataset is free or paid
    Possible values: `FREE`, `PAID`
  - `pricing_model` (string)
    What the pricing model is (e.g. paid, subscription, paid upfront); should only be present if cost is paid
  - `update_frequency` (object)
    How often data is updated
    - `interval` (int64)
    - `unit` (string)
      Possible values: `NONE`, `SECOND`, `MINUTE`, `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`
  - `collection_granularity` (object)
    Smallest unit of time in the dataset
    - `interval` (int64)
    - `unit` (string)
      Possible values: `NONE`, `SECOND`, `MINUTE`, `HOURLY`, `DAILY`, `WEEKLY`, `MONTHLY`, `QUARTERLY`, `YEARLY`
  - `collection_date_start` (int64)
    The starting date timestamp for when the data spans
  - `collection_date_end` (int64)
    The ending date timestamp for when the data spans
  - `data_source` (string)
    Where/how the data is sourced
  - `size` (double)
    size of the dataset in GB
  - `assets` (array of string)
    Type of assets included in the listing. eg. GIT_REPO, DATA_TABLE, MODEL, NOTEBOOK
    Possible values: `ASSET_TYPE_UNSPECIFIED`, `ASSET_TYPE_GIT_REPO`, `ASSET_TYPE_DATA_TABLE`, `ASSET_TYPE_MODEL`, `ASSET_TYPE_NOTEBOOK`, `ASSET_TYPE_MEDIA`, `ASSET_TYPE_PARTNER_INTEGRATION`, `ASSET_TYPE_APP`, `ASSET_TYPE_MCP`
  - `license` (string)
    ID 20, 21 removed don't use
     License of the data asset - Required for listings with model based assets
  - `tags` (array of object)
    Listing tags - Simple key value pair to annotate listings.
     When should I use tags vs dedicated fields?
     Using tags avoids the need to add new columns in the database for new annotations.
     However, this should be used sparingly since tags are stored as key value pair.
     Use tags only:
      1. If the field is optional and won't need to have NOT NULL integrity check
      2. The value is fairly fixed, static and low cardinality (eg. enums).
      3. The value won't be used in filters or joins with other tables.
    - `tag_name` (string)
      Tag name (enum)
      Possible values: `LISTING_TAG_TYPE_UNSPECIFIED`, `LISTING_TAG_TYPE_LANGUAGE`, `LISTING_TAG_TYPE_TASK`
    - `tag_values` (array of string)
      String representation of the tag value. Values should be string literals (no complex types)

## Example

```json
{
  "id": "string",
  "summary": {
    "name": "string",
    "subtitle": "string",
    "status": "string",
    "share": {},
    "provider_region": {},
    "setting": {},
    "created_at": 0,
    "created_by": "string",
    "updated_at": 0,
    "updated_by": "string",
    "published_at": 0,
    "published_by": "string",
    "categories": [
      "string"
    ],
    "listingType": "string",
    "created_by_id": 0,
    "updated_by_id": 0,
    "provider_id": "string",
    "exchange_ids": [
      "string"
    ],
    "git_repo": {}
  },
  "detail": {
    "description": "string",
    "terms_of_service": "string",
    "documentation_link": "string",
    "support_link": "string",
    "file_ids": [
      "string"
    ],
    "privacy_policy_link": "string",
    "embedded_notebook_file_infos": [
      {}
    ],
    "geographical_coverage": "string",
    "cost": "string",
    "pricing_model": "string",
    "update_frequency": {},
    "collection_granularity": {},
    "collection_date_start": 0,
    "collection_date_end": 0,
    "data_source": "string",
    "size": 0,
    "assets": [
      "string"
    ],
    "license": "string",
    "tags": [
      {}
    ]
  }
}
```