Google Immersive Product API

Google Immersive Product API allows you to retrieve extra information on a product from "Immersive Product" block. When this block is clicked, Google will open a pop-up with complete product details. The API is accessed through the following endpoint: /search?engine=google_immersive_product. A user may query the following: https://serpapi.com/search?engine=google_immersive_product utilizing a GET request. Head to the playground for a live and interactive demo.

API Parameters

Search Query

page_token

Required

Parameter defines the token needed to show more product info in Google immersive popup. Token is generated by SerpApi using our Google Immersive Product API.

Serpapi Parameters

engine

Required

Set parameter to google_immersive_product to use the Google Immersive Product API engine.

no_cache

Optional

Parameter will force SerpApi to fetch the Google Immersive Product results even if a cached version is already present. A cache is served only if the query and all parameters are exactly the same. Cache expires after 1h. Cached searches are free, and are not counted towards your searches per month. It can be set to false (default) to allow results from the cache, or true to disallow results from the cache. no_cache and async parameters should not be used together.

async

Optional

Parameter defines the way you want to submit your search to SerpApi. It can be set to false (default) to open an HTTP connection and keep it open until you got your search results, or true to just submit your search to SerpApi and retrieve them later. In this case, you'll need to use our Searches Archive API to retrieve your results. async and no_cache parameters should not be used together.

api_key

Required

Parameter defines the SerpApi private key to use.

output

Optional

Parameter defines the final output you want. It can be set to json (default) to get a structured JSON of the results, or html to get the raw html retrieved.

API Results

JSON Results

JSON output includes structured data for immersive product.

A search status is accessible through search_metadata.status. It flows this way: Processing -> Success || Error. If a search has failed, error will contain an error message. search_metadata.id is the search ID inside SerpApi.

HTML Results

HTML output is useful to debug JSON results or support features not supported yet by SerpApi. HTML output gives you the raw HTML results from Google Async API.
This API does not have html response, just a text. search_metadata.prettify_html_file contains prettified version of the result. It is displayed in the playground.

API Examples

Example with page_token: eyJlaSI6IlN3clNZcmF... parameter

Example with page_token: eyJlaSI6IlN3clNZcmF... parameter

JSON Example

{
  ...
  "product_results": {
    "thumbnails": [
      "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcQjEowwRpY2eLyF80edHNAguvlGIewpWSAmzGUqXwvby4FrUEAnhRkYqX6-A19-MQqU57mMBsPVGR05pVTgzt9eLBqVO7w937o6Enwfq1PrHCG4neThXQkv",
      "https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcTrwEc18Y24epF8aSr_uCYmMUfa39UMl0UqvbbMFo1vwNrheu-useUGsIDDkxuWuzWRKdqNEJ0jOnbm9G7zP_Yd6oKt9CN765h8rxdwfoArUvkB2Xm4K63c",
      "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcSRVYt2lRA-_Kli8n63iP6CS66G84Wlt04DiHBzSnwNQJFtRVhEqqVpd87GkhnzlHYYqRk19SNHBiuS-X8kizyU878BlxQbnL9vu_sLli7vdgSzEfX_b7ic9w",
      ...
    ],
    "title": "Patagonia Men's Recycled Wool Sweater",
    "brand": "Patagonia",
    "reviews": 88,
    "rating": 4.4,
    "ratings": [
      {
        "stars": 1,
        "amount": 2
      },
      {
        "stars": 2,
        "amount": 4
      },
      {
        "stars": 3,
        "amount": 12
      },
      {
        "stars": 4,
        "amount": 11
      },
      {
        "stars": 5,
        "amount": 59
      },
    ],
    "stores": [
      {
        "name": "Patagonia",
        "logo": "https://encrypted-tbn2.gstatic.com/faviconV2?url=https://www.patagonia.com&client=SHOPPING&size=32&type=FAVICON&fallback_opts=TYPE,SIZE,URL&nfrp=2",
        "link": "https://www.patagonia.com/product/mens-recycled-wool-sweater/191743121159.html",
        "price": "$139.00",
        "extracted_price": 139.0
      },
      {
        "name": "Geiger's",
        "logo": "https://encrypted-tbn1.gstatic.com/faviconV2?url=https://www.shopgeigers.com&client=SHOPPING&size=32&type=FAVICON&fallback_opts=TYPE,SIZE,URL&nfrp=2",
        "link": "https://www.shopgeigers.com/patagonia/patagonia-mens-recycled-wool-sweater-46420",
        "price": "$96.99",
        "extracted_price": 96.99
      },
      ...
    ],
    "variants": [
      {
        "serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJlaSI6IlN3clNZcmFlRnFETXdia1A0Y20zMkFvIiwiY2F0YWxvZ2lkIjoiMTU5NTU5MzkxODU0NTAwMDU3MjUiLCJ2YyI6IjI1OTQ0NzAwMTQxODE5NDE0ODgiLCJ2c2MiOiI2NjYyMzE2OTMzMjUwMjk2MDcwIiwiaGVhZGxpbmVPZmZlckRvY2lkIjoiMTMxOTk2NzY4MTI5MDY4NTQ5MDEiLCJpbWFnZURvY2lkIjoiMTgwMDcyMTg2NzgwOTA4Nzg3OTUiLCJyZHMiOiJQQ182MDUyMTgzNjI1MTU3Mzc5NjAxfFBST0RfUENfNjA1MjE4MzYyNTE1NzM3OTYwMSIsInF1ZXJ5IjoibWVucytzd2VhdGVyIn0%3D",
        "thumbnail": "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcSWjVLC2QZV6CbyIUi0eLjsfOX0Duk2wihqF4M_wWeqtSN7ueAFG6SYWZudlqIbJHSsuS5lgti-tiCokGFCHFM1IkUFaltn4KTq3X1KcVvWV6gd-epkzg",
        "images": [
          "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcQFrZPAtVA17f_Q6gzBgH3_aDXNtg8e9hCi4-eopCiSz6TTbgtpc1QRdMWjOJqxisg60PVYMyp9Kr4WUmqPFliXzd7GmYYtXOmGctOw5KZz9kKCx6uCm0eq"
        ]
      },
      {
        "serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJlaSI6IlN3clNZcmFlRnFETXdia1A0Y20zMkFvIiwiY2F0YWxvZ2lkIjoiMTU5NTU5MzkxODU0NTAwMDU3MjUiLCJ2YyI6IjI1OTQ0NzAwMTQxODE5NDE0ODgiLCJ2c2MiOiI0MjA1NTQ0ODIwMzk1MzkyNjcyIiwiaGVhZGxpbmVPZmZlckRvY2lkIjoiMTMxOTk2NzY4MTI5MDY4NTQ5MDEiLCJpbWFnZURvY2lkIjoiMTgwMDcyMTg2NzgwOTA4Nzg3OTUiLCJyZHMiOiJQQ182MDUyMTgzNjI1MTU3Mzc5NjAxfFBST0RfUENfNjA1MjE4MzYyNTE1NzM3OTYwMSIsInF1ZXJ5IjoibWVucytzd2VhdGVyIn0%3D",
        "thumbnail": "https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcTQXmj4_SBTciFfaISyO-gFBhOJXGccFRgrPH3uikGvyC_xq8Jt6p0NDmHwGRezdsAnV82Kh97bpOfbXvDiFFbdIAkL7XMsObrp0rkM3mjWrk8Q-Xp9Sw",
        "images": [
          "https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcQKfhX3jJFUdaXtXW91ETmKj3d0EfxWviGX4OWOOxYluvIDf1FEKQxXl-pz9chH4vp9OYXLeuU1QlFYV7GTU5ptTmYewbSJxn9oj0-UKa03NklsqlV6IWXC",
          "https://encrypted-tbn0.gstatic.com/shopping?q=tbn:ANd9GcRohDKlAFVuspSWTboS7i-4LAuFFSqFcntamXqVODo5L8lM-CF_0q3h418dAYV3aXn6GEznmd6m40R40gKbUNo_NMurpceetRfO0qlThrNHh8e3RGE0ggqB",
          "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcTJEvwjG5NzItCNI7u2Lb_1rLYrzCyHpEvcxTmpVYRgjm9WBpbdandKz6zqtF6C_Z2_IioOvfOOteq1Cu_4PQ3LD0W5NPDtFjWOCA72_wW1-U3pO1jE96AvCg",
          ...
        ]
      },
      {
        "serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJlaSI6IlN3clNZcmFlRnFETXdia1A0Y20zMkFvIiwiY2F0YWxvZ2lkIjoiMTU5NTU5MzkxODU0NTAwMDU3MjUiLCJ2YyI6IjI1OTQ0NzAwMTQxODE5NDE0ODgiLCJ2c2MiOiI3MzE1MTE4OTk4NjUxMDkwNjU2IiwiaGVhZGxpbmVPZmZlckRvY2lkIjoiMTMxOTk2NzY4MTI5MDY4NTQ5MDEiLCJpbWFnZURvY2lkIjoiMTgwMDcyMTg2NzgwOTA4Nzg3OTUiLCJyZHMiOiJQQ182MDUyMTgzNjI1MTU3Mzc5NjAxfFBST0RfUENfNjA1MjE4MzYyNTE1NzM3OTYwMSIsInF1ZXJ5IjoibWVucytzd2VhdGVyIn0%3D",
        "thumbnail": "https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcQSUMeLoRzpWI0yY-jXmYYFvoR0alosLLj8tQfo_kxcz410uy4j8e4bli8yt9YyEtnyLx-LYxGbj4si3y8w4r8j809GzQHuzYWpaZBT08zNIM9rGqpt-A",
        "images": [
          "https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcS_vN7n5fmuMGcixqA8kuILhLB8aq7_yQK_7PaAd3JEAxCm2XOHSQeYr3aOXJRdABfi9X40C2XjW-oNhBA9bZ3kuxb8ap5IzI_hNY7mtNJMrsqXHVV2NMEG",
          "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcRWU647XAheuaDYWJF4RSYF-jVRmhX4i4CxtxNge870U7gQ_kdk_d0V_N8-V-LMP7PXCZwce-UrCGWLpzmoSjRnBt6LoWm15FyFYts3BRiQ",
          "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcST-PCpzc2i3EuNPDxlwuDDzwNRxpW0oDlBO6l0W3gOjhAqGzQEWffWHrCEldvszU1Lj8erRlGfKIgg_HKRArbMIy1doGFSgH0xxhgA-7FX",
          ...
        ]
      },
    ],
    "user_reviews": [
      {
        "title": "Absolutely Love It",
        "text": "I have a hard time buying sweaters because I find one that I like but the fit never works for me. This sweater does everything right in terms of fit, and I'm loving it so far.
For some reason a lot of sweaters are super long in the sleeves, and I find myself trying to size down so that the sleeves dont bunch around my wrists and slide down my hand. On this one, Patagonia made a provision for cuffing the sleeves (it's sold with the sleeves already cuffed), so the length is more reasonable, and can be extended, if preferred.
The other really nice feature is the generous waistband. I have an athletic build and sweaters will tend to ride up and sit high on my waist, and I'm constantly adjusting them back down. The waist on this sweater is relaxed and it sits just like it should around my hips.
It's a pricey sweater - no doubt about it. But at the end of the day, it looks amazing, is made responsibly with quality materials, and will be guaranteed for life. I'm loving it, and would gladly buy it again.",
        "user_name": "Drew",
        "source": "patagonia.com",
        "rating": 5,
        "date": "6 months ago"
      },
      {
        "title": "Not durable, though warm & breathable",
        "text": "I've only worn this sweater for about 20 days. Its stretched out way too much in this time as well as developing lots of little snags. I haven't found it to be on par with the quality of other Patagonia products which is a bummer.
I'm familiar with how to properly care for wool sweaters as I own several others I've found at thrift stores. In comparison to other sweaters I own, this is the most delicate. It has lost a lot of its shape in a short time, stretching out around the shoulders, wrists and waist. I don't mind the snags so much, but they seemingly appear out of nowhere...Its a pretty loose knit compared to my other wool sweaters. This is somewhat superficial, but in my opinion the sweater has lost a lot of functionality due to its fragility and loss of shape.
Wool sweaters are expected to be durable which is why they've been famously worn by fisherman, skiers, woodsman etc. over the years.
Hopefully the next iteration is improved.",
        "user_name": "Will",
        "source": "patagonia.com",
        "rating": 2,
        "date": "a year ago"
      }
    ]
  },
  "similar_products": [
    {
      "name": "Fjallraven Ovik Knit Sweater",
      "thumbnail": "https://encrypted-tbn2.gstatic.com/shopping?q=tbn:ANd9GcSUJ_A5uFteKlSn1J4e_UPShFJ2l5DefHGU9pPzKizBn4n6ow1w8HK4Z30tQNh2mleCgwAsgipr6mD2CLuBAx6OBFUzcX_llrgBbsd3IQ",
      "brand": "Fjällräven USA",
      "price": "$150.00",
      "extracted_price": 150.0,
      "serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJlaSI6IlN3clNZcmFlRnFETXdia1A0Y20zMkFvIiwiY2F0YWxvZ2lkIjoiNTMyMjA3MjExODAzMjY2NzkzNSIsInZjIjoiODcyNDk1MjQwMDU2MjA2NzA0OSIsInZzYyI6IiIsImhlYWRsaW5lT2ZmZXJEb2NpZCI6IjE3MDc5MDg4NzM4NDg5MjgwMDkwIiwiaW1hZ2VEb2NpZCI6IjMzNzQ1MzA3NDk4ODA4NDA5OTgiLCJyZHMiOiJQQ18xODM3MzUyNzU5MTgxOTg5MDMxM3xQUk9EX1BDXzE4MzczNTI3NTkxODE5ODkwMzEzIiwicXVlcnkiOiJtZW5zK3N3ZWF0ZXIifQ%3D%3D"
    },
    {
      "name": "Patagonia Men's Recycled Wool Sweater",
      "thumbnail": "https://encrypted-tbn1.gstatic.com/shopping?q=tbn:ANd9GcSkfYpwNI1KfEGOAqhJJLsenAObEAvu_hoCk-BskaLVFptPFfEjchykrEfSmSBOyLZZq-VKPNfZaVSeATgpxiXy4X7jXpC3TEOFRL9BLcKYqJGbjMMolPM",
      "brand": "BobsSportsChalet.com",
      "price": "$139.00",
      "extracted_price": 139.0,
      "serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJlaSI6IlN3clNZcmFlRnFETXdia1A0Y20zMkFvIiwiY2F0YWxvZ2lkIjoiODMwMzk0NDQxNjYxMjg2NTcwOCIsInZjIjoiMjU5NDQ3MDAxNDE4MTk0MTQ4OCIsInZzYyI6IiIsImhlYWRsaW5lT2ZmZXJEb2NpZCI6Ijg4MTQwNjg0Njg0NzEzODY1NDQiLCJpbWFnZURvY2lkIjoiMTUxNzE4NzUwODQwOTYzMTE3IiwicmRzIjoiUENfNjA1MjE4MzYyNTE1NzM3OTYwMXxQUk9EX1BDXzYwNTIxODM2MjUxNTczNzk2MDEiLCJxdWVyeSI6Im1lbnMrc3dlYXRlciJ9"
    },
    {
      "name": "Patagonia Women's Ridge Rise Stripe Uprisal Crew Sweatshirt",
      "thumbnail": "https://encrypted-tbn3.gstatic.com/shopping?q=tbn:ANd9GcRc09Q7m37plfoovYe5a3FgT5XLJGOlOb2iGA1P5d4QW_Y1cqBEfbNVhdXZPkIQhAaVjNQGPKwyYhfSEJCYkriZsw9KqeusERfkSs-B7W-im9t8jeQL1Vo",
      "brand": "Glik's",
      "price": "$69.00",
      "extracted_price": 69.0,
      "serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJlaSI6IlN3clNZcmFlRnFETXdia1A0Y20zMkFvIiwiY2F0YWxvZ2lkIjoiMTE2NzMyMjI4Njk5OTgyNTg4NzciLCJ2YyI6IjEzMTI3MzQ3NjEzNTgzMzg4MDQyIiwidnNjIjoiIiwiaGVhZGxpbmVPZmZlckRvY2lkIjoiMTcwNTg0NzMxOTY3NTY5NDc5MzMiLCJpbWFnZURvY2lkIjoiNTMzODIyNjA2MjY1MzIwNTY0MyIsInJkcyI6IlBDXzU0NDUyOTEzNjQzOTg1MTM3NDl8UFJPRF9QQ181NDQ1MjkxMzY0Mzk4NTEzNzQ5IiwicXVlcnkiOiJtZW5zK3N3ZWF0ZXIifQ%3D%3D"
    },
    ...
  ],
  "style_ideas_serpapi_link": "https://serpapi.com/search.json?device=desktop&engine=google_immersive_product&google_domain=google.com&page_token=eyJyZXFwbGQiOlsiMTgwMDcyMTg2NzgwOTA4Nzg3OTUiLDEwLDEsIi9tLzAxOWI4MCIsMV19"
  ...
}

Example with Style Ideaspage_token: eyJyZXFwbGQiOlsiMT... parameter

Example with Style Ideas, page_token: eyJyZXFwbGQiOlsiMT... parameter

JSON Example

{
  ...
  "style_ideas": [
    {
      "thumbnail": "https://t1.gstatic.com/images?q=tbn:ANd9GcQce98Q7A5OrRASpTK3MXbLip_cl59K63Vpku-x60Nd2ZvtRnoN",
      "image": "https://cdn.monsterchildren.com/wp-content/uploads/2019/09/04184449/monster-children-brixton-1-of-7.jpg",
      "website": "https://www.monsterchildren.com/kenny-anderson-talks-style-with-brixton-in-new-series-threads/"
    },
    {
      "thumbnail": "https://t0.gstatic.com/images?q=tbn:ANd9GcQGRXi2hW4Gn9THR27SrOYgHHi_A4fMB57arkCksPpfLGTf13B1",
      "image": "https://i.pinimg.com/originals/a4/f6/23/a4f62304f747dcfc98a98e91042221da.jpg",
      "website": "https://www.pinterest.com/rdeho/matt-style/"
    },
    {
      "thumbnail": "https://t1.gstatic.com/images?q=tbn:ANd9GcRXI5epFqlce4DdDAHGZdT5O-TysHmKzwGaEkH4VFvmNEnGgF_a",
      "image": "https://arancrafts.com/wp-content/uploads/2021/12/C4015-Navy-scaled.jpg",
      "website": "https://arancrafts.com/product/norwegian-style-sweater-c4015/"
    },
    ...
  ]
}