Перейти к основному содержимому

/3.0/ads/advise/gta/online

API docs by Redocly

Рекламные материалы (3.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Реклама

Получение GTA баннеров с обогащением

Запрос в advisor с обогащением данных. Если филиал не найден в базе, то он будет выкинут из результата. Обогащение делается не только справочными материалами, но и реклаными материалами в случае работы fallback схемы (ненастоящий GTA-баннер).

query Parameters
key
required
string

Уникальный ключ пользователя API.

Request Body schema: application/json

Запрос в формате json.

One of
banner_slot
required
string
Enum: "recovery_list" "discovery_list"

Место показа рекламы.

query
required
string [ 1 .. 1024 ] characters

Текст поискового запроса.

query_context_rubrics
Array of integers[ items ]

Контекстные категории запроса, сгруппированные по эквивалентности.

region_id
integer

Идентификатор проекта. Обладает наименьшим приоритетом среди viewport и userLocation при определении проекта.

auth_user_id
integer

Идентификатор пользователя из auth, если пользователь залогинен.

object

Местоположение пользователя. Обязателен при наличии, и если не запрещено GDPR.

locale
string = 5 characters

Локаль.

product_id
integer

Идентификатор продукта, такой же как отправляется в BSS. Если не передан, будет взят из key.

shv
string

Версия оболочки. Если не передан, будет взята версия АПИ.

Array of objects (PropPoint) = 4 items unique

Координаты вьюпорта. Может использоваться, когда для пользователя ничего неизвестно, и чтобы понять, какие РД ему показать. Порядок точек строго определён: обход против часовой стрелки, начиная с левого верхнего угла.

user_id
string <uuid>

Обязателен, если не запрещено GDPR. appInstanceId — для мобилок, обычный BSS userID для остальных продуктов.

Responses

Response Schema: application/json
required
object (ObjMeta)

Метаданные ответа

required
object (PropGtaOnline)

Request samples

Content type
application/json
Example
{
  • "banner_slot": "recovery_list",
  • "query": "string",
  • "query_context_rubrics": [
    • [
      ]
    ],
  • "region_id": 0,
  • "auth_user_id": 0,
  • "user_location": {
    • "accuracy": 0,
    • "reliable": true,
    • "lon": 55.10401153,
    • "lat": 36.75896072
    },
  • "locale": "ru_RU",
  • "product_id": 0,
  • "shv": "string",
  • "viewport": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5"
}

Response samples

Content type
application/json
{
  • "meta": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    },
  • "result": {
    • "banners": [
      ],
    • "stories": {
      }
    }
}