/3.0/ads/advise/gta/online/dashboard

• Реклама
  • postПолучение GTA баннеров с обогащением для dashboard

API docs by Redocly

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

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

Реклама

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

Запрос в advisor с обогащением данных. То же, что и просто online, но с предопределённым значение slot.

query Parameters

key required

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

Request Body schema: application/json

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

region_id	integer Идентификатор проекта. Обладает наименьшим приоритетом среди viewport и userLocation при определении проекта.
shv	string Версия оболочки. Если не передан, будет взята версия АПИ.
	Array of objects (PropPoint) = 4 items unique Координаты вьюпорта. Может использоваться, когда для пользователя ничего неизвестно, и чтобы понять, какие РД ему показать. Порядок точек строго определён: обход против часовой стрелки, начиная с левого верхнего угла.
user_id	string <uuid> Обязателен, если не запрещено GDPR. appInstanceId — для мобилок, обычный BSS userID для остальных продуктов.
auth_user_id	integer Идентификатор пользователя из auth, если пользователь залогинен.
	object Местоположение пользователя. Обязателен при наличии, и если не запрещено GDPR.
locale	string = 5 characters Локаль.
product_id	integer Идентификатор продукта, такой же как отправляется в BSS. Если не передан, будет взят из key.

Responses

Response Schema: application/json

required	object (PropGtaOnline)
required	object (ObjMeta) Метаданные ответа

https://catalog.api.2gis.com/3.0/ads/advise/gta/online/dashboard

Request samples

• Payload

Content type

application/json

{

• "region_id": 0,
• "shv": "string",
• "viewport": [

  • {

    • "lon": 55.10401153,
    • "lat": 36.75896072

    },
  • {

    • "lon": 55.10401153,
    • "lat": 36.75896072

    },
  • {

    • "lon": 55.10401153,
    • "lat": 36.75896072

    },
  • {

    • "lon": 55.10401153,
    • "lat": 36.75896072

    }

  ],
• "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
• "auth_user_id": 0,
• "user_location": {

  • "reliable": true,
  • "accuracy": 0,
  • "lon": 55.10401153,
  • "lat": 36.75896072

  },
• "locale": "ru_RU",
• "product_id": 0

}

Response samples

• 200
• 400
• 403
• 404
• 500

Content type

application/json

{

• "result": {

  • "banners": [

    • {

      • "region_id": "123456",
      • "segment_id": "123456",
      • "hash": "string",
      • "name_ex": {

        • "short_name": "Солнышко",
        • "primary": "Солнышко",
        • "extension": "кафе",
        • "legal_name": "ООО Солнышко",
        • "addition": "string",
        • "description": "Склад"

        },
      • "org": {

        • "id": "123456",
        • "name": "string",
        • "extension": "string",
        • "primary": "string",
        • "branch_count": "7"

        },
      • "main_rubric_id": 0,
      • "ad_attributes": {

        • "erid": [

          • "string"

          ],
        • "project_id": 0,
        • "auction_id": "185078a5-6bda-458b-bf76-91149ffd8ccc",
        • "is_ads": true,
        • "ads_id": "123456",
        • "content": {

          • "img": {

            • "value": "http://example.com",
            • "link": "http://example.com"

            },
          • "options": {

            • "images": [

              • {

                • "url": "string"

                }

              ],
            • "color": "string",
            • "logo": {

              • "img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
              • "bg_color": "#FFFFFF",
              • "bg_img_url": "https://cdn.ams.2gis.com/asdfasdfasdfasdfasdf.png",
              • "text_color": "#000000",
              • "use_default_value": true

              },
            • "actions": [

              • {

                • "type": "string",
                • "value": "string",
                • "name": "string",
                • "platforms": [

                  • null

                  ],
                • "caption": "string"

                }

              ],
            • "videos": [

              • {

                • "resources_description_url": "string"

                }

              ]

            },
          • "text": "string",
          • "text_warning": "string",
          • "html": "https://ams2-cdn.2gis.com/raws/7ea88e81-2e25-4d62-bbdb-bd1444b2528e/d1c6a03cf93b46f72e6b17912e16e7d1-1.html"

          },
        • "algorithm_id": 1,
        • "branch_id": "string",
        • "placement": 0,
        • "legal_name": "string",
        • "rubric_id": 0,
        • "banner_id": "string"

        }

      }

    ],
  • "stories": {

    • "objects": [

      • {

        • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        • "content": {

          • "slides": [

            • {

              • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
              • "body": "string",
              • "footnote": {

                • "logoUrl": "string",
                • "warning": "string",
                • "title": "string",
                • "subtitle": "string"

                },
              • "swipeInterval": 8000,
              • "template": {

                • "textPosition": "left_top"

                },
              • "backgroundUrl": "string",
              • "title": "string",
              • "rating": 0.5,
              • "button": {

                • "backgroundColor": "string",
                • "action": {

                  • "type": null,
                  • "value": null,
                  • "name": null,
                  • "platforms": [ ],
                  • "caption": null

                  }

                },
              • "video": {

                • "duration": 0,
                • "url": "string"

                }

              }

            ],
          • "preview": {

            • "backgroundUrl": "string",
            • "text": "string"

            }

          },
        • "algorithmId": 1,
        • "adsId": "123456",
        • "erid": [

          • "string"

          ],
        • "legalName": "string",
        • "orgId": "string",
        • "projectId": 0

        }

      ]

    }

  },
• "meta": {

  • "code": 200,
  • "api_version": "dev",
  • "issue_date": "string"

  }

}