Method: sdfdownloadtasks.create

Crea una tarea de descarga de SDF. Devuelve 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 se deben recuperar con media.download.

El estado de la operación se puede recuperar con sdfdownloadtasks.operations.get.

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

Solicitud HTTP

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

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

Cuerpo de la solicitud

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

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

enum (SdfVersion)

Obligatorio. Es la versión del SDF del archivo descargado. Si se establece en SDF_VERSION_UNSPECIFIED, se usará de forma predeterminada la versión especificada por el anunciante o socio identificado por root_id. A menos que se configure lo contrario, un anunciante hereda la versión del SDF de su socio.
Obligatorio. El ID raíz determina el contexto de la solicitud de descarga. Se debe configurar exactamente un campo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
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.
Fin de los campos mutuamente excluyentes.
Obligatorio. Son opciones que especifican los tipos y los rangos de entidades que se descargarán. Se debe configurar exactamente un campo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
parentEntityFilter

object (ParentEntityFilter)

Filtra los tipos de archivo seleccionados. Las entidades de cada archivo se filtran según un conjunto elegido de entidades de filtro. Las entidades de filtro deben ser del mismo tipo que los tipos de archivo seleccionados o de un tipo principal de estos.
idFilter

object (IdFilter)

Filtra las entidades por sus IDs.
inventorySourceFilter

object (InventorySourceFilter)

Filtra las fuentes de inventario por sus IDs.
Fin de los campos mutuamente excluyentes.

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 permiso de OAuth:

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

Para obtener más información, consulta OAuth 2.0 Overview.

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. Son los tipos de archivo que se devolverán.
filterType

enum (FilterType)

Obligatorio. Es el tipo de filtro que se usa para filtrar las entidades recuperadas.
filterIds[]

string (int64 format)

Son los IDs 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

Son los posibles tipos de archivos que se pueden descargar.

Enums
FILE_TYPE_UNSPECIFIED Es el valor predeterminado cuando el tipo no se especifica o es desconocido en esta versión.
FILE_TYPE_CAMPAIGN Es la campaña.
FILE_TYPE_MEDIA_PRODUCT Producto de medios.
FILE_TYPE_INSERTION_ORDER Pedido de inserción.
FILE_TYPE_LINE_ITEM Es la línea de pedido.
FILE_TYPE_AD_GROUP Es un grupo de anuncios de YouTube.
FILE_TYPE_AD Es un anuncio de YouTube.
FILE_TYPE_LINE_ITEM_QA Línea de pedido: Formato de QA
FILE_TYPE_AD_GROUP_QA Grupo de anuncios de YouTube: Formato de QA.

FilterType

Son los tipos posibles por los que se puede filtrar.

Enums
FILTER_TYPE_UNSPECIFIED Es el valor predeterminado cuando el tipo no se especifica o es desconocido en esta versión.
FILTER_TYPE_NONE Si se selecciona 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 Es el ID del anunciante. Si se selecciona, todos los IDs de filtro deben ser IDs de anunciante 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 especificados en CreateSdfDownloadTaskRequest.
FILTER_TYPE_MEDIA_PRODUCT_ID Es el ID del producto de medios. Si se selecciona, todos los IDs de filtro deben ser IDs de productos multimedia que pertenezcan a Advertiser o 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 pedidos 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_LINE_ITEM_QA, FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA y FILE_TYPE_AD.
FILTER_TYPE_LINE_ITEM_ID ID de artículo pedido. Si se selecciona, todos los IDs de filtro deben ser IDs de líneas de pedido que pertenezcan a Advertiser o Partner especificados en CreateSdfDownloadTaskRequest. Solo se puede usar para descargar FILE_TYPE_LINE_ITEM, FILE_TYPE_LINE_ITEM_QA,FILE_TYPE_AD_GROUP, FILE_TYPE_AD_GROUP_QA y FILE_TYPE_AD.

IdFilter

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

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

string (int64 format)

Son las campañas que se descargarán por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.
mediaProductIds[]

string (int64 format)

Productos de medios para descargar por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.
insertionOrderIds[]

string (int64 format)

Son los IDs de los pedidos de inserción que se descargarán. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.
lineItemIds[]

string (int64 format)

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

string (int64 format)

Son los IDs de los grupos de anuncios de YouTube que se descargarán. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.
adGroupAdIds[]

string (int64 format)

Son los IDs de los anuncios de YouTube que se pueden descargar. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.
lineItemQaIds[]

string (int64 format)

Opcional. Son los artículos de la línea de pedido, por ID, que se descargarán en formato de QA. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.
adGroupQaIds[]

string (int64 format)

Opcional. Son los grupos de anuncios de YouTube, por ID, para descargar en formato de QA. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest.

InventorySourceFilter

Es una opción de filtrado para filtrar entidades de Inventory Source.

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

string (int64 format)

Son las fuentes de inventario que se descargarán por ID. Todos los IDs deben pertenecer al mismo Advertiser o Partner especificado en CreateSdfDownloadTaskRequest. Déjalo vacío para descargar todas las fuentes de inventario del socio o anunciante seleccionado.