get

Возвращает наборы минус-фраз.

Узнайте больше

Запрос

Структура запроса в формате JSON:

{
  "method": "get",
  "params": { /* params */
    "SelectionCriteria": {  /* IdsCriteria */
      "Ids": [(long), ... ] /* required */
    },
    "FieldNames": [( "Id" | "Name" | "NegativeKeywords" | "Associated" ), ... ] /* required */
    "Page": {  /* LimitOffset */
      "Limit": (long),
      "Offset": (long)
    }
  }
}

Параметр

Тип

Описание

Обязательный

Структура params (для JSON) / GetRequest (для SOAP)

SelectionCriteria

IdsCriteria

Критерий отбора наборов минус-фраз. Если не указан, будут получены все наборы минус-фраз, принадлежащие рекламодателю.

Нет

FieldNames

array of NegativeKeywordSharedSetFieldEnum

Имена параметров верхнего уровня, которые требуется получить.

Да

Page

LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет

Структура IdsCriteria

Ids

array of long

Отбирать наборы минус-фраз с указанными идентификаторами. Не более 30 элементов в массиве.

Да

Ответ

Структура ответа в формате JSON:

{
  "result": { /* result */
    "NegativeKeywordSharedSets": [{  /* NegativeKeywordSharedSetGetItem */
      "Id": (long),
      "Name": (string),
      "NegativeKeywords": [(string), ... ],
      "Associated": ( "YES" | "NO" )
    }, ... ],
    "LimitedBy": (long)
  }
}

Параметр

Тип

Описание

Структура result (для JSON) / GetResponse (для SOAP)

NegativeKeywordSharedSets

array of NegativeKeywordSharedSetGetItem

Наборы минус-фраз.

LimitedBy

long

Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.

Структура NegativeKeywordSharedSetGetItem

Id

long

Идентификатор набора минус-фраз.

Name

string

Название набора минус-фраз (не более 255 символов).

NegativeKeywords

array of string

Массив минус-фраз.

Минус-фразу следует указывать без минуса перед первым словом.

Не более 7 слов в минус-фразе. Длина каждого слова — не более 35 символов. Суммарная длина минус-фраз в массиве — не более 4096 символов. Пробелы, дефисы и операторы не учитываются в суммарной длине.

Associated

YesNoEnum

Привязан ли набор минус-фраз хотя бы к одной группе объявлений.
Предыдущая
delete
Следующая
update