Method: sdfdownloadtasks.create

Создает задачу на скачивание SDF-файла. Возвращает Operation.

Задача скачивания файла структурированных данных – это длительная асинхронная операция. Тип metadata этой операции – SdfDownloadTaskMetadata. Если запрос выполнен успешно, тип response операции – SdfDownloadTask. Ответ не будет содержать скачиваемые файлы, которые необходимо получить с помощью media.download.

Статус операции можно получить с помощью sdfdownloadtasks.operations.get.

Ошибки можно найти в error.message. Обратите внимание, что поле error.details должно быть пустым.

HTTP-запрос

POST https://displayvideo.googleapis.com/v5/sdfdownloadtasks

URL имеет синтаксис gRPC Transcoding.

Тело запроса

Ниже приведена структура данных в теле запроса.

JSON-представление 
{
  "version": enum (SdfVersion),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of mutually exclusive fields.
}
Поля
version

enum (SdfVersion)

Обязательно. Версия файла структурированных данных. Если задано значение SDF_VERSION_UNSPECIFIED, по умолчанию будет использоваться версия, указанная рекламодателем или партнером, который задан в параметре root_id. Рекламодатель наследует версию файлов структурированных данных от партнера, если не заданы другие настройки.
Обязательно. Корневой идентификатор определяет контекст запроса на скачивание. Нужно задать только одно поле. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
partnerId

string (int64 format)

Идентификатор партнера, для которого нужно скачать файл структурированных данных.
advertiserId

string (int64 format)

Идентификатор рекламодателя, для которого нужно скачать SDF-файл.
Конец взаимоисключающих полей.
Обязательно. Параметры, определяющие типы и диапазоны объектов для скачивания. Нужно задать только одно поле. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
parentEntityFilter

object (ParentEntityFilter)

Фильтрует по выбранным типам файлов. Объекты в каждом файле фильтруются по выбранному набору объектов фильтра. Объекты фильтра должны быть того же типа, что и выбранные типы файлов, или их родительского типа.
idFilter

object (IdFilter)

Фильтрует объекты по их идентификаторам.
inventorySourceFilter

object (InventorySourceFilter)

Фильтрует источники инвентаря по идентификаторам.
Конец взаимоисключающих полей.

Тело ответа

Тело ответа, полученного на запрос, содержит новый экземпляр Operation.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/display-video

Дополнительную информацию вы найдете в OAuth 2.0 Overview.

ParentEntityFilter

Вариант фильтрации, который позволяет отбирать файлы определенных типов, принадлежащие выбранному набору объектов фильтра.

JSON-представление 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Поля
fileType[]

enum (FileType)

Обязательно. Типы файлов, которые будут возвращены.
filterType

enum (FilterType)

Обязательно. Тип фильтра, используемый для фильтрации полученных объектов.
filterIds[]

string (int64 format)

Идентификаторы фильтров указанного типа. Используется для фильтрации объектов, которые нужно получить. Если тип фильтра не FILTER_TYPE_NONE, необходимо указать хотя бы один идентификатор.

FileType

Типы файлов, которые можно скачать.

Перечисления
FILE_TYPE_UNSPECIFIED Значение по умолчанию, если тип не указан или неизвестен в этой версии.
FILE_TYPE_CAMPAIGN А в этой кампании
FILE_TYPE_MEDIA_PRODUCT Медиапродукт.
FILE_TYPE_INSERTION_ORDER Заказ на размещение.
FILE_TYPE_LINE_ITEM Позиция.
FILE_TYPE_AD_GROUP Группа объявлений YouTube.
FILE_TYPE_AD Реклама на YouTube.
FILE_TYPE_LINE_ITEM_QA Позиция – формат контроля качества.
FILE_TYPE_AD_GROUP_QA Группа объявлений YouTube – формат контроля качества.

FilterType

Возможные типы, по которым можно фильтровать.

Перечисления
FILTER_TYPE_UNSPECIFIED Значение по умолчанию, если тип не указан или неизвестен в этой версии.
FILTER_TYPE_NONE Если выбран этот вариант, фильтр не будет применяться к скачиванию. Можно использовать, только если в CreateSdfDownloadTaskRequest указан Advertiser.
FILTER_TYPE_ADVERTISER_ID Идентификатор рекламодателя. Если выбран этот вариант, все идентификаторы фильтров должны быть идентификаторами рекламодателей, которые относятся к Partner, указанному в CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID Идентификатор кампании. Если выбран этот вариант, все идентификаторы фильтров должны быть идентификаторами кампаний, которые относятся к Advertiser или Partner, указанным в CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Идентификатор медиапродукта. Если выбран этот вариант, все идентификаторы фильтров должны быть идентификаторами медиапродуктов, которые относятся к Advertiser или Partner, указанным в CreateSdfDownloadTaskRequest. Можно использовать только для скачивания FILE_TYPE_MEDIA_PRODUCT.
FILTER_TYPE_INSERTION_ORDER_ID Идентификатор заказа на размещение. Если выбран этот вариант, все идентификаторы фильтров должны быть идентификаторами заказов на размещение, которые относятся к Advertiser или Partner, указанным в CreateSdfDownloadTaskRequest. Можно использовать только для скачивания следующих типов данных: FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA и FILE_TYPE_AD.
FILTER_TYPE_LINE_ITEM_ID Идентификатор позиции. Если выбран этот вариант, все идентификаторы фильтров должны быть идентификаторами позиций, которые относятся к Advertiser или Partner, указанным в CreateSdfDownloadTaskRequest. Можно использовать только для скачивания FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA и FILE_TYPE_AD.

IdFilter

Фильтр, который позволяет отбирать объекты по их идентификаторам.

JSON-представление 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ],
  "lineItemQaIds": [
    string
  ],
  "adGroupQaIds": [
    string
  ]
}
Поля
campaignIds[]

string (int64 format)

Кампании для скачивания по идентификатору. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Идентификаторы медиапродуктов, которые нужно скачать. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Заказы на размещение, которые нужно скачать, по идентификатору. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Позиции для скачивания по идентификатору. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Группы объявлений YouTube, которые нужно скачать, по идентификатору. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Объявления YouTube, которые нужно скачать по идентификатору. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
lineItemQaIds[]

string (int64 format)

Необязательное поле. Идентификаторы позиций, которые нужно скачать в формате для контроля качества. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

Необязательное поле. Группы объявлений YouTube, по идентификатору, для скачивания в формате QA. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest.

InventorySourceFilter

Фильтр для объектов источников инвентаря.

JSON-представление 
{
  "inventorySourceIds": [
    string
  ]
}
Поля
inventorySourceIds[]

string (int64 format)

Источники инвентаря, доступные для скачивания, по идентификатору. Все идентификаторы должны относиться к одному и тому же значению Advertiser или Partner, указанному в CreateSdfDownloadTaskRequest. Если вы хотите скачать все источники инвентаря для выбранного рекламодателя или партнера, оставьте это поле пустым.