# Google Shopping results (`breathtaking_turtle/google-shopping-results`) Actor This api is design to do google shopping search and return link for product page - **URL**: https://apify.com/breathtaking\_turtle/google-shopping-results.md - **Developed by:** [Abinash Sonowal](https://apify.com/breathtaking_turtle) (community) - **Categories:** E-commerce - **Stats:** 2 total users, 1 monthly users, 33.3% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Google Shopping Results Scraper An Apify Actor written in Python that scrapes product details from Google Shopping based on search queries. It extracts essential product IDs (such as Catalog ID, GPC ID, headline offer ID, and image ID) and constructs direct Google Shopping detail URLs. ### Features - **Google SERP Proxy Integration**: Employs Apify's Google SERP proxy groups to bypass search engine blocks. - **Detailed Product Identifiers**: Extracts: - **Catalog ID (`catalogid`)**: Google's identifier for the product catalog entry. - **GPC ID (`gpcid`)**: Global Product Code. - **Headline Offer Doc ID (`headline_offer_docid`)**: The ID of the primary/headline merchant offer. - **Image Doc ID (`image_docid`)**: The ID for the main product image. - **Direct Shopping Links**: Synthesizes a valid `https://www.google.com/search` URL that opens the Google Shopping product comparison page directly (`ibp=oshop`). - **Robust Parsing**: Built with `aiohttp` for async HTTP requests and `BeautifulSoup4` for HTML structure extraction. ### Input Configuration The Actor accepts input in JSON format. The schema is defined in `.actor/input_schema.json`. | Field | Type | Required | Default | Description | | :--- | :--- | :--- | :--- | :--- | | `q` | String | **Yes** | - | The product search query (e.g., `wireless headphones`). | | `country` | String | No | `us` | The Google country code for localized results (e.g., `us`, `gb`, `in`, `ca`). | #### Input Example ```json { "q": "mechanical keyboard", "country": "us" } ```` ### Output Data Structure The results are stored in the default dataset. For each product found, the output contains the following fields: - `title`: The product card title. - `catalogid`: Google's internal product catalog ID. - `gpcid`: Global Product Code ID. - `headline_offer_docid`: Document ID of the merchant offer shown. - `image_docid`: Document ID of the product image. - `url`: Direct link to the Google Shopping comparison interface. #### Output Example ```json { "title": "Keychron K2 Wireless Mechanical Keyboard", "catalogid": "1234567890123456789", "gpcid": "9876543210", "headline_offer_docid": "off_abc123xyz", "image_docid": "img_789qwerty", "url": "https://www.google.com/search?ibp=oshop&q=mechanical+keyboard&prds=catalogid%3A1234567890123456789%2CheadlineOfferDocid%3Aoff_abc123xyz%2CimageDocid%3Aimg_789qwerty%2Crds%3APC_9876543210%7CPROD_PC_9876543210%2Cgpcid%3A9876543210%2Cpvt%3Ahg&hl=en&gl=us&udm=28" } ``` ### Local Development To run this Actor locally, make sure you have Python 3.8+ and the Apify CLI installed. 1. **Install dependencies**: ```bash pip install -r requirements.txt ``` 2. **Run locally using Apify CLI**: ```bash apify run ``` This will execute the code and simulate the Apify platform environment locally. The inputs are read from `storage/key_value_stores/default/INPUT.json` and the output datasets are written to `storage/datasets/default/`. ### Deployment Deploy your Actor to the Apify platform using: ```bash apify push ``` ### Resources - [Apify Platform documentation](https://docs.apify.com/platform) - [Apify SDK for Python documentation](https://docs.apify.com/sdk/python) - [Apify Console](https://console.apify.com/) # Actor input Schema ## `q` (type: `string`): The product search query to scrape from Google Shopping ## `country` (type: `string`): Google country code for localized results (e.g. us, gb, in) ## Actor input object example ```json { "q": "wireless headphones", "country": "us" } ``` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "q": "wireless headphones" }; // Run the Actor and wait for it to finish const run = await client.actor("breathtaking_turtle/google-shopping-results").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "q": "wireless headphones" } # Run the Actor and wait for it to finish run = client.actor("breathtaking_turtle/google-shopping-results").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "q": "wireless headphones" }' | apify call breathtaking_turtle/google-shopping-results --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=breathtaking_turtle/google-shopping-results", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Google Shopping results", "description": "This api is design to do google shopping search and return link for product page", "version": "0.0", "x-build-id": "gusqfeRaWYEmmMJwm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/breathtaking_turtle~google-shopping-results/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-breathtaking_turtle-google-shopping-results", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/breathtaking_turtle~google-shopping-results/runs": { "post": { "operationId": "runs-sync-breathtaking_turtle-google-shopping-results", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/breathtaking_turtle~google-shopping-results/run-sync": { "post": { "operationId": "run-sync-breathtaking_turtle-google-shopping-results", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "q" ], "properties": { "q": { "title": "Search Query", "type": "string", "description": "The product search query to scrape from Google Shopping" }, "country": { "title": "Country Code", "type": "string", "description": "Google country code for localized results (e.g. us, gb, in)", "default": "us" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```