Última actualización: 6 de diciembre de 2022
Migra tu aplicación
Para migrar de la v1 a la v2, debes actualizar las URLs de extremo para llamar a la v2 y actualizar tu aplicación para que tenga en cuenta los cambios rotundos.
Actualiza tus llamadas a la API de la versión 1 a la 2
Para usar la versión 2 en lugar de la 1, debes actualizar tus solicitudes para usar los nuevos extremos de la versión 2.
Por ejemplo, para llamar al método advertisers.get con v1, usarías la siguiente URL:
GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId
Para la versión 2, actualiza la URL a la siguiente:
GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId
Si usas una biblioteca cliente para realizar solicitudes a la API, usa la versión más reciente de la biblioteca cliente y actualiza la configuración para usar la versión 2.
Realiza los cambios necesarios
Presentamos varios cambios rotundos en la versión 2. Revisa las siguientes instrucciones y realiza los cambios necesarios en función del uso que ya haces de la API de Display & Video 360.
Actualiza las llamadas a los métodos de segmentación
Algunos tipos de segmentación ahora se asignan con valores de enumeración en lugar de IDs de opciones de segmentación. Por ejemplo, los dispositivos de tablet ahora se segmentan directamente con la enumeración
DeviceTypedeDEVICE_TYPE_TABLET, en lugar del ID de la opción de segmentación del serviciotargetingTypes.targetingOptions. Las versiones de cadena de estas enumeraciones se representan en el nuevo campoassignedTargetingOptionIdAliasen estos recursosAssignedTargetingOptiony se pueden usar cuando se recupera o borra la segmentación existente. El valor deassignedTargetingOptionIdde estos recursosAssignedTargetingOptionno cambió.Actualiza las llamadas que administran los siguientes tipos de segmentación para usar valores enum:
TARGETING_TYPE_AGE_RANGETARGETING_TYPE_CONTENT_INSTREAM_POSITIONTARGETING_TYPE_CONTENT_OUTSTREAM_POSITIONTARGETING_TYPE_DEVICE_TYPETARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSIONTARGETING_TYPE_ENVIRONMENTTARGETING_TYPE_EXCHANGETARGETING_TYPE_GENDERTARGETING_TYPE_HOUSEHOLD_INCOMETARGETING_TYPE_NATIVE_CONTENT_POSITIONTARGETING_TYPE_OMIDTARGETING_TYPE_PARENTAL_STATUSTARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSIONTARGETING_TYPE_VIDEO_PLAYER_SIZETARGETING_TYPE_VIEWABILITY
El método
advertisers.lineItems.bulkEditLineItemAssignedTargetingOptionsse reemplazó por el métodoadvertisers.lineItems.bulkEditAssignedTargetingOptions.El método
advertisers.lineItems.bulkListLineItemAssignedTargetingOptionsse reemplazó por el métodoadvertisers.lineItems.bulkListAssignedTargetingOptions.Se actualizaron las llamadas que administran
TARGETING_TYPE_PROXIMITY_LOCATION_LISTpara usar un tamaño de radio y una unidad de distancia establecidos en lugar de un valor de enumeraciónProximityRadiusRange.Se cambió el nombre de los métodos de segmentación que recuperan o editan opciones de segmentación en varios tipos de segmentación en un solo recurso superior.
Actualiza las llamadas a los siguientes métodos para usar sus nombres nuevos:
- De
advertisers.bulkEditAdvertiserAssignedTargetingOptionsaadvertisers.editAssignedTargetingOptions - De
advertisers.bulkListAdvertiserAssignedTargetingOptionsaadvertisers.listAssignedTargetingOptions - De
advertisers.campaigns.bulkListCampaignAssignedTargetingOptionsaadvertisers.campaigns.listAssignedTargetingOptions - De
advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptionsaadvertisers.insertionOrders.listAssignedTargetingOptions - De
partners.bulkEditPartnerAssignedTargetingOptionsapartners.editAssignedTargetingOptions
- De
Actualiza las llamadas al servicio advertisers.lineItems
- Se quitó el campo
inventorySourceIds. Administra la asignación de la fuente de inventario con los recursosAssignedTargetingOptiondeTARGETING_TYPE_INVENTORY_SOURCE. Los siguientes valores de enumeración
LineItemWarningMessagedejaron de estar disponibles en la versión 2 y ya no aparecerán enLineItem.warningMessages:NO_POSITIVE_AUDIENCE_LIST_TARGETEDAPP_INSTALL_NO_CONVERSION_PIXELTARGETING_REVOKED_OR_CLOSED_USER_LISTAPP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGYCREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALSNO_CREATIVE_FOR_TARGETED_DEALSTARGETING_DEPRECATED_GEO_TARGET
Se quitó el campo
triggerIddel objetoLineItemFlighty el valorLINE_ITEM_FLIGHT_DATE_TYPE_TRIGGERdel tipo de enumeraciónLineItemFlightDateType. La versión 2 no admite la configuración de líneas de pedido para que se inviertan en función de la activación de activadores manuales.
Actualiza las llamadas al servicio customBiddingAlgorithms
Los campos customBiddingAlgorithmState y modelReadiness
se reemplazaron por el campo modelDetails
, que proporciona los estados de preparación y suspensión del modelo de algoritmo existente para cada anunciante que tiene acceso a través de una lista de objetos CustomBiddingModelDetails.
Cambios adicionales
Además de los cambios rotundos que se mencionaron anteriormente, la versión 2 también presenta funciones nuevas.
Las funciones que se agregaron a la versión 2 después del lanzamiento inicial se pueden encontrar en nuestras notas de la versión.
Acceso de solo lectura a las unidades de anuncios de YouTube
En la versión 2, los elementos de una sola línea de YouTube y su configuración de segmentación se pueden recuperar con los servicios advertisers.lineItems y advertisers.lineItems.targetingTypes.assignedTargetingOptions, respectivamente. La API proporciona acceso de solo lectura, lo que significa que cualquier intento de solicitud de escritura que se realice a estos elementos de una sola línea mostrará un error. Los elementos de una sola línea de YouTube tendrán uno de los siguientes valores de LineItemType:
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTIONLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIOLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLELINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACHLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLELINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOPLINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE
Nuevos métodos que permiten un mejor rendimiento
En la versión 2, el servicio advertisers.lineItems proporciona métodos nuevos para usar en lugar de las solicitudes por lotes para mejorar el rendimiento y reducir el consumo de cuota:
- Puedes usar
advertisers.lineItems.bulkUpdatepara establecer los mismos valores de campo para varias líneas de pedido. Por el momento, solo se admiten actualizaciones del campoentityStatus. - Puedes usar
advertisers.lineItems.bulkEditAssignedTargetingOptionspara agregar o quitar las mismas opciones de segmentación asignadas en varios elementos de línea. - Puedes usar
advertisers.lineItems.bulkListAssignedTargetingOptionspara enumerar las opciones de segmentación asignadas en varias líneas de pedido. - Puedes usar
advertisers.lineItems.duplicatepara crear un duplicado de un elemento de una sola línea existente dentro del mismo orden de inserción y copiar todos los parámetros de configuración y de segmentación.
Acceso de escritura parcial para la segmentación de pedidos de inserción
En la versión 2, puedes editar la configuración de segmentación de un subconjunto de recursos InsertionOrder con los nuevos métodos create y delete en el servicio advertisers.insertionOrders.targetingTypes.assignedTargetingOptions. Los siguientes tipos de segmentación se pueden administrar por completo a nivel del pedido de inserción:
TARGETING_TYPE_AGE_RANGETARGETING_TYPE_BROWSERTARGETING_TYPE_CATEGORYTARGETING_TYPE_CHANNELTARGETING_TYPE_DEVICE_MAKE_MODELTARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSIONTARGETING_TYPE_ENVIRONMENTTARGETING_TYPE_GENDERTARGETING_TYPE_KEYWORDTARGETING_TYPE_LANGUAGETARGETING_TYPE_NEGATIVE_KEYWORD_LISTTARGETING_TYPE_OPERATING_SYSTEMTARGETING_TYPE_PARENTAL_STATUSTARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSIONTARGETING_TYPE_VIEWABILITY