Chuyển từ phiên bản 2 sang phiên bản 3

Lần cập nhật gần đây nhất: 31/10/2023

Di chuyển ứng dụng

Để di chuyển từ phiên bản 2 sang phiên bản 3, bạn cần cập nhật URL điểm cuối để gọi phiên bản 3 và cập nhật ứng dụng để tính đến các thay đổi có thể gây lỗi.

Cập nhật lệnh gọi API từ phiên bản 2 lên phiên bản 3

Để sử dụng phiên bản 3 thay vì phiên bản 2, bạn cần cập nhật các yêu cầu để sử dụng các điểm cuối phiên bản 3 mới.

Ví dụ: để gọi phương thức advertisers.get bằng v2, bạn sẽ sử dụng URL sau:

GET https://displayvideo.googleapis.com/v2/advertisers/advertiserId

Đối với phiên bản 3, hãy cập nhật URL thành:

GET https://displayvideo.googleapis.com/v3/advertisers/advertiserId

Nếu bạn đang sử dụng thư viện ứng dụng để gửi yêu cầu đến API, hãy sử dụng phiên bản mới nhất của thư viện ứng dụng và cập nhật cấu hình để sử dụng phiên bản 3.

Thực hiện các thay đổi bắt buộc

Chúng tôi sẽ ra mắt một số thay đổi có thể gây lỗi trong phiên bản 3. Xem lại các hướng dẫn sau và thực hiện các thay đổi bắt buộc liên quan đến cách bạn hiện đang sử dụng API Display & Video 360.

  • Tài nguyên YoutubeAdGroup và YoutubeAdGroupAd đã được thay thế bằng tài nguyên AdGroup và AdGroupAd. Các tài nguyên mới này cung cấp thông tin gần giống với tài nguyên phiên bản 2, nhưng có thể sử dụng tên trường hoặc loại enum đã cập nhật. Trong quá trình tích hợp, hãy thay thế việc sử dụng tài nguyên YoutubeAdGroup hoặc YoutubeAdGroupAd bằng tài nguyên AdGroup và AdGroupAd, đồng thời cập nhật các lệnh gọi đến các dịch vụ v2 sau đây thành dịch vụ v3 tương ứng:
  • Các tệp tham chiếu đến đối tượng YoutubeAndPartnersBiddingStrategy đã được di chuyển sang trường youtubeAndPartnersBid mới trong đối tượng BiddingStrategy chung. Trường biddingStrategy đã bị xoá khỏi đối tượng YoutubeAndPartnersSettings. Cập nhật chế độ tích hợp để truy xuất chiến lược đặt giá thầu cho các mục hàng hoặc nhóm quảng cáo trên YouTube từ đối tượng BiddingStrategy trong trường bidStrategy của tài nguyên LineItem hoặc AdGroup.
  • Trường thirdPartyMeasurementSettings đã được đổi tên thành thirdPartyMeasurementConfigs trong đối tượng YoutubeAndPartnersSettings và đối tượng YoutubeAndPartnersThirdPartyMeasurementSettings đã được đổi tên thành ThirdPartyMeasurementConfigs. Cập nhật chế độ tích hợp để truy xuất thông tin cấu hình đo lường của bên thứ ba bằng cách sử dụng trường và đối tượng mới.

Thêm cấu hình thanh toán bắt buộc khi tạo nhà quảng cáo

billingConfig hiện là trường bắt buộc trong tài nguyên Advertiser. Cập nhật các yêu cầu advertisers.create để xác minh rằng bạn đã đặt trường này. Bạn có thể truy xuất thông tin thanh toán mặc định cho đối tác chính thông qua trường tài nguyên billingConfig Partner mới.

Sử dụng trường mới để kiểm soát tính năng tối ưu hoá tiêu chí nhắm mục tiêu

Trường boolean enableOptimizedTargeting mới đã thay thế trường targetingExpansionLevel trong đối tượng TargetingExpansionConfig.

Cập nhật chế độ tích hợp đơn đặt hàng quảng cáo để sử dụng trường KPI mới

Trường kpi mới đã thay thế trường performanceGoal trong tài nguyên InsertionOrder. Trường mới này sử dụng đối tượng Kpi thay cho đối tượng PerformanceGoal, đồng thời sử dụng các trường và enum mới.

Xoá các tệp tham chiếu đến các dịch vụ và trường không dùng nữa

Nhiều thực thể đã bị xoá trong phiên bản 3 để phù hợp với các tính năng ngừng hoạt động trước đây:

Các nội dung thay đổi khác

Ngoài các thay đổi có thể gây lỗi nêu trên, phiên bản 3 cũng ra mắt các tính năng mới.

Bạn có thể xem các tính năng được thêm vào phiên bản 3 sau lần phát hành đầu tiên trong ghi chú phát hành của chúng tôi.

Quản lý danh sách vị trí ở gần

Trong phiên bản 3, bạn có thể quản lý đầy đủ danh sách vị trí ở gần, cho phép bạn sử dụng dịch vụ advertisers.locationLists.assignedLocations để tạo và xoá các vị trí được chỉ định cho tài nguyên TARGETING_LOCATION_TYPE_PROXIMITY LocationList. Vị trí được xác định bằng mã nhận dạng của tài nguyên TARGETING_TYPE_POI TargetingOption. Bạn có thể truy xuất các giá trị này bằng cách sử dụng targetingTypes.targetingOptions.search.

Khả năng xây dựng thuật toán đặt giá thầu tuỳ chỉnh dựa trên quy tắc

Trong phiên bản 3, bạn có thể tạo và truy xuất thuật toán đặt giá thầu tuỳ chỉnh dựa trên quy tắc bằng cách sử dụng các dịch vụ customBiddingAlgorithms, media, customBiddingAlgorithms.rules.

Tính năng này đang trong giai đoạn thử nghiệm và chỉ dành cho những đối tác có tên trong danh sách cho phép. Nếu đối tác của bạn không có trong danh sách cho phép, thì yêu cầu của bạn sẽ trả về lỗi.