Migrar da v2 para a v3

Última atualização: 31/10/2023

Migrar o aplicativo

A migração da v2 para a v3 exige a atualização dos URLs de endpoint para chamar a v3 e a atualização do aplicativo para considerar as mudanças incompatíveis.

Atualizar as chamadas de API da v2 para a v3

Para usar a v3 em vez da v2, atualize suas solicitações para usar os novos endpoints da v3.

Por exemplo, para chamar o método advertisers.get com a v2, use o seguinte URL:

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

Para a v3, atualize o URL para o seguinte:

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

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

Faça as alterações necessárias

Estamos introduzindo várias mudanças interruptivas na v3. Revise as instruções a seguir e faça as mudanças necessárias relevantes para seu uso atual da API Display & Video 360.

Atualizar chamadas que recuperam recursos do YouTube e a segmentação relacionada

• Os recursos YoutubeAdGroup e YoutubeAdGroupAd foram substituídos pelos recursos AdGroup e AdGroupAd. Esses novos recursos fornecem informações quase idênticas aos recursos da v2, mas podem usar nomes de campo ou tipos de enumeração atualizados. Na sua integração, substitua os usos dos recursos YoutubeAdGroup ou YoutubeAdGroupAd pelos recursos AdGroup e AdGroupAd e atualize as chamadas para os seguintes serviços da v2 para o serviço correspondente da v3:
  • advertisers.youtubeAdGroupAds a advertisers.adGroupAds
  • advertisers.youtubeAdGroups a advertisers.adGroups
  • advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions a advertisers.adGroups.targetingTypes.assignedTargetingOptions
• As referências a objetos YoutubeAndPartnersBiddingStrategy foram movidas para um novo campo youtubeAndPartnersBid no objeto geral BiddingStrategy. O campo biddingStrategy foi removido do objeto YoutubeAndPartnersSettings. Atualize sua integração para recuperar a estratégia de lances dos itens de linha ou grupos de anúncios do YouTube no objeto BiddingStrategy no campo bidStrategy do recurso LineItem ou AdGroup.
• O campo thirdPartyMeasurementSettings foi renomeado como thirdPartyMeasurementConfigs no objeto YoutubeAndPartnersSettings, e o objeto YoutubeAndPartnersThirdPartyMeasurementSettings foi renomeado como ThirdPartyMeasurementConfigs. Atualize sua integração para recuperar informações de configuração de métricas de terceiros usando o novo campo e objeto.

Incluir as configurações de faturamento necessárias ao criar anunciantes

billingConfig agora é um campo obrigatório no recurso Advertiser. Atualize suas solicitações de advertisers.create para verificar se esse campo está definido. As informações de faturamento padrão podem ser recuperadas para o parceiro principal usando o novo campo billingConfig do recurso Partner.

Usar novo campo para controlar a segmentação otimizada

Um novo campo booleano enableOptimizedTargeting substituiu o campo targetingExpansionLevel no objeto TargetingExpansionConfig.

Atualizar a integração do pedido de inserção para usar o novo campo de KPI

Um novo campo kpi substituiu o campo performanceGoal no recurso InsertionOrder. Esse novo campo usa um objeto Kpi em vez do objeto PerformanceGoal e usa novos campos e enums.

Remover referências a serviços e campos descontinuados

Várias entidades foram removidas na v3 para se alinhar com descontinuações de recursos anteriores:

• O serviço advertisers.manualTriggers foi removido porque os gatilhos manuais foram descontinuados.
• O campo billableOutcome foi removido do recurso InsertionOrder porque a compra com base em resultados foi descontinuada.

Alterações adicionais

Além das mudanças significativas listadas acima, a v3 também apresenta novos recursos.

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

Gerenciamento de listas de locais por proximidade

Na v3, é possível gerenciar totalmente as listas de locais de proximidade, permitindo usar o serviço advertisers.locationLists.assignedLocations para criar e excluir locais atribuídos a recursos LocationList de TARGETING_LOCATION_TYPE_PROXIMITY. Os locais são identificados usando o ID dos recursos TARGETING_TYPE_POI TargetingOption. Eles podem ser recuperados usando targetingTypes.targetingOptions.search.

Capacidade de criar algoritmos de lances personalizados com base em regras

Na v3, é possível criar e recuperar algoritmos de lances personalizados baseados em regras usando os serviços customBiddingAlgorithms, media e customBiddingAlgorithms.rules.

Esse recurso está na versão Beta e disponível apenas para parceiros na lista de permissões. Se o parceiro não estiver na lista de permissões, sua solicitação vai retornar um erro.