Zu einer neuen Version migrieren

Neue Versionen der Campaign Manager 360 API werden regelmäßig veröffentlicht. Mit der Veröffentlichung neuer Versionen werden frühere Versionen eingestellt und schließlich ganz entfernt. Wenn eine Version eingestellt wird, geben alle Anfragen an diese Version Fehler zurück.

Wenn die von Ihnen verwendete Version veraltet ist, müssen Sie so schnell wie möglich ein Upgrade durchführen, um Dienstunterbrechungen zu vermeiden.

Schritt 1: Ermitteln, welche Version Sie verwenden

Mit der folgenden Anleitung können Sie ermitteln, welche API-Version Sie verwenden. In den meisten Fällen greifen Sie über eine unserer sprachspezifischen Clientbibliotheken oder eine offizielle Integration auf die API zu.

Neuer Apps Script-Editor

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ü für die Version ausgewählte Wert ist die verwendete Campaign Manager 360 API-Version.

Apps Script-Legacy-Editor

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

  1. Klicken Sie im Apps Script-Editor auf 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ü für die Version ausgewählte Wert ist die verwendete Campaign Manager 360 API-Version.

C#

Versionsinformationen für die Google API-Clientbibliothek für .NET sind an den folgenden Stellen verfügbar:

  1. Im NuGet-Paketnamen und Dienstnamespace enthalten. 
    Google.Apis.Dfareporting.v3_4
  2. Über eine öffentliche Property von DfareportingService verfügbar gemacht. 
    Console.WriteLine(DfareportingService.Version);

Java

Versionsinformationen für die Google API-Clientbibliothek für Java sind an den folgenden Stellen verfügbar:

  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. Über eine öffentliche Property von Dfareporting verfügbar gemacht. 
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Versionsinformationen für die Google API-Clientbibliothek für PHP werden über eine öffentliche Eigenschaft von Google_Service_Dfareporting bereitgestellt: 

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

Python

Die Google API-Clientbibliothek für Python (v1/v2) 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

Versionen der Google API-Clientbibliothek für Ruby < 0.9 sind 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 } )

In Versionen der Google API-Clientbibliothek für Ruby ab Version 0.9 wird die Version im Dienst-Namespace verfügbar gemacht: 

Google.Apis.DfareportingV3_4

Schritt 2: Status Ihrer Version ermitteln

Prüfen Sie den Zeitplan für die Einstellung, um den Status Ihrer Version zu ermitteln. Wenn Ihre Version nicht aufgeführt ist, wurde sie eingestellt und wird nicht mehr unterstützt.

Wenn Ihre Version aufgeführt ist, sehen Sie in den Spalten Deprecation Date (Einstellungsdatum) und Sunset Date (Datum der endgültigen Einstellung) nach:

  • Wenn keine Daten angegeben sind, wird Ihre Version vollständig unterstützt.
  • Wenn Datumsangaben vorhanden sind, ist Ihre Version veraltet und wird am angegebenen Datum eingestellt.

Wenn Ihre Version eingestellt wurde, müssen Sie zu einer neueren Version migrieren, um Dienstunterbrechungen zu vermeiden. Wir empfehlen, zur neuesten Version zu migrieren, die im Zeitplan aufgeführt ist (Betaversionen ausgenommen), um die Zeit zwischen Upgrades zu maximieren.

Schritt 3: Versionen aktualisieren

Wenn Sie zu einer neueren Version der API migrieren möchten, müssen Sie Ihre Integration aktualisieren oder einen aktualisierten Build Ihrer bevorzugten Clientbibliothek abrufen. Einige Clientbibliotheken bieten möglicherweise einen einzelnen Build, der mit jeder API-Version funktioniert, andere haben separate Builds für jede Version. Die folgende Liste enthält allgemeine Informationen zum Upgrade für die am häufigsten verwendeten Clientbibliotheken und Integrationen.

Neuer Apps Script-Editor

Google Apps Script unterstützt alle Versionen der Campaign Manager 360 API. Sie können die Version, die verwendet werden soll, für jedes Skript einzeln auswählen. So ändern Sie die Version, die von einem bestimmten Skript verwendet wird:

  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 Campaign Manager 360 API-Version über das Drop-down-Menü „Version“.
  4. Klicken Sie auf Hinzufügen, um Ihre Änderungen zu speichern.

Apps Script-Legacy-Editor

Google Apps Script unterstützt alle Versionen der Campaign Manager 360 API. Sie können die Version, die verwendet werden soll, für jedes Skript einzeln auswählen. So ändern Sie die Version, die von einem bestimmten Skript verwendet wird:

  1. Klicken Sie im Apps Script-Editor auf Ressourcen > Erweiterte Google-Dienste.
  2. Suchen Sie in der Liste der verfügbaren Dienste nach der Campaign Manager 360 API.
  3. Ändern Sie die 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 werden. Aktualisieren Sie auf eine Version der Clientbibliothek, die der API-Version entspricht, die Sie verwenden möchten.

Eine detaillierte 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 werden. Aktualisieren Sie auf eine Version der Clientbibliothek, die der API-Version entspricht, die Sie verwenden möchten.

Eine detaillierte 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 werden. Aktualisieren Sie auf eine Version der Clientbibliothek, die der API-Version entspricht, die Sie verwenden möchten.

Eine detaillierte Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

Python

Jeder Build der Google API-Clientbibliothek für Python (Version 1/2) unterstützt alle Versionen der Campaign Manager 360 API. Wenn Sie zu einer neuen Version der Campaign Manager 360 API migrieren möchten, aktualisieren Sie 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 v0.8 und niedriger unterstützt alle Versionen der Campaign Manager 360 API. Wenn Sie zu einer neuen Version der Campaign Manager 360 API migrieren möchten, aktualisieren Sie den Versionsstring, der als Argument an den Service-Konstruktor ü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 v0.9+ bietet separate Builds für jede Version der Campaign Manager 360 API, die über RubyGems verteilt werden. Aktualisieren Sie auf eine Version der Clientbibliothek, die der API-Version entspricht, die Sie verwenden möchten. Eine detaillierte Installationsanleitung oder alternative Downloadoptionen finden Sie in der Dokumentation zur Clientbibliothek.

REST

Wenn Sie die API direkt über HTTPS aufrufen, müssen Sie den Endpunkt für Ihre Anfragen aktualisieren, damit die neue API-Versionsnummer verwendet wird.

Wenn Sie beispielsweise von v4 zu v5 migrieren, ändern Sie die Basis-URL von: 

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

Schritt 4: Unterschiede bei Adressversionen beheben

Neue API-Versionen sind nach Möglichkeit abwärtskompatibel. Einige Updates können jedoch wichtige Änderungen enthalten, die eine Anpassung Ihres Codes erfordern. Diese Änderungen werden in den Versionshinweisen beschrieben.

Sehen Sie sich bei der Migration die Versionshinweise für jede Version zwischen Ihrer aktuellen Version und der Version an, auf die Sie ein Upgrade durchführen. Achten Sie besonders auf die folgenden Abschnitte:

  • Neue Funktionen: Neu hinzugefügte Funktionen. Für die Migration sind keine Codeänderungen erforderlich.
  • Einstellung: Funktionen, die aus der API entfernt wurden. Ersatzfunktionen werden angegeben, sofern verfügbar.
  • Bekannte Probleme: Änderungen an der bestehenden Funktionalität, z. B. umbenannte Felder oder Methoden oder geänderte Validierungslogik.

Wenn Ihre Anwendung Funktionen verwendet, die in den Abschnitten Einstellung oder Bekannte Probleme aufgeführt sind, müssen Sie Ihren Code aktualisieren, um diese Änderungen zu berücksichtigen.

Auf dem Laufenden bleiben

Behalten Sie den Google Ads Developer Blog im Blick, um als Erster über API-Releases, -Einstellung und -Deaktivierung informiert zu werden.