Обзор документации
Справочник API
Google Places API
Поиск местных предприятий и мест. Укажите имена, адреса, координаты, рейтинги и контактные данные, когда они доступны.
Создать запрос
Дополнительные параметры
Начинается с 1. Каждая страница представляет собой отдельный запрос.
Выражение Google tbs. Поддерживаемые фильтры различаются по типу поиска.
https://data.flashdata.dev/v1/queries/realtimeПараметры
Отправить source и query на высшем уровне. Варианты источника принадлежат params. Факультативные поля можно опустить.
Тело запроса
sourcestring / Обязательно- Настройка на google_places.
querystring / Обязательно- Поисковый запрос. Поддерживает поисковые операторы Google, такие как site: и intitle:.1 то 2 000 персонажиПо умолчанию:
Не установлен paramsobject / Необязательно- Settings для этого запроса.По умолчанию:
{} callback_urlstring · nullable / Необязательно- Async и пакетные. Публичный HTTPS завершает URL на порте 443, вплоть до символов 2,048. Никаких учетных данных пользователя или фрагмента URL. Omit, используйте null или пустую строку без уведомления. В партии, установите это на каждый запрос, вне парамов.По умолчанию:
Не установлен
Страна, язык и местоположение
params.glstring / Необязательно- Двухбуквенный код страны, например, gb, de или sg. Настройте явно, чтобы выбрать страну.Точно. 2 персонажиПо умолчанию:
Не установленПринятый формат
^[A-Za-z]{2}$ params.hlstring / Необязательно- Язык интерфейса Google. Настройте явно, чтобы выбрать язык.1 то 35 персонажиПо умолчанию:
Не установленПринятый формат
^[A-Za-z0-9-]+$ params.locationstring / Необязательно- Запрашиваемое место поиска, предпочтительно город, такой как "London, England, United Kingdom". Доступность зависит от типа поиска.1 то 200 персонажиПо умолчанию:
Не установлен
Начинание
params.numinteger / Необязательно- Запрошенный результат подсчитан. FlashData не добавляет фиксированный по умолчанию, когда он опущен. Возвращенное количество может отличаться по типу запроса и поиска.1 то 100, целые числаПо умолчанию:
Не установлен params.pageinteger / Необязательно- Запрошенная страница результатов. Устанавливается явно. Каждая страница представляет собой отдельный запрос API.1 то 100, целые числаПо умолчанию:
Не установлен
Поисковые фильтры
params.tbsstring / Необязательно- Запрошенные фильтры поиска Google, такие как qdr:d за прошедший день или qdr:w за прошлую неделю. Доступность зависит от типа поиска.1 то 200 персонажиПо умолчанию:
Не установлен params.autocorrectboolean / Необязательно- Запросить исправление орфографии с помощью true или запросить его отключение с помощью false. Прикладное поведение зависит от типа поиска; не использовать поведение Google.
trueилиfalseПо умолчанию:Не установлен
Ответ
Realtime возвращается status: done с выходом поиска в results[0]. Матчи проходят results[0].places. usage.credits Записывает обвинение.
Результаты описывают места, в том числе адреса и координаты, когда они доступны. Рейтинги и контактные данные являются необязательными; используйте явные настройки страны и местоположения, когда имеет значение география.
Прочитайте результат
Сохраните успешный ответ JSON как response.json. Сохраните это как read-response.py и запустите python read-response.py. Он использует только стандартную библиотеку Python и не делает никаких новых запросов.
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = [
{name: item.get(name) for name in ("title", "address", "latitude", "longitude", "website")}
for item in result.get("places", [])
]
print(json.dumps(output, ensure_ascii=False, indent=2))Доступные поля зависят от типа запроса и поиска. Факультативные поля могут отсутствовать, а дополнительные поля могут быть возвращены.
Количество возвращенных предметов и searchParameters.num может отличаться от params.num. Используйте возвращенный массив для определения фактического количества результатов.
Все поля ответов
| Поле | Описание |
|---|---|
sourcestring | Запрошенный источник API. |
statusstring | Делается, когда запрос в режиме реального времени успешен. |
created_atstring | Время создания ответов в формате ISO 8601. |
usage.creditsnumber | Кредиты, взимаемые за запрос, исходя из вашего плана. |
results[0].searchParametersobject | Настройки поиска, сообщенные Google, с запросом, записанным как q. Возвращенные настройки могут отличаться от запрашиваемых значений. |
results[0].placesarray | Результаты локального поиска. |
results[0].places[].titlestring | Место или название компании. |
results[0].places[].addressstring · optional | Уличный адрес. |
results[0].places[].latitudenumber · optional | Широта. |
results[0].places[].longitudenumber · optional | Долгота. |
results[0].places[].ratingnumber · optional | Средний рейтинг. |
results[0].places[].ratingCountinteger · optional | Количество рейтингов. |
results[0].places[].categorystring · optional | Бизнес-категория. |
results[0].places[].phoneNumberstring · optional | Записанный номер телефона. |
results[0].places[].websitestring · optional | Бизнес-сайт. |
results[0].places[].cidstring · optional | Идентификатор места Google. |
results[0].places[].positioninteger | Итоговая позиция. |
results[0].places[].priceLevelstring · optional | Отображается уровень цен при наличии. |
Вышеприведенные поля описывают ответ JSON по умолчанию. JSON, простой текст и форматы Markdown.
Async и пакетный жизненный цикл
Подача возвращает квитанцию, а не результаты. Async создает одну работу; партия возвращает отдельную работу в queries[] на каждый принятый запрос. Отслеживайте и извлекайте каждую работу самостоятельно.
Представить data.flashdata.dev; читать статус работы и результаты api.flashdata.dev С тем же X-API-Key. Связанные базовые примеры API используют Python и cURL.
1. Сохранить работу IDs
Держите поля запросов этого источника при переходе на Async. Для Batch поместите каждый запрос в массив запросов объекта JSON. Сохраните все возвращенные работы ID.
2. Проверьте статус
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: Опрос с задержкой и уважениемRetry-Afterкогда присутствует.completed: Принесите результаты.failed: Проверитьjob.error.Читайте job.status, а не статус квитанции о представлении.
Проверить статус: Python и cURL
Статус работы API ссылка3. Получить результаты
GET https://api.flashdata.dev/v2/jobs/{jobId}/resultsПосле завершения аутентификации считывайте результат, а затем возьмите хранилище 302 URL без ключа API. Сохраните JSON в течение часов завершения 24.
Результаты поиска: Python и cURL · Форматы ответов
Результат скачивания ссылки API
Опросы и получение существующих результатов не потребляют кредиты запросов. Тайм-аут для голосования не отменяет работу: сохраняйте свой ID вместо того, чтобы подавать дубликат оплачиваемой работы. Коды ошибок и поведение retry.
Вебхуки завершения
Подписаться на запрос
Настройка callback_url на верхнем уровне асинхронного запроса, или Внутри каждого запроса в партии, снаружи params. Отдельного запроса на регистрацию webhook не требуется. Запросы Realtime не отправляют обратные вызовы.
Используйте общедоступный HTTPS URL на порту 443. FlashData POST - уведомление для каждой работы completed или failed; Событие содержит ссылки, а не сам результат.
Признать и проверить
Возвращение 2xx После того, как он принял это событие. Дублировать через delivery_id, Также посланный как X-Delivery-Id. Переадресации не выполняются.
Неудачные поставки с экспоненциальным обратным откатом, вплоть до 8 - полная версия и в большинстве 24 часов после завершения. Продолжайте опросы как запасной вариант.
Обратные звонки не подписаны. Подтвердить работу ID, исходный и терминальный статус через аутентифицированная конечная точка статуса перед обработкой уведомления. Поставка ID предназначена для дедупликации, а не для подтверждения подлинности.
Пример события web-cook и полей
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "google_places",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| Поле | Описание |
|---|---|
delivery_idstring | Стабильный идентификатор доставки. Дублировать уведомления с использованием этого значения; он также отправляется в заголовке X-Delivery-Id. |
idstring | Работать ID. |
sourcestring | Запрошенный источник данных. |
statusstring | завершены или не выполнены. |
linksarray | Статус и результат ссылки. Уведомления не включают контент результата или ключ API. |
links[].relstring | себя или результаты. |
links[].hrefstring | Абсолютный менеджмент API URL; аутентифицируйтесь с помощью ключа API. |
links[].methodstring | GET. |
Восстановление ошибок
Завершенный поиск может содержать меньше совпадений, чем запрашивалось. Проверить gl, hl, расположение и фильтры; необязательные поля с богатыми результатами могут отсутствовать.
Для аутентификации, баланса, сбоев формата запроса и ограничения скорости используйте общую ссылку на ошибку. Тайм-аут может все еще создать работу; проверьте существующую работу перед повторным использованием.
Ошибки и коды состояния · Когда повторно · Ограничения по ставкам
Пошаговое руководство: Выберите и уточните поиск Google
Цены
| Планы | Ставки использованияза 1 000 запросов | Подписки | Включенные кредиты за расчетный период |
|---|---|---|---|
| Оплата по использованию | 1,00 $ | Без ежемесячной платы | Пополняйте по мере необходимости |
| Micro | 0,80 $ | 49,00 $ / месяц | 1 000 кредиты ()50,00 $ из API использование, включая |
| Starter | 0,65 $ | 199,00 $ / месяц | 4 000 кредиты ()200,00 $ из API использование, включая |
| Pro | 0,60 $ | 499,00 $ / месяц | 10 000 кредиты ()500,00 $ из API использование, включая |
| Scale | 0,50 $ | 999,00 $ / месяц | 20 000 кредиты ()1 000,00 $ из API использование, включая |
| Business | 0,40 $ | 1 999,00 $ / месяц | 40 000 кредиты ()2 000,00 $ из API использование, включая |
Один тариф аккаунта. Общие кредиты для трёх продуктов. Использование, покрытое включёнными кредитами, повторно не оплачивается.
Текущие цены и лимиты плана