Русский
Выбрать
English
Данный параметр предназначен только для операций чтения и добавления, т.е. для работы с операторами
get и add.
В некоторых методах этот параметр может применяться в связке с операцией редактирования для получения изменяемых объектов.
Подобное поведение дополнительно описывается в документации к данному методу.
Выбор возвращаемых полей (fields)
По умолчанию сервис возвращает стандартный набор полей элементов. Например, только их ID.
Чтобы обеспечить хорошую скорость работы API и своего приложения, необходимо указывать только те поля, которые необходимы для конкретной задачи.
Список всех доступных полей описан в документации к сервису.
Примеры
Для примера получим список ключевых слов, добавленных в ядро проекта NN.
Также будут получены их ID и имена их групп.
Запрос
POST /v2/json/get/keywords_2/keywords/{"project_id": /* id проекта (число) */}Результат
{"result":[{"id":"80764821","name":"тестовый запрос 1"},{"id":"80764822","name":"тестовый запрос 2"},{"id":"80764823","name":"тестовый запрос 3"},{"id":"80764824","name":"тестовый запрос 4"},{"id":"80764825","name":"тестовый запрос 5"}]}
Запрос
POST /v2/json/get/keywords_2/keywords/{"project_id": /* id проекта (число) */, "fields":["id","name","group_name"]}Результат
{"result":[{"id":"80764821","name":"тестовый запрос 1","group_name":"Группа 1"},{"id":"80764822","name":"тестовый запрос 2","group_name":"Группа 1"},{"id":"80764823","name":"тестовый запрос 3","group_name":"Группа 1"},{"id":"80764824","name":"тестовый запрос 4","group_name":"Группа 2"},{"id":"80764825","name":"тестовый запрос 5","group_name":"Группа 2"}]}
Пример SDK
Для примера получим список ключевых слов, добавленных в ядро проекта NN.
Также будут получены их ID и имена их групп.
<?php
$projectId = '%NN%'; // ID of your project
$TVSession = new TV\Session();
$selectorKeywords = new TV\Pen($TVSession, 'get', 'keywords_2', 'keywords');
$selectorKeywords->setData(['project_id' => $project_id]);
$selectorKeywords->setFields(['id', 'name', 'group_name']);
$page = $selectorKeywords->exec();
if(is_null($page->getResult())) return var_dump($page->getErrors());
// $page - array of keywords
foreach($page->getResult() as $resultItem){
var_dump($resultItem);
}