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

• Advertising
  • postGetting GTA banners with enrichment for dashboard

API docs by Redocly

Advertising materials (3.0)

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

Advertising

Getting GTA banners with enrichment for dashboard

The request to advisor with the data enrichment. Same as a simple online, but it has a predefined slot value.

query Parameters

key required

string Unique key of API user.

Request Body schema: application/json

Query in json format.

region_id	integer Project ID. Has the lowest priority among viewport and userLocation when defining the project.
shv	string Version of the shell. If the parameter has not been passed, the current version of the API will be taken.
	Array of objects (PropPoint) = 4 items unique Viewport coordinates. Can be used when a user is unknown, in order to understand what advertisers to offer them. The order of the points is strictly defined: counter-clockwise, starting from the top left corner.
user_id	string <uuid> Obligatory, if not prohibited by GDPR. appInstanceId – for mobile apps, a regular BSS userID for other products.
auth_user_id	integer The user ID from auth if a user is logged in.
	object The location of the user. Mandatory if available, and if not prohibited by GDPR.
locale	string = 5 characters Locale.
product_id	integer The product ID, the same as the one that is sent to BSS. If it is not passed, it will be taken from the key.

Responses

Response Schema: application/json

required	object (PropGtaOnline)
required	object (ObjMeta) Response metadata

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": "Sunny",
        • "primary": "Sunny",
        • "extension": "cafe",
        • "legal_name": "LLC Sunny",
        • "addition": "string",
        • "description": "Warehouse"

        },
      • "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"

  }

}