Идентификатор рекламодателя, для которого требуется составить список кампаний.
Параметры запроса
Параметры
pageSize
integer
Запрошенный размер страницы. Должно быть от 1 до 200 . Если не указано, по умолчанию будет 100 .
pageToken
string
Токен, идентифицирующий страницу результатов, которую должен вернуть сервер. Обычно это значение nextPageToken , возвращенное в результате предыдущего вызова метода campaigns.list . Если не указано, будет возвращена первая страница результатов.
orderBy
string
Поле, по которому сортируется список. Приемлемые значения:
displayName (по умолчанию)
entityStatus
updateTime
По умолчанию порядок сортировки — по возрастанию. Чтобы указать порядок убывания поля, к имени поля следует добавить суффикс «desc». Пример: displayName desc .
filter
string
Позволяет фильтровать по полям кампании.
Поддерживаемый синтаксис:
Выражения фильтра состоят из одного или нескольких ограничений.
Ограничения могут быть объединены логическими операторами AND или OR . Последовательность ограничений неявно использует AND .
Ограничение имеет форму {field} {operator} {value} .
Поле updateTime должно использовать операторы GREATER THAN OR EQUAL TO (>=) или LESS THAN OR EQUAL TO (<=) .
Во всех остальных полях должен использоваться оператор EQUALS (=) .
Поддерживаемые поля:
campaignId
displayName
entityStatus
updateTime (ввод в формате ISO 8601 или YYYY-MM-DDTHH:MM:SSZ )
Примеры:
Все кампании ENTITY_STATUS_ACTIVE или ENTITY_STATUS_PAUSED от рекламодателя: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
Все кампании со временем обновления, меньшим или равным 2020-11-04T18:54:47Z (формат ISO 8601): updateTime<="2020-11-04T18:54:47Z"
Все кампании со временем обновления, большим или равным 2020-11-04T18:54:47Z (формат ISO 8601): updateTime>="2020-11-04T18:54:47Z"
Длина этого поля не должна превышать 500 символов.
Токен для получения следующей страницы результатов. Передайте это значение в поле pageToken при последующем вызове метода campaigns.list чтобы получить следующую страницу результатов.