check

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

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

Как проверять наличие изменений

Запрос

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

{
  "method": "check",
  "params": { /* params */
    "CampaignIds": [(long), ... ],
    "AdGroupIds": [(long), ... ],
    "AdIds": [(long), ... ],
    "Timestamp": (string), /* required */
    "FieldNames": [( "CampaignIds" | "AdGroupIds" | "AdIds" | "CampaignsStat" ), ... ] /* required */
  }
}

Параметр	Тип	Описание	Обязательный
Структура params (для JSON) / CheckRequest (для SOAP)
`CampaignIds`	array of long	Идентификаторы кампаний, для которых требуется проверить наличие изменений. От 1 до 3000 элементов в массиве.	Либо `CampaignIds`, либо `AdGroupIds`, либо `AdIds`
`AdGroupIds`	array of long	Идентификаторы групп, для которых требуется проверить наличие изменений. От 1 до 10 000 элементов в массиве.
`AdIds`	array of long	Идентификаторы объявлений, для которых требуется проверить наличие изменений. От 1 до 50 000 элементов в массиве.
`FieldNames`	array of FieldNamesEnum	Наличие каких изменений следует проверить: CampaignIds — изменения в параметрах кампаний (изменения в дочерних группах, объявлениях и фразах не учитываются); CampaignsStat — корректировка статистики кампании (как правило, в связи с фильтрацией недобросовестных кликов); AdGroupIds — изменения в группах объявлений и ключевых фразах (изменения в объявлениях не учитываются); AdIds — изменения в объявлениях. Наличие изменений проверяется для всех связанных объектов. Например, если указан входной параметр `AdIds` и значение CampaignIds в массиве `FieldNames`, то проверяется наличие изменений в кампаниях, которым принадлежат указанные объявления. Подробнее см. Примеры ниже.	Да
`Timestamp`	string	Момент времени, начиная с которого проверяются изменения. Указывается в формате `YYYY-MM-DDThh:mm:ssZ` (согласно ISO 8601), например `2015-05-24T23:59:59Z`.	Да

Примечание

Параметры CampaignIds, AdGroupIds, AdIds являются взаимоисключающими: только один из них может присутствовать в запросе.

Ответ

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

{
  "result": { /* result */
   "Modified": {  /* CheckResponseModified */
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "AdIds": [(long), ... ],
      "CampaignsStat": [{  /* CampaignStatItem */
        "CampaignId": (long), /* required */
        "BorderDate": (string) /* required */
       }, ... ]
   },
   "NotFound": {  /* CheckResponseIds */
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "AdIds": [(long), ... ]
   },
   "Unprocessed": {  /* CheckResponseIds */
      "CampaignIds": [(long), ... ],
      "AdGroupIds": [(long), ... ],
      "AdIds": [(long), ... ]
   },
   "Timestamp": (string)
  }
}

Параметр	Тип	Описание
Структура result (для JSON) / CheckResponse (для SOAP)
`Modified`	CheckResponseModified	Объекты, указанные в запросе или связанные с ними, в которых произошли изменения.
`NotFound`	CheckResponseIds	Объекты, указанные в запросе, которые не были найдены.
`Unprocessed`	CheckResponseIds	Объекты, указанные в запросе, которые не были обработаны. Для этих объектов необходимо сделать отдельный запрос.
`Timestamp`	string	Момент времени, когда выполнялась проверка изменений. Выводится в формате `YYYY-MM-DDThh:mm:ssZ` (согласно ISO 8601), например `2015-05-24T23:59:59Z`. Это время указывают при следующем вызове метода, чтобы проверять изменения начиная с этого момента.
Структура CheckResponseModified
`CampaignIds`	array of long	Идентификаторы кампаний, в параметрах которых произошли изменения (изменения в дочерних группах и объявлениях не учитываются).
`AdGroupIds`	array of long	Идентификаторы групп, в которых произошли изменения (учитываются также изменения во фразах, изменения в объявлениях не учитываются).
`AdIds`	array of long	Идентификаторы объявлений, в которых произошли изменения.
`CampaignsStat`	array of CampaignStatItem	Кампании, в статистике которых произошли корректировки.
Структура CampaignStatItem
`CampaignId`	long	Идентификатор кампании.
`BorderDate`	string	Дата актуальности статистики. Выводится для кампаний, статистика по которым была скорректирована в течение проверяемого периода. Как правило, корректировка статистики связана с фильтрацией недобросовестных кликов и приводит к уменьшению количества кликов и увеличению баланса кампании. Сформированные ранее отчеты по статистике могут оказаться неактуальными, если в них отражены данные после даты BorderDate. Такие отчеты рекомендуется переформировать.
Структура CheckResponseIds
`CampaignIds`	array of long	Идентификаторы кампаний.
`AdGroupIds`	array of long	Идентификаторы групп.
`AdIds`	array of long	Идентификаторы объявлений.

Примеры

Проверка наличия изменений в группах и ключевых фразах указанных кампаний

{
  "method": "check",
  "params": {
    "CampaignIds": [13765,13767],
    "FieldNames": ["AdGroupIds"],
    "Timestamp": "2015-02-02T10:08:22Z"
  }
}

Ответ:

{
  "result": {
    "Modified": {
      "AdGroupIds": [23543,23544,23874]
    }
    "Timestamp": "2015-02-02T12:23:11Z"
  }
}

Комментарий: были изменены три группы (или ключевые фразы в этих группах).

Проверка наличия изменений в заданных кампаниях и их дочерних группах и объявлениях

{
  "method": "check",
  "params": {
    "CampaignIds": [13765,13766,13767,13769],
    "FieldNames": ["CampaignIds","CampaignsStat","AdGroupIds","AdIds"],
    "Timestamp": "2015-02-02T10:08:22Z"
  }
}

Ответ:

{
  "result": {
    "Modified": {
      "CampaignIds": [13767,13769],
      "AdGroupIds": [23543,23544,23874],
      "AdIds": [33651,33921,34028,34106],
      "CampaignsStat": [
        {
          "CampaignId": 13767,
          "BorderDate": "2015-01-28"
        }
      ]
    },
    "NotFound": {
      "CampaignIds": [13765]
    },
    "Timestamp": "2015-02-02T12:23:11Z"
  }
}

Комментарий: были изменены две кампании, три дочерние группы (или ключевые фразы в этих группах), четыре дочерних объявления. В одной кампании была скорректирована статистика. Одна кампания не найдена.

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

{
  "method": "check",
  "params": {
    "AdIds": [33651,33732,34028,34029],
    "FieldNames": ["CampaignIds","AdGroupIds","AdIds"],
    "Timestamp": "2015-02-02T10:08:22Z"
  }
}

Ответ:

{
  "result": {
    "Modified": {
      "CampaignIds": [13767],
      "AdGroupIds": [],
      "AdIds": [33651,34028]
    },
    "NotFound": {
      "AdIds": [33732]
    },
    "Timestamp": "2015-02-02T12:25:19Z"
  }
}

Комментарий: были изменены два объявления и одна кампания, которой принадлежит одно или несколько объявлений, указанных в запросе. Одно объявление не найдено.

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

{
  "method": "check",
  "params": {
    "AdGroupIds": [23764],
    "FieldNames": ["CampaignIds","AdGroupIds","AdIds"],
    "Timestamp": "2015-02-02T10:08:22Z"
  }
}

Ответ:

{
  "result": {
    "Modified": {
      "CampaignIds": [],
      "AdGroupIds": [],
      "AdIds": [33651,34028]
    },
    "Timestamp": "2015-02-02T12:25:19Z"
  }
}

Комментарий: в группе (или ключевых фразах этой группы), а также в родительской кампании изменений не было. Были изменены два объявления из группы.

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

{
  "method": "check",
  "params": {
    "AdGroupIds": [23543,23544,23874],
    "FieldNames": ["CampaignIds","AdGroupIds","AdIds"],
    "Timestamp": "2015-02-02T12:25:19Z"
  }
}

Ответ:

{
  "result": {
    "Modified": {
      "CampaignIds": [13767],
      "AdGroupIds": [23543],
      "AdIds": [33651,33732,34028,34029,33921,34028,34106]
    },
    "Unprocessed": {
      "AdGroupIds": [23544,23874]
    },
    "Timestamp": "2015-02-02T14:51:40Z"
  }
}

Комментарий: изменилась одна группа (или ключевые фразы в этой группе), кампания, которой принадлежит эта группа, и 7 объявлений группы. Две группы не были обработаны: возможно, в них тоже были изменения, необходим отдельный запрос.

Была ли статья полезна?

checkCampaigns

Clients: управление параметрами рекламодателя и настройками пользователя