אפשר להשתמש ב-GoogleAdsFieldService כדי לבקש באופן דינמי את הקטלוג של משאבים, שדות של משאבים, מפתחות פילוח ומדדים שזמינים בשיטות Search ו-SearchStream של GoogleAdsService. הקטלוג מספק מטא-נתונים שיכולים לשמש לקוחות של 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-
המאפיין
selectableWithבשדה של משאב או פלח מציין משאבים, פלחים או מדדים אחרים שאפשר לבחור באותה שאילתת GAQL. המאפיין הזה חשוב במיוחד כשרוצים לכלול שדות ממקור או מקטע שלא צוינו בסעיףFROM.כשיוצרים שאילתת GAQL:
- המשאב בסעיף
FROMהוא הישות הראשית. תמיד אפשר לבחור שדות מהמקור הזה. - אפשר גם לבחור מדדים ופלחים תואמים שזמינים עם הישות הראשית.
- אם כוללים שדות מכל משאב או פלח מחוץ לסעיף
FROM, צריך לוודא שהמשאב או הפלח הזה שאינוFROMתואם לכל השדות, הפלחים והמדדים האחרים שנבחרו בשאילתה.
- המשאב בסעיף
הרשימה
selectableWithשל משאב ספציפי (נקרא לו משאב א') מכילה את כל המשאבים, הפלחים והמדדים האחרים שאפשר לבחור לצד שדות ממשאב א' כשמשאב א' הוא לא הישות הראשית.דוגמה:
דוגמה לשאילתה:
SELECT ad_group.id, segments.date, campaign.name FROM ad_groupהפסקה
FROMמציינתad_group.השאילתה הזו בוחרת את
ad_group.id(מהמשאבFROM),segments.dateו-campaign.name.בחרת באפשרות
campaign.name, אבלcampaignלא מופיע בסעיףFROM, לכן עליך לוודא שהוא תואם לרכיבים האחרים שבחרת.כדי לוודא שהשאילתה הזו תקינה, המשאב
campaignצריך להיות תואם ל-segments.date(שדה אחר שנבחר). לכן, צריך לבדוק את המאפייןselectableWithבמשאבcampaign. אםsegments.dateמופיע ברשימהselectableWithשלcampaign, השאילתה תקינה.
אם בוחרים שדות ממשאב שלא מופיע בסעיף
FROM, רשימתselectableWithשל המשאב הזה צריכה לכלול את כל הפלחים והמשאבים האחרים שמופיעים בסעיףSELECT.
פרטי המטא-נתונים
אפשר לבקש את הקטלוג באמצעות GoogleAdsFieldService ברמות הבאות:
- משאב
- לדוגמה,
googleAdsFields/campaign. - השדה של המשאב
- לדוגמה,
googleAdsFields/campaign.name. - שדה פילוח
- לדוגמה,
googleAdsFields/segments.ad_network_type. - מדד
- לדוגמה,
googleAdsFields/metrics.clicks.