הרכיבים העיקריים של Search Ads 360 Reporting API הם משאבים ושירותים. משאב מייצג ישות ב-Search Ads 360, ומשתמשים בשירות כדי לאחזר ישויות ב-Search Ads 360.
היררכיית אובייקטים
חשבון Search Ads 360 הוא היררכיה של אובייקטים.
המשאב ברמה העליונה של החשבון הוא הלקוח.
כל חשבון מכיל קמפיין פעיל אחד או יותר.
כל
Campaignמכיל קבוצת מודעות אחת או יותר שמקבצות את המודעות שלכם לאוספים לוגיים.כל
AdGroupמכיל מודעה אחת או יותר מקבוצת מודעות.אפשר לצרף
AdGroupCriterionאוCampaignCriterionאחד או יותר לקבוצת מודעות או לקמפיין. הקריטריונים קובעים איך המודעות מופעלות.- יש הרבה סוגים של קריטריונים, כמו מילות מפתח, טווחי גיל ומיקומים. קריטריונים שמוגדרים ברמת הקמפיין משפיעים על כל המשאבים האחרים בקמפיין. אפשר גם לציין תקציבים ותאריכים ברמת הקמפיין.
משאבים
המשאבים מייצגים את הישויות בחשבון Search Ads 360. דוגמאות למשאבים: Customer, Campaign ו-AdGroup.
מזהי אובייקטים
לכל אובייקט ב-Search Ads 360 יש מזהה משלו. חלק מהמזהים הם ייחודיים ברמת המערכת, כלומר בכל חשבונות Search Ads 360, וחלקם ייחודיים רק בהיקף מוגבל.
| היקף הייחודיות של מזהה האובייקט | |
|---|---|
| מזהה תקציב | גלובלי |
| מזהה הקמפיין | גלובלי |
| קוד זיהוי של קבוצת מודעות | גלובלי |
| Ad ID | קבוצת מודעותכל צמד AdGroupId / AdId הוא ייחודי באופן גלובלי. |
| מזהה AdGroupCriterion | קבוצת מודעותכל צמד AdGroupId / CriterionId הוא ייחודי באופן גלובלי. |
| CampaignCriterion ID | קמפייןכל צמד CampaignId / CriterionId הוא ייחודי באופן גלובלי. |
| תוספים למודעות | קמפייןכל צמד CampaignId / AdExtensionId הוא ייחודי באופן גלובלי. |
| מזהה העדכון | גלובלי |
| מזהה הפריט בפיד | גלובלי |
| מזהה מאפיין פיד | פיד |
| מזהה מיפוי הפיד | גלובלי |
| קוד זיהוי תווית | גלובלי |
| מזהה רשימת משתמשים | גלובלי |
כללי הזיהוי האלה יכולים להיות שימושיים בתכנון אחסון מקומי לאובייקטים של Search Ads 360.
סוגי אובייקטים
אפשר להשתמש באובייקטים מסוימים בכמה סוגי ישויות. במקרה כזה, האובייקט מכיל שדה type שמתאר את התוכן שלו. לדוגמה, הערך AdGroupAd יכול להתייחס למודעת טקסט, למודעת מלון או למודעת עסק מקומי.
אפשר לגשת לערך הסוג דרך השדה AdGroupAd.ad.type. הערך שלו מוחזר ב-enum AdType.
שמות המשאבים
כל משאב מזוהה באופן ייחודי באמצעות מחרוזת resource_name שמקשרת את המשאב ואת ההורים שלו לנתיב.
לדוגמה, שמות המשאבים של הקמפיין בפורמט:
customers/CUSTOMER_ID/campaigns/CAMPAIGN_ID
בקמפיין עם המזהה 987654 בחשבון Search Ads 360 עם מספר הלקוח 1234567, המאפיינים של resource_name הם:
customers/1234567/campaigns/987654
שירותים
שירותים מאפשרים לאחזר את הישויות והמטא-נתונים שלכם ב-Search Ads 360. יש שלושה סוגי שירותים:
- שירות חיפוש
SearchAds360Serviceהוא השירות המאוחד לאחזור כל אובייקטי המשאבים ונתוני הסטטיסטיקה של הביצועים. יש לה שתי שיטות:Searchו-SearchStream. בשתי השיטות נדרשת שאילתה שמציינת את המשאב שאליו רוצים לשלוח את השאילתה, את מאפייני המשאב ואת מדדי הביצועים שרוצים לאחזר, את התנאים המקדימים (predicates) שבהם יש להשתמש כדי לסנן את הבקשה ואת הפלחים שבהם יש להשתמש כדי לפרט עוד יותר את נתוני הסטטיסטיקה של הביצועים. מידע נוסף זמין במאמרים יצירת דוחות חיפוש ושפת השאילתות של Search Ads 360.- שירות שדה הפונקציה
SearchAds360FieldServiceמאחזרת מטא-נתונים על משאבים, כמו המאפיינים הזמינים של משאב וסוג הנתונים שלו. אפשר לבקש את הקטלוג של המשאבים, שדות המשאבים, מפתחות הפלחה והמדדים שזמינים בשיטות החיפושSearchAds360Service. למידע נוסף, ראו אחזור מטא-נתונים של משאבים.- שירותים ספציפיים לישות
השירותים האלה מספקים שיטת בקשה
GETשמאחזרת מכונה אחת של משאב. האפשרות הזו שימושית לבדיקה של המבנה של משאב.דוגמאות לשירותים ספציפיים לישות:
- CustomColumnService שמחזיר את העמודה בהתאמה אישית המבוקשת בפירוט מלא.