- Solicitud HTTP
- Cuerpo de la solicitud
- Cuerpo de la respuesta
- Alcances de la autorización
- ParentEntityFilter
- FileType
- FilterType
- IdFilter
- InventorySourceFilter
- Pruébala
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 de forma correcta, el tipo response
de la operación es SdfDownloadTask
. La respuesta no incluirá los archivos de descarga, que se deben recuperar con media.download
. El estado de operación se puede recuperar con sdfdownloadtask.operations.get
.
Puedes encontrar los errores 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 ( |
Campos | |
---|---|
version |
Obligatorio. Es la versión SDF del archivo descargado. Si se configura como |
Campo de unión root_id . Obligatorio. El ID raíz determina el contexto de la solicitud de descarga. Se debe establecer solo un campo. Las direcciones (root_id ) solo pueden ser una de las siguientes opciones: |
|
partnerId |
El ID del socio para el que se descargará el SDF. |
advertiserId |
Es el ID del anunciante para el que se descarga el SDF. |
Campo de unión filtering_option . Obligatorio. Opciones que especifican los tipos de entidades y rangos que se descargarán. Se debe establecer solo un campo. Las direcciones (filtering_option ) solo pueden ser una de las siguientes opciones: |
|
parentEntityFilter |
Filtros de los tipos de archivo seleccionados. Las entidades en cada archivo se filtran según un conjunto elegido de entidades de filtro. Las entidades del filtro deben ser del mismo tipo que los tipos de archivo seleccionados, o un tipo superior. |
idFilter |
Filtra las entidades por sus IDs. |
inventorySourceFilter |
Filtra en 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
.
Permisos de 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 archivo seleccionados que pertenecen a un conjunto determinado de entidades de filtro.
Representación JSON |
---|
{ "fileType": [ enum ( |
Campos | |
---|---|
fileType[] |
Obligatorio. Tipos de archivo que se mostrarán. |
filterType |
Obligatorio. Tipo de filtro usado para filtrar las entidades recuperadas. |
filterIds[] |
Los ID del tipo de filtro especificado. Se usa para filtrar entidades que se recuperarán. Si el tipo de filtro no es |
FileType
Tipos de archivos que se pueden descargar.
Enumeradores | |
---|---|
FILE_TYPE_UNSPECIFIED |
Valor predeterminado cuando el tipo no se especifica o se desconoce 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 |
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.
Enumeradores | |
---|---|
FILTER_TYPE_UNSPECIFIED |
Valor predeterminado cuando el tipo no se especifica o se desconoce en esta versión. |
FILTER_TYPE_NONE |
Si se selecciona, 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 al Advertiser o al Partner especificado en CreateSdfDownloadTaskRequest . |
FILTER_TYPE_MEDIA_PRODUCT_ID |
Es el ID del producto multimedia. Si se selecciona, todos los IDs de filtro deben ser IDs de productos multimedia que pertenezcan al Advertiser o al Partner especificados 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 al Partner especificados 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ínea de pedido que pertenezcan al 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
Una opción de filtrado que filtra las entidades por sus ID.
Representación JSON |
---|
{ "campaignIds": [ string ], "mediaProductIds": [ string ], "insertionOrderIds": [ string ], "lineItemIds": [ string ], "adGroupIds": [ string ], "adGroupAdIds": [ string ] } |
Campos | |
---|---|
campaignIds[] |
Campañas por descargar por ID. Todos los ID deben pertenecer al mismo |
mediaProductIds[] |
Productos multimedia para descargar por ID. Todos los ID deben pertenecer al mismo |
insertionOrderIds[] |
Pedidos de inserción para descargar por ID. Todos los ID deben pertenecer al mismo |
lineItemIds[] |
Líneas de pedido que se descargarán por ID. Todos los ID deben pertenecer al mismo |
adGroupIds[] |
Grupos de anuncios de YouTube para descargar por ID. Todos los ID deben pertenecer al mismo |
adGroupAdIds[] |
Anuncios de YouTube para descargar por ID. Todos los ID deben pertenecer al mismo |
InventorySourceFilter
Es una opción para filtrar las entidades de la fuente de inventario.
Representación JSON |
---|
{ "inventorySourceIds": [ string ] } |
Campos | |
---|---|
inventorySourceIds[] |
Fuentes de inventario que se pueden descargar por ID. Todos los ID deben pertenecer al mismo |