Fazer upgrade para a versão mais recente

Periodicamente, convém fazer upgrade de uma versão principal mais antiga da API Google Ads para uma versão principal mais nova. Pode ser porque uma versão será desativada ou porque você quer usar um recurso novo. Recomendamos que você sempre atualize para a versão mais recente.

Confira nossa programação de descontinuação para planejar seus upgrades. Consulte nosso guia de controle de versões para saber como ele funciona.

Confira uma lista de verificação para começar o processo de upgrade:

  1. Seu endpoint será alterado quando você alterar as versões principais. Atualize suas bibliotecas de cliente para usar o endpoint mais recente.
  2. Leia as notas da versão para conferir as mudanças introduzidas em cada versão.
  3. Confira nas tabelas abaixo as áreas específicas de foco para a versão para a qual você está fazendo upgrade.

Para uma visão geral abrangente das mudanças com base em uma diferença entre os protos das duas versões, consulte a tabela de diferenças.

v16 a v17

Mudanças nos serviços e componentes deles
GoogleAdsService Solicitações Search e SearchStream

O erro quando sua solicitação é limitada por ser muito caro será QuotaError.EXCESSIVE_SHORT_TERM_QUERY_RESOURCE_CONSUMPTION ou QuotaError.EXCESSIVE_LONG_TERM_QUERY_RESOURCE_CONSUMPTION em vez de QuotaError.RESOURCE_EXHAUSTED. Confira a postagem do blog para mais detalhes.

Solicitações GoogleAdsService Search.

Transmitir um page_size para GoogleAdsService.Search vai resultar em um erro RequestError.PAGE_SIZE_NOT_SUPPORTED.

Campaign e Ad

As campanhas com AdvertisingChannelType de DISCOVERY agora terão um AdvertisingChannelType de DEMAND_GEN.

Além disso, alguns anúncios mudam de tipo e nomes de campo para a geração de relatórios:

  • DISCOVERY_MULTI_ASSET_ADD vai se tornar DEMAND_GEN_MULTI_ASSET_ADD, e o campo de relatório correspondente ad_group_ad.ad.discovery_multi_asset_ad vai passar a ser ad_group_ad.ad.demand_gen_multi_asset_ad
  • DISCOVERY_CAROUSEL_AD vai se tornar DEMAND_GEN_CAROUSEL_AD, e o campo de relatório correspondente ad_group_ad.ad.discovery_carousel_ad vai passar a ser ad_group_ad.ad.demand_gen_carousel_ad
  • DISCOVERY_VIDEO_RESPONSIVE_AD vai se tornar DEMAND_GEN_VIDEO_RESPONSIVE_AD, e o campo de relatório correspondente ad_group_ad.ad.discovery_video_responsive_ad vai passar a ser ad_group_ad.ad.demand_gen_video_responsive_ad

AdService O endpoint GetAd será removido. Assim, o AdService fica alinhado a outros serviços da API Google Ads. Consulte nosso guia sobre como recuperar objetos para saber a maneira recomendada de buscar anúncios e outros tipos de recursos.
CustomerLifecycleGoal e CampaignLifecycleGoal A maneira como você gerencia segmentos para metas de ciclo de vida foi reformulada. Consulte a seção Segmentar seus públicos-alvo da documentação de metas do ciclo de vida para ter uma visão geral completa.
ProductLink Ao executar uma solicitação de pesquisa GoogleAdsService ou de fluxo de pesquisa para product_link, agora é possível selecionar apenas os campos relacionados a um produto vinculado. A seleção de vários campos de diferentes produtos vinculados resultará em um erro QuotaError.PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE.
Relatório O campo metrics.sk_ad_network_conversion_value foi renomeado como metrics.sk_ad_network_fine_conversion_value.

v15 a v16

Mudanças nos serviços e componentes deles
AccountLink Os links data_partner e google_ads em linked_account foram removidos. Use ProductLinkService e ProductLinkInvitationService.
CampaignLifecycleGoal Ao atualizar um CampaignLifecycleGoal já existente, você emitiria uma operação create com requisitos específicos. Agora você pode emitir uma operação update como acontece com outros tipos de recursos.
Relatórios de erros Dois casos em que o erro genérico ContextError.OPERATION_NOT_PERMITTED_FOR_CONTEXT foi retornado agora resultam em mensagens de erro mais específicas:
  • CampaignError.CANNOT_LINK_TO_COMPARISON_SHOPPING_SERVICE_ACCOUNT
  • CampaignError.CANNOT_TARGET_NETWORK_FOR_COMPARISON_SHOPPING_SERVICE_LINKED_ACCOUNTS
AudienceInsightsAttributeMetadata O campo score foi removido.
KeywordMatchTypeRecommendation Se o tipo de correspondência de palavra-chave não for definido, a API vai retornar UNSPECIFIED em vez de UNKNOWN no campo recommended_match_type.

v14 para v15

Mudanças nos serviços e componentes deles
AssetGroupListingGroupFilter O campo de enumeração vertical foi renomeado para feed_type.
MediaFileService O serviço foi removido porque não é mais necessário. Confira a mudança de ImageAdInfo abaixo.
ImageAdInfo O campo media_file foi substituído por image_asset.
MerchantCenterLinkService O serviço foi substituído por ProductLinkInvitationService e ProductLinkService.
Campaign.ShoppingSetting O campo sales_country foi removido. As informações agora são retornadas no campo feed_label.
ProductBiddingCategoryConstant Substituído por ProductCategoryConstant. Vários campos foram renomeados corretamente. Confira as próximas três mudanças abaixo.
ListingDimensionInfo O campo product_bidding_category foi substituído por product_category.
ListingGroupFilterDimension O campo product_bidding_category foi substituído por product_category.
Relatório shopping_performance_view Os seguintes campos de segmento:
  • product_bidding_category_level1
  • product_bidding_category_level2
  • product_bidding_category_level3
  • product_bidding_category_level4
  • product_bidding_category_level5
foram substituídos por:
  • product_category_level1
  • product_category_level2
  • product_category_level3
  • product_category_level4
  • product_category_level5
Campaign.shopping_setting Removemos o suporte para criação de campanhas de pesquisa com esse campo.
CampaignCriterion.listing_scope Removemos o suporte para criação de campanhas de pesquisa com este campo.
Relatório sk_ad_network_conversions O metrics.sk_ad_network_conversions foi substituído por metrics.sk_ad_network_installs.
OfflineConversionClientSummary O campo offline_conversion_client_summaries foi movido de Customer para um recurso de nível superior que você pode consultar separadamente.

Altere sua consulta de:

SELECT customer.offline_conversion_client_summaries
FROM customer
para:
SELECT
  offline_conversion_upload_client_summary.client,
  offline_conversion_upload_client_summary.status,
  offline_conversion_upload_client_summary.total_event_count,
  offline_conversion_upload_client_summary.successful_event_count,
  offline_conversion_upload_client_summary.last_upload_date_time,
  ...
FROM offline_conversion_upload_client_summary

Use o criador de consultas para explorar a lista de campos disponíveis para seleção e filtragem.

OfflineConversionUploadAlert Renomeada como OfflineConversionAlert.
OfflineConversionUploadError Renomeada como OfflineConversionError.
AdNetworkType Os tipos enumerados YOUTUBE_SEARCH e YOUTUBE_WATCH foram mesclados em um único tipo enumerado: YOUTUBE.