SDK engine

Google Shopping

Google Shopping search with typed product, price, filter and pagination fields.

engine: google_shopping TS: XylopSearchEngines.GoogleShopping JS: XylopSearchEngines.GoogleShopping C#: XylopSearchEngines.GoogleShopping Python: XylopSearchEngines.GOOGLE_SHOPPING PHP: XylopSearchEngines::GOOGLE_SHOPPING Ruby: XylopApiClient::Engines::GOOGLE_SHOPPING Java: XylopSearchEngines.GOOGLE_SHOPPING Kotlin: XylopSearchEngines.GOOGLE_SHOPPING Swift: XylopSearchEngines.googleShopping Dart: XylopSearchEngines.googleShopping C++: xylop::api::engines::google_shopping Go: xylop.EngineGoogleShopping GET /search
TypeScript пример

Вызов через @xylop/api-client-typescript

import { XylopSearchClient, XylopSearchEngines } from "@xylop/api-client-typescript";

interface SearchResponse {
  [key: string]: unknown;
}

const client = new XylopSearchClient({
  apiKey: "YOUR_API_KEY"
});

const response = await client.search<SearchResponse>(
  XylopSearchEngines.GoogleShopping,
  {
    q: "running shoes",
    location: "Austin, Texas, United States",
    gl: "us",
    hl: "en",
    num: "10",
  });

TypeScript SDK написан на TypeScript, генерирует `.d.ts`, поддерживает generic response type и работает через `fetch`.

JavaScript пример

Вызов через @xylop/api-client

import { XylopSearchClient, XylopSearchEngines } from "@xylop/api-client";

const client = new XylopSearchClient({
  apiKey: "YOUR_API_KEY"
});

const response = await client.search(
  XylopSearchEngines.GoogleShopping,
  {
    q: "running shoes",
    location: "Austin, Texas, United States",
    gl: "us",
    hl: "en",
    num: "10",
  });

JavaScript SDK работает в Node.js 18+ и современных браузерах через `fetch`; TypeScript declarations входят в npm package.

C# пример

Вызов через XylopSearchClient

using Xylop.Api.Client;

var client = new XylopSearchClient(new HttpClient(), "YOUR_API_KEY");

using var response = await client.SearchJsonAsync(
    XylopSearchEngines.GoogleShopping,
    new Dictionary<string, string?>
    {
        ["q"] = "running shoes",
        ["location"] = "Austin, Texas, United States",
        ["gl"] = "us",
        ["hl"] = "en",
        ["num"] = "10",
    });

Для типизированного режима используйте `SearchAsync<TResponse>` и response-модель из `Xylop.Logic.SerpApiResponses.*`, которая входит в пакет C# SDK.

Python пример

Вызов через xylop-api-client

from xylop_api_client import XylopSearchClient, XylopSearchEngines

client = XylopSearchClient("YOUR_API_KEY")

response = client.search(
    XylopSearchEngines.GOOGLE_SHOPPING,
    {
        "q": "running shoes",
        "location": "Austin, Texas, United States",
        "gl": "us",
        "hl": "en",
        "num": "10",
    },
)

Python SDK возвращает JSON как обычные `dict`/`list` и не требует runtime-зависимостей.

PHP пример

Вызов через xylop/api-client

<?php

use Xylop\Api\Client\XylopSearchClient;
use Xylop\Api\Client\XylopSearchEngines;

$client = new XylopSearchClient('YOUR_API_KEY');

$response = $client->search(
    XylopSearchEngines::GOOGLE_SHOPPING,
    [
        'q' => 'running shoes',
        'location' => 'Austin, Texas, United States',
        'gl' => 'us',
        'hl' => 'en',
        'num' => '10',
    ]
);

PHP SDK использует стандартные stream wrappers, возвращает decoded JSON array и не требует runtime-зависимостей.

Ruby пример

Вызов через xylop-api-client

require "xylop_api_client"

client = XylopApiClient::Client.new(api_key: "YOUR_API_KEY")

response = client.search(
  XylopApiClient::Engines::GOOGLE_SHOPPING,
  {
    "q" => "running shoes",
    "location" => "Austin, Texas, United States",
    "gl" => "us",
    "hl" => "en",
    "num" => "10",
  }
)

Ruby SDK использует стандартные `net/http`, `json` и возвращает JSON как обычные Hash/Array значения.

Java пример

Вызов через xylop-api-client

import java.util.Map;
import ru.xylop.api.client.XylopSearchClient;
import ru.xylop.api.client.XylopSearchEngines;

var client = new XylopSearchClient("YOUR_API_KEY");

String responseJson = client.searchJson(
    XylopSearchEngines.GOOGLE_SHOPPING,
    Map.of(
        "q", "running shoes",
        "location", "Austin, Texas, United States",
        "gl", "us",
        "hl", "en",
        "num", "10"
    ));

Java SDK использует `java.net.http.HttpClient`, возвращает JSON-строку и не требует runtime-зависимостей.

Kotlin пример

Вызов через xylop-api-kotlin-client

import ru.xylop.api.kotlin.XylopSearchClient
import ru.xylop.api.kotlin.XylopSearchEngines

val client = XylopSearchClient("YOUR_API_KEY")

val responseJson = client.searchJson(
    XylopSearchEngines.GOOGLE_SHOPPING,
    mapOf(
        "q" to "running shoes",
        "location" to "Austin, Texas, United States",
        "gl" to "us",
        "hl" to "en",
        "num" to "10",
    ),
)

Kotlin SDK использует JVM `HttpClient`, возвращает JSON-строку и оставляет JSON-маппинг приложению.

Swift пример

Вызов через XylopApiClient

import XylopApiClient

let client = XylopSearchClient(apiKey: "YOUR_API_KEY")

let response = try await client.searchJSON(
    engine: XylopSearchEngines.googleShopping,
    parameters: [
        "q": "running shoes",
        "location": "Austin, Texas, United States",
        "gl": "us",
        "hl": "en",
        "num": "10",
    ]
)

Swift SDK использует Foundation `URLSession`, поддерживает async/await и возвращает Data, JSONSerialization values или caller-owned Decodable models.

Dart пример

Вызов через xylop_api_client

import 'package:xylop_api_client/xylop_api_client.dart';

Future<void> main() async {
  final client = XylopSearchClient('YOUR_API_KEY');

  final response = await client.search(
    XylopSearchEngines.googleShopping,
    <String, Object?>{
      'q': 'running shoes',
      'location': 'Austin, Texas, United States',
      'gl': 'us',
      'hl': 'en',
      'num': '10',
    },
  );

  print(response);
}

Dart SDK использует `dart:io`, возвращает decoded JSON или raw response text и не требует runtime-зависимостей.

C++ пример

Вызов через Xylop.Api.Cpp

#include <xylop/api/client.hpp>
#include <xylop/api/curl_transport.hpp>

int main()
{
    xylop::api::search_client client(
        "YOUR_API_KEY",
        xylop::api::curl_transport);

    auto response_json = client.search_text(
        xylop::api::engines::google_shopping,
        {
            {"q", "running shoes"},
            {"location", "Austin, Texas, United States"},
            {"gl", "us"},
            {"hl", "en"},
            {"num", "10"},
        });

    return 0;
}

C++ SDK имеет header-only C++17 core, принимает transport callback и может использовать optional libcurl adapter `xylop::api::curl_transport`.

Go пример

Вызов через Xylop.Api.Go

package main

import (
    "context"
    "log"

    xylop "github.com/Leonid-Vizel/Xylop.AdminPanel/src/Xylop.Api.Go"
)

func main() {
    client, err := xylop.NewClient("YOUR_API_KEY")
    if err != nil {
        log.Fatal(err)
    }

    var response map[string]any
    err = client.SearchJSON(
        context.Background(),
        xylop.EngineGoogleShopping,
        xylop.Params(map[string]string{
            "q": "running shoes",
            "location": "Austin, Texas, United States",
            "gl": "us",
            "hl": "en",
            "num": "10",
        }),
        &response)
    if err != nil {
        log.Fatal(err)
    }
}

Go SDK возвращает raw JSON bytes или декодирует ответ в пользовательскую структуру, `map[string]any` либо другой target.

Endpoint

HTTP контракт

URL
https://api.xylop.ru/search
Engine
google_shopping
API key
Передается SDK автоматически из настроек клиента.
Входные параметры

Параметры запроса

Параметр Тип Обязателен Значение Описание
api_key SDK string Да Ключ Xylop API. В SDK задается один раз в настройках или конструкторе клиента.
engine SDK string Да google_shopping Google Shopping engine.
q string Да running shoes Product search query.
location string Нет Austin, Texas, United States Search city or region.
gl string Нет us Country code.
hl string Нет en Interface language.
num number Нет 10 Number of results.
start number Нет 0 Pagination offset.
direct_link string Нет true Ask SerpApi for direct merchant links when available.
device string Нет desktop desktop, tablet or mobile.
Выходные параметры

Поля ответа

Поле Тип Источник Описание
search_metadata object пример ответа Метаданные запроса: статус, идентификатор, время выполнения и служебная информация провайдера.
search_parameters object пример ответа Нормализованные параметры, с которыми upstream-поиск выполнил запрос.
shopping_results array пример ответа Товары, цены, продавцы, рейтинги и ссылки на карточки.
JSON

Пример ответа

{
  "search_metadata": {
    "status": "Success",
    "google_shopping_url": "https://www.google.com/search?tbm=shop&q=running+shoes"
  },
  "search_parameters": {
    "engine": "google_shopping",
    "q": "running shoes"
  },
  "shopping_results": [
    {
      "position": 1,
      "title": "Example running shoe",
      "price": "$89.00",
      "source": "Example Store",
      "thumbnail": "https://example.com/shoe.jpg"
    }
  ]
}