אפשר להשתמש ב-GoogleAdsFieldService
כדי לבקש באופן דינמי את הקטלוג של משאבים, שדות של משאבים, מפתחות פילוח ומדדים שזמינים ב-methods GoogleAdsService
חיפוש ו-SearchStream. בקטלוג יש מטא-נתונים שבהם לקוחות Google Ads API יכולים להשתמש לצורך אימות ויצירה של הצהרות בשפת השאילתות של Google Ads.
דוגמה של בקשת HTTP ותשובה
הבקשה מורכבת מ-HTTP GET
לשרת Google Ads API בכתובת ה-URL הבאה:
https://googleads.googleapis.com/v17/googleAdsFields/{resource_or_field}
הדוגמה הבאה היא דוגמה לבקשה ואחריה התשובה שחוזרת מ-GoogleAdsFieldService
למשאב ad_group:
בקשה
https://googleads.googleapis.com/v17/googleAdsFields/ad_group
תשובה
{
"resourceName": "googleAdsFields/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
הקיים.
פרטי מטא-נתונים
אפשר לבקש את הקטלוג באמצעות GoogleAdsFieldService
ברמות הבאות:
- משאב
- לדוגמה,
googleAdsFields/campaign
. - השדה של המשאב
- לדוגמה,
googleAdsFields/campaign.name
. - שדה פילוח
- לדוגמה,
googleAdsFields/segments.ad_network_type
. - המדד
- לדוגמה,
googleAdsFields/metrics.clicks
.