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

Các phiên bản mới của API Campaign Manager 360 đượ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ũ hơn sẽ ngừng hoạt động 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 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ó được dùng nữa 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 API Campaign Manager 360 không còn được dùng nữa, 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 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 từng ngôn ngữ hoặc chế độ tích hợp chính thức của chúng tôi. 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à tích hợp này đang sử dụng ở bên dưới:

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

Thông tin phiên bản của Apps Script sẽ xuất hiện trong hộp thoại dịch vụ nâng cao:

  1. Trên 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 API Campaign Manager 360 trong danh sách các dịch vụ có sẵn.
  3. Giá trị đã 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 sẽ xuất hiện trong hộp thoại dịch vụ nâng cao:

  1. Từ 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 API Campaign Manager 360 trong danh sách các dịch vụ có sẵn.
  3. Giá trị đã 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 .NET cho API của Google sẽ được công bố ở những vị trí sau:

  1. Có trong tên gói và vùng chứa tên dịch vụ nuget.
    Google.Apis.Dfareporting.v3_4
  2. Được hiển thị thông qua 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 API của Google cho Java được hiển thị ở những vị trí sau:

  1. Được chỉ định trong cấu phần phần mềm 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 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 Python cho API của Google chưa được tạo phiên bản. Phiên bản API cần sử dụng được chỉ định làm đối số cho trình tạo khám phá:

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

Ruby

Thư viện Google API Client phiên bản <0.9 chưa được tạo phiên bản. Phiên bản API cần sử dụng được chỉ định làm đố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 các phiên bản Ruby >= 0.9, phiên bản sẽ hiển thị trong vùng chứa 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.

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

Lịch biểu 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 được liệt kê trong cột Ngày ngừng sử dụngNgày ngừng hoạt động thì bạn đang sử dụng phiên bản được hỗ trợ đầy đủ.
  2. Nếu ngày được liệt kê, phiên bản bạn đang sử dụng hiện không đượ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ì có nghĩa là phiên bản đó đã ngừng hoạt động và không còn được hỗ trợ nữa.

Nếu bị chuyển sang trạng thái #2 hoặc #3 ở trên, bạn cần 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, phiên bản này đượ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). Nhờ đó, bạn sẽ 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 đã xác định rằng bạn cần di chuyển, bước tiếp theo là cập nhật tích hợp của bạn hoặc lấy bản dựng cập nhật của thư viện ứng dụng ưa thích. 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 bất kỳ phiên bản API nào, nhưng một số thư viện khác sẽ có bản dựng riêng cho mỗi phiên bản. Danh sách dưới đây cung cấp thông tin nâng cấp chung cho các thư viện ứng dụng và tích hợp được sử dụng rộng rãi nhất.

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

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

  1. Trên 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 API Campaign Manager 360 trong danh sách các dịch vụ có sẵn.
  3. Thay đổi phiên bản API Campaign Manager 360 đang được 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ả các phiên bản của API Campaign Manager 360 và cho phép bạn chọn phiên bản để sử dụng trên cơ sở từng tập lệnh. Để thay đổi phiên bản được một tập lệnh cụ thể sử dụng:

  1. Từ 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 API Campaign Manager 360 trong danh sách các dịch vụ có sẵn.
  3. Thay đổi phiên bản API Campaign Manager 360 đang được 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 .NET cho API của Google 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 Nuget.

Để biết hướng dẫn cài đặt chi tiết hoặc các tùy 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 Java cho API của Google 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 Maven.

Để biết hướng dẫn cài đặt chi tiết hoặc các tùy 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 qua Packagist.

Để biết hướng dẫn cài đặt chi tiết hoặc các tùy 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 Python cho API của Google đều hỗ trợ tất cả cá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 đang được truyền làm đối số cho 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 tùy 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 phiên bản Ruby 0.8 trở xuống hỗ trợ tất cả cá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 đang được truyền 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
    }
)
Thư viện ứng dụng API của Google cho Ruby v0.9+ 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 RubyGems. Để biết hướng dẫn cài đặt chi tiết hoặc các tùy 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 các điểm 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 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 thiết thay đổi mã của bạn. Trong trường hợp không thể thực hiện việc này, chúng tôi sẽ thông báo về những thay đổi cần nhà phát triển (còn gọi là thay đổi có thể gây lỗi) trong ghi chú phát hành của chúng tôi.

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 với phiên bản sau phiên bản mà bạn đã bắt đầu từ đó (mà bạn đã ghi chú trong phần trước) và tiếp tục cho đến phiên bản mà 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.
  • Hoàng hôn – Chức năng đã bị xoá khỏi API. Phần này sẽ đề cập đến chức năng thay thế khi có sẵn.
  • Vấn đề đã biết – Những thay đổi không được bổ sung hoặc xóa. Ví dụ: phần này có thể bao gồm các trường hoặc phương pháp đã được đổi tên hoặc logic xác thực đã thay đổi.

Chức năng trong Tính năng mới sẽ không yêu cầu thay đổi mã và có thể bỏ qua ngay bây giờ. Vui lòng quay lại phần này sau nếu bạn muốn thử nghiệm điều gì đó mà chúng tôi đã thêm.

Ngược lại, nếu bạn thấy thay đổi trong mục Hoàng hôn 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 thông qua mã của mình để xác định xem ứng dụng có sử dụng chức năng đã sửa đổi hay đã bị sửa đổi gì không. Nếu có, bạn sẽ cần phải cập nhật mã để giải quyết các thay đổi này

Nắm bắt thông tin

Như đã đề cập trước đó, việc phát hành và ngừng sử dụng API của Campaign Manager 360 thường xuyên xảy ra. Nội dung cập nhật về các bản phát hành mới, không dùng nữa và ngừng hoạt động được đăng lên các kênh sau:

Bạn nên đăng ký một hoặc nhiều kênh trong số này để luôn nắm được những tin tức mới nhất về API.