אפשר להשתמש ב-GoogleAdsFieldService כדי לבקש באופן דינמי את הקטלוג של משאבים, שדות משאבים, מפתחות פילוח ומדדים שזמינים בשיטות GoogleAdsService Search ו-SearchStream. הקטלוג מספק מטא-נתונים שיכולים לשמש לקוחות של Google Ads API לאימות ולבנייה של הצהרות בשפת השאילתות של Google Ads.
דוגמה לבקשת HTTP ותשובה
הבקשה מורכבת מ-HTTP GET לשרת Google Ads API בכתובת ה-URL הבאה:
https://googleads.googleapis.com/v22/googleAdsFields/{resource_or_field}
בדוגמה הבאה מוצגת בקשה ואחריה התגובה שמוחזרת מ-GoogleAdsFieldService עבור המשאב ad_group:
בקשה
https://googleads.googleapis.com/v22/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.