המבנה של ה-API לדיווח ב-Search Ads 360

הרכיבים העיקריים של 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, ואחרים ייחודיים רק בהיקף מוגבל.

היקף הייחודיות של מזהה האובייקט
מזהה תקציב	כל העולם
מזהה קמפיין	כל העולם
קוד זיהוי של קבוצת מודעות	כל העולם
קוד זיהוי מודעה	קבוצת מודעות כל צמד של AdGroupId / AdId הוא ייחודי ברחבי העולם.
מזהה GroupCriterion	קבוצת מודעות כל צמד של AdGroupId / CriterionId הוא ייחודי ברחבי העולם.
מזהה CampaignCriterion	עדיפות כל צמד של 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. בשתי השיטות נדרשת שאילתה שמפרטת את המשאב לשאילתה, את מאפייני המשאבים ואת מדדי הביצועים שרוצים לאחזר, את הייחוסים שישמשו לסינון הבקשה ואת הפלחים שבהם צריך להשתמש כדי להציג פירוט נוסף של הנתונים הסטטיסטיים של הביצועים. למידע נוסף, אפשר לקרוא את המאמרים יצירת דוחות חיפוש ושפת השאילתות של Search Ads 360.

שירות שטח

הפונקציה SearchAds360FieldService מאחזרת מטא-נתונים של משאבים, כמו המאפיינים הזמינים למשאב וסוג הנתונים שלו. תוכלו לבקש את הקטלוג למשאבים, שדות משאבים, מפתחות פילוח ומדדים שזמינים בשיטות החיפוש של SearchAds360Service. למידע נוסף, ראו אחזור מטא-נתונים של משאבים.

שירותים ספציפיים לישות

בשירותים האלה יש שיטת בקשה של GET שמאחזרת מכונה של משאב אחת. כך בודקים את המבנה של משאב.

דוגמאות לשירותים ספציפיים לישות:

• CustomColumnService שמחזיר את העמודה המותאמת אישית המבוקשת בפירוט מלא.