Migrar para uma nova versão

Novas versões da API Campaign Manager 360 são lançadas regularmente. À medida que novas versões são lançadas, as mais antigas são suspensas e, depois de um tempo, desativadas. Quando uma versão é desativada, todas as solicitações referentes a ela começam a retornar erros.

Se a versão que você está usando estiver descontinuada, faça upgrade o mais rápido possível para evitar interrupções no serviço.

Etapa 1: determinar qual versão você está usando

Você pode determinar qual versão da API está usando com as instruções a seguir. Na maioria dos casos, a API é acessada por uma das nossas bibliotecas de cliente específicas para cada linguagem ou por uma integração oficial.

Novo editor do Apps Script

As informações de versão do Apps Script são exibidas na caixa de diálogo de serviços avançados:

  1. No editor do Apps Script, clique em Adicionar um serviço .
  2. Localize a API Campaign Manager 360 na lista de serviços disponíveis.
  3. O valor selecionado no menu suspenso é a versão da API do Campaign Manager 360 em uso.

Editor legado do Apps Script

As informações de versão do Apps Script são exibidas na caixa de diálogo de serviços avançados:

  1. No editor do Apps Script, acesse Recursos > Serviços avançados do Google.
  2. Localize a API Campaign Manager 360 na lista de serviços disponíveis.
  3. O valor selecionado no menu suspenso é a versão da API do Campaign Manager 360 em uso.

C#

As informações de versão da biblioteca de cliente da Google API para .NET estão expostas nos seguintes locais:

  1. Incluídas no nome do pacote NuGet e no namespace de serviço. 
    Google.Apis.Dfareporting.v3_4
  2. Expostas usando uma propriedade pública de DfareportingService. 
    Console.WriteLine(DfareportingService.Version);

Java

As informações de versão da biblioteca de cliente da Google API para Java estão expostas nos seguintes locais:

  1. Especificado no artifactId do Maven. 
    <dependency> <groupId>com.google.apis</groupId>
<artifactId>google-api-services-dfareporting</artifactId>
<version>v3.4-rev1-1.21.0</version>
</dependency>
  2. Incluídas no nome de arquivo JAR. 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Expostas usando uma propriedade pública de Dfareporting. 
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

As informações de versão da biblioteca de cliente da API do Google para PHP são expostas usando uma propriedade pública de Google_Service_Dfareporting: 

$service = new Google_Service_Dfareporting($client) print
$service->version;

Python

A biblioteca de cliente de APIs do Google para Python (v1/v2) não recebe uma versão. A versão da API a ser usada é especificada como um argumento para o gerador de descobertas: 

discovery.build('dfareporting', 'v3.4', http=http)

Ruby

A biblioteca de cliente da API do Google para Ruby versões < 0.9 não recebe versões. A versão da API a ser usada é especificada como um argumento para o gerador de serviços: 

service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application",
:application_version => '1.0.0', :authorization => authorization } )

No caso da biblioteca de cliente da Google API para versões Ruby >= 0.9, a versão é exposta no namespace de serviço: 

Google.Apis.DfareportingV3_4

Etapa 2: determinar o status da sua versão

Confira a programação de descontinuação para determinar o status da sua versão. Se sua versão não estiver listada, significa que ela já foi desativada e não é mais compatível.

Se a sua versão estiver listada, verifique as colunas Data de suspensão e Data de desativação:

  • Se não houver datas, sua versão terá suporte total.
  • Se as datas estiverem presentes, significa que a versão usada está suspensa e será desativada na data especificada.

Se a sua versão estiver descontinuada ou tiver sido desativada, migre para uma versão mais recente para evitar interrupções no serviço. Recomendamos migrar para a versão mais recente mostrada na programação (excluindo versões Beta) para maximizar o tempo entre upgrades.

Etapa 3: fazer upgrade de versões

Para migrar para uma versão mais recente da API, atualize sua integração ou consiga uma compilação atualizada da biblioteca de cliente que você prefere. Algumas bibliotecas de cliente fornecem somente uma versão que funciona com qualquer versão da API. No entanto, outras têm versões separadas para cada versão. A lista a seguir fornece informações gerais de upgrade para as bibliotecas de cliente e integrações mais usadas.

Novo editor do Apps Script

O Google Apps Script é compatível com todas as versões da API Campaign Manager 360 e permite selecionar a versão usada em cada script. Para mudar a versão usada por um script específico:

  1. No editor do Apps Script, clique em Adicionar um serviço .
  2. Localize a API Campaign Manager 360 na lista de serviços disponíveis.
  3. Mude a versão da API Campaign Manager 360 usando o menu suspenso de versões.
  4. Clique em Adicionar para salvar as mudanças.

Editor legado do Apps Script

O Google Apps Script é compatível com todas as versões da API Campaign Manager 360 e permite selecionar a versão usada em cada script. Para mudar a versão usada por um script específico:

  1. No editor do Apps Script, acesse Recursos > Serviços avançados do Google.
  2. Localize a API Campaign Manager 360 na lista de serviços disponíveis.
  3. Mude a versão da API Campaign Manager 360 usando o menu suspenso de versões.
  4. Clique em OK para salvar as alterações.

C#

A biblioteca de cliente da API do Google para .NET fornece versões separadas para cada versão da API Campaign Manager 360, distribuídas pelo NuGet. Atualize para uma versão da biblioteca de cliente que corresponda à versão da API que você quer usar.

Para instruções de instalação detalhadas ou opções alternativas de download, consulte a documentação da biblioteca de cliente.

Java

A biblioteca de cliente da API do Google para Java fornece versões separadas para cada versão da API Campaign Manager 360, distribuídas pelo Maven. Atualize para uma versão da biblioteca de cliente que corresponda à versão da API que você quer usar.

Para instruções de instalação detalhadas ou opções alternativas de download, consulte a documentação da biblioteca de cliente.

PHP

A biblioteca de cliente da API do Google para PHP fornece versões separadas para cada versão da API Campaign Manager 360, distribuídas pelo Packagist. Atualize para uma versão da biblioteca de cliente que corresponda à versão da API que você quer usar.

Para ver instruções de instalação detalhadas ou opções alternativas de download, consulte a documentação da biblioteca de cliente.

Python

Cada versão da biblioteca de cliente da API do Google para Python (v1/v2) é compatível com todas as versões da API Campaign Manager 360. Para migrar para uma nova versão da API Campaign Manager 360, atualize a string da versão transmitida como um argumento para o gerador de descobertas: 

discovery.build('dfareporting', 'v3.4', http=http)
 Para ver instruções de instalação detalhadas ou opções alternativas de download, consulte a documentação da biblioteca de cliente.

Ruby

A biblioteca de cliente da API do Google para Ruby v0.8 e versões anteriores é compatível com todas as versões da API Campaign Manager 360. Para migrar para uma nova versão da API Campaign Manager 360, atualize a string de versão transmitida como um argumento para o gerador de serviços: 

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
 A biblioteca de cliente da API do Google para Ruby v0.9+ oferece versões separadas para cada versão da API Campaign Manager 360, distribuídas pelo RubyGems. Atualize para uma versão da biblioteca de cliente que corresponda à versão da API que você quer usar. Para ver instruções de instalação detalhadas ou opções alternativas de download, consulte a documentação da biblioteca de cliente.

REST

Se você estiver chamando a API diretamente usando HTTPS, atualize o endpoint das solicitações para usar o novo número da versão da API.

Por exemplo, ao migrar de v4 para v5, você mudaria o URL base de: 

https://dfareporting.googleapis.com/dfareporting/v4/...
 para: 
https://dfareporting.googleapis.com/dfareporting/v5/...

Etapa 4: resolver diferenças de versão

As novas versões da API são projetadas para serem compatíveis com versões anteriores sempre que possível. No entanto, algumas atualizações podem incluir mudanças interruptivas que exigem a modificação do seu código. Essas mudanças estão detalhadas nas notas da versão.

Ao migrar, revise as notas da versão de cada versão entre a atual e a que você está atualizando. Preste atenção especial às seguintes seções:

  • Novos recursos: são funcionalidades adicionadas recentemente. Elas não exigem mudanças no código para migração.
  • Desativações: funcionalidades removidas da API. A funcionalidade de substituição é indicada quando disponível.
  • Problemas conhecidos: modificações na funcionalidade atual, como campos ou métodos renomeados ou lógica de validação alterada.

Se o aplicativo usar funcionalidades listadas nas seções Desativações ou Problemas conhecidos, será necessário atualizar o código para resolver essas mudanças.

Fique por dentro

Monitore regularmente o blog para desenvolvedores do Google Ads e seja o primeiro a saber sobre lançamentos, descontinuações e encerramentos de APIs.