SDK engine

Google Autocomplete

Подсказки Google Autocomplete с поддержкой разных клиентов SerpApi и гибкими дополнительными полями.

engine: google_autocomplete TS: XylopSearchEngines.GoogleAutocomplete JS: XylopSearchEngines.GoogleAutocomplete C#: XylopSearchEngines.GoogleAutocomplete Python: XylopSearchEngines.GOOGLE_AUTOCOMPLETE PHP: XylopSearchEngines::GOOGLE_AUTOCOMPLETE Ruby: XylopApiClient::Engines::GOOGLE_AUTOCOMPLETE Java: XylopSearchEngines.GOOGLE_AUTOCOMPLETE Kotlin: XylopSearchEngines.GOOGLE_AUTOCOMPLETE Swift: XylopSearchEngines.googleAutocomplete Dart: XylopSearchEngines.googleAutocomplete C++: xylop::api::engines::google_autocomplete Go: xylop.EngineGoogleAutocomplete 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.GoogleAutocomplete,
  {
    q: "coffee",
    client: "chrome",
    gl: "us",
    hl: "en",
  });

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.GoogleAutocomplete,
  {
    q: "coffee",
    client: "chrome",
    gl: "us",
    hl: "en",
  });

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.GoogleAutocomplete,
    new Dictionary<string, string?>
    {
        ["q"] = "coffee",
        ["client"] = "chrome",
        ["gl"] = "us",
        ["hl"] = "en",
    });

Для типизированного режима используйте `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_AUTOCOMPLETE,
    {
        "q": "coffee",
        "client": "chrome",
        "gl": "us",
        "hl": "en",
    },
)

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_AUTOCOMPLETE,
    [
        'q' => 'coffee',
        'client' => 'chrome',
        'gl' => 'us',
        'hl' => 'en',
    ]
);

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_AUTOCOMPLETE,
  {
    "q" => "coffee",
    "client" => "chrome",
    "gl" => "us",
    "hl" => "en",
  }
)

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_AUTOCOMPLETE,
    Map.of(
        "q", "coffee",
        "client", "chrome",
        "gl", "us",
        "hl", "en"
    ));

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_AUTOCOMPLETE,
    mapOf(
        "q" to "coffee",
        "client" to "chrome",
        "gl" to "us",
        "hl" to "en",
    ),
)

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.googleAutocomplete,
    parameters: [
        "q": "coffee",
        "client": "chrome",
        "gl": "us",
        "hl": "en",
    ]
)

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.googleAutocomplete,
    <String, Object?>{
      'q': 'coffee',
      'client': 'chrome',
      'gl': 'us',
      'hl': 'en',
    },
  );

  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_autocomplete,
        {
            {"q", "coffee"},
            {"client", "chrome"},
            {"gl", "us"},
            {"hl", "en"},
        });

    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.EngineGoogleAutocomplete,
        xylop.Params(map[string]string{
            "q": "coffee",
            "client": "chrome",
            "gl": "us",
            "hl": "en",
        }),
        &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_autocomplete
API key
Передается SDK автоматически из настроек клиента.
Входные параметры

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

Параметр Тип Обязателен Значение Описание
api_key SDK string Да Ключ Xylop API. В SDK задается один раз в настройках или конструкторе клиента.
engine SDK string Да google_autocomplete Движок Google Autocomplete.
q string Да coffee Начало поисковой фразы.
client string Нет chrome Клиент Google Autocomplete.
gl string Нет us Код страны.
hl string Нет en Язык интерфейса.
Выходные параметры

Поля ответа

Поле Тип Источник Описание
search_metadata object пример ответа Метаданные запроса: статус, идентификатор, время выполнения и служебная информация провайдера.
search_information object пример ответа Сводка по выдаче: примерное число результатов, время поиска и дополнительные статусы.
suggestions array пример ответа Подсказки автодополнения или уточнения запроса.
verbatim_relevance number пример ответа Типизированное поле ответа для этого engine; структура зависит от upstream-провайдера и параметров запроса.
JSON

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

{
  "search_metadata": {
    "status": "Success",
    "google_autocomplete_url": "https://www.google.com/complete/search?..."
  },
  "search_information": {
    "autocomplete_results_state": "Showing completion results."
  },
  "suggestions": [
    {
      "value": "coffee near me",
      "relevance": 1250,
      "type": "QUERY"
    }
  ],
  "verbatim_relevance": 886
}