遷移至新版本

Campaign Manager 360 API 會定期推出新版本。隨著新版本的推出，舊版會逐步淘汰，最終也會停用。當某個版本停用時，所有針對該版本的請求都會開始傳回錯誤。

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

步驟 1：判斷您使用的版本

如果您維護的應用程式疑似使用 Campaign Manager 360 API 的已淘汰版本，請先確認您使用的具體版本。在大多數情況下，您會透過我們的語言專屬用戶端程式庫或官方整合服務存取 API。如要瞭解如何找出這些用戶端程式庫和整合項目使用的 API 版本，請參閱以下說明：

Apps Script 新版編輯器

進階服務對話方塊會顯示「應用程式指令碼」的版本資訊：

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

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 用戶端程式庫 (第 1 版/第 2 版) 沒有版本。要使用的 API 版本會指定為探索建構工具的引數：

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

小茹

適用於 Ruby 的 Google API 用戶端程式庫版本 < 0.9 不含版本號碼。要使用的 API 版本會指定為服務建構函式的引數：

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

對於 Google API 用戶端程式庫 (適用於 Ruby) 版本 0.9 以上，版本資訊會在服務命名空間中公開：

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. 按一下 [新增] 即可儲存變更。

Apps Script 舊版編輯器

Google Apps Script 支援所有 Campaign Manager 360 API 版本，並允許您依據個別指令碼選取要使用的版本。如要變更特定指令碼使用的版本，請按照下列步驟操作：

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

C#

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

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

Java

Java 適用的 Google API 用戶端程式庫會為每個 Campaign Manager 360 API 版本提供個別的版本，並透過 Maven 發布。

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

PHP

PHP 適用的 Google API 用戶端程式庫會為每個 Campaign Manager 360 API 版本提供個別的版本，並透過 Packagist 發布。

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

Python

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

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

小茹

適用於 Ruby 的 Google API 用戶端程式庫 v0.8 以下版本支援所有版本的 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 相關消息。