Zu einer neuen Version migrieren

Neue Versionen der Campaign Manager 360 API werden regelmäßig veröffentlicht. Wenn neue Versionen veröffentlicht werden, werden ältere Versionen eingestellt und laufen bald ab. Wenn eine Version eingestellt wird, geben alle Anfragen für diese Version Fehler zurück.

Wenn eine Version der von Ihnen verwendeten API veraltet ist, müssen Sie vor dem geplanten Ablauf der Migration zu einer neueren Version migrieren. In diesem Leitfaden erfahren Sie, wie Sie feststellen, ob die von Ihnen verwendete API-Version verworfen wurde. Außerdem finden Sie darin empfohlene Migrationsschritte.

Schritt 1: Herausfinden, welche Version Sie verwenden

Wenn Sie eine Anwendung verwalten, bei der Sie eine veraltete Version der Campaign Manager 360 API verwenden, sollten Sie zuerst prüfen, welche Version Sie gerade verwenden. In den meisten Fällen greifen Sie über eine unserer sprachspezifischen Clientbibliotheken oder eine offizielle Integration auf die API zu. So finden Sie die API-Version, die von diesen Clientbibliotheken und Integrationen verwendet wird:

Apps Script – neuer Editor

Die Versionsinformationen für Apps Script werden im Dialogfeld für erweiterte Dienste angezeigt:

  1. Klicken Sie im Apps Script-Editor auf Dienst hinzufügen .
  2. Suchen Sie in der Liste der verfügbaren Dienste nach der Campaign Manager 360 API.
  3. Der im Drop-down-Menü ausgewählte Wert ist die Version der Campaign Manager 360 API, die derzeit verwendet wird.

Apps Script-Editor (alt)

Die Versionsinformationen für Apps Script werden im Dialogfeld für erweiterte Dienste angezeigt:

  1. Gehen Sie im Apps Script-Editor zu Ressourcen > Erweiterte Google-Dienste.
  2. Suchen Sie in der Liste der verfügbaren Dienste nach der Campaign Manager 360 API.
  3. Der im Drop-down-Menü ausgewählte Wert ist die Version der Campaign Manager 360 API, die derzeit verwendet wird.

C#

Versionsinformationen für die Google API-Clientbibliothek für .NET werden an folgenden Stellen angezeigt:

  1. Im Nunu-Paketnamen und Dienst-Namespace enthalten.
    Google.Apis.Dfareporting.v3_4
  2. Sichtbar über eine öffentliche Property von DfareportingService.
    Console.WriteLine(DfareportingService.Version);

Java

Versionsinformationen für die Google API-Clientbibliothek für Java finden Sie an folgenden Stellen:

  1. Wird in der Maven-Artefakt-ID angegeben.
    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-dfareporting</artifactId>
      <version>v3.4-rev1-1.21.0</version>
    </dependency>
  2. Im JAR-Dateinamen enthalten.
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Sichtbar über eine öffentliche Property von Dfareporting.
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Die Versionsinformationen für die Google API-Clientbibliothek für PHP werden über ein öffentliches Attribut von Google_Service_Dfareporting bereitgestellt:

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

Python

Die Google API-Clientbibliothek für Python ist nicht versioniert. Die zu verwendende API-Version wird als Argument für den Discovery-Builder angegeben:

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

Ruby

Die Google API-Clientbibliothek für Ruby-Versionen < 0.9 wird nicht versioniert. Die zu verwendende API-Version wird als Argument für den Dienstkonstruktor angegeben:

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

Bei der Google API-Clientbibliothek für Ruby-Versionen ab 0.9 wird die Version im Dienst-Namespace angezeigt:

Google.Apis.DfareportingV3_4

Notieren Sie sich die Version, da Sie diese später benötigen.

Schritt 2: Versionsstatus ermitteln

Im Zeitplan für die Einstellung ist der Status aller derzeit unterstützten Versionen aufgeführt. Suchen Sie Ihre Version in der Liste und ermitteln Sie ihren Status:

  1. Wenn in den Spalten Einstellungsdatum und Datum der Einstellung kein Datum angegeben ist, verwenden Sie eine vollständig unterstützte Version.
  2. Wenn Daten aufgeführt sind, ist die von Ihnen verwendete Version veraltet und wird zum angegebenen Datum eingestellt.
  3. Wenn Ihre Version nicht aufgeführt ist, wurde sie bereits eingestellt und wird nicht mehr unterstützt.

Wenn Sie Version 2 oder 3 oben erhalten, müssen Sie zu einer neueren Version migrieren, um Dienstunterbrechungen zu vermeiden. Es wird empfohlen, zur neuesten Version zu migrieren, die oben in der Tabelle mit dem Zeitplan für die Einstellung (mit Ausnahme der Betaversionen) aufgeführt ist. So erhalten Sie die maximale Zeitspanne zwischen Upgrades.

Schritt 3: Versionen aktualisieren

Wenn Sie entschieden haben, dass Sie migrieren müssen, ist der nächste Schritt, Ihre Integration zu aktualisieren oder einen aktualisierten Build Ihrer bevorzugten Clientbibliothek zu erhalten. Beachten Sie, dass einige Clientbibliotheken möglicherweise nur einen einzigen Build bereitstellen, der mit jeder API-Version funktioniert. Andere haben separate Builds für jede Version. Die folgende Liste enthält allgemeine Informationen zum Upgrade der am häufigsten verwendeten Clientbibliotheken und Integrationen.

Apps Script – neuer Editor

Google Apps Script unterstützt alle Versionen der Campaign Manager 360 API und ermöglicht die Auswahl der Skriptversion. So ändern Sie die von einem bestimmten Skript verwendete Version:

  1. Klicken Sie im Apps Script-Editor auf Dienst hinzufügen .
  2. Suchen Sie in der Liste der verfügbaren Dienste nach der Campaign Manager 360 API.
  3. Ändern Sie die verwendete Campaign Manager 360 API-Version über das Drop-down-Menü „Version“.
  4. Klicken Sie auf Hinzufügen, um Ihre Änderungen zu speichern.

Apps Script-Editor (alt)

Google Apps Script unterstützt alle Versionen der Campaign Manager 360 API und ermöglicht die Auswahl der Skriptversion. So ändern Sie die von einem bestimmten Skript verwendete Version:

  1. Gehen Sie im Apps Script-Editor zu Ressourcen > Erweiterte Google-Dienste.
  2. Suchen Sie in der Liste der verfügbaren Dienste nach der Campaign Manager 360 API.
  3. Ändern Sie die verwendete Campaign Manager 360 API-Version über das Drop-down-Menü „Version“.
  4. Klicken Sie auf OK, um die Änderungen zu speichern.

C#

Die Google API-Clientbibliothek für .NET bietet separate Builds für jede Version der Campaign Manager 360 API, die über Nuget verteilt wird.

Eine ausführliche Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

Java

Die Google API-Clientbibliothek für Java bietet separate Builds für jede Version der Campaign Manager 360 API, die über Maven verteilt wird.

Eine ausführliche Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

PHP

Die Google API-Clientbibliothek für PHP bietet separate Builds für jede Version der Campaign Manager 360 API, die über Packagist verteilt wird.

Eine ausführliche Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

Python

Jeder Build der Google API-Clientbibliothek für Python unterstützt alle Versionen der Campaign Manager 360 API. Aktualisieren Sie einfach den Versionsstring, der als Argument an den Discovery Builder übergeben wird:

discovery.build('dfareporting', 'v3.4', http=http)
Eine ausführliche Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

Ruby

Die Google API-Clientbibliothek für Ruby ab Version 0.8 unterstützt alle Versionen der Campaign Manager 360 API. Aktualisieren Sie einfach den Versionsstring, der als Argument an den Dienstkonstruktor übergeben wird:

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
Die Google API-Clientbibliothek für Ruby ab Version 0.9 bietet für jede Version der Campaign Manager 360 API separate Builds, die über RubyGems verteilt werden. Eine ausführliche Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

Schritt 4: Versionsunterschiede beheben

Wir sind bestrebt, unsere neuen Releases abwärtskompatibel zu machen. Das bedeutet, dass die Migration zwischen API-Versionen keine Änderungen am Code erforderlich macht. Wenn dies nicht möglich ist, geben wir die Änderungen, die von Entwicklern durchgeführt werden müssen, in unseren Versionshinweisen bekannt. Diese Änderungen werden auch als funktionsgefährdende Änderungen bezeichnet.

Sie sollten nun unsere Versionshinweise lesen und mit der Version beginnen, nach der Sie begonnen haben (die Sie sich in einem früheren Abschnitt notiert haben). Sie sollten die Version bis zu Ihrer Version fortsetzen. Die Abschnitte der Versionshinweise sollten so interpretiert werden:

  • Neue Funktionen: Neue Funktionen.
  • Sonnenuntergang – Funktion, die aus der API entfernt wurde. Sofern verfügbar, werden in diesem Abschnitt die Funktionen zum Ersetzen beschrieben.
  • Bekannte Probleme: Änderungen, die nicht hinzugefügt oder entfernt wurden. In diesem Abschnitt werden beispielsweise Felder oder Methoden, die umbenannt wurden, oder geänderte Validierungslogik behandelt.

Für die Funktionalität unter Neue Funktionen sind keine Codeänderungen erforderlich. Sie können vorerst ignoriert werden. Du kannst später zu diesem Abschnitt zurückkehren, wenn du etwas Neues ausprobieren möchtest.

Wenn Sie jedoch Änderungen in den Bereichen Sonnenuntergänge oder Bekannte Probleme feststellen, müssen Sie möglicherweise Maßnahmen ergreifen. Sie sollten Ihren Code durchsuchen, um festzustellen, ob eine der entfernten oder modifizierten Funktionen von Ihrer Anwendung verwendet wird. Falls ja, müssen Sie Ihren Code entsprechend aktualisieren.

Auf dem Laufenden bleiben

Wie bereits erwähnt, werden Campaign Manager 360 API-Versionen regelmäßig eingestellt und eingestellt. Aktuelle Informationen zu Neuveröffentlichungen, zur Einstellung von Produkten und zur Einstellung von Funktionen werden auf folgenden Kanälen veröffentlicht:

Wir empfehlen dir, einen oder mehrere dieser Kanäle zu abonnieren, damit du immer über API-News informiert bist.