Las versiones nuevas de la API de Campaign Manager 360 se lanzan con regularidad. A medida que se lanzan versiones nuevas, las versiones anteriores dejan de estar disponibles y, finalmente, dejan de funcionar. Cuando se da de baja una versión, todas las solicitudes a esa versión comienzan a mostrar errores.
Si una versión de la API que usas deja de estar disponible, deberás migrar a una versión más reciente antes de la fecha de desactivación programada. En esta guía, se proporcionan detalles para determinar si la versión de la API que usas está obsoleta y se indican los pasos de migración recomendados.
Paso 1: Determina qué versión estás usando
Si administras una aplicación que sospechas que puede estar usando una versión obsoleta de la API de Campaign Manager 360, primero debes verificar qué versión específica estás usando. En la mayoría de los casos, accederás a la API a través de una de nuestras bibliotecas cliente específicas de un lenguaje o una integración oficial. A continuación, se incluyen instrucciones para encontrar la versión de la API que usan estas bibliotecas cliente y estas integraciones:
Nuevo editor de Apps Script
La información de la versión de Apps Script se muestra en el diálogo de servicios avanzados:
- En el editor de Apps Script, haz clic en Agregar un servicio .
- Busca la API de Campaign Manager 360 en la lista de servicios disponibles.
- El valor seleccionado en el menú desplegable de versiones es la versión de la API de Campaign Manager 360 que se está usando actualmente.
Editor heredado de Apps Script
La información de la versión de Apps Script se muestra en el diálogo de servicios avanzados:
- En el editor de Apps Script, navega a Recursos > Servicios de Google avanzados.
- Busca la API de Campaign Manager 360 en la lista de servicios disponibles.
- El valor seleccionado en el menú desplegable de versiones es la versión de la API de Campaign Manager 360 que se está usando actualmente.
C#
La información de versión de la biblioteca cliente de la API de Google para .NET se expone en los siguientes lugares:
- Se incluye en el nombre del paquete de NuGet y el espacio de nombres del servicio.
Google.Apis.Dfareporting.v3_4
- Se expone a través de una propiedad pública de
DfareportingService.Console.WriteLine(DfareportingService.Version);
Java
La información de versión de la biblioteca cliente de la API de Google para Java se expone en los siguientes lugares:
- Se especifica en el ID del artefacto de Maven.
<dependency> <groupId>com.google.apis</groupId> <artifactId>google-api-services-dfareporting</artifactId> <version>v3.4-rev1-1.21.0</version> </dependency>
- Se incluye en el nombre del archivo JAR.
google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
- Se expone a través de una propiedad pública de
Dfareporting.System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);
PHP
La información de versión de la biblioteca cliente de la API de Google para PHP se expone a través de una propiedad pública de Google_Service_Dfareporting:
$service = new Google_Service_Dfareporting($client) print $service->version;
Python
La biblioteca cliente de la API de Google para Python (v1/v2) no tiene control de versiones. La versión de la API que se usará se especifica como un argumento para el compilador de Discovery:
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
Las versiones anteriores a la 0.9 de la biblioteca cliente de la API de Google para Ruby no tienen control de versiones. La versión de la API que se usará se especifica como un argumento para el constructor del servicio:
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
En el caso de las versiones de la biblioteca cliente de la API de Google para Ruby superiores o iguales a 0.9, la versión se expone en el espacio de nombres del servicio:
Google.Apis.DfareportingV3_4
Toma nota de la versión que usas, ya que necesitarás esta información más adelante.
Paso 2: Determina el estado de tu versión
En el Programa de baja, se indica el estado de cada versión que se admite actualmente. Busca tu versión en esta lista y determina su estado de la siguiente manera:
- Si no hay fechas en las columnas Fecha de baja y Fecha de desactivación, significa que estás usando una versión completamente compatible.
- Si se indican fechas, significa que la versión que usas dejó de estar disponible y dejará de funcionar en la fecha especificada.
- Si tu versión no aparece en la lista, significa que ya se retiró y ya no es compatible.
Si te encuentras en los casos 2 o 3 anteriores, deberás migrar a una versión más reciente para evitar una interrupción del servicio. Te recomendamos que migres a la versión más reciente, que se indica en la parte superior de la tabla del programa de baja (sin incluir las versiones beta). Esto te permitirá tener la mayor cantidad de tiempo posible entre las actualizaciones.
Paso 3: Actualiza las versiones
Si determinaste que debes realizar la migración, el siguiente paso es actualizar la integración o obtener una compilación actualizada de tu biblioteca cliente preferida. Ten en cuenta que, si bien algunas bibliotecas cliente solo pueden proporcionar una compilación que funcione con cualquier versión de la API, otras tendrán compilaciones independientes para cada versión. En la siguiente lista, se proporciona información general sobre la actualización de las bibliotecas cliente y las integraciones más utilizadas.
Nuevo editor de Apps Script
Google Apps Script admite todas las versiones de la API de Campaign Manager 360 y te permite seleccionar la versión que deseas usar en cada secuencia de comandos. Para cambiar la versión que usa una secuencia de comandos en particular, sigue estos pasos:
- En el editor de Apps Script, haz clic en Agregar un servicio .
- Busca la API de Campaign Manager 360 en la lista de servicios disponibles.
- Cambia la versión de la API de Campaign Manager 360 que se está usando a través del menú desplegable de versiones.
- Haz clic en Agregar para guardar los cambios.
Editor heredado de Apps Script
Google Apps Script admite todas las versiones de la API de Campaign Manager 360 y te permite seleccionar la versión que deseas usar en cada secuencia de comandos. Para cambiar la versión que usa una secuencia de comandos en particular, sigue estos pasos:
- En el editor de Apps Script, navega a Recursos > Servicios de Google avanzados.
- Busca la API de Campaign Manager 360 en la lista de servicios disponibles.
- Cambia la versión de la API de Campaign Manager 360 que se está usando a través del menú desplegable de versiones.
- Haz clic en Aceptar para guardar los cambios.
C#
La biblioteca cliente de la API de Google para .NET proporciona compilaciones independientes para cada versión de la API de Campaign Manager 360, que se distribuye a través de Nuget.
Para obtener instrucciones de instalación detalladas o opciones de descarga alternativas, consulta la documentación de la biblioteca cliente.
Java
La biblioteca cliente de la API de Google para Java proporciona compilaciones independientes para cada versión de la API de Campaign Manager 360, que se distribuye a través de Maven.
Para obtener instrucciones de instalación detalladas o opciones de descarga alternativas, consulta la documentación de la biblioteca cliente.
PHP
La biblioteca cliente de la API de Google para PHP proporciona compilaciones independientes para cada versión de la API de Campaign Manager 360, que se distribuye a través de Packagist.
Para obtener instrucciones de instalación detalladas o opciones de descarga alternativas, consulta la documentación de la biblioteca cliente.
Python
Cada compilación de la biblioteca cliente de la API de Google para Python (v1/v2) admite todas las versiones de la API de Campaign Manager 360. Simplemente actualiza la cadena de versión que se pasa como argumento al compilador de discovery:
discovery.build('dfareporting', 'v3.4', http=http)
Ruby
La biblioteca cliente de la API de Google para Ruby v0.8 y versiones anteriores admite todas las versiones de la API de Campaign Manager 360. Simplemente actualiza la cadena de versión que se pasa como argumento al constructor del servicio:
service = Google::APIClient::Service.new("dfareporting", "v3.4", { :application_name => "My application", :application_version => '1.0.0', :authorization => authorization } )
Paso 4: Soluciona las diferencias entre las versiones
Nos esforzamos por hacer que nuestras nuevas versiones sean retrocompatibles, lo que significa que migrar entre versiones de la API no requerirá cambios en tu código. Cuando esto no es posible, anunciamos los cambios que requieren una acción de los desarrolladores (también conocidos como cambios rotundos) en nuestras notas de la versión.
En este punto, debes revisar nuestras notas de lanzamiento, comenzando por la versión posterior a la que usaste para comenzar (que tomaste nota en una sección anterior) y continuando hasta la versión a la que te actualizarás. Las secciones de las notas de la versión deben interpretarse de la siguiente manera:
- Funciones nuevas: Funciones agregadas recientemente.
- Baja de servicio: Funcionalidad que se quitó de la API. Cuando esté disponible, se explicará la función de reemplazo en esta sección.
- Problemas conocidos: Son cambios que no son incorporaciones ni eliminaciones. Por ejemplo, esta sección puede abarcar campos o métodos a los que se les cambió el nombre, o bien la lógica de validación que cambió.
La funcionalidad de Funciones nuevas no requerirá cambios en el código y se puede ignorar por el momento. No dudes en volver a esta sección más tarde si quieres experimentar con algo que agregamos.
Por otro lado, si encuentras cambios en las secciones Parámetros de configuración que dejarán de estar disponibles o Problemas conocidos, es posible que debas tomar medidas. Debes buscar en tu código para determinar si tu aplicación usa alguna de las funciones quitadas o modificadas. Si es así, deberás actualizar tu código para abordar estos cambios.
Mantente informado
Como se mencionó anteriormente, las versiones y los retiros de la API de Campaign Manager 360 se producen con regularidad. Las actualizaciones sobre lanzamientos nuevos, baja de la versión y desactivación se publican en los siguientes canales:
- Blog para desarrolladores de Google Ads (suscríbete para recibir alertas por correo electrónico)
- Foro de la API de Campaign Manager 360
Te recomendamos que te suscribas a uno o más de estos canales para mantenerte al tanto de las noticias más recientes de las APIs.