Skip to content

Latest commit

 

History

History
89 lines (76 loc) · 4.98 KB

google-dataset.md

File metadata and controls

89 lines (76 loc) · 4.98 KB

Google Dataset Search support

Description

Google Dataset Search is a search engine from Google that helps researchers locate online data that is freely available for use. Google Dataset Search relies on exposed crawlable structured data via schema.org markup, using the schema.org Dataset class. In order for our pages to pop up in the search results, we need to add markup in the JSON-LD format. Examples of this markup can be found here and also below.

<script type="application/ld+json">
{
  "@context": "https://schema.org",
  "@type": "Dataset",
  "name": "Sales of the leading ice cream brands of the U.S. 2020",
  "description": "This graph shows the sales of the leading ice cream brands of the United States in 2020. Ben &amp;amp; Jerry&amp;#039;s was the top ranked ice cream brand of the United States with about 863.1 million U.S. dollars worth of sales for the 52 weeks ended November 1, 2020. Total ice cream category sales amounted to about 6.97 billion U.S. dollars. Despite being far from the top brand, consumers stated that they regularly purchase Breyers above any other brand. Ice cream is a part of the frozen dessert category and serves as an indulgent snack for those with a sweet tooth. Ice cream comes in a large variety of styles ranging from regular ice cream to low-fat ice cream. There are fruity and creamy options available or a combination of both.",
  "url": "https://www.statista.com/statistics/190426/top-ice-cream-brands-in-the-united-states/",
  "keywords": [
    "sales",
    "ice cream",
    "ice cream brands",
    "brands"
  ],
  "temporalCoverage": "52 weeks ended Novmeber 1, 2020",
  "creator": {
    "@type": "Organization",
    "url": "https://www.statista.com"
  }
}
</script>

How to enable it

  1. Setup the annotation correctly using pattern expansion. ERMrestJS validates the generated JSON-LD and any incorrect attributes are discarded and the rest is appended to the <head> tag. Check the browser console for any logs about any issues discovered during the validation of JSON-LD.

  2. For more fine grain control of cases where JSON-LD should be added, a config file called google-dataset-config.js is used to specify the cases that should contain the JSON-LD. It can be plugged in similar to chaise-config.js. So you can use the same configRules property can be used to define different configs for each host.

    JSON-LD will only be appended when the row in question is in the config (if it exists for the table) and the annotation is setup correctly as well. This is an optional step and if no config file exists then the JSON-LD will still be appended if the annotation is setup correctly. Example below:

var googleDatasetConfig = {
    "configRules": [
        {
            "host": [
                "www.gudmap.org"
            ],
            "config": {
                "allowlist": {
                    "2": {
                        "Protocol": {
                            "Protocol": {
                                "columns": [
                                    "RID"
                                ],
                                "values": [
                                    "N-H98J","N-H98R"
                                ]
                            }
                        },
                        "Common": {
                            "Collection": {
                                "columns": [
                                    "RID"
                                ],
                                "values": [
                                    "Q-3K5E","R-ZD4C","16-26EY","16-QKNG","16-WHS4","16-WMM4","17-DSBR"
                                ]
                            },
                            "Gene": {
                                "columns": [
                                    "RID"
                                ],
                                "values": [
                                    "Q-4M5E","Q-5G0C","Q-3QBE","Q-46MG","Q-47YR"
                                ]
                            }
                        },
                    }
                }
            }
        }
    ]
}

  1. Verify that the JSON-LD is appended to <head> by inspecting the <head> tag or using the Chrome extension Structured Data Testing. This extension also shows warnings and/or errors(if any) in the structured data.

  2. Use Google Search Console to stay updated about any issues with the structured data.