พารามิเตอร์สตริงคำค้นหา filters
จะจำกัดข้อมูลที่แสดงผลในรายงาน AdSense Management API เมื่อใช้พารามิเตอร์ filters
ระบบจะจัดเตรียมมิติข้อมูลที่ต้องการกรอง ตามด้วยนิพจน์ตัวกรอง
การค้นหาที่กรองแล้วจะจำกัดแถวที่จะรวมไว้ในผลลัพธ์ ระบบจะทดสอบแต่ละแถวในผลลัพธ์กับตัวกรอง หากตัวกรองตรงกัน แถวจะยังคงอยู่และหากไม่ตรงกัน ระบบจะไม่แถวนั้นทิ้ง
- การเข้ารหัส URL: ไลบรารีของไคลเอ็นต์จะเข้ารหัสโอเปอเรเตอร์ตัวกรองโดยอัตโนมัติ อย่างไรก็ตาม หากคุณส่งคำขอไปยังโปรโตคอลโดยตรง คุณต้องเข้ารหัสโอเปอเรเตอร์ตัวกรองอย่างชัดเจนตามที่ระบุไว้ในตารางด้านล่าง
- ลำดับความสำคัญในการกรอง: การกรองจะเกิดขึ้นก่อนการรวมมิติข้อมูล เพื่อให้เมตริกที่แสดงผลแสดงผลรวมของมิติข้อมูลที่เกี่ยวข้องเท่านั้น
ไวยากรณ์ตัวกรอง
ตัวกรองเดียวจะใช้แบบฟอร์มต่อไปนี้
name operator expression
ในไวยากรณ์นี้
- name — ชื่อของมิติข้อมูลที่จะกรอง
เช่น
AD_CLIENT_ID
จะกรองรหัสไคลเอ็นต์ของโฆษณา - โอเปอเรเตอร์ — กำหนดประเภทการจับคู่ตัวกรองที่จะใช้
- นิพจน์ — ระบุค่าที่รวมอยู่ในผลลัพธ์
สามารถใช้มิติข้อมูลทั้งหมดที่ใช้กับเมตริกที่รายงานเป็นตัวกรองได้ โดยยกเว้นมิติข้อมูลที่เกี่ยวข้องกับวันที่ (DATE
, WEEK
และ MONTH
) หากต้องการกรองตามวันที่ ให้ระบุช่วงวันที่ของรายงานแทน
โอเปอเรเตอร์ตัวกรอง
โอเปอเรเตอร์ตัวกรองมี 2 แบบ โอเปอเรเตอร์ต้องเป็น URL ที่เข้ารหัสเพื่อให้รวมอยู่ในสตริงการค้นหาของ URL
ผู้ประกอบธุรกิจ | คำอธิบาย | แบบฟอร์มที่เข้ารหัส URL | ตัวอย่าง |
---|---|---|---|
== |
การทำงานแบบตรงทั้งหมด | %3D%3D |
รวมเมตริกที่มีชื่อประเทศเป็นแคนาดา:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
มีสตริงย่อย | %3D@ |
เมตริกรวมที่มีชื่อประเทศมีคำว่าสหรัฐอเมริกา ซึ่งจะตรงกับสหรัฐอเมริกาและสหราชอาณาจักร เช่น filters=COUNTRY_NAME%3D@United |
กรองนิพจน์
มีกฎที่สำคัญสองข้อสำหรับนิพจน์ตัวกรอง:
- อักขระที่สงวน URL — อักขระอย่าง
&
ต้องได้รับการเข้ารหัส URL ด้วยวิธีปกติ ไลบรารีของไคลเอ็นต์จะดูแลเรื่องนี้ให้คุณ ดังนั้นคุณจึงไม่ต้องกังวลกับการเข้ารหัสนี้ในกรณีที่คุณเรียกใช้โปรโตคอลโดยตรงเท่านั้น - อักขระที่ห้ามใช้ - คอมมาและแบ็กสแลชต้องเป็นแบ็กสแลชเป็นอักขระหลีกเมื่อปรากฏในนิพจน์
- แบ็กสแลช
\\
- คอมมา
\,
- แบ็กสแลช
หมายเหตุ: อย่าลืมใช้อักขระหลีกกับแบ็กสแลชก่อนเครื่องหมายจุลภาค เพื่อหลีกเลี่ยงการ Escape 2 ครั้ง
การรวมตัวกรอง
ตัวกรองสามารถรวมได้โดยใช้ตรรกะบูลีน OR
และ AND
ตรรกะ OR
ตรรกะ OR
จะกำหนดโดยใช้คอมมา (,
) ภายในนิพจน์ตัวกรอง
ตัวอย่าง: (แต่ละรายการต้องมีการเข้ารหัส URL)
รหัสประเทศเป็น (US หรือ UK):
COUNTRY_CODE==US,COUNTRY_CODE==UK
ตรรกะ AND
ตรรกะ AND
จะเกิดขึ้นได้โดยการระบุพารามิเตอร์ตัวกรองหลายรายการ
ซึ่งหมายถึงการมอบอาร์เรย์ของตัวกรองในไลบรารีของไคลเอ็นต์
ตัวอย่างเช่น
รหัสประเทศคือ US และรหัสผลิตภัณฑ์คือ AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
การรวมตรรกะ AND และ OR
สามารถรวมตรรกะ AND และ OR เป็นนิพจน์เดียว
หมายเหตุ: ระบบจะประเมินตัวกรองแต่ละรายการแยกกันก่อนที่จะรวมตัวกรองทั้งหมดเป็นนิพจน์ตรรกะ "และ"
ตัวอย่างเช่น
รหัสประเทศคือ (US หรือ UK) และรหัสผลิตภัณฑ์คือ AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC