אפשר להשתמש ב-SearchAds360FieldService
כדי לבקש באופן דינמי את הקטלוג של משאבים, שדות של משאבים, מפתחות פילוח ומדדים שזמינים בשיטות SearchAds360Service
Search
ו-SearchStream
. הקטלוג מספק מטא-נתונים שאפשר להשתמש בהם בלקוחות Search Ads 360 Reporting API כדי לאמת ולבנות הצהרות של שפת השאילתות של Search Ads 360.
דוגמה של בקשת HTTP ותשובה
הבקשה מורכבת מ-HTTP GET
לשרת של Search Ads 360 Reporting API בכתובת ה-URL הבאה:
https://searchads360.googleapis.com/v0/searchAds360Fields/{resource_or_field}
בהמשך מוצגת דוגמה לבקשה ואחריה התגובה שחוזרת מ-SearchAds360FieldService
למשאב ad_group:
בקשה
https://searchads360.googleapis.com/v0/searchAds360Fields/ad_group
תשובה
{
"resourceName": "searchAds360Fields/ad_group",
"name": "ad_group",
"category": "RESOURCE",
"selectable": false,
"filterable": false,
"sortable": false,
"selectableWith": [
"campaign",
"customer",
"metrics.average_cpc",
"segments.device",
...
],
"attributeResources": [
"customer",
"campaign"
],
"metrics": [
"metrics.conversions",
"metrics.search_budget_lost_impression_share",
"metrics.average_cost",
"metrics.clicks",
...
],
"segments": [
"segments.date",
"segments.ad_network_type",
"segments.device",
...
]
}
לצורך הדוגמה הזו, המערכים החשובים הם:
attributeResources
- משאבים שאפשר לצרף באופן מרומז למשאב בסעיף
FROM
. metrics
- מדדים שזמינים לבחירה עם המשאב בפסקה
FROM
. השדה מאוכלס רק בשדות שבהם הערך שלcategory
הואRESOURCE
. segments
- מפתחות פלחים שאפשר לבחור עם המשאב בפסקה
FROM
. הם מפלחים את המדדים שצוינו בשאילתה. השדה מאוכלס רק בשדות שבהם הערך שלcategory
הואRESOURCE
. selectableWith
- שדות שאפשר לבחור לצד שדה נתון, כשהם לא נמצאים בפסקה
FROM
. המאפיין הזה רלוונטי רק כשמזהים משאבים או פלחים שאפשר לבחור בשאילתה שבה הם לא נכללים במשאב שבסעיףFROM
. לדוגמה, אם בוחרים אתad_group.id
ו-segments.date
מתוךad_group
, ורוצים לכלול מאפיינים מ-campaign
, צריך לבדוק ש-segments.date
נמצא במאפייןselectableWith
בקמפיין, כי הוא נבחר לצד השדהsegments.date
הקיים.
פרטי המטא-נתונים
אפשר לבקש את הקטלוג באמצעות SearchAds360FieldService
ברמות הבאות:
- משאב
- לדוגמה,
searchAds360Fields/campaign
. - השדה של המשאב
- לדוגמה,
searchAds360Fields/campaign.name
. - שדה פילוח
- לדוגמה,
searchAds360Fields/segments.ad_network_type
. - מדד
- לדוגמה,
searchAds360Fields/metrics.clicks
.
שימוש בשאילתה כדי לקבל פרטי שדה
אפשר לקבל את פרטי השדה על-ידי שליחת שאילתה אל
https://searchads360.googleapis.com/v0/searchAds360Fields:search
דוגמה 1: שימוש בביטוי רגולרי.
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE name LIKE 'ad_group.%'"
דוגמה 2: שליחת שאילתות לשדות, מדדים או פלחים ספציפיים.
SELECT
name,
category,
selectable,
filterable,
sortable,
selectable_with,
data_type,
is_repeated
WHERE
name IN (
"ad_group.id",
"ad_group.name",
"segments.date",
"customer.id",
"customer.manager",
"metrics.clicks"
)