סקירה כללית

אנחנו רוצים להציג את גרסת הבטא של Merchant API. זאת הגרסה החדשה של Content API for Shopping ועל העתיד.

לקבלת מידע על האופן שבו Merchant API יכול לשפר את השילוב שלכם ועל האופן שבו תוכלו לעזור לעצב את בעתיד, ראו הכרזה גרסת הבטא של Merchant API.

Reporting API

Reporting API מאפשר למוכרים לנהל אינטראקציה עם נתוני הביצועים שלהם באופן פרוגרמטי דרך שפת השאילתות של Merchant Center. התוצאה הזו דומה ל: את היכולת ליצור דוחות בהתאמה אישית ישירות ב-Merchant Center. ל-Reporting API יש את היתרונות הבאים:

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

משתמשי ה-API יכולים לציין אילו נתוני ביצועים הם רוצים לאחזר חיפוש תגובה לשיחה, למשל:

• המדדים שיוצגו (למשל: קליקים, חשיפות)
• מאפיינים שבהם יתבצע פילוח של הנתונים (לדוגמה: מזהה מבצע, תאריך)
• תנאים שצריך להתקיים (לדוגמה: קליקים > 100)

שפת השאילתה של Reporting API יכולה לשלוח שאילתות על Content API for Shopping מדדי ביצועים (קליקים, חשיפות), שעשויים להיות מפולחים לפי מאפיינים (מאפייני אירוע שדווחו, כמו תוכנית, תאריך ומוצר מאפיינים כמו מותג, קטגוריה וכו'), באמצעות השיטה Search שירות Reports.

התוצאה משאילתה לשירות Reports היא רשימה של ReportRow כאשר כל ReportRow מייצג את הערכים של המדדים המבוקשים לפלחים שציינתם בשאילתה. אם לא יצוינו פלחים, מוחזרת עם מדדים שנצברים מכל הפלחים. אחרת, אם בכלל יישלחו בקשות לפלחים לצד המדדים, אז התשובה תופיע שורה אחת עבור לכל פלח ייחודי. אפשר לבחור כמה פלחים מספר מדדים בשאילתה אחת.

נקודה חשובה: אם אף פעם לא פרסמתם את המוצרים או שיתפתם אותם בחינם לרישומים, לא יהיו לכם מדדים משויכים ותוחזר לכם שדה תוצאות שמכיל מערך ריק.

שאילתה לגבי מדדים

אפשר לשלוח שאילתה למדדים (קליקים, חשיפות, שיעור קליקים וכו') שרוצים הוחזרו. צריך להוסיף מסנן בטווח התאריכים כדי להריץ שאילתות על הדוחות לאחר מכן. השאילתה לדוגמה שבהמשך מחזירה שורה אחת: הסכום המצטבר הקליקים במסגרת התנאי הנוסף של טווח תאריכים.

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

נקודה חשובה: חובה לציין באופן מפורש את הנתונים שרוצים להחזיר. תווים כלליים לחיפוש (לדוגמה, Select metrics.*) תחזיר שגיאה.

דוגמה לתשובה

הדוגמה הבאה של קוד JSON מראה איך המוכר הזה קיבל 4,440 קליקים לסיכום משותף של כל המוצרים בכל היעדים שלהם בין 1 בדצמבר 2020 ו-21 בדצמבר 2020.

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

נקודה חשובה: אם לא תבחרו פלחים בשאילתה שלך, החזירה שורה אחת של מדדים.

שאילתה לגבי פלחים

לצד מדדים ניתן גם להריץ שאילתה על פלחים, שיכולים להיות תכונה של מוצר (offer_id, brand, category וכו') או מאפיין של פריט שדווח אירוע (date, program). אירוע מדווח הוא חשיפה או קליק של המוצר.

פלחים פועלים באופן דומה ל-GROUP BY ב-SQL. פילוחים שנבחרו פוצלו מדדים, שמקובצים לפי כל פלח בקטע SELECT. השאילתה לדוגמה שלמטה מחזירה קליקים ליום, ממוינים לפי קליקים בסדר יורד במסגרת התנאי שנוסף של טווח תאריכים. רק שורות שבהן לפחות מדד מבוקש אחד אינו אפס שיוחזר.

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

דוגמה לתשובה

הדוגמה הבאה של קוד JSON מראה איך המוכר הזה קיבל 1,546 קליקים בכל המוצרים של החברה בכל היעדים שלה ב-1 בדצמבר 2020 ב-829 קליקים בכל המוצרים שלהם בכל היעדים 2 בדצמבר 2020. לא יוחזר אובייקט מאז 3 בדצמבר 2020. למוכר לא היו קליקים באותו יום.

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}

נקודה חשובה: אפשר לבחור פלחים רק אם נבחרו גם מדדים. אם לא תבחרו אף מדד בשאילתה, תקבלו הודעת שגיאה.