Migracja do nowej wersji

Nowe wersje interfejsu API Campaign Managera 360 są publikowane regularnie. Wraz z wydaniem nowych wersji starsze wersje są wycofywane, a ostatecznie wyłączane. Gdy wersja zostanie wycofana, wszystkie żądania dotyczące tej wersji zaczną zwracać błędy.

Jeśli wersja interfejsu API, której używasz, została wycofana, musisz przejść na nowszą wersję przed zaplanowanym terminem wycofania. Ten przewodnik zawiera szczegółowe informacje o tym, jak sprawdzić, czy wersja interfejsu API, z której korzystasz, została wycofana, oraz zalecane kroki migracji.

Krok 1. Sprawdź, z której wersji korzystasz

Jeśli zarządzasz aplikacją, która według Ciebie może używać wycofanej wersji interfejsu Campaign Managera 360 API, najpierw sprawdź, której wersji używasz. W większości przypadków dostęp do interfejsu API uzyskujesz za pomocą jednej z naszych bibliotek klienta dla danego języka lub oficjalnej integracji. Poniżej znajdziesz instrukcje znajdowania wersji interfejsu API używanej przez te biblioteki klienta i integracje:

Nowy edytor Apps Script

Informacje o wersji Apps Script są widoczne w oknie usług zaawansowanych:

  1. W edytorze Apps Script kliknij Dodaj usługę .
  2. Na liście dostępnych usług odszukaj interfejs API Campaign Managera 360.
  3. Wartość wybrana w menu „Wersja” to wersja interfejsu API Campaign Managera 360, która jest obecnie używana.

Starszy edytor Apps Script

Informacje o wersji Apps Script są widoczne w oknie usług zaawansowanych:

  1. W edytorze Apps Script kliknij Zasoby > Zaawansowane usługi Google.
  2. Na liście dostępnych usług odszukaj interfejs API Campaign Managera 360.
  3. Wartość wybrana w menu „Wersja” to wersja interfejsu API Campaign Managera 360, która jest obecnie używana.

C#

Informacje o wersji biblioteki klienta interfejsu API Google dla .NET są dostępne w tych miejscach:

  1. Włączone w nazwę pakietu nuget i przestrzeń nazw usługi. 
    Google.Apis.Dfareporting.v3_4
  2. Zasób widoczny w usłudze publicznej DfareportingService. 
    Console.WriteLine(DfareportingService.Version);

Java

Informacje o wersji biblioteki klienta interfejsu API Google dla języka Java są dostępne w tych miejscach:

  1. Określony w archiwium maven artifactId. 
    <dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v3.4-rev1-1.21.0</version>
</dependency>
  2. Włączona w nazwę pliku JAR. 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Zasób widoczny w usłudze publicznej Dfareporting. 
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Informacje o wersji biblioteki klienta interfejsu API Google dla języka PHP są dostępne za pomocą właściwości publicznej Google_Service_Dfareporting: 

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

Python

Biblioteka klienta interfejsu API Google dla języka Python (w wersji 1 lub 2) nie jest wersjonowana. Wersja interfejsu API, której chcesz użyć, jest podawana jako argument w kreatorze wykrywania: 

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

Ruby

Biblioteka klienta interfejsu API Google dla języka Ruby w wersjach < 0.9 nie jest wersjonowana. Wersja interfejsu API, której chcesz użyć, jest podawana jako argument konstruktora usługi: 

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

W przypadku wersji biblioteki klienta interfejsu API Google dla języka Ruby ≥ 0.9 wersja jest widoczna w katalogu usługi: 

Google.Apis.DfareportingV3_4

Zapisz wersję, której używasz, ponieważ będziesz jej potrzebować później.

Krok 2. Sprawdź stan wersji

Harmonogram wycofywania zawiera stan każdej wersji, która jest obecnie obsługiwana. Znajdź swoją wersję na tej liście i sprawdź jej stan w ten sposób:

  1. Jeśli w kolumnach Data wycofania i Data wycofania nie ma żadnych dat, używasz wersji w pełni obsługiwanej przez Google.
  2. Jeśli są podane daty, oznacza to, że wersja, której używasz, jest obecnie wycofywana i zostanie wycofana w określonym dniu.
  3. Jeśli Twoja wersja nie jest wymieniona, oznacza to, że została wycofana i nie jest już obsługiwana.

Jeśli Twoja sytuacja odpowiada punktowi 2 lub 3 powyżej, musisz przejść na nowszą wersję, aby uniknąć przerwy w działaniu usługi. Zalecamy przejście na najnowszą wersję, która znajduje się u góry tabeli harmonogramu wycofywania (z wyjątkiem wersji beta). Dzięki temu będziesz mieć maksymalną ilość czasu między ulepszeniami.

Krok 3. Zaktualizuj wersje

Jeśli stwierdzisz, że musisz przeprowadzić migrację, następnym krokiem będzie zaktualizowanie integracji lub pobranie zaktualizowanej wersji preferowanej biblioteki klienta. Pamiętaj, że niektóre biblioteki klienta mogą udostępniać tylko jedną wersję, która działa z dowolną wersją interfejsu API, a inne będą miały oddzielne wersje dla każdej wersji. Na liście poniżej znajdziesz ogólne informacje o aktualizacji w przypadku najczęściej używanych bibliotek klienta i integracji.

Nowy edytor Apps Script

Google Apps Script obsługuje wszystkie wersje interfejsu Campaign Managera 360 API i pozwala wybrać wersję do użycia w konkretnym przypadku. Aby zmienić wersję używaną przez konkretny skrypt:

  1. W edytorze Apps Script kliknij Dodaj usługę .
  2. Na liście dostępnych usług odszukaj interfejs API Campaign Managera 360.
  3. Zmień używaną wersję interfejsu Campaign Managera 360 API, korzystając z menu wersji.
  4. Aby zapisać zmiany, kliknij Dodaj.

Starszy edytor Apps Script

Google Apps Script obsługuje wszystkie wersje interfejsu Campaign Managera 360 API i pozwala wybrać wersję do użycia w konkretnym przypadku. Aby zmienić wersję używaną przez konkretny skrypt:

  1. W edytorze Apps Script kliknij Zasoby > Zaawansowane usługi Google.
  2. Na liście dostępnych usług odszukaj interfejs API Campaign Managera 360.
  3. Zmień używaną wersję interfejsu Campaign Managera 360 API, korzystając z menu wersji.
  4. Aby zapisać zmiany, kliknij OK.

C#

Biblioteka klienta interfejsu API Google dla .NET udostępnia osobne wersje dla każdej wersji interfejsu API Campaign Managera 360, które są rozpowszechniane za pomocą Nuget.

Szczegółowe instrukcje instalacji lub alternatywne opcje pobierania znajdziesz w dokumentacji biblioteki klienta.

Java

Biblioteka klienta interfejsu API Google dla języka Java udostępnia osobne wersje dla każdej wersji interfejsu API Campaign Managera 360, które są rozpowszechniane za pomocą Mavena.

Szczegółowe instrukcje instalacji lub alternatywne opcje pobierania znajdziesz w dokumentacji biblioteki klienta.

PHP

Biblioteka klienta interfejsu Google API dla PHP udostępnia osobne wersje dla każdej wersji interfejsu API Campaign Managera 360, które są rozpowszechniane za pomocą usługi Packagist.

Szczegółowe instrukcje instalacji lub alternatywne opcje pobierania znajdziesz w dokumentacji biblioteki klienta.

Python

Każda wersja biblioteki klienta interfejsu API Google dla języka Python (w wersji 1 lub 2) obsługuje wszystkie wersje interfejsu API Campaign Managera 360. Wystarczy zaktualizować ciąg znaków wersji przekazywany jako argument do kreatora reklam Discovery: 

discovery.build('dfareporting', 'v3.4', http=http)
 Szczegółowe instrukcje instalacji lub alternatywne opcje pobierania znajdziesz w dokumentacji biblioteki klienta.

Ruby

Biblioteka klienta interfejsu API Google dla języka Ruby w wersji 0.8 i starszych obsługuje wszystkie wersje interfejsu Campaign Managera 360 API. Wystarczy zaktualizować ciąg znaków wersji przekazywany jako argument konstruktora usługi: 

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
 Biblioteka klienta interfejsu API Google dla języka Ruby w wersji 0.9 lub nowszej udostępnia osobne kompilacje dla każdej wersji interfejsu API Campaign Managera 360, które są rozpowszechniane za pomocą RubyGems. Szczegółowe instrukcje instalacji lub alternatywne opcje pobierania znajdziesz w dokumentacji biblioteki klienta.

Krok 4. Rozwiąż różnice między wersjami

Staramy się, aby nasze nowe wersje były zgodne ze starszymi wersjami, co oznacza, że przenoszenie między wersjami interfejsu API nie wymaga wprowadzania zmian w kodzie. Jeśli nie jest to możliwe, ogłaszamy zmiany, które wymagają działania deweloperów (zwane też zmianami powodującymi przerwanie), w opisie wersji.

W tym momencie powinieneś przejrzeć nasze informacje o wersji, zaczynając od wersji po tej, od której zacząłeś (oznaczoną w poprzedniej sekcji), a następnie przejść do wersji, na którą chcesz przejść. Sekcje informacji o wersji należy interpretować w ten sposób:

  • Nowe funkcje – nowe funkcje.
  • Zawieszone – funkcje, które zostały usunięte z interfejsu API. W tej sekcji opisano funkcje zastępcze, jeśli są dostępne.
  • Znane problemy – zmiany, które nie są dodaniem ani usunięciem. Może to być na przykład sekcja dotycząca pól lub metod, które zostały przemianowane, lub logiki walidacji, która uległa zmianie.

Funkcje opisane w sekcji Nowe funkcje nie wymagają wprowadzania zmian w kodzie i na razie można je zignorować. Jeśli chcesz wypróbować coś z dodanych przez nas funkcji, możesz wrócić do tej sekcji później.

Jeśli natomiast zauważysz zmiany w sekcji Zachód słońca lub Znane problemy, może być konieczne podjęcie działań. Przejrzyj kod, aby sprawdzić, czy aplikacja korzysta z funkcji, które zostały usunięte lub zmodyfikowane. Jeśli tak, musisz zaktualizować kod, aby uwzględnić te zmiany.

Bądź na bieżąco

Jak już wspomnieliśmy, interfejs API Campaign Managera 360 jest regularnie aktualizowany. Aktualizacje dotyczące nowych wersji, wycofanych funkcji i zawieszonych usług są publikowane w tych kanałach:

Aby być na bieżąco z najnowszymi wiadomościami o interfejsie API, zasubskrybuj co najmniej 1 z tych kanałów.