Khẩu trang tại chỗ

API REST của Ad Manager sử dụng mặt nạ trường để đọc và ghi một phần. Điều này có thể cải thiện hiệu suất bằng cách giới hạn lượng dữ liệu được chuyển. Mặt nạ trường được biểu thị bằng một danh sách tên trường được phân tách bằng dấu phẩy. Ví dụ:

startTime,endTime,targeting.geoTargeting

Đọc mặt nạ

Mặt nạ đọc kiểm soát trường nào có trong phản hồi API. Bạn có thể đặt đọc mặt nạ trên yêu cầu của bạn theo hai cách:

  1. Tham số truy vấn fields:

    curl https://admanager.googleapis.com/v1/networks/123456/adUnits?fields=adUnits,nextPageToken,totalSize

  2. Tiêu đề HTTP X-Goog-FieldMask:

    curl -H "X-Goog-FieldMask: adUnits,nextPageToken,totalSize" \
    https://admanager.googleapis.com/v1/networks/123456/adUnits

Mặt nạ đọc mặc định

Một số phương thức API bao gồm mặt nạ trường mặc định cho các trường tốn kém quay lại. Ví dụ về phương thức danh sách. Theo mặc định, các thành phần này không bao gồm totalSize .

Bạn phải yêu cầu rõ ràng các trường này trong mặt nạ trường theo tên hoặc bằng cách bằng ký tự đại diện *.

Cập nhật khẩu trang

Cập nhật mặt nạ kiểm soát những trường sẽ được thay đổi trong một bản cập nhật (PATCH) của bạn. Khi bạn đặt mặt nạ cập nhật, chỉ các trường trong mặt nạ này được cập nhật bất kể trường nào được đặt trong nội dung yêu cầu.

Mặt nạ cập nhật được đặt làm tham số truy vấn. Ví dụ:

curl -X PATCH https://admanager.googleapis.com/v1/networks/1234/order/4567?updateMask=displayName

Truyền tải tại chỗ

Mặt nạ trường có thể chỉ định các trường trong một thực thể bằng cách sử dụng ký tự . cho truyền tải. Đây là cú pháp tương tự được sử dụng bởi Bộ lọc.

Mặt nạ trường luôn liên quan đến đối tượng phản hồi. Ví dụ: mặt nạ cho việc đọc LineItem có thể bao gồm primaryGoal.units. Mặt nạ tương ứng đối với trang thông tin LineItems là lineItems.primaryGoal.units.

Bạn có thể chỉ định toàn bộ một trường hoặc một trong các trường phụ của trường đó. Cả hai primaryGoal và primaryGoal.units là hợp lệ.

Điều này cũng áp dụng cho các trường lặp lại. Mặt nạ trường LineItem của creativePlaceholders.size hợp lệ và chỉ bao gồm trường size cho mỗi CreativePlaceholder.

Ký tự đại diện

Mặt nạ trường hỗ trợ ký tự * cho biết tất cả các trường trong thông báo. Các ví dụ sau đây minh hoạ việc sử dụng ký tự đại diện khi liệt kê Orders. Phương thức này có mặt nạ đọc mặc định không bao gồm trường total_size.

Ví dụ: Ý nghĩa
* Bao gồm tất cả các trường, bao gồm cả total_size
orders Chỉ bao gồm trường orders và tất cả các trường phụ
orders.* Chỉ bao gồm trường orders và tất cả các trường phụ

Trường không hợp lệ

Nếu mặt nạ trường tham chiếu đến một giá trị không tồn tại, API sẽ phản hồi có lỗi INVALID_ARGUMENT.