Lập phiên bản

Tạo phiên bản ngữ nghĩa

Google Ads API tuân theo cách tạo phiên bản ngữ nghĩa với số phiên bản chính và số phiên bản phụ. Các phiên bản được viết dưới dạng MAJOR.MINOR hoặc vMAJOR.MINOR. Ví dụ: v25.0 (hoặc v25) là phiên bản chính, còn v25.1 là phiên bản phụ.

Hãy xem ghi chú phát hành để biết thông tin chi tiết về các phiên bản hiện tại và trước đây.

Phiên bản chính

Các phiên bản phát hành chính có những thay đổi có thể gây lỗi và không tương thích ngược. Bản phát hành ban đầu của một phiên bản lớn kết thúc bằng số 0 (vX.0 hoặc vX, trong đó X là số phiên bản lớn).

Mỗi phiên bản lớn đều có một đường dẫn điểm cuối REST và gRPC riêng (vX), không bao gồm hậu tố phiên bản nhỏ. Trong URL sau, X là số phiên bản chính (ví dụ: v25):

https://googleads.googleapis.com/vX

Nếu bạn đang nâng cấp từ một phiên bản lớn cũ hơn, thì mã của bạn có thể cần thay đổi khi bạn chuyển sang điểm cuối phiên bản lớn mới. Nếu bạn đang sử dụng thư viện ứng dụng của chúng tôi, hãy nâng cấp lên bản phát hành thư viện ứng dụng hỗ trợ phiên bản lớn mới. Khi phát hành một phiên bản chính, chúng tôi sẽ cung cấp hướng dẫn nâng cấp để giúp bạn giải quyết mọi thay đổi gây lỗi trong mã của mình.

Sau đây là một số ví dụ về các thay đổi gây lỗi:

  • Xoá hoặc đổi tên dịch vụ, giao diện, trường, phương thức hoặc giá trị enum.
  • Thay đổi loại trường.
  • Thay đổi định dạng tên tài nguyên.
  • Thay đổi định dạng URL trong định nghĩa HTTP.
  • Thay đổi định dạng đầu ra, chẳng hạn như thay đổi giá trị mặc định.
  • Thay đổi lý do gây ra lỗi được trả về từ A thành B.

Phiên bản phụ

Các phiên bản phụ chỉ giới thiệu những thay đổi tương thích ngược. Đối với phiên bản nhỏ, vMAJOR.MINOR có số MINOR lớn hơn 0 (ví dụ: v25.1).

Khi một phiên bản nhỏ được phát hành, điểm cuối phiên bản lớn hiện có (https://googleads.googleapis.com/vX) sẽ tự động được cập nhật tại chỗ. Bạn không cần thay đổi đường dẫn phiên bản trong URL điểm cuối và mã hiện có vẫn tiếp tục hoạt động mà không bị gián đoạn.

Phiên bản phụ bổ sung các tính năng hoặc bản cập nhật không ảnh hưởng đến mã hiện có của bạn. Để sử dụng các trường hoặc tính năng của một phiên bản nhỏ bằng thư viện ứng dụng, hãy nâng cấp thư viện ứng dụng lên một bản phát hành có chứa các định nghĩa về phiên bản nhỏ.

Ngừng sử dụng và ngừng cung cấp

Định kỳ, các phiên bản Google Ads API cũ sẽ bị ngừng sử dụng và sau đó ngừng hoạt động:

  • Không dùng nữa: Khi một phiên bản lớn (chẳng hạn như v25) được phát hành, tất cả các phiên bản lớn trước đó sẽ được đánh dấu là không dùng nữa. Các lệnh gọi API đến các phiên bản không dùng nữa sẽ tiếp tục thành công cho đến ngày ngừng hoạt động và các bản phát hành thư viện ứng dụng hiện có sẽ tiếp tục hỗ trợ các phiên bản này, mặc dù các bản phát hành thư viện ứng dụng tiếp theo sẽ bỏ qua các phiên bản API không dùng nữa để giảm kích thước gói.
  • Ngừng hoạt động: Một phiên bản sẽ bị vô hiệu hoá vào ngày ngừng hoạt động và tất cả lệnh gọi API đến điểm cuối của phiên bản đó sẽ không thực hiện được.

Chúng tôi đăng thông báo trên blog dành cho nhà phát triển trước khi ngừng hỗ trợ phiên bản. Xem lịch ngừng sử dụng và ngừng cung cấp để biết ngày ngừng sử dụng, ngày ngừng cung cấp theo lịch và ngày ngừng cung cấp đang hoạt động.