Поля объектов

Каждый тип данных содержит свой набор полей.
Списки возможных типов данных и полей представлены в разделе Сервисы API.

Типы полей

  • int - число
  • string - строка
  • array - массив
  • set - одно или несколько значений (разделяемых запятой) из списка допустимых значений
  • enum - одно значение из списка допустимых значений
  • int boolean - 0 или 1
  • array of int - массив из чисел
  • array of string - массив из строк
  • array of enum - массив из значений enum

Описания часто используемых полей

Имя поля Название Описание
id ID объекта ID объекта, с типом которого ведется работа.
project_id ID проекта Идентификатор проекта используется для указания проекта, с которым должна вестись работа.
searcher_key ПС

Ключ Поисковой Системы:

  • 0: Yandex
  • 20: Yandex.com
  • 21: Yandex.com.tr
  • 1: Google
  • 2: go.Mail
  • 3: Sputnik
  • 4: YouTube
  • 5: Bing
  • 6: Yahoo
region_key Ключ региона

Ключ региона (города, области, страны или другого территориального объекта), идентифицирующий его в сервисе Топвизор.

Ключ региона является уникальным в контексте всего сервиса.

region_lang Язык региона Язык региона определяет язык интерфейса, на котором будет вестись проверка позиций.
region_index Индекс региона

Индекс региона определяет уникальный набор параметров searcher_key + region_key + region_lang.

Индекс региона можно узнать в настройках регионов проекта или используя метод get/positions/regionIndex.

volume Частота запроса

Частота запроса является составным полем и опредлеляется следующими характеристиками:

  • region_key - ключ региона
  • searcher_key - ключ ПС
  • type - номер формы частоты

type может принимать следующие значения в зависимости от ПС:

Яндекс:
  • 1 - Частота
  • 2 - "Частота"
  • 3 - "!Частота"
  • 5 - "[Частота]"
  • 6 - "[!Частота]"

Google:
  • 3 - Частота