הפרמטר filters
של מחרוזת השאילתה מגביל את הנתונים שמוחזרים
בדוח של AdSense Management API. כשמשתמשים בפרמטר filters
,
מספקים את המאפיין שרוצים לסנן לפיו, ואחריו את ביטוי הסינון.
שאילתות מסוננות מגבילות את השורות שכלולות בתוצאה. כל שורה בתוצאה נבדקת מול המסנן: אם המסנן תואם, השורה נשמר ואם הוא לא תואם, השורה תושמט.
- קידוד כתובות URL: ספריות הלקוח מקודדות באופן אוטומטי את האופרטורים של הסינון. אבל, אם תשלחו בקשות ישירות לפרוטוקול, עליכם לקודד במפורש אופרטורים של סינון, כפי שמצוין בטבלה שלמטה.
- עדיפות הסינון: הסינון מתרחש לפני סינון מצטברים, כך שהמדדים המוחזרים מייצגים את רק למאפיינים הרלוונטיים.
התחביר של המסנן
מסנן יחיד משתמש בתבנית:
name operator expression
בתחביר הזה:
- name – שם המאפיין שלפיו יתבצע הסינון.
לדוגמה: הערך
AD_CLIENT_ID
יסנן לפי מספר הלקוח של המודעה. - אופרטור – מגדיר את סוג התאמת המסנן לשימוש.
- expression - מציין את הערכים הכלולים בתוצאות.
כל המאפיינים
חלות על המדדים המדווחים עליהם יכולים לשמש כמסננים, עם
חריג למאפיינים שקשורים לתאריכים (DATE
, WEEK
,
ו-MONTH
). כדי לסנן לפי תאריך, יש לציין את
את טווח התאריכים של הדוח.
אופרטורים של מסננים
יש שני אופרטורים של סינון. האופרטורים צריכים להיות מקודדים בכתובת URL כדי להיכלל במחרוזות שאילתה של כתובת URL.
מפעיל | תיאור | טופס מקודד בכתובת URL | דוגמה |
---|---|---|---|
== |
התאמה מדויקת | %3D%3D |
מדדים מצטברים שבהם שם המדינה הוא קנדה:
filters=COUNTRY_NAME%3D%3DCanada |
=@ |
מכיל מחרוזת משנה | %3D@ |
מדדים מצטברים שבהם שם המדינה מכיל את המילה ארצות הברית.
תואם לארצות הברית ולבריטניה לדוגמה:
filters=COUNTRY_NAME%3D@United |
ביטויי סינון
יש כמה כללים חשובים לביטויי סינון:
- תווים שמורים בכתובת URL – תווים כמו
&
חייב להיות מקודד בכתובות URL בדרך הרגילה. ספריות לקוח נטפל בזה בשבילכם, כך שתצטרכו לדאוג לגבי הקידוד הזה רק אם אתם מבצעים שיחות ישירות לפרוטוקול. - תווים שמורים — הפסיק והלוכסן ההפוך חייבים
יופיע תו לוכסן הפוך (escape) כשהוא מופיע בביטוי.
- לוכסן הפוך
\\
- פסיק
\,
- לוכסן הפוך
הערה: לפני שיוצרים תווי לוכסן הפוך, צריך לסמן אותם בתו בריחה (escape) פסיקים, כדי למנוע בריחה כפולה.
שילוב מסננים
ניתן לשלב מסננים באמצעות ערך בוליאני OR
ו-AND
בלוגיקה.
לוגיקה של OR
הלוגיקה של OR
מוגדרת באמצעות פסיק (,
) בתוך רכיב
ביטוי סינון.
דוגמה: (כל אחת מהן חייבת להיות מקודדת בכתובת URL)
קוד המדינה הוא (ארה"ב או בריטניה):
COUNTRY_CODE==US,COUNTRY_CODE==UK
לוגיקת AND
כדי להשיג את הלוגיקה של AND
, אפשר לספק כמה פרמטרים של סינון,
כלומר, מתן מגוון של מסננים בספריות הלקוח.
דוגמה:
קוד המדינה הוא ארה"ב וקוד המוצר הוא AFC:
filters=COUNTRY_CODE%3D%3DUS&filters=PRODUCT_CODE%3D%3DAFC
שילוב לוגיקת AND ו-OR
ניתן לשלב את הלוגיקה AND ו-OR בביטוי אחד.
הערה : כל מסנן נבדק בנפרד לפני שכל המסננים ישולבו לביטוי לוגי AND.
דוגמה:
קוד המדינה הוא (ארה"ב או בריטניה) וקוד המוצר הוא AFC:
filters=COUNTRY_CODE%3D%3DUS,COUNTRY_CODE%3D%3DUK&filters=PRODUCT_CODE%3D%3DAFC