หน้ากากอนามัย

Ad Manager REST API ใช้มาสก์ช่องสำหรับการอ่านและเขียนบางส่วน สิ่งนี้สามารถ ปรับปรุงประสิทธิภาพด้วยการจำกัดปริมาณข้อมูลที่ถ่ายโอน ฟิลด์มาสก์ แสดงด้วยรายการชื่อช่องที่คั่นด้วยคอมมา เช่น

startTime,endTime,targeting.geoTargeting

อ่านมาสก์

มาสก์การอ่านจะควบคุมช่องที่จะแสดงในการตอบสนองของ API คุณสามารถตั้ง อ่านมาสก์ในคำขอของคุณใน 2 วิธี ดังนี้

1. พารามิเตอร์การค้นหา fields:

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

2. ส่วนหัว HTTP ของ X-Goog-FieldMask:

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

หมายเหตุ: สตริงมาสก์ฟิลด์จะรองรับทั้ง camelCase และ snake_case

มาสก์การอ่านเริ่มต้น

เมธอด API บางอย่างมีมาสก์ฟิลด์เริ่มต้นสำหรับช่องที่มีราคาแพง เพื่อกลับไป ตัวอย่างวิธีการแสดงรายการ โดยค่าเริ่มต้น จะไม่มีการรวมค่าเหล่านี้ totalSize ด้วย

ต้องระบุข้อมูลในฟิลด์เหล่านี้อย่างชัดแจ้งในมาสก์ด้วยชื่อหรือโดย โดยใช้ไวลด์การ์ด *

อัปเดตมาสก์

อัปเดตมาสก์จะควบคุมช่องที่จะมีการเปลี่ยนแปลงในการอัปเดต (PATCH) อีกครั้ง เมื่อตั้งค่ามาสก์การอัปเดตแล้ว ระบบจะอัปเดตเฉพาะช่องในมาสก์เท่านั้น ไม่ว่าจะมีการตั้งค่าช่องใดในเนื้อหาคำขอก็ตาม

มาสก์สำหรับอัปเดตจะตั้งค่าไว้เป็นพารามิเตอร์การค้นหา เช่น

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

การส่งผ่านฟิลด์

มาสก์ช่องสามารถระบุช่องภายในเอนทิตีโดยใช้อักขระ . สำหรับ การส่งผ่าน ซึ่งเป็นไวยากรณ์เดียวกันกับที่ใช้โดย ตัวกรอง

มาสก์ของช่องจะสัมพันธ์กับออบเจ็กต์การตอบกลับเสมอ เช่น มาสก์สำหรับ การอ่าน LineItem อาจรวม primaryGoal.units มาสก์ที่เกี่ยวข้อง สำหรับข้อมูล LineItems คือ lineItems.primaryGoal.units

คุณสามารถระบุฟิลด์โดยรวมหรือฟิลด์ย่อยก็ได้ ทั้ง 2 อย่าง primaryGoal และ primaryGoal.units ถูกต้อง

ซึ่งจะมีผลกับช่องที่ซ้ำด้วย ฟิลด์มาสก์ LineItem ของ creativePlaceholders.size ถูกต้องและมีเฉพาะช่อง size สำหรับ CreativePlaceholder แต่ละรายการ

หมายเหตุ: มาสก์ของช่องไม่อนุญาตให้เข้าถึงองค์ประกอบที่เฉพาะเจาะจงของข้อมูลที่ซ้ำกัน ตามดัชนี ซึ่งส่งผลให้เกิดข้อผิดพลาด INVALID_ARGUMENT รายการ

สัญลักษณ์แทน

คำเตือน: การใช้ไวลด์การ์ดในมาสก์การอัปเดตจะส่งต่อไม่ได้ ไวลด์การ์ดจะล้างช่องใดก็ตามที่ไคลเอ็นต์ไม่รู้จัก

ฟิลด์มาสก์รองรับอักขระ * ซึ่งระบุฟิลด์ทั้งหมดในข้อความ ตัวอย่างต่อไปนี้แสดงการใช้ไวลด์การ์ดเมื่อข้อมูล Orders เมธอดนี้มีมาสก์การอ่านเริ่มต้นที่มี ไม่รวมฟิลด์ total_size

ตัวอย่าง	ความหมาย
*	รวมทุกช่อง รวมถึง total_size
orders	รวมเฉพาะช่อง orders และฟิลด์ย่อยทั้งหมด
orders.*	รวมเฉพาะช่อง orders และฟิลด์ย่อยทั้งหมด

ช่องไม่ถูกต้อง

หากฟิลด์มาสก์อ้างอิงถึงค่าที่ไม่มีอยู่ API จะตอบสนอง มีข้อผิดพลาด INVALID_ARGUMENT