Русский
EnglishПоля объектов и их типы
Сервисы API работают с различными моделями данных.
Каждая модель данных содержит свой набор полей.
Списки моделей данных и полей представлены в разделе Сервисы API.
Типы полей
- int - число
- float - число с плавающей точкой
- string - строка
- date - строка с датой в формате: "yyyy-mm-dd"
- datetime - строка с датой и временем в формате: "yyyy-mm-dd hh:mm:ss"
- array - массив
- object - объект / ассоциативный массив
- set - одно или несколько значений (разделяемых запятой) из списка допустимых значений
- enum - одно значение из списка допустимых значений
- boolean - 0 или 1
- array of int - массив из чисел
- array of float - массив из чисел с плавающей точкой
- array of string - массив из строк
- array of date - массив из значений date
- array of enum - массив из значений enum
Описания часто используемых полей
| Имя поля | Название | Описание |
| id | ID объекта | ID объекта, с типом которого ведется работа. |
| project_id | ID проекта | Идентификатор проекта используется для указания проекта, с которым должна вестись работа. |
| searcher_key | ПС |
Ключ Поисковой Системы: {tpl("templates/api/searchersKeys.php")} - File template not found: templates/api/searchersKeys.php |
| region_key | Ключ региона |
Ключ региона (города, области, страны или другого территориального объекта), идентифицирующий его в сервисе Топвизор. Ключ региона является уникальным в контексте всего сервиса. |
| region_lang | Язык региона | Язык региона определяет язык интерфейса, на котором будет вестись проверка позиций. |
| region_index | Индекс региона |
Индекс региона определяет уникальный набор параметров searcher_key, region_key и region_lang. Индекс региона можно узнать в настройках регионов проекта, используя метод get/projects_2/projects. |
| volume | Частота запроса |
Частота запроса является составным полем и опредлеляется следующими характеристиками:
type может принимать следующие значения в зависимости от ПС: Яндекс:
Google:
|
Русский
English