Chuyển sang phiên bản mới

Các phiên bản mới của Campaign Manager 360 API được phát hành thường xuyên. Khi các phiên bản mới được phát hành, các phiên bản cũ sẽ không được dùng nữa và cuối cùng sẽ ngừng hoạt động. Khi một phiên bản ngừng hoạt động, tất cả các yêu cầu đối với phiên bản đó sẽ bắt đầu trả về lỗi.

Nếu phiên bản API mà bạn đang sử dụng không còn được dùng nữa, bạn cần phải chuyển sang phiên bản mới hơn trước ngày ngừng hoạt động theo lịch. Hướng dẫn này cung cấp thông tin chi tiết về cách xác định xem phiên bản API bạn đang sử dụng có ngừng hoạt động hay không và cung cấp các bước di chuyển được đề xuất.

Bước 1: Xác định phiên bản bạn đang sử dụng

Nếu duy trì một ứng dụng mà bạn nghi ngờ có thể đang sử dụng phiên bản không dùng nữa của API Campaign Manager 360, trước tiên, bạn nên xác minh phiên bản cụ thể mà bạn đang sử dụng. Trong hầu hết các trường hợp, bạn sẽ truy cập API thông qua một trong các thư viện ứng dụng dành riêng cho ngôn ngữ hoặc một công cụ tích hợp chính thức. Bạn có thể xem hướng dẫn tìm phiên bản API mà các thư viện ứng dụng và công cụ tích hợp này đang sử dụng ở bên dưới:

Trình chỉnh sửa mới của Apps Script

Thông tin phiên bản của Apps Script được hiển thị trong hộp thoại dịch vụ nâng cao:

  1. Trong trình chỉnh sửa Apps Script, hãy nhấp vào biểu tượng Thêm dịch vụ .
  2. Tìm Campaign Manager 360 API trong danh sách các dịch vụ có sẵn.
  3. Giá trị được chọn trong trình đơn thả xuống phiên bản là phiên bản API Campaign Manager 360 hiện đang được sử dụng.

Trình chỉnh sửa cũ của Apps Script

Thông tin phiên bản của Apps Script được hiển thị trong hộp thoại dịch vụ nâng cao:

  1. Trong trình chỉnh sửa Apps Script, hãy chuyển đến Tài nguyên > Dịch vụ nâng cao của Google.
  2. Tìm Campaign Manager 360 API trong danh sách các dịch vụ có sẵn.
  3. Giá trị được chọn trong trình đơn thả xuống phiên bản là phiên bản API Campaign Manager 360 hiện đang được sử dụng.

C#

Thông tin phiên bản của Thư viện ứng dụng API của Google cho .NET được hiển thị ở những nơi sau:

  1. Có trong tên gói nuget và không gian tên dịch vụ. 
    Google.Apis.Dfareporting.v3_4
  2. Được hiển thị thông qua một thuộc tính công khai của DfareportingService. 
    Console.WriteLine(DfareportingService.Version);

Java

Thông tin phiên bản của Thư viện ứng dụng Java cho API của Google được hiển thị ở những nơi sau:

  1. Được chỉ định trong artifactId maven. 
    <dependency>
  <groupId>com.google.apis</groupId>
  <artifactId>google-api-services-dfareporting</artifactId>
  <version>v3.4-rev1-1.21.0</version>
</dependency>
  2. Có trong tên tệp JAR. 
    google-api-services-dfareporting-v3.4-rev1-1.21.0.jar
  3. Được hiển thị thông qua một thuộc tính công khai của Dfareporting. 
    System.out.println(Dfareporting.DEFAULT_SERVICE_PATH);

PHP

Thông tin phiên bản của Thư viện ứng dụng API của Google cho PHP được hiển thị thông qua thuộc tính công khai của Google_Service_Dfareporting: 

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

Python

Thư viện ứng dụng API của Google cho Python (phiên bản 1/phiên bản 2) không có phiên bản. Phiên bản API cần sử dụng được chỉ định dưới dạng đối số cho trình tạo khám phá: 

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

Ruby

Thư viện ứng dụng API của Google cho Ruby phiên bản < 0.9 không được tạo phiên bản. Phiên bản API cần sử dụng được chỉ định dưới dạng đối số cho hàm khởi tạo dịch vụ: 

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

Đối với Thư viện ứng dụng API của Google cho phiên bản Ruby >= 0.9, phiên bản sẽ hiển thị trong không gian tên dịch vụ: 

Google.Apis.DfareportingV3_4

Ghi lại phiên bản bạn đang sử dụng vì bạn sẽ cần thông tin này sau này.

Bước 2: Xác định trạng thái của phiên bản

Lịch ngừng sử dụng liệt kê trạng thái của mọi phiên bản hiện được hỗ trợ. Tìm phiên bản của bạn trong danh sách này và xác định trạng thái của phiên bản như sau:

  1. Nếu không có ngày nào được liệt kê trong cột Ngày ngừng sử dụng và Ngày ngừng hoạt động, thì bạn đang sử dụng phiên bản được hỗ trợ đầy đủ.
  2. Nếu có ngày được liệt kê, thì phiên bản bạn đang sử dụng hiện không còn được dùng nữa và sẽ ngừng hoạt động vào ngày được chỉ định.
  3. Nếu phiên bản của bạn không có trong danh sách, thì phiên bản đó đã ngừng hoạt động và không còn được hỗ trợ nữa.

Nếu thuộc trường hợp #2 hoặc #3 ở trên, bạn cần di chuyển sang phiên bản mới hơn để tránh bị gián đoạn dịch vụ. Bạn nên chuyển sang phiên bản mới nhất được liệt kê ở đầu bảng lịch trình ngừng sử dụng (ngoại trừ các bản phát hành beta). Điều này sẽ giúp bạn có được khoảng thời gian tối đa giữa các lần nâng cấp.

Bước 3: Nâng cấp phiên bản

Nếu bạn xác định rằng mình cần di chuyển, bước tiếp theo là cập nhật chế độ tích hợp hoặc tải bản dựng mới của thư viện ứng dụng mà bạn muốn. Xin lưu ý rằng mặc dù một số thư viện ứng dụng có thể chỉ cung cấp một bản dựng hoạt động với mọi phiên bản API, nhưng một số thư viện khác sẽ có các bản dựng riêng cho từng phiên bản. Danh sách bên dưới cung cấp thông tin nâng cấp chung cho các thư viện ứng dụng và công cụ tích hợp được sử dụng rộng rãi nhất.

Trình chỉnh sửa Apps Script mới

Google Apps Script hỗ trợ tất cả phiên bản API Campaign Manager 360 và cho phép bạn chọn phiên bản để sử dụng theo từng tập lệnh. Cách thay đổi phiên bản mà một tập lệnh cụ thể sử dụng:

  1. Trong trình chỉnh sửa Apps Script, hãy nhấp vào biểu tượng Thêm dịch vụ .
  2. Tìm Campaign Manager 360 API trong danh sách các dịch vụ có sẵn.
  3. Thay đổi phiên bản API Campaign Manager 360 đang sử dụng thông qua trình đơn thả xuống phiên bản.
  4. Nhấp vào Thêm để lưu các thay đổi.

Trình chỉnh sửa cũ của Apps Script

Google Apps Script hỗ trợ tất cả phiên bản API Campaign Manager 360 và cho phép bạn chọn phiên bản để sử dụng theo từng tập lệnh. Cách thay đổi phiên bản mà một tập lệnh cụ thể sử dụng:

  1. Trong trình chỉnh sửa Apps Script, hãy chuyển đến Tài nguyên > Dịch vụ nâng cao của Google.
  2. Tìm Campaign Manager 360 API trong danh sách các dịch vụ có sẵn.
  3. Thay đổi phiên bản API Campaign Manager 360 đang sử dụng thông qua trình đơn thả xuống phiên bản.
  4. Nhấp vào OK để lưu các thay đổi.

C#

Thư viện ứng dụng API Google cho .NET cung cấp các bản dựng riêng cho từng phiên bản API Campaign Manager 360, được phân phối thông qua Nuget.

Để biết hướng dẫn cài đặt chi tiết hoặc các lựa chọn tải xuống thay thế, hãy tham khảo tài liệu về thư viện ứng dụng.

Java

Thư viện ứng dụng API Google cho Java cung cấp các bản dựng riêng cho từng phiên bản API Campaign Manager 360, được phân phối thông qua Maven.

Để biết hướng dẫn cài đặt chi tiết hoặc các lựa chọn tải xuống thay thế, hãy tham khảo tài liệu về thư viện ứng dụng.

PHP

Thư viện ứng dụng API của Google cho PHP cung cấp các bản dựng riêng cho từng phiên bản của API Campaign Manager 360, được phân phối thông qua Packagist.

Để biết hướng dẫn cài đặt chi tiết hoặc các lựa chọn tải xuống thay thế, hãy tham khảo tài liệu về thư viện ứng dụng.

Python

Mọi bản dựng của Thư viện ứng dụng API của Google cho Python (phiên bản 1/phiên bản 2) đều hỗ trợ tất cả phiên bản của API Campaign Manager 360. Bạn chỉ cần cập nhật chuỗi phiên bản được truyền dưới dạng đối số đến trình tạo khám phá: 

discovery.build('dfareporting', 'v3.4', http=http)
 Để biết hướng dẫn cài đặt chi tiết hoặc các lựa chọn tải xuống thay thế, hãy tham khảo tài liệu về thư viện ứng dụng.

Ruby

Thư viện ứng dụng API của Google cho Ruby phiên bản 0.8 trở xuống hỗ trợ tất cả phiên bản API Campaign Manager 360. Bạn chỉ cần cập nhật chuỗi phiên bản được truyền dưới dạng đối số đến hàm khởi tạo dịch vụ: 

service = Google::APIClient::Service.new("dfareporting", "v3.4",
    {
      :application_name => "My application",
      :application_version => '1.0.0',
      :authorization => authorization
    }
)
 Thư viện ứng dụng API của Google cho Ruby phiên bản 0.9 trở lên cung cấp các bản dựng riêng biệt cho từng phiên bản API của Campaign Manager 360, được phân phối thông qua RubyGems. Để biết hướng dẫn cài đặt chi tiết hoặc các lựa chọn tải xuống thay thế, hãy tham khảo tài liệu về thư viện ứng dụng.

Bước 4: Giải quyết sự khác biệt về phiên bản

Chúng tôi cố gắng làm cho các bản phát hành mới có khả năng tương thích ngược, nghĩa là việc di chuyển giữa các phiên bản API sẽ không cần thay đổi mã của bạn. Khi không thể làm được điều này, chúng tôi sẽ thông báo về những thay đổi cần nhà phát triển hành động (còn gọi là thay đổi có thể gây lỗi) trong ghi chú phát hành.

Tại thời điểm này, bạn nên xem lại ghi chú phát hành của chúng tôi, bắt đầu từ phiên bản sau phiên bản bạn bắt đầu (bạn đã ghi chú trong phần trước) và tiếp tục cho đến phiên bản bạn đang nâng cấp. Các phần của ghi chú phát hành phải được diễn giải như sau:

  • Tính năng mới – Chức năng mới được thêm.
  • Sunsets (Ngừng hoạt động) – Chức năng đã bị xoá khỏi API. Nếu có, chức năng thay thế sẽ được đề cập trong phần này.
  • Vấn đề đã biết – Những thay đổi không phải là việc thêm hoặc xoá. Ví dụ: phần này có thể đề cập đến các trường hoặc phương thức đã được đổi tên hoặc logic xác thực đã thay đổi.

Chức năng trong phần Tính năng mới sẽ không yêu cầu thay đổi mã và hiện có thể bỏ qua. Bạn có thể quay lại phần này sau nếu muốn thử nghiệm một tính năng nào đó mà chúng tôi đã thêm.

Mặt khác, nếu thấy có thay đổi trong phần Ngừng hoạt động hoặc Vấn đề đã biết, thì bạn có thể cần phải hành động. Bạn nên tìm kiếm trong mã để xác định xem ứng dụng của mình có sử dụng bất kỳ chức năng nào đã bị xoá hoặc sửa đổi hay không. Nếu có, bạn cần cập nhật mã để giải quyết những thay đổi này

Nắm bắt thông tin

Như đã đề cập trước đó, các bản phát hành và nội dung bị ngừng sử dụng của API Campaign Manager 360 thường xuyên diễn ra. Thông tin cập nhật về các bản phát hành mới, các tính năng ngừng hoạt động và ngừng cung cấp được đăng trên các kênh sau:

Bạn nên đăng ký theo dõi một hoặc nhiều kênh này để nắm bắt thông tin mới nhất về API.