Esta página foi traduzida pela API Cloud Translation.

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 para essa versão começam a retornar erros.

Se uma versão da API que você está usando for descontinuada, será necessário migrar para uma versão mais recente antes da data programada de desativação. Este guia fornece detalhes sobre como determinar se a versão da API usada está obsoleta e apresenta as etapas de migração recomendadas.

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

Se você tiver um aplicativo e suspeitar que ele esteja usando uma versão descontinuada da API Campaign Manager 360, primeiro verifique qual versão específica está sendo usada. 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. As instruções para encontrar a versão da API em uso por essas bibliotecas de cliente e integrações podem ser encontradas abaixo:

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:

No editor do Apps Script, clique em Add a service .
Localize a API Campaign Manager 360 na lista de serviços disponíveis.
O valor selecionado no menu suspenso é a versão da API 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:

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

C#

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

Incluído no nome do pacote nuget e no namespace de serviço.
```
Google.Apis.Dfareporting.v3_4
```
Expostas por uma propriedade pública de DfareportingService.
```
Console.WriteLine(DfareportingService.Version);
```

Java

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

Especificado no maven artifactId.

<dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v3.4-rev1-1.21.0</version>
</dependency>

Incluídas no nome de arquivo JAR.

google-api-services-dfareporting-v3.4-rev1-1.21.0.jar

Expostas por 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 por uma propriedade pública de Google_Service_Dfareporting:

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

Python

Não é possível controlar a versão da biblioteca de cliente da API do Google para Python. A versão da API a ser usada é especificada como um argumento para o criador de descobertas:

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

Ruby

A biblioteca de cliente da API do Google para versões do Ruby anteriores à versão 0.9 não tem controle de versões. A versão da API a ser usada é especificada como um argumento para o construtor do serviço:

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

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

Google.Apis.DfareportingV3_4

Anote a versão que você está usando, porque ela será necessária mais tarde.

Etapa 2: determinar o status da versão

A programação da descontinuação mostra o status de cada versão que é compatível. Encontre a versão na lista e determine o status dela da seguinte maneira:

Se não houver datas listadas nas colunas Data de suspensão e Data de desativação, significa que você está usando uma versão totalmente compatível.
Se as datas estiverem listadas, isso significa que a versão usada está obsoleta e será desativada na data especificada.
Se a sua versão não estiver listada, isso significa que ela já foi desativada e não é mais compatível.

Se você se enquadrar no 2 ou 3 acima, precisará migrar para uma versão mais recente para evitar uma interrupção no serviço. É recomendável migrar para a versão mais recente, listada na parte superior da tabela de programações de descontinuação (excluindo as versões Beta). Assim, você terá o tempo máximo entre os upgrades.

Etapa 3: fazer upgrade das versões

Se você precisa migrar, a próxima etapa é atualizar sua integração ou criar uma versão atualizada da sua biblioteca de cliente preferida. Embora algumas bibliotecas de cliente possam fornecer apenas um único build que funcione com qualquer versão da API, outros terão builds separados para cada versão. A lista abaixo 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 alterar a versão usada por um script específico:

No editor do Apps Script, clique em Add a service .
Localize a API Campaign Manager 360 na lista de serviços disponíveis.
Mude a versão da API Campaign Manager 360 em uso no menu suspenso de versões.
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 alterar a versão usada por um script específico:

No editor do Apps Script, acesse Recursos > Serviços avançados do Google.
Localize a API Campaign Manager 360 na lista de serviços disponíveis.
Mude a versão da API Campaign Manager 360 em uso no menu suspenso de versões.
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.

Para instruções detalhadas de instalação 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.

Para instruções detalhadas de instalação 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.

Para instruções detalhadas de instalação 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 é compatível com todas as versões da API Campaign Manager 360. Basta atualizar a string da versão transmitida como um argumento para o criador de descobertas:

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

Para instruções detalhadas de instalação 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 são compatíveis com todas as versões da API Campaign Manager 360. Basta atualizar a string da versão sendo transmitida como um argumento para o construtor do serviço:

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+ fornece builds separados para cada versão da API Campaign Manager 360, distribuídas pelo RubyGems. Para instruções detalhadas de instalação ou opções alternativas de download, consulte a documentação da biblioteca de cliente.

Etapa 4: resolver as diferenças de versão

Fazemos o possível para que nossas novas versões sejam compatíveis com versões anteriores. Isso significa que a migração entre versões de API não exige mudanças no código. Quando isso não for possível, anunciaremos as mudanças que exigem alguma ação dos desenvolvedores (também conhecidas como alterações interruptivas) nas nossas notas da versão.

Neste ponto, você deve ler nossas notas de lançamento, começando com a versão posterior à que você usou para começar (anotado em uma seção anterior) e continuando até a versão para a qual você está fazendo upgrade. As seções das notas da versão precisam ser interpretadas da seguinte maneira:

Novos recursos: funcionalidades adicionadas recentemente.
Desativações: funcionalidades que foram removidas da API. Quando disponível, a funcionalidade de substituição será abordada nesta seção.
Problemas conhecidos: são alterações que não são adições nem remoções. Por exemplo, essa seção pode abranger campos ou métodos que foram renomeados ou lógica de validação alterada.

A funcionalidade de Novos recursos não exige mudanças no código e pode ser ignorada por enquanto. Volte a essa seção mais tarde se quiser testar algo que adicionamos.

Se você encontrar mudanças nas seções Desativações ou Problemas conhecidos, talvez seja necessário realizar ações. Pesquise seu código para determinar se alguma funcionalidade removida ou modificada é usada pelo aplicativo. Nesse caso, você precisará atualizar seu código para resolver essas mudanças.

Fique por dentro

Como mencionado anteriormente, os lançamentos e a desativação da API Campaign Manager 360 ocorrem regularmente. Atualizações sobre lançamentos, descontinuações e desativações são postadas nos seguintes canais:

É recomendável se inscrever em um ou mais desses canais para ficar por dentro das novidades da API.