checkCampaigns
Запрос
Структура запроса в формате JSON:
{
"method": "checkCampaigns",
"params": { /* params */
"Timestamp": (string) /* required */
}
}
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / CheckCampaignsRequest (для SOAP) | |||
---|---|---|---|
Timestamp | string | Момент времени, начиная с которого проверяются изменения. Указывается в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601), например 2015-05-24T23:59:59Z . | Да |
Параметр | Тип | Описание | Обяза-тельный |
Структура params (для JSON) / CheckCampaignsRequest (для SOAP) | |||
---|---|---|---|
Timestamp | string | Момент времени, начиная с которого проверяются изменения. Указывается в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601), например 2015-05-24T23:59:59Z . | Да |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"Campaigns": [{ /* CampaignChangesItem */
"CampaignId": (long), /* required */
"ChangesIn": [( "SELF" | "CHILDREN" | "STAT" ), ... ] /* required */
}, ... ],
"Timestamp": (string) /* required */
}
}
Параметр | Тип | Описание |
Структура result (для JSON) / CheckCampaignsResponse (для SOAP) | ||
---|---|---|
Campaigns | array of CampaignChangesItem | Кампании, в которых произошли изменения. |
Timestamp | string | Момент времени, когда выполнялась проверка изменений. Выводится в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601), например 2015-05-24T23:59:59Z . Это время указывают при следующем вызове метода, чтобы проверять изменения начиная с этого момента. |
Структура CampaignChangesItem | ||
CampaignId | long | Идентификатор кампании. |
ChangesIn | array of CampaignChangesInEnum | Где именно произошли изменения:
|
Параметр | Тип | Описание |
Структура result (для JSON) / CheckCampaignsResponse (для SOAP) | ||
---|---|---|
Campaigns | array of CampaignChangesItem | Кампании, в которых произошли изменения. |
Timestamp | string | Момент времени, когда выполнялась проверка изменений. Выводится в формате YYYY-MM-DDThh:mm:ssZ (согласно ISO 8601), например 2015-05-24T23:59:59Z . Это время указывают при следующем вызове метода, чтобы проверять изменения начиная с этого момента. |
Структура CampaignChangesItem | ||
CampaignId | long | Идентификатор кампании. |
ChangesIn | array of CampaignChangesInEnum | Где именно произошли изменения:
|
Примеры
- Проверка наличия изменений в кампаниях, начиная с 02.02.2015 10:08:22 UTC
-
{ "method": "checkCampaigns", "params": { "Timestamp": "2015-02-02T10:08:22Z" } }
- Ответ
-
{ "result": { "Campaigns": [{ "CampaignId": 13243, "ChangesIn": ["SELF"] }, { "CampaignId": 13326, "ChangesIn": ["SELF","CHILDREN"] }, { "CampaignId": 14742, "ChangesIn": ["CHILDREN"] }], "Timestamp": "2015-02-02T12:24:31Z" } }
Произошли изменения в трех кампаниях: в двух изменились параметры кампании и в двух — дочерние объекты.