add
Создает наборы быстрых ссылок.
Ограничения
Не более 1000 наборов быстрых ссылок в одном вызове метода.
Если у наборов все поля идентичны, то будет создан только один набор.
Запрос
Структура запроса в формате JSON:
{
"method": "add",
"params": { /* params */
"SitelinksSets": [{ /* SitelinksSetAddItem */
"Sitelinks": [{ /* Sitelink */
"Title": (string), /* required */
"Href": (string),
"Description": (string),
"TurboPageId": (long)
}, ... ] /* required */
}, ... ] /* required */
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / AddRequest (для SOAP) | |||
---|---|---|---|
SitelinksSets | array of SitelinksSetAddItem | Наборы быстрых ссылок, которые требуется добавить. | Да |
Структура SitelinksSetAddItem | |||
Sitelinks | array of Sitelink | Набор быстрых ссылок. От 1 до 8 элементов в массиве. | Да |
Структура Sitelink | |||
Title | string | Текст быстрой ссылки (не более 30 символов). Суммарная длина текстов быстрых ссылок № 1–4 — не более 66 символов. Суммарная длина текстов быстрых ссылок № 5–8 — также не более 66 символов. | Да |
Href | string | Ссылка на сайт рекламодателя (не более 1024 символов). Должна содержать протокол и доменное имя. Может содержать подстановочные переменные. Внимание. В быстрых ссылках подстановка значений переменных {campaign_id} , {ad_id} , {banner_id} , {phrase_id} гарантируется только при наличии этих же переменных в основной ссылке объявления. | Хотя бы один из параметров Href или TurboPageId (могут присутствовать оба) |
TurboPageId | long | Идентификатор Турбо-страницы. | |
Description | string | Описание быстрой ссылки (не более 60 символов) для отображения объявления в расширенном формате. | Нет |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / AddRequest (для SOAP) | |||
---|---|---|---|
SitelinksSets | array of SitelinksSetAddItem | Наборы быстрых ссылок, которые требуется добавить. | Да |
Структура SitelinksSetAddItem | |||
Sitelinks | array of Sitelink | Набор быстрых ссылок. От 1 до 8 элементов в массиве. | Да |
Структура Sitelink | |||
Title | string | Текст быстрой ссылки (не более 30 символов). Суммарная длина текстов быстрых ссылок № 1–4 — не более 66 символов. Суммарная длина текстов быстрых ссылок № 5–8 — также не более 66 символов. | Да |
Href | string | Ссылка на сайт рекламодателя (не более 1024 символов). Должна содержать протокол и доменное имя. Может содержать подстановочные переменные. Внимание. В быстрых ссылках подстановка значений переменных {campaign_id} , {ad_id} , {banner_id} , {phrase_id} гарантируется только при наличии этих же переменных в основной ссылке объявления. | Хотя бы один из параметров Href или TurboPageId (могут присутствовать оба) |
TurboPageId | long | Идентификатор Турбо-страницы. | |
Description | string | Описание быстрой ссылки (не более 60 символов) для отображения объявления в расширенном формате. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"AddResults": [{ /* ActionResult */
"Id": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ... ],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ... ]
}, ... ]
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / AddResponse (для SOAP) | ||
---|---|---|
AddResults | array of ActionResult | Результаты добавления наборов быстрых ссылок. |
Объект ActionResult | ||
Id | long | Идентификатор созданного набора быстрых ссылок. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |
Параметр | Тип | Описание |
Структура result (для JSON) / AddResponse (для SOAP) | ||
---|---|---|
AddResults | array of ActionResult | Результаты добавления наборов быстрых ссылок. |
Объект ActionResult | ||
Id | long | Идентификатор созданного набора быстрых ссылок. Возвращается в случае отсутствия ошибок, см. раздел Операции над массивом объектов. |
Warnings | array of ExceptionNotification | Предупреждения, возникшие при выполнении операции. |
Errors | array of ExceptionNotification | Ошибки, возникшие при выполнении операции. |