遷移至新版本

我們會定期發布新版 Campaign Manager 360 API。隨著新版本發布,舊版會逐步淘汰,最終停止支援。版本停用後,針對該版本的所有要求都會開始傳回錯誤。

如果您使用的版本已淘汰,請盡快升級,以免服務中斷。

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

您可以按照下列指示,判斷目前使用的 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

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

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

Python

適用於 Python 的 Google API 用戶端程式庫 (第 1 版/第 2 版) 沒有版本。要使用的 API 版本會指定為探索建構工具的引數:

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

Ruby

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 Client Library for Ruby 0.9 以上版本,版本會公開在服務命名空間中:

Google.Apis.DfareportingV3_4

步驟 2:判斷版本狀態

請查看淘汰時間表,瞭解版本狀態。如果沒有列出你使用的版本,表示該版本已淘汰,我們不再支援。

如果您的版本列於其中,請查看「淘汰日期」和「終止日期」欄:

  • 如果沒有顯示日期,表示你的版本完全受到支援。
  • 如果顯示日期,表示該版本已淘汰,並將在指定日期停用。

如果您的版本已淘汰或終止支援,請遷移至較新版本,以免服務中斷。建議您遷移至時間表中的最新版本 (不含 Beta 版),盡量延長升級間隔。

步驟 3:升級版本

如要遷移至新版 API,您必須更新整合項目,或取得偏好用戶端程式庫的更新版本。請注意,部分用戶端程式庫可能提供適用於任何 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 發布。更新至與您要使用的 API 版本相應的用戶端程式庫版本。

如需詳細安裝說明或替代下載選項,請參閱用戶端程式庫說明文件

Java

Java 適用的 Google API 用戶端程式庫會為每個版本的 Campaign Manager 360 API 提供個別的建構版本,並透過 Maven 發布。更新至與您要使用的 API 版本相應的用戶端程式庫版本。

如需詳細安裝說明或替代下載選項,請參閱用戶端程式庫說明文件

PHP

PHP 適用的 Google API 用戶端程式庫會為每個版本的 Campaign Manager 360 API 提供個別建構版本,並透過 Packagist 發布。更新為與您要使用的 API 版本對應的用戶端程式庫版本。

如需詳細安裝說明或替代下載選項,請參閱用戶端程式庫說明文件

Python

適用於 Python 的 Google API 用戶端程式庫 (第 1 版/第 2 版) 的每個建構版本,都支援所有版本的 Campaign Manager 360 API。如要遷移至新版 Campaign Manager 360 API,請更新傳遞為探索建構工具引數的版本字串:

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

Ruby

Ruby 專用的 Google API 用戶端程式庫 v0.8 以下版本支援所有版本的 Campaign Manager 360 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 發布。更新為與您要使用的 API 版本對應的用戶端程式庫版本。如需詳細安裝說明或替代下載選項,請參閱用戶端程式庫說明文件

REST

如果您是使用 HTTPS 直接呼叫 API,請更新要求端點,改用新的 API 版本號碼。

舉例來說,從 v4 遷移至 v5 時,您會將基本網址從:

https://dfareporting.googleapis.com/dfareporting/v4/...
收件者:
https://dfareporting.googleapis.com/dfareporting/v5/...

步驟 4:地址版本差異

新版 API 盡可能設計為回溯相容。不過,部分更新可能包含破壞性變更,需要您修改程式碼。如要瞭解這些異動的詳細資訊,請參閱版本資訊

遷移時,請詳閱目前版本與要升級版本之間的各個版本資訊。請特別留意下列章節:

  • 新功能:新增功能。這些項目不需要變更程式碼即可遷移。
  • 淘汰:從 API 中移除功能。如果可以更換,我們會註明。
  • 已知問題:修改現有功能,例如重新命名欄位或方法,或是變更驗證邏輯。

如果應用程式使用「淘汰」或「已知問題」部分列出的功能,請務必更新程式碼,以因應這些變更。

掌握最新資訊

請定期查看 Google Ads 開發人員網誌,搶先瞭解 API 發布、淘汰和終止的消息。