Migra de v1 a v2

Última actualización: 6 de diciembre de 2022

Migra tu aplicación

La migración de v1 a v2 requiere actualizar tus URLs de extremo para llamar a v2 y actualizar tu aplicación a fin de que tenga en cuenta los cambios rotundos.

Actualiza tus llamadas a la API de la versión 1 a la v2

Si quieres usar v2 en lugar de v1, debes actualizar tus solicitudes para usar extremos nuevos de v2.

Por ejemplo, para llamar al método advertisers.get con la versión 1, usarías la siguiente URL:

GET https://displayvideo.googleapis.com/v1/advertisers/advertiserId

Para v2, 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, utiliza la versión más reciente de la biblioteca cliente y actualiza tu configuración para usar v2.

Realiza los cambios necesarios

Presentamos varios cambios rotundos en la versión 2. Revisa las siguientes instrucciones y realiza los cambios necesarios que sean relevantes para tu uso actual de la API de Display & Video 360.

Actualizar las llamadas a los métodos de segmentación

• Algunos tipos de segmentación ahora se asignan mediante valores de enumeración en lugar de los IDs de opciones de segmentación. Por ejemplo, los dispositivos tablet ahora se segmentan directamente con la enumeración DEVICE_TYPE_TABLET DeviceType, en lugar del ID de la opción de segmentación del servicio targetingTypes.targetingOptions. Las versiones de cadena de estas enumeraciones se representan en el nuevo campo assignedTargetingOptionIdAlias en estos recursos AssignedTargetingOption y se pueden usar cuando se recupera o borra la segmentación existente. El valor assignedTargetingOptionId de estos recursos AssignedTargetingOption no cambió.

  Actualiza las llamadas que administran los siguientes tipos de segmentación para usar valores enum:

  • TARGETING_TYPE_AGE_RANGE
  • TARGETING_TYPE_CONTENT_INSTREAM_POSITION
  • TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION
  • TARGETING_TYPE_DEVICE_TYPE
  • TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
  • TARGETING_TYPE_ENVIRONMENT
  • TARGETING_TYPE_EXCHANGE
  • TARGETING_TYPE_GENDER
  • TARGETING_TYPE_HOUSEHOLD_INCOME
  • TARGETING_TYPE_NATIVE_CONTENT_POSITION
  • TARGETING_TYPE_OMID
  • TARGETING_TYPE_PARENTAL_STATUS
  • TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
  • TARGETING_TYPE_VIDEO_PLAYER_SIZE
  • TARGETING_TYPE_VIEWABILITY

• Se reemplazó el método advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions por el método advertisers.lineItems.bulkEditAssignedTargetingOptions.

• Se reemplazó el método advertisers.lineItems.bulkListLineItemAssignedTargetingOptions por el método advertisers.lineItems.bulkListAssignedTargetingOptions.

• Actualiza las llamadas que administran TARGETING_TYPE_PROXIMITY_LOCATION_LIST para usar un tamaño de radio y una unidad de distancia establecidos, en lugar de un valor de enumeración ProximityRadiusRange.

• Se cambió el nombre de los métodos de segmentación que recuperan o editan las 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:

  • advertisers.bulkEditAdvertiserAssignedTargetingOptions a advertisers.editAssignedTargetingOptions
  • advertisers.bulkListAdvertiserAssignedTargetingOptions a advertisers.listAssignedTargetingOptions
  • advertisers.campaigns.bulkListCampaignAssignedTargetingOptions a advertisers.campaigns.listAssignedTargetingOptions
  • advertisers.insertionOrders.bulkListInsertionOrderAssignedTargetingOptions a advertisers.insertionOrders.listAssignedTargetingOptions
  • partners.bulkEditPartnerAssignedTargetingOptions a partners.editAssignedTargetingOptions

Actualiza las llamadas al servicio de advertisers.lineItems

• Se eliminó el campo inventorySourceIds. Administra la asignación de la fuente de inventario con los recursos AssignedTargetingOption de TARGETING_TYPE_INVENTORY_SOURCE.

• Los siguientes valores enum LineItemWarningMessage dejaron de estar disponibles en la versión 2 y ya no se mostrarán en LineItem.warningMessages:

  • NO_POSITIVE_AUDIENCE_LIST_TARGETED
  • APP_INSTALL_NO_CONVERSION_PIXEL
  • TARGETING_REVOKED_OR_CLOSED_USER_LIST
  • APP_INSTALL_NO_OPTIMAL_BIDDING_STRATEGY
  • CREATIVE_SIZE_NOT_IN_USE_FOR_TARGETED_DEALS
  • NO_CREATIVE_FOR_TARGETED_DEALS
  • TARGETING_DEPRECATED_GEO_TARGET

• Se quitó el campo triggerId del objeto LineItemFlight y el valor LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER se quitó del tipo enum LineItemFlightDateType. v2 no admite la configuración de líneas de pedido para gastar en función de la activación de activadores manuales.

Actualiza las llamadas al servicio de 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 mencionados anteriormente, la versión 2 también incluye 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 líneas de pedido de YouTube

En la versión 2, las líneas de pedido 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 solicitud de escritura intentada que se realice a estas líneas de pedido mostrará un error. Las líneas de pedido de YouTube tendrán uno de los siguientes valores LineItemType:

• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE
• LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP
• LINE_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 que se pueden usar en lugar de solicitudes por lotes para obtener un mejor rendimiento y un consumo de cuota reducido:

• Puedes usar advertisers.lineItems.bulkUpdate a fin de establecer los mismos valores de campo para varias líneas de pedido. Por el momento, solo se admiten actualizaciones del campo entityStatus.
• Puedes usar advertisers.lineItems.bulkEditAssignedTargetingOptions para agregar o quitar las mismas opciones de segmentación asignadas en varias líneas de pedido.
• Puedes usar advertisers.lineItems.bulkListAssignedTargetingOptions para enumerar las opciones de segmentación asignadas en varias líneas de pedido.
• Puedes usar advertisers.lineItems.duplicate para crear un duplicado de una línea de pedido existente dentro del mismo pedido de inserción y copiar todas las opciones de configuración y los ajustes de segmentación.

Acceso parcial de escritura para la segmentación de pedidos de inserción

En la versión 2, puedes editar una configuración de segmentación de subconjunto para los 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_RANGE
• TARGETING_TYPE_BROWSER
• TARGETING_TYPE_CATEGORY
• TARGETING_TYPE_CHANNEL
• TARGETING_TYPE_DEVICE_MAKE_MODEL
• TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION
• TARGETING_TYPE_ENVIRONMENT
• TARGETING_TYPE_GENDER
• TARGETING_TYPE_KEYWORD
• TARGETING_TYPE_LANGUAGE
• TARGETING_TYPE_NEGATIVE_KEYWORD_LIST
• TARGETING_TYPE_OPERATING_SYSTEM
• TARGETING_TYPE_PARENTAL_STATUS
• TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION
• TARGETING_TYPE_VIEWABILITY