遷移至新版本

新版的 Campaign Manager 360 API 會定期發布。新版本推出後，舊的版本會遭到淘汰，最終將會淘汰。版本停用時，針對該版本的所有要求都會傳回錯誤。

如果您使用的 API 版本已淘汰，您必須在預定的日落日期前遷移至較新版本。本指南詳細說明如何判斷您使用的 API 版本是否已淘汰，並提供建議的遷移步驟。

步驟 1：確認您使用的版本

如果您維護的應用程式可能使用了已淘汰的 Campaign Manager 360 API 版本，請先驗證您目前使用的特定版本。在大部分情況下，您會使用我們的語言專屬用戶端程式庫或官方整合系統來存取 API。尋找這些用戶端程式庫和整合作業所用的 API 版本，操作說明如下：

Apps Script 新版編輯器

「進階服務」對話方塊會顯示 Apps Script 版本資訊：

  1. 在 Apps Script 編輯器中，按一下「新增服務」圖示 。
  2. 在可用服務清單中找出 Campaign Manager 360 API。
  3. 您在版本下拉式選單中選取的值，就是目前正在使用的 Campaign Manager 360 API 版本。

Apps Script 舊版編輯器

「進階服務」對話方塊會顯示 Apps Script 版本資訊：

  1. 在 Apps Script 編輯器中，依序前往 [資源] > [進階 Google 服務]。
  2. 在可用服務清單中找出 Campaign Manager 360 API。
  3. 您在版本下拉式選單中選取的值，就是目前正在使用的 Campaign Manager 360 API 版本。

C#

適用於 .NET 的 Google API 用戶端程式庫版本資訊位於下列位置：

  1. 包含在 nuget 套件名稱和服務命名空間中。
    Google.Apis.Dfareporting.v3_4
  2. 透過 DfareportingService 的公開屬性公開。
    Console.WriteLine(DfareportingService.Version);

Java

適用於 Java 的 Google API 用戶端程式庫版本資訊如下：

  1. 在 Maven ArtifactId 中指定。 
    <dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v3.4-rev1-1.21.0</version>
</dependency>
  2. 包含在 JAR 檔案名稱中。 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. 透過 Dfareporting 的公開屬性公開。
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

透過 Google_Service_Dfareporting 的公開屬性公開了 PHP 適用的 Google API 用戶端程式庫版本資訊： 

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

Python

Python 適用的 Google API 用戶端程式庫並未版本管理。系統會將要使用的 API 版本指定為探索建構工具的引數： 

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

Ruby

Ruby 版本不到 0.9 的 Google API 用戶端程式庫並非版本管理。要使用的 API 版本會指定為服務建構函式的引數： 

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

在 Ruby= 0.9 以上的 Google API 用戶端程式庫中，版本會在服務命名空間中公開：

Google.Apis.DfareportingV3_4

記下您使用的版本，稍後將會用到。

步驟 2：確認版本狀態

「淘汰時間表」則會列出目前支援的每個版本狀態。請在下列清單中找出您的版本，並查看對應的狀態：

  1. 如果「淘汰日期」和「停用日期」欄中未列出任何日期，表示您使用的是完全支援的版本。
  2. 如果系統列出日期，表示您目前使用的版本目前已淘汰，而且會在指定日期停用。
  3. 如果畫面上未列出你的版本，表示這個版本現已停用，且不再支援。

如果您落入上述第 2 或第 3 名，就必須改用新版服務，以免服務中斷。建議您遷移至最新版本，此清單列於淘汰時間表頂端 (Beta 版除外)。這樣可以為您提供升級之間的最長時間。

步驟 3：升級版本

如果您已確定需要遷移，下一步就是更新您的整合，或取得您偏好的用戶端程式庫的更新版本。請注意，雖然部分用戶端程式庫可能只能提供適用於任何 API 版本的單一版本，而其他用戶端則會為每個版本建立個別版本。以下清單針對最常用的用戶端程式庫和整合項目提供一般升級資訊。

Apps Script 新版編輯器

Google Apps Script 支援所有 Campaign Manager 360 API 版本，可讓您選取逐行使用的版本。如何變更特定指令碼使用的版本：

  1. 在 Apps Script 編輯器中，按一下「新增服務」圖示 。
  2. 在可用服務清單中找出 Campaign Manager 360 API。
  3. 透過版本下拉式選單變更目前使用的 Campaign Manager 360 API 版本。
  4. 按一下 [Add] (新增) 即可儲存變更。

Apps Script 舊版編輯器

Google Apps Script 支援所有 Campaign Manager 360 API 版本，可讓您選取逐行使用的版本。如何變更特定指令碼使用的版本：

  1. 在 Apps Script 編輯器中，依序前往 [資源] > [進階 Google 服務]。
  2. 在可用服務清單中找出 Campaign Manager 360 API。
  3. 透過版本下拉式選單變更目前使用的 Campaign Manager 360 API 版本。
  4. 按一下 [OK] (確定) 儲存變更。

C#

適用於 .NET 的 Google API 用戶端程式庫為每個 Campaign Manager 360 API 版本提供不同版本。透過 Nuget 發布。

如需詳細的安裝操作說明或其他下載選項，請參閱用戶端程式庫說明文件。

Java

適用於 Java 的 Google API 用戶端程式庫為每個 Campaign Manager 360 API 版本提供不同版本。

如需詳細的安裝操作說明或其他下載選項，請參閱用戶端程式庫說明文件。

PHP

適用於 PHP 的 Google API 用戶端程式庫可以為 Campaign Manager 360 API 的每個版本分別提供版本。

如需詳細的安裝操作說明或其他下載選項，請參閱用戶端程式庫說明文件。

Python

每個 Python 適用的 Google API 用戶端程式庫都支援所有 Campaign Manager 360 API 版本。只要將做為引數傳遞的版本字串更新至探索建構工具： 

discovery.build('dfareporting', 'v3.4', http=http)
如需詳細的安裝操作說明或其他替代下載選項，請參閱用戶端程式庫說明文件。

Ruby

Ruby v0.8 以下版本的 Google API 用戶端程式庫支援所有 Campaign Manager 360 API 版本。只要將做為版本引數傳遞的版本字串更新至服務建構函式即可： 

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
Ruby 專用的 Google API 用戶端程式庫 v0.9 以上版本為各個版本的 Campaign Manager 360 API 提供獨立的建構方式，且此版本是透過 RubyGems 發布。 如需詳細的安裝操作說明或其他下載選項，請參閱用戶端程式庫說明文件。

步驟 4：解決版本差異

我們致力於讓新版本能回溯相容，也就是說，在 API 版本之間進行遷移並不會對程式碼造成變更。如果無法採取這種做法，我們會在版本資訊中宣布開發人員必須採取行動的異動 (也稱為「破壞性變更」)。

此時，您應詳閱版本資訊，也就是您一開始使用的版本編號 (在之前章節中註明的內容)，然後繼續發布及更新您要升級的版本。版本資訊的說明內容應以下列方式解讀：

  • 新功能 - 新增的功能。
  • 日落 - 已從 API 移除的功能。如有可用功能，本節將涵蓋相關功能。
  • 已知問題：不會新增或移除的變更內容。舉例來說，本節可能會涵蓋已重新命名的欄位或方法，或是已變更的驗證邏輯。

新功能中的功能不需要修改程式碼，目前可以忽略。如果想試用新增的內容，請稍後再回來查看這個部分。

另一方面，如果發現「日落」或「已知問題」部分有任何變更，您可能需要採取行動。建議您搜尋程式碼，確認應用程式是否使用了任何已移除或修改的功能。如果是的話，您必須修改程式碼，以因應這些異動

持續關注最新資訊

如前所述，Campaign Manager 360 API 的發布與終止作業會定期進行。我們會在下列頻道中推出新曲、淘汰內容及日落等最新消息：

建議您訂閱一或多個頻道，隨時掌握最新的 API 相關消息。