Method: sdfdownloadtasks.create

Создает задачу загрузки SDF. Возвращает Operation .

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

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

HTTP-запрос

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

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные следующей структуры:

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

  // Union field root_id can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field root_id.

  // Union field filtering_option can be only one of the following:
  "parentEntityFilter": {
    object (ParentEntityFilter)
  },
  "idFilter": {
    object (IdFilter)
  },
  "inventorySourceFilter": {
    object (InventorySourceFilter)
  }
  // End of list of possible types for union field filtering_option.
}
Поля
version

enum ( SdfVersion )

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

Поле объединения root_id . Необходимый. Корневой идентификатор определяет контекст запроса на загрузку. Должно быть задано ровно одно поле. root_id может быть только одним из следующих:
partnerId

string ( int64 format)

Идентификатор партнера, для которого необходимо загрузить SDF.

advertiserId

string ( int64 format)

Идентификатор рекламодателя, для которого необходимо загрузить SDF.

Поле объединения filtering_option . Необходимый. Параметры, определяющие типы и диапазоны объектов для загрузки. Должно быть задано ровно одно поле. filtering_option может быть только одним из следующих:
parentEntityFilter

object ( ParentEntityFilter )

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

idFilter

object ( IdFilter )

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

inventorySourceFilter

object ( InventorySourceFilter )

Фильтрует источники инвентаря по их идентификаторам.

Тело ответа

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

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

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

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

Дополнительную информацию см. в обзоре OAuth 2.0 .

РодительскийEntityFilter

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

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

enum ( FileType )

Необходимый. Типы файлов, которые будут возвращены.

filterType

enum ( FilterType )

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

filterIds[]

string ( int64 format)

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

тип файла

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

Перечисления
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.

Тип фильтра

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

Перечисления
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_AD_GROUP и FILE_TYPE_AD .
FILTER_TYPE_LINE_ITEM_ID Идентификатор позиции. Если этот параметр выбран, все идентификаторы фильтров должны быть идентификаторами позиций, принадлежащими Advertiser или Partner , указанному в CreateSdfDownloadTaskRequest . Можно использовать только для загрузки FILE_TYPE_LINE_ITEM , FILE_TYPE_AD_GROUP и FILE_TYPE_AD .

ИдФильтер

Параметр фильтрации, который фильтрует объекты по их идентификаторам.

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

string ( int64 format)

Кампании для скачивания по ID. Все идентификаторы должны принадлежать одному 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 .

ИнвентарьИсточникФильтр

Параметр фильтрации для фильтрации по объектам источника инвентаря.

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

string ( int64 format)

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