Migrar da v1 para a v2

Última atualização: 06/12/2022

Migrar seu aplicativo

A migração de v1 para v2 requer a atualização dos URLs de endpoint para chamar v2 e atualizando o aplicativo para considerar alterações interruptivas.

Atualizar suas chamadas de API da v1 para a v2

Para usar a v2 em vez da v1, atualize suas solicitações para usar a nova v2 endpoints.

Por exemplo, para chamar o método advertisers.get com a v1, você precisaria use o seguinte URL:

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

Para a v2, atualize o URL para o seguinte:

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

Se você estiver usando uma biblioteca de cliente para fazer solicitações à API, use a linguagem versão mais recente da biblioteca de cliente e atualizar sua configuração para usar a v2.

Faça as alterações necessárias

Estamos introduzindo várias alterações interruptivas na v2. Analise o seguinte e faça as alterações necessárias relevantes ao seu uso atual do Rede de Display e API Video 360.

Atualizar chamadas para métodos de segmentação

• Agora, alguns tipos de segmentação são atribuídos usando valores de tipo enumerado em vez de segmentação. IDs de opção. Por exemplo, os tablets agora são segmentados diretamente com o Enumeração DEVICE_TYPE_TABLET DeviceType, em vez do ID da opção de segmentação serviço targetingTypes.targetingOptions. Versões de string de esses tipos enumerados são representados assignedTargetingOptionIdAlias nestas AssignedTargetingOption e pode ser usada ao recuperar ou excluir a segmentação existente. O valor assignedTargetingOptionId destes AssignedTargetingOption recursos não foram alterados.

  Atualize as chamadas que gerenciam os seguintes tipos de segmentação para usar valores de enumeração:

  • 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

• O método advertisers.lineItems.bulkEditLineItemAssignedTargetingOptions foi substituído pelo método advertisers.lineItems.bulkEditAssignedTargetingOptions

• O método advertisers.lineItems.bulkListLineItemAssignedTargetingOptions foi substituído pelo método advertisers.lineItems.bulkListAssignedTargetingOptions

• Atualizar chamadas gerenciando TARGETING_TYPE_PROXIMITY_LOCATION_LIST para usar um tamanho de raio definido e unidade de distância em vez de Valor de enumeração ProximityRadiusRange.

• Métodos de segmentação que recuperam ou editam opções de segmentação em várias os tipos de segmentação em um único recurso pai foram renomeados.

  Atualize as chamadas para os seguintes métodos para usar os novos nomes:

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

Atualizar chamadas para o serviço advertisers.lineItems

• O campo inventorySourceIds foi removido. Gerenciar atribuição de origem de inventário usando os recursos AssignedTargetingOption de TARGETING_TYPE_INVENTORY_SOURCE.

• Os seguintes valores de tipo enumerado LineItemWarningMessage têm foi descontinuado na v2 e não será mais exibido em 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

• O campo triggerId foi removido da LineItemFlight e o O valor LINE_ITEM_FLIGHT_DATE_TYPE_TRIGGER foi removido do Tipo de enumeração LineItemFlightDateType. A v2 não oferece suporte definir itens de linha para gastar o orçamento com base na ativação de acionadores manuais.

Atualizar chamadas para o serviço customBiddingAlgorithms

customBiddingAlgorithmState e modelReadiness Os campos foram substituídos pelo campo modelDetails , que informa a prontidão e suspensão do algoritmo atual para cada anunciante que tem acesso usando uma lista de CustomBiddingModelDetails.

Alterações adicionais

Além das alterações interruptivas listadas acima, a v2 também introduz novos atributos de machine learning.

Os recursos adicionados à v2 após o lançamento inicial podem ser encontrados no nosso notas da versão.

Acesso somente leitura a itens de linha do YouTube

Na v2, os itens de linha do YouTube e suas configurações de segmentação podem ser recuperados usando os objetos advertisers.lineItems e advertisers.lineItems.targetingTypes.assignedTargetingOptions serviços, respectivamente. A API fornece acesso somente leitura, de solicitações de gravação feitas a esses itens de linha retornará um erro. YouTube os itens de linha serão de um dos seguintes LineItemType valores:

• 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

Novos métodos que melhoram a performance

Na v2, o serviço advertisers.lineItems oferece novos métodos a serem usados no lugar de solicitações em lote para uma melhor desempenho e redução do consumo de cota:

• Use advertisers.lineItems.bulkUpdate para definir o os mesmos valores de campo para vários itens de linha. Somente as atualizações feitas nos entityStatus são aceitos no momento.
• Você pode usar advertisers.lineItems.bulkEditAssignedTargetingOptions para adicionar ou remover as mesmas opções de segmentação atribuídas em várias linhas itens.
• Você pode usar advertisers.lineItems.bulkListAssignedTargetingOptions para listar as opções de segmentação atribuídas em vários itens de linha.
• Você pode usar advertisers.lineItems.duplicate para criar uma cópia. de um item de linha no mesmo pedido de inserção, copiando todos e de segmentação.

Acesso parcial de gravação para segmentação de pedidos de inserção

Na v2, é possível editar as configurações de segmentação de um subconjunto para InsertionOrder recursos usando os novos create e delete no advertisers.insertionOrders.targetingTypes.assignedTargetingOptions serviço. Os seguintes tipos de segmentação podem ser totalmente gerenciados na inserção nível do pedido:

• 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