אפשר להשתמש ב-GoogleAdsFieldService (דרך GetGoogleAdsField או SearchGoogleAdsFields) כדי לבקש באופן דינמי את קטלוג המשאבים, שדות המשאבים, מפתחות הפילוח והמדדים שזמינים ב-GoogleAdsService Search וב-method SearchStream. הקטלוג מספק מטא-נתונים שאפשר להשתמש בהם כדי לאמת ולבנות הצהרות של Google Ads Query Language (GAQL) בלקוחות של Google Ads API.
דוגמה לבקשת HTTP ותשובה
הבקשה מורכבת מ-HTTP GET לשרת Google Ads API בכתובת ה-URL הבאה:
https://googleads.googleapis.com/v25/googleAdsFields/{resource_or_field}
בדוגמה הבאה מוצגת בקשה ואחריה התגובה שמוחזרת מ-GoogleAdsFieldService עבור המשאב ad_group:
בקשה
https://googleads.googleapis.com/v25/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בלי לפלח את המדדים. השדה הזה מאוכלס רק אם הערך שלcategoryהואRESOURCE. metrics- מדדים שאפשר לבחור יחד עם המשאב בפסקה
FROM. השדה הזה מאוכלס רק אם הערך שלcategoryהואRESOURCE. segments- מפתחות פילוח (שדות
segments.*ומשאבי פילוח) שאפשר לבחור באמצעות המשאב בסעיףFROM. הם מחלקים את המדדים שצוינו בשאילתה. השדה הזה מאוכלס רק בשדות שבהם הערך שלcategoryהואRESOURCE. selectableWith- משאבים, פלחים או מדדים שאפשר לבחור באותה שאילתה בשפת השאילתות של Google Ads, כשהמשאב או הפלח הזה לא מוגדרים כמשאב הראשי בסעיף
FROM.
תאימות שאילתות ל-selectableWith
המאפיין selectableWith בשדה של משאב או פלח מציין משאבים, פלחים או מדדים אחרים שאפשר לבחור באותה שאילתה בשפת השאילתות של Google Ads.
המאפיין הזה חשוב במיוחד כשרוצים לכלול שדות ממשאב או מפלח שלא צוינו בסעיף FROM.
כשיוצרים שאילתה בשפת השאילתות של Google Ads:
- המשאב בסעיף
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 (לפי שם המשאב עם GetGoogleAdsField או באמצעות שאילתה עם SearchGoogleAdsFields) ברמות GoogleAdsFieldCategory הבאות:
- מקור מידע (
RESOURCE) - לדוגמה,
googleAdsFields/campaign. - מאפיין משאב (
ATTRIBUTE) - לדוגמה,
googleAdsFields/campaign.name. - שדה פילוח (
SEGMENT) - לדוגמה,
googleAdsFields/segments.ad_network_type. - מדד (
METRIC) - לדוגמה,
googleAdsFields/metrics.clicks.