# Recipe (`Recipe`, `HowTo`, `ItemList`) structured data Help users find your recipe content by telling Google about your recipe with structured data. When you provide information such as reviewer ratings, cooking and preparation times, and nutrition information, Google can better understand your recipe and present it to users in interesting ways. Recipes can appear in Google Search results and Google Images. ![An illustration of how recipe rich results can appear in Google Search. It contains 4 rich results from different websites, with details about how long it takes to cook the recipe, an image, and review information.](https://developers.google.com/static/search/docs/images/recipe-rich-result-google-search.png) ![An illustration of how a recipes can appear in Google Images. There are 6 images results showing different food items, with 3 results containing a recipe badge that tells the user it's a recipe](https://developers.google.com/static/search/docs/images/recipes-in-google-images.png) Based on how you mark up your content, your recipes can be eligible for the following enhancements: | **Recipe enhancements** || |---|---| | **Recipe host carousel** : Enable users to explore your recipe gallery pages by adding [`ItemList` structured data](https://developers.google.com/search/docs/appearance/structured-data/recipe#item-list). | ![An illustration of how a recipe host carousel can appear in Google Search. It shows 3 different recipes from the same website in a carousel format that users can explore and select a specific recipe](https://developers.google.com/static/search/docs/images/recipe-host-carousel-rich-result.png) | ## How to add structured data Structured data is a standardized format for providing information about a page and classifying the page content. If you're new to structured data, you can learn more about [how structured data works](https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data). Here's an overview of how to build, test, and release structured data. 1. Add the [required properties](https://developers.google.com/search/docs/appearance/structured-data/recipe#structured-data-type-definitions). Based on the format you're using, learn where to [insert structured data on the page](https://developers.google.com/search/docs/appearance/structured-data/intro-structured-data#format-placement). > [!NOTE] > **Using a CMS?** It may be easier to use a plugin that's integrated into your CMS. > **Using JavaScript?** Learn how to [generate structured data with JavaScript](https://developers.google.com/search/docs/appearance/structured-data/generate-structured-data-with-javascript). 2. Follow the [guidelines](https://developers.google.com/search/docs/appearance/structured-data/recipe#guidelines). 3. Validate your code using the [Rich Results Test](https://search.google.com/test/rich-results) and fix any critical errors. Consider also fixing any non-critical issues that may be flagged in the tool, as they can help improve the quality of your structured data (however, this isn't necessary to be eligible for rich results). 4. Deploy a few pages that include your structured data and use the [URL Inspection tool](https://support.google.com/webmasters/answer/9012289) to test how Google sees the page. Be sure that your page is accessible to Google and not blocked by a robots.txt file, the `noindex` tag, or login requirements. If the page looks okay, you can [ask Google to recrawl your URLs](https://developers.google.com/search/docs/crawling-indexing/ask-google-to-recrawl). > [!NOTE] > **Note**: Allow time for re-crawling and re-indexing. Remember that it may take several days after publishing a page for Google to find and crawl it. 5. To keep Google informed of future changes, we recommend that you [submit a sitemap](https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap). You can automate this with the [Search Console Sitemap API](https://developers.google.com/webmaster-tools/v1/sitemaps). ## Examples Here are some examples of recipes using JSON-LD code. > [!NOTE] > **Note**: The actual appearance in Search results might be different. Preview the structured data in the Rich Results Test for the most up-to-date layout. ### Recipe on Search Here's an example of a page that's eligible to be displayed on Search. \ \ \Non-Alcoholic Piña Colada\ \ ``` ### Carousel Here's an example of a recipe summary page (a page with a list of recipes) with `https://developers.google.com/search/docs/appearance/structured-data/recipe#item-list` structured data. This content may be eligible to be displayed in a grid in Search results. \ \ \Grandma's Best Pie Recipes\ \ ``` ## Guidelines You must follow the [general structured data guidelines](https://developers.google.com/search/docs/appearance/structured-data/sd-policies) for your markup to be eligible to appear in Search results. > [!NOTE] > If you violate these policies, your recipe might not show up as a rich result, but your content will still appear in Search results. Read about [Spammy Structured Markup](https://support.google.com/webmasters/answer/3498001). The following guidelines apply to `Recipe` structured data. - Use `Recipe` structured data for content about preparing a particular dish. For example, "facial scrub" or "party ideas" are not valid names for a dish. - To enable your recipes to appear in a [carousel](https://developers.google.com/search/docs/appearance/structured-data/carousel) or grid, you must follow these guidelines: - Provide `ItemList` structured data to summarize the recipes for your list. You can provide `ItemList` structured data separately or together with recipe structured data. - Your site must have a summary page that lists all the recipes in the collection. For example, when a user clicks the summary link from Search results, they are properly directed to a page on your site listing the recipes related to their search. ## Structured data type definitions You must include the required properties for your content to be eligible for display as a rich result in Google Search. You can also include the recommended properties to add more information about your content, which could provide a better user experience. ### `Recipe` Mark up your recipe content with the following properties of the schema.org [`Recipe`](https://schema.org/Recipe) type. The full definition of `Recipe` is available at [schema.org/Recipe](https://schema.org/Recipe). The Google-supported properties are the following: | Required properties || |---|---| | `image` | `https://schema.org/URL` or `https://schema.org/ImageObject` Image of the completed dish. Additional image guidelines: - Image URLs must be crawlable and indexable. To check if Google can access your URLs, use the [URL Inspection tool](https://support.google.com/webmasters/answer/9012289). - Images must represent the marked up content. - Images must be in a file format that's [supported by Google Images](https://developers.google.com/search/docs/appearance/google-images#supported-image-formats). - For best results, we recommend providing multiple high-resolution images (minimum of 50K pixels when multiplying width and height) with the following aspect ratios: 16x9, 4x3, and 1x1. For example: ``` "image": [ "https://example.com/photos/1x1/photo.jpg", "https://example.com/photos/4x3/photo.jpg", "https://example.com/photos/16x9/photo.jpg" ] ``` > [!NOTE] > Specifying the `image` property in `Recipe` markup has no impact on the image chosen for a [text result image](https://developers.google.com/search/docs/appearance/visual-elements-gallery#text-result-image). To optimize for a text result image, follow the [image SEO best practices](https://developers.google.com/search/docs/appearance/google-images). | | `name` | `https://schema.org/Text` The name of the dish. | | Recommended properties || |---|---| | `aggregateRating` | `https://schema.org/AggregateRating` Annotation for the average review score assigned to the item. Follow the [Review snippet guidelines](https://developers.google.com/search/docs/appearance/structured-data/review-snippet#guidelines) and list of required and recommended [`AggregateRating` properties](https://developers.google.com/search/docs/appearance/structured-data/review-snippet#aggregated-rating-type-definition). If the `Recipe` structured data contains a single review, the reviewer's name must be a valid person or organization. For example, "50% off ingredients" is not a valid name for a reviewer. | | `author` | `https://schema.org/Person` or `https://schema.org/Organization` The name of the person or organization that wrote the recipe. To help Google best understand authors across various features, consider following the [author markup best practices](https://developers.google.com/search/docs/appearance/structured-data/article#author-bp). | | `cookTime` | `https://schema.org/Duration` The time it takes to actually cook the dish in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), if applicable. Always use in combination with `prepTime`. | | `datePublished` | `https://schema.org/Date` The date the recipe was published in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), if applicable. | | `description` | `https://schema.org/Text` A short summary describing the dish. | | `keywords` | `https://schema.org/Text` Other terms for your recipe such as the season ("summer"), the holiday ("Halloween"), or other descriptors ("quick", "easy", "authentic"). **Additional guidelines** - Separate multiple entries in a keywords list with commas. - Don't use a tag that's actually a `recipeCategory` or `recipeCuisine`. **Not recommended**: ``` "keywords": "dessert, American" ``` **Recommended**: ``` "keywords": "winter apple pie, nutmeg crust" ``` | | `nutrition.calories` | `https://schema.org/Energy` The number of calories in each serving produced with this recipe. If `nutrition.calories` is defined, `recipeYield` must be defined with the number of servings. | | `prepTime` | `https://schema.org/Duration` The length of time it takes to prepare ingredients and workspace for the dish, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), if applicable. Always use in combination with `cookTime`. | | `recipeCategory` | `https://schema.org/Text` The type of meal or course your recipe is about. For example: "dinner", "main course", or "dessert, snack". | | `recipeCuisine` | `https://schema.org/Text` The region associated with your recipe. For example, "French", Mediterranean", or "American". | | `recipeIngredient` | `https://schema.org/Text` An ingredient used in the recipe. For example: ``` "recipeIngredient": [ "1 (15 ounce) package double crust ready-to-use pie crust", "6 cups thinly sliced, peeled apples (6 medium)", "3/4 cup sugar", "2 tablespoons all-purpose flour", "3/4 teaspoon ground cinnamon", "1/4 teaspoon salt", "1/8 teaspoon ground nutmeg", "1 tablespoon lemon juice" ] ``` **Additional guidelines**: - Include only the ingredient text that is necessary for making the recipe. - Don't include unnecessary information, such as a definition of the ingredient. | | `recipeInstructions` | `https://schema.org/HowToStep`, `https://schema.org/HowToSection`, or `https://schema.org/Text` The steps to make the dish. There are several options for setting the value of `recipeInstructions`. We recommend using `HowToStep`. `HowToSection` can also be used to group HowToSteps when the recipe has sections. - **`HowToStep`** : Specify this recipe's steps with `HowToStep`. ``` "recipeInstructions": [ { "@type": "HowToStep", "name": "Preheat", "text": "Heat oven to 425°F.", "url": "https://example.com/recipe#step1", "image": "https://example.com/photos/recipe/step1.jpg" }, { "@type": "HowToStep", "name": "Prepare crust", "text": "Place 1 pie crust in ungreased 9-inch glass pie plate, pressing firmly against side and bottom.", "url": "https://example.com/recipe#step2", "image": "https://example.com/photos/recipe/step2.jpg" }, { "@type": "HowToStep", "name": "Make filling", "text": "In large bowl, gently mix filling ingredients; spoon into crust-lined pie plate.", "url": "https://example.com/recipe#step3", "image": "https://example.com/photos/recipe/step3.jpg" }, { "@type": "HowToStep", "name": "Cover", "text": "Top with second crust. Cut slits or shapes in several places in top crust.", "url": "https://example.com/recipe#step4", "image": "https://example.com/photos/recipe/step4.jpg" }, { "@type": "HowToStep", "name": "Bake", "text": "Bake 40 to 45 minutes. The pie is ready when the apples are tender and the crust is golden brown.", "url": "https://example.com/recipe#step5", "image": "https://example.com/photos/recipe/step5.jpg" }, { "@type": "HowToStep", "name": "Cool", "text": "Cool on cooling rack at least 2 hours before serving.", "url": "https://example.com/recipe#step6", "image": "https://example.com/photos/recipe/step6.jpg" } ] ``` - **`HowToSection` (only if a recipe has multiple sections)** : Use to group steps into multiple sections. See `https://developers.google.com/search/docs/appearance/structured-data/recipe#how-to-section` for an example. - **Single or repeated property of text** : A block of text that includes one or more steps. Google treats all steps as being in a single section. Repeated property values are concatenated into a single block of text. Google then attempts to automatically split the single block of text into individual steps. Google tries to find and remove any section names, step numbers, keywords, and anything else that can incorrectly appear in recipe step text. For best results, we recommend you unambiguously specify steps with `https://developers.google.com/search/docs/appearance/structured-data/recipe#how-to-step`. ``` "recipeInstructions": [ "In large bowl, gently mix filling ingredients; spoon into crust-lined pie plate. Top with second crust. Cut slits or shapes in several places in top crust. Bake 40 to 45 minutes. The pie is ready when the or until apples are tender and the crust is golden brown. Cool on cooling rack at least 2 hours before serving." ] ``` **Additional guidelines** - Don't include metadata that belongs elsewhere. In particular, use the `author` property to specify the author, `recipeCuisine` for cuisine, `recipeCategory` for category, and `keywords` for other keywords. - Include only text on how to make the dish and don't include other text such as "Directions", "Watch the video", "Step 1". Specify those phrases outside of structured data. **Not recommended**: ``` "recipeInstructions": [{ "@type": "HowToStep", "text": "Step 1. Heat oven to 425°F." }] ``` **Recommended**: ``` "recipeInstructions": [{ "@type": "HowToStep", "text": "Heat oven to 425°F." }] ``` | | `recipeYield` | `https://schema.org/Text` or `https://schema.org/Integer` The quantity produced by the recipe, if applicable. Specify the number of servings produced from this recipe with just a number. If you wish to use a different unit (for example, number of items), you may include additional yields. This is required if you specify any nutritional information per serving (such as `nutrition.calories`). Example ``` "recipeYield": [ "6", "24 cookies" ] ``` | | `totalTime` | `https://schema.org/Duration` The total time it takes to prepare the cook the dish, in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601), if applicable. Use `totalTime` or a combination of both `cookTime` and `prepTime`. | | `video` | `https://schema.org/VideoObject` A video depicting the steps to make the dish. Follow the list of required and recommended [Video properties](https://developers.google.com/search/docs/appearance/structured-data/video#video-object). | ### `HowToSection` > [!NOTE] > Most recipes don't have sections. Start by splitting the recipe instructions into `HowToStep` properties, and only add `HowToSection` if you need to additionally specify sections of steps. Use `HowToSection` to group a sequence of steps (or sub-sections) that make up part of the instructions for a recipe. Specify `HowToSection` directly within the definition of `recipeInstructions` property, or as an `itemListElement` of another `HowToSection`. The `HowToSection` type defines a section of a single recipe and contains one or multiple steps. Don't use `HowToSection` to define different recipes for the same dish; instead, use `HowToSection` as part of a single recipe. For listing multiple recipes for a dish, use multiple `Recipe` objects. For example, for multiple ways to make an apple pie, list them as multiple `Recipe` objects, not `HowToSection` objects. The full definition of `HowToSection` is available at [schema.org/HowToSection](https://schema.org/HowToSection). | Required properties || |---|---| | `itemListElement` | `https://developers.google.com/search/docs/appearance/structured-data/recipe#how-to-step` A list of detailed steps for the section, and/or sub-sections. For example, a pizza recipe may have one section of steps for making the crust, one for preparing the toppings, and one for combining and baking. Example: ``` { "@type": "HowToSection", "name": "Assemble the pie", "itemListElement": [ { "@type": "HowToStep", "text": "In large bowl, gently mix filling ingredients; spoon into crust-lined pie plate." }, { "@type": "HowToStep", "text": "Top with second crust. Cut slits or shapes in several places in top crust." } ] } ``` | | `name` | `https://schema.org/Text` The name of the section. | ### `HowToStep` Use `HowToStep` to group one or more sentences that explain how to do part of the recipe, if this makes sense for your content. Define the `text` property with the sentences or, alternately, define `itemListElement` with a `HowToDirection` or `HowToTip` for each sentence. Mark up your recipe steps with the following properties of the [HowToStep](https://schema.org/HowToStep) type. Specify a `HowToStep` directly within the definition of `recipeInstructions` property, or as an `itemListElement` of a `HowToSection`. The full definition of `HowToStep` is available at [schema.org/HowToStep](https://schema.org/HowToStep). | Required properties || |---|---| | `itemListElement` | `https://schema.org/HowToDirection` or `https://schema.org/HowToTip` A list of detailed substeps, including directions or tips. Optional if `text` is used. | | `text` | `https://schema.org/Text` The full instruction text of this step. Optional if `itemListElement` is used. Additional guidelines: - Include only instructional text and don't include other text such as "Directions", "Watch the video", "Step 1". Specify those phrases outside of the marked up property. **Not recommended**: ``` { "@type": "HowToStep", "text": "Step 1. Heat oven to 425°F." } ``` **Recommended**: ``` { "@type": "HowToStep", "text": "Heat oven to 425°F." } ``` | | Recommended properties || |---|---| | `image` | `https://schema.org/ImageObject` or `https://schema.org/URL` An image for the step. Additional image guidelines: - Image URLs must be [crawlable and indexable](https://developers.google.com/search/docs/crawling-indexing/sitemaps/image-sitemaps). - Images must represent the marked up content. - Images must be in .jpg, .png, or. gif format. | | `name` | `https://schema.org/Text` The word or short phrase summarizing the step (for example, "Arrange pie crust"). Don't use non-descriptive text (for example, "Step 1: \[text\]") or other form of step number (for example, "1. \[text\]"). | | `url` | `https://schema.org/URL` A `URL` that directly links to the step (if one is available). For example, an anchor link fragment. | | `video` | `https://schema.org/VideoObject` or `https://schema.org/Clip` A video for this step or a clip of the video. For `https://schema.org/VideoObject`, follow the list of required and recommended [Video](https://developers.google.com/search/docs/appearance/structured-data/video#type-definitions) or [Clip](https://developers.google.com/search/docs/appearance/structured-data/video#clip) properties. | ### `HowToDirection` and `HowToTip` Use `HowToDirection` and `HowToTip` to describe directions or tips, if applicable. They have the same required and recommended properties. The full definitions of `HowToDirection` and `HowToTip` are available at [schema.org/HowToDirection](https://schema.org/HowToDirection) and [schema.org/HowToTip](https://schema.org/HowToTip). | Required properties || |---|---| | `text` | `https://schema.org/Text` The text of the direction or tip. | ### `ItemList` In addition to [Recipe properties](https://developers.google.com/search/docs/appearance/structured-data/recipe#recipe-properties), add the following properties for host-specific lists. While `ItemList` isn't required, you must add the following properties if you want your recipe to be eligible for a host carousel. For more information about host carousel, see [Carousel](https://developers.google.com/search/docs/appearance/structured-data/carousel). The full definition of `ItemList` is available at [schema.org/ItemList](https://schema.org/ItemList). | Required properties || |---|---| | `itemListElement` | `https://schema.org/ListItem` Annotation for a single item page. | | `ListItem.position` | `https://schema.org/Integer` Ordinal position of the item page in the list. For example: ``` "itemListElement": [ { "@type": "ListItem", "position": 1, }, { "@type": "ListItem", "position": 2, } ] ``` | | `ListItem.url` | `https://schema.org/URL` The canonical URL of the item page. Every item must have a unique URL. | ## Monitor rich results with Search Console Search Console is a tool that helps you monitor how your pages perform in Google Search. You don't have to sign up for Search Console to be included in Google Search results, but it can help you understand and improve how Google sees your site. We recommend checking Search Console in the following cases: 1. [After deploying structured data for the first time](https://developers.google.com/search/docs/appearance/structured-data/recipe#after-deploying) 2. [After releasing new templates or updating your code](https://developers.google.com/search/docs/appearance/structured-data/recipe#after-releasing) 3. [Analyzing traffic periodically](https://developers.google.com/search/docs/appearance/structured-data/recipe#analyzing-periodically) [Video](https://www.youtube.com/watch?v=Vmfvf8nG09k) ### After deploying structured data for the first time After Google has indexed your pages, look for issues using the relevant [Rich result status report](https://support.google.com/webmasters/answer/7552505). Ideally, there will be an increase of valid items, and no increase in invalid items. If you find issues in your structured data: 1. [Fix the invalid items](https://developers.google.com/search/docs/appearance/structured-data/recipe#troubleshooting). 2. [Inspect a live URL](https://support.google.com/webmasters/answer/9012289#test_live_page) to check if the issue persists. 3. [Request validation](https://support.google.com/webmasters/answer/13300208) using the status report. ### After releasing new templates or updating your code When you make significant changes to your website, monitor for increases in structured data invalid items. - If you see an **increase in invalid items**, perhaps you rolled out a new template that doesn't work, or your site interacts with the existing template in a new and bad way. - If you see a **decrease in valid items** (not matched by an increase in invalid items), perhaps you are no longer embedding structured data in your pages. Use the [URL Inspection tool](https://support.google.com/webmasters/answer/9012289) to learn what is causing the issue. ### Analyzing traffic periodically Analyze your Google Search traffic using the [Performance Report](https://support.google.com/webmasters/answer/7576553). The data will show you how often your page appears as a rich result in Search, how often users click on it and what is the average position you appear on search results. You can also automatically pull these results with the [Search Console API](https://developers.google.com/webmaster-tools/search-console-api-original/v3/how-tos/search_analytics). ## Troubleshooting If you're having trouble implementing or debugging structured data, here are some resources that may help you. - If you're using a content management system (CMS) or someone else is taking care of your site, ask them to help you. Make sure to forward any Search Console message that details the issue to them. - Google does not guarantee that features that consume structured data will show up in search results. For a list of common reasons why Google may not show your content in a rich result, see the [General Structured Data Guidelines](https://developers.google.com/search/docs/appearance/structured-data/sd-policies). - You might have an error in your structured data. Check the [list of structured data errors](https://support.google.com/webmasters/answer/13300873) and the [Unparsable structured data report](https://support.google.com/webmasters/answer/9166415). - If you received a structured data manual action against your page, the structured data on the page will be ignored (although the page can still appear in Google Search results). To fix [structured data issues](https://support.google.com/webmasters/answer/9044175#zippy=%2Cstructured-data-issue), use the [Manual Actions report](https://support.google.com/webmasters/answer/9044175). - Review the [guidelines](https://developers.google.com/search/docs/appearance/structured-data/recipe#guidelines) again to identify if your content isn't compliant with the guidelines. The problem can be caused by either spammy content or spammy markup usage. However, the issue may not be a syntax issue, and so the Rich Results Test won't be able to identify these issues. - Structured data issues can affect how your site's content appears in search results. Use this [Troubleshoot missing rich results / drop in total rich results](https://support.google.com/webmasters/answer/13300208) guide to review a step-by-step approach to identify, fix, and validate these issues in Search Console. - Allow time for re-crawling and re-indexing. Remember that it may take several days after publishing a page for Google to find and crawl it. For general questions about crawling and indexing, check the [Google Search crawling and indexing FAQ](https://developers.google.com/search/help/crawling-index-faq). - Post a question in the [Google Search Central forum](https://support.google.com/webmasters/community).