Lập phiên bản

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

Google Ads API tuân theo 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ụ: v26.0 (hoặc v26) là phiên bản chính, còn v26.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 lớn

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 có khả năng tương thích ngược. Bản phát hành đầu tiên 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 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ụ: v26):

https://googleads.googleapis.com/vX

Nếu bạn đang nâng cấp từ một phiên bản lớn cũ, thì mã của bạn có thể cần thay đổi khi bạn chuyển sang điểm cuối của 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 có thể gây lỗi trong mã của bạn.

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

  • Xoá hoặc đổi tên một 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 lỗi được trả về từ A thành B.

Phiên bản nhỏ

Các phiên bản nhỏ 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ụ: v26.1).

Khi một phiên bản nhỏ được phát hành, điểm cuối của 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ị lỗi.

Phiên bản nhỏ 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ẽ không được dùng nữa và sau đó sẽ ngừng hoạt động:

  • Ngừng sử dụng: Khi một phiên bản lớn (chẳng hạn như v26) được phát hành, tất cả các phiên bản lớn trước đó sẽ được đánh dấu là ngừng sử dụng. Các lệnh gọi API đến phiên bản không dùng nữa vẫn 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ó vẫn tiếp tục hỗ trợ các phiên bản đó, 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 đó đều không thành công.

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 cung cấp phiên bản. Hãy xem lịch ngừng sử dụng và ngừng cung cấp để biết ngày hoạt động, ngày ngừng sử dụng và ngày ngừng cung cấp theo lịch.