מטא-נתונים של משאבים

אפשר להשתמש ב-GoogleAdsFieldService כדי לבקש באופן דינמי את הקטלוג של משאבים, שדות משאבים, מפתחות פילוח ומדדים שזמינים בשיטות GoogleAdsService Search ו-SearchStream. הקטלוג מספק מטא-נתונים שיכולים לשמש לקוחות של Google Ads API לאימות ולבנייה של הצהרות בשפת השאילתות של Google Ads.

דוגמה לבקשת HTTP ותשובה

הבקשה מורכבת מ-HTTP GET לשרת Google Ads API בכתובת ה-URL הבאה:

https://googleads.googleapis.com/v23/googleAdsFields/{resource_or_field}

בדוגמה הבאה מוצגת בקשה ואחריה התגובה שמוחזרת מ-GoogleAdsFieldService עבור המשאב ad_group:

בקשה

https://googleads.googleapis.com/v23/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:

  1.  המשאב בסעיף FROM הוא הישות הראשית. תמיד אפשר לבחור שדות מהמקור הזה.
  2.  אפשר גם לבחור מדדים ופלחים תואמים שזמינים עם הישות הראשית.
  3.  אם כוללים שדות מכל משאב או פלח מחוץ לסעיף 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.