Tạo phiên bản trong API Báo cáo Search Ads 360

API Báo cáo Search Ads 360 sử dụng cách tạo phiên bản ngữ nghĩa.

Có các phiên bản lớn và nhỏ, có định dạng là vMAJOR_MINOR. Ví dụ: v0_0 là phiên bản lớn đầu tiên và v0_1 là phiên bản nhỏ đầu tiên. Hậu tố của số phiên bản cho biết loại phiên bản: đối với các phiên bản lớn, số này luôn bằng 0, còn đối với các phiên bản nhỏ, số phiên bản luôn lớn hơn 0.

Phiên bản lớn

Các bản phát hành chính tạo ra những thay đổi có thể gây lỗi, tức là những thay đổi không có khả năng tương thích ngược.

Mỗi phiên bản lớn có một điểm cuối riêng, ví dụ:

https://searchads360.googleapis.com/v0

https://searchads360.googleapis.com/v1

Khi nâng cấp từ một phiên bản lớn lên một phiên bản lớn khác, bạn có thể phải thay đổi mã trước khi chuyển sang điểm cuối của phiên bản lớn mới.

Nếu sử dụng thư viện ứng dụng, bạn cần nâng cấp lên phiên bản mới nhất. Các phiên bản lớn mới cung cấp hướng dẫn di chuyển để giúp bạn khắc phục mọi thay đổi có thể gây lỗi trong mã.

Sau đây là một số ví dụ về các 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 của một 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 0 thành -- làm giá trị mặc định.
  • Thay đổi lý do lỗi được trả về từ A thành B.

Phiên bản nhỏ

Phiên bản nhỏ chỉ giới thiệu các thay đổi có khả năng tương thích ngược.

Khi phát hành một phiên bản nhỏ, điểm cuối đang được sử dụng sẽ tự động được cập nhật. Điều này không khiến mã của bạn bị hỏng. Bạn có thể tiếp tục sử dụng thư viện ứng dụng hiện có.

Các phiên bản nhỏ bao gồm các tính năng hoặc bản cập nhật mới không ảnh hưởng đến mã hiện có. Nếu muốn sử dụng các tính năng mới, bạn cần nâng cấp thư viện ứng dụng lên phiên bản mới nhất.

Hoàng hôn

Khi một phiên bản API Báo cáo Search Ads 360 cũ dự kiến ngừng hoạt động, chúng tôi sẽ đăng thông báo về nhóm Google searchads-api-announcements.