Última atualização: 31/10/2023
Migrar seu aplicativo
Migrar da v2 para a v3 exige a atualização dos URLs do endpoint para chamar a v3 e a atualização do aplicativo para considerar as alterações interruptivas.
Atualizar suas chamadas de API da v2 para a v3
Para usar a v3 em vez da v2, é necessário atualizar 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 dela e atualize a configuração para utilizar a v3.
Faça as alterações necessárias
Estamos introduzindo várias alterações interruptivas na v3. Leia as instruções a seguir e faça as alterações necessárias relevantes ao seu uso atual da API Display & Video 360.
Atualizar as chamadas que recuperam recursos do YouTube e a segmentação relacionada
- Os recursos
YoutubeAdGroup
eYoutubeAdGroupAd
foram substituídos pelos recursosAdGroup
eAdGroupAd
. Esses novos recursos fornecem informações quase idênticas aos recursos da v2, mas podem usar nomes de campo ou tipos de tipos enumerados atualizados. Na sua integração, substitua os usos dos recursosYoutubeAdGroup
ouYoutubeAdGroupAd
pelos recursosAdGroup
eAdGroupAd
e atualize as chamadas para os seguintes serviços da v2 para o serviço v3 correspondente:advertisers.youtubeAdGroupAds
paraadvertisers.adGroupAds
advertisers.youtubeAdGroups
paraadvertisers.adGroups
advertisers.youtubeAdGroups.targetingTypes.assignedTargetingOptions
paraadvertisers.adGroups.targetingTypes.assignedTargetingOptions
- As referências a objetos
YoutubeAndPartnersBiddingStrategy
foram movidas para um novo campoyoutubeAndPartnersBid
dentro do objetoBiddingStrategy
geral. O campobiddingStrategy
foi removido do objetoYoutubeAndPartnersSettings
. Atualize sua integração para recuperar a estratégia de lances para itens de linha ou grupos de anúncios do YouTube do objetoBiddingStrategy
no campobidStrategy
do recursoLineItem
ouAdGroup
. - O campo
thirdPartyMeasurementSettings
foi renomeado comothirdPartyMeasurementConfigs
no objetoYoutubeAndPartnersSettings
, e o objetoYoutubeAndPartnersThirdPartyMeasurementSettings
foi renomeado comoThirdPartyMeasurementConfigs
. Atualize sua integração para recuperar informações de configuração da medição 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 advertisers.create
para verificar se esse campo está definido. As informações de faturamento padrão podem
ser recuperadas para o parceiro pai por meio do novo campo Partner
recurso billingConfig
.
Usar o novo campo para controlar a segmentação otimizada
Um novo campo booleano enableOptimizedTargeting
substituiu o
campo targetingExpansionLevel
no objeto
TargetingExpansionConfig
.
Atualize 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
no lugar do objeto PerformanceGoal
e usa novos campos e tipos enumerados.
Remover referências a serviços e campos descontinuados
Várias entidades foram removidas na v3 para se alinhar às descontinuações de recursos anteriores:
- O serviço
advertisers.manualTriggers
foi removido porque os gatilhos manuais foram descontinuados. - O campo
billableOutcome
foi removido do recursoInsertionOrder
porque a compra com base em resultados foi descontinuada.
Alterações adicionais
Além das alterações interruptivas listadas acima, a v3 também introduz novos recursos.
Os recursos adicionados à v3 após o lançamento inicial podem ser encontrados nas notas da versão.
Gerenciamento da lista de locais próximos
Na v3, é possível gerenciar totalmente as listas de locais por proximidade, permitindo que você use o serviço advertisers.locationLists.assignedLocations
para criar e excluir locais atribuídos aos recursos do LocationList
TARGETING_LOCATION_TYPE_PROXIMITY
. Os locais são identificados pelo ID dos recursos TARGETING_TYPE_POI
TargetingOption
. Elas podem ser
recuperadas 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 retornará um erro.