Method: sdfdownloadtasks.create

Crea una tarea de descarga de SDF. Muestra un Operation.

Una tarea de descarga de SDF es una operación asíncrona de larga duración. El tipo metadata de esta operación es SdfDownloadTaskMetadata. Si la solicitud se realiza correctamente, el tipo response de la operación es SdfDownloadTask. La respuesta no incluirá los archivos de descarga, que deben recuperarse con media.download. El estado de la operación se puede recuperar con sdfdownloadtask.operations.get.

Puedes encontrar cualquier error en error.message. Ten en cuenta que se espera que error.details esté vacío.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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.
}
Campos
version

enum (SdfVersion)

Obligatorio. Es la versión de SDF del archivo descargado. Si se establece como SDF_VERSION_UNSPECIFIED, se usará de forma predeterminada la versión que especifique el anunciante o socio identificado por root_id. Un anunciante hereda su versión de SDF de su socio, a menos que se configure lo contrario.
Campo de unión root_id. Obligatorio. El ID raíz determina el contexto de la solicitud de descarga. Se debe configurar exactamente un campo. Las direcciones (root_id) solo pueden ser una de las siguientes opciones:
partnerId

string (int64 format)

Es el ID del socio para el que se descargará el SDF.
advertiserId

string (int64 format)

Es el ID del anunciante para el que se descargará el SDF.
Campo de unión filtering_option. Obligatorio. Opciones que especifican los tipos de entidades y los rangos que se descargarán. Se debe configurar exactamente un campo. Las direcciones (filtering_option) solo pueden ser una de las siguientes opciones:
parentEntityFilter

object (ParentEntityFilter)

Filtros en los tipos de archivos seleccionados. Las entidades de cada archivo se filtran según un conjunto seleccionado de entidades de filtro. Las entidades de filtro deben ser del mismo tipo que los tipos de archivo seleccionados o un tipo superior de estos.
idFilter

object (IdFilter)

Filtra entidades por sus IDs.
inventorySourceFilter

object (InventorySourceFilter)

Filtra las fuentes de inventario por sus IDs.

Cuerpo de la respuesta

Si el proceso se realiza de forma correcta, el cuerpo de la respuesta contiene una instancia recién creada de Operation.

Alcances de la autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la descripción general de OAuth 2.0.

ParentEntityFilter

Es una opción de filtrado que filtra los tipos de archivos seleccionados que pertenecen a un conjunto elegido de entidades de filtro.

Representación JSON 
{
  "fileType": [
    enum (FileType)
  ],
  "filterType": enum (FilterType),
  "filterIds": [
    string
  ]
}
Campos
fileType[]

enum (FileType)

Obligatorio. Tipos de archivos que se mostrarán.
filterType

enum (FilterType)

Obligatorio. Tipo de filtro que se usa para filtrar las entidades recuperadas.
filterIds[]

string (int64 format)

Los ID del tipo de filtro especificado. Se usa para filtrar las entidades que se recuperarán. Si el tipo de filtro no es FILTER_TYPE_NONE, se debe especificar al menos un ID.

FileType

Los posibles tipos de archivos que se pueden descargar.

Enumeraciones
FILE_TYPE_UNSPECIFIED Valor predeterminado cuando el tipo no se especifica o es desconocido en esta versión.
FILE_TYPE_CAMPAIGN Campaña.
FILE_TYPE_MEDIA_PRODUCT Producto multimedia.
FILE_TYPE_INSERTION_ORDER Pedido de Inserción.
FILE_TYPE_LINE_ITEM de la línea de pedido.
FILE_TYPE_AD_GROUP Grupo de anuncios de YouTube.
FILE_TYPE_AD Anuncio de YouTube.

FilterType

Tipos posibles que se pueden filtrar.

Enumeraciones
FILTER_TYPE_UNSPECIFIED Valor predeterminado cuando el tipo no se especifica o es desconocido en esta versión.
FILTER_TYPE_NONE Si seleccionas esta opción, no se aplicará ningún filtro a la descarga. Solo se puede usar si se especifica un Advertiser en CreateSdfDownloadTaskRequest.
FILTER_TYPE_ADVERTISER_ID ID del anunciante Si se selecciona, todos los IDs de filtro deben ser IDs de anunciantes que pertenezcan al Partner especificado en CreateSdfDownloadTaskRequest.
FILTER_TYPE_CAMPAIGN_ID ID de la campaña. Si se selecciona, todos los IDs de filtro deben ser IDs de campaña que pertenezcan a los valores Advertiser o Partner especificados en CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID ID del producto de medios. Si se selecciona, todos los IDs de filtro deben ser IDs de productos multimedia que pertenezcan al Advertiser o Partner especificado en CreateSdfDownloadTaskRequest. Solo se puede usar para descargar FILE_TYPE_MEDIA_PRODUCT.
FILTER_TYPE_INSERTION_ORDER_ID Es el ID del pedido de inserción. Si se selecciona, todos los IDs de filtro deben ser IDs de pedido de inserción que pertenezcan al Advertiser o Partner especificado en CreateSdfDownloadTaskRequest. Solo se puede usar para descargar FILE_TYPE_INSERTION_ORDER, FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP y FILE_TYPE_AD.
FILTER_TYPE_LINE_ITEM_ID ID de la línea de pedido. Si se selecciona, todos los IDs de filtro deben ser IDs de líneas de pedido que pertenezcan al elemento Advertiser o Partner especificado en CreateSdfDownloadTaskRequest. Solo se puede usar para descargar FILE_TYPE_LINE_ITEM, FILE_TYPE_AD_GROUP y FILE_TYPE_AD.

IdFilter

Es una opción de filtrado que filtra entidades por sus IDs de entidad.

Representación JSON 
{
  "campaignIds": [
    string
  ],
  "mediaProductIds": [
    string
  ],
  "insertionOrderIds": [
    string
  ],
  "lineItemIds": [
    string
  ],
  "adGroupIds": [
    string
  ],
  "adGroupAdIds": [
    string
  ]
}
Campos
campaignIds[]

string (int64 format)

Campañas para descargar por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Productos multimedia para descargar por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Pedidos de inserción para descargar por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

Son las líneas de pedido que se deben descargar por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest.
adGroupIds[]

string (int64 format)

Grupos de anuncios de YouTube para descargarlos por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Anuncios de YouTube para descargar por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest.

InventorySourceFilter

Es una opción para filtrar las entidades de fuente de inventario.

Representación JSON 
{
  "inventorySourceIds": [
    string
  ]
}
Campos
inventorySourceIds[]

string (int64 format)

Fuentes de inventario que se descargarán por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner que se especifica en CreateSdfDownloadTaskRequest. Deje el campo vacío para descargar todas las fuentes de inventario del anunciante o socio seleccionado.