שילוב API וערכת כלים לסיוע בכתיבת קוד

כדי להאיץ את המעבר ל-Merchant API, אפשר להשתמש בערכת הכלים API Integration and Code Assist Toolkit ולפתח שילובים חדשים בעזרת כלי פיתוח מבוססי-AI.

סקירה כללית

כשעוברים מ-Content API for Shopping ל-Merchant API או כשיוצרים שילוב חדש, צריך להבין את המבנים החדשים של השירות, את שמות המשאבים ואת השיטות. כלים מבוססי-AI לפיתוח מתאימים במיוחד לסיוע בפעולות הבאות:

  • תרגום והעברה של קוד: עוזר להבין ולהמיר קוד מדור קודם של Content API for Shopping לפורמט החדש של Merchant API. הפעולה הזו כוללת מיפוי של מאפייני המוצרים למבנה החדש ועדכון של קבצים לניהול תלות.
  • מומחיות בתיעוד API: מספק הסברים ברורים על משאבים, שיטות, שדות, מכסות ושיטות מומלצות של Merchant API, על סמך הקשר מהימן מתיעוד ה-API הרשמי של Google.
  • יצירת קוד: יצירת קטעי קוד למשימות שונות ב-Merchant API בשפות כמו Python,‏ Java,‏ PHP ועוד.
  • פתרון בעיות: עוזר לאבחן ולתקן שגיאות נפוצות ב-API.

בוחרים את האפשרות שהכי מתאימה לסביבת הפיתוח ולתרחיש השימוש הספציפי. אתם יכולים להשתמש בערכת הכלים API Integration and Code Assist כדי להתאים את ההגדרה לתהליך העבודה המועדף עליכם:

בתרשים הבא מוצגות אפשרויות ההגדרה להעברת קוד בעזרת AI בסביבות פיתוח משולבות (IDE) הנפוצות ביותר, כמו Antigravity, ‏ Visual Studio Code, ‏ Cursor או Copilot. אפשר להגדיר עוזרים אישיים לתכנות כמו Gemini,‏ Claude,‏ ChatGPT,‏ Grok ולתת להם גישה לשרת Merchant API Developer Documentation MCP או ל-Merchant API Agent Skills כדי להגביר את מהירות ההטמעה.

(Merchant API) תרשים של עוזר תכנות אישי מבוסס-AI

תיעוד למפתחים של Merchant API שרת MCP

אפשר לקבל מידע הקשרי על Merchant API מהעוזר לתכנות שתבחרו. בסביבת הפיתוח המשולבת (IDE), אפשר עכשיו לגשת למסמכי העזרה למפתחים באמצעות שירות Model Context Protocol‏ (MCP). השירות הזה מספק למפתח הקוד מידע חשוב ממסמכי התיעוד הרשמיים של Google API. מידע נוסף על הפרוטוקול עצמו זמין בתקן Model Context Protocol.

איך זה עובד

כששואלים את העוזר האישי לתכנות של סביבת הפיתוח המשולבת (IDE) שמופעל בה MCP שאלה לגבי Merchant API, השירות מאחזר את קטעי הטקסט והקוד הרלוונטיים ביותר ממקורות רשמיים ומחזיר אותם כהקשר לעוזר האישי לתכנות באמצעות קצה עורפי (backend) ייעודי של Retrieval-Augmented Generation‏ (RAG). מערכת RAG היא מערכת שמשפרת את איכות התשובות של מודלים גדולים של שפה (LLM) על ידי קישור שלהם למקורות ידע חיצוניים ועדכניים. כך תוכלו לקבל מהעוזר תשובות מדויקות ועדכניות בלי לצאת מסביבת הפיתוח.

תהליך עבודה לדוגמה:

  1. אתם שואלים שאלה בעוזר או בסוכן תכנות שתואמים ל-MCP (למשל, שאלה בשפה טבעית, בקשה לדוגמת קוד או תרגום קוד).
  2. עוזר התכנות שולח בקשה להקשר לנקודת הקצה של MCP.
  3. שירות ה-MCP מחפש באוסף המאונדקס שלו של מסמכים רשמיים, מדריכים ודוגמאות קוד של Merchant API.
  4. השירות מחזיר קטעי מידע מהימנים כהקשר לעוזר התכנות.
  5. עוזר התכנות משתמש בהקשר הזה כדי ליצור תשובה מבוססת או משימת תרגום קוד.

תחילת העבודה

כדי לשלב ולהשתמש ב-MCP, פועלים לפי השלבים הבאים:

1. שימוש בכלי תואם

פותחים סביבת פיתוח משולבת (IDE) או עוזר אישי לתכנות שתומכים בפרוטוקול Model Context Protocol עם העברה של HTTP בסטרימינג.

2. הגדרת נקודת הקצה

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

הגדרות תצורה:

Antigravity

פועלים לפי ההוראות במסמכי התיעוד של Antigravity.

"mcpServers": {
  "mapi-devdocs": {
    "command": "npx",
    "args": [
      "-y",
      "mcp-remote",
      "https://merchantapi.googleapis.com/devdocs/mcp"
    ]
  }
}

קוד Visual Studio

פועלים לפי ההוראות בתיעוד של Visual Studio Code.

"servers": {
"mapi-devdocs": {
  "type": "http",
  "url": "https://merchantapi.googleapis.com/devdocs/mcp/"
  }
}

3. הוספת הוראות לסוכן (אופציונלי)

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

תרחישים לדוגמה לשימוש

השימוש ב-MCP יכול לייעל את תהליך העבודה בתרחישים הנפוצים הבאים:

תרחיש 1: העברת קוד products.insert

אפשר לבקש מהנציג להעביר ישירות קוד שילוב של Content API for Shopping products.insert אל Merchant API.

הנחיה למשתמש:

‫"Migrate products.insert code to Merchant API"

אם תספקו לסוכן שלכם הוראות מערכת וגישה ל-MCP, הוא יוכל לתרגם קוד של Content API for Shopping לקוד של Merchant API ישירות בסביבת הפיתוח המשולבת (IDE). במקרה כזה, המערכת תזהה את productInputs.insert כקריאה שוות ערך ותמפה את מאפייני המוצר מהפורמט הישן לפורמט החדש שנדרש על ידי Merchant API. הוא יכול גם לעדכן יבוא חובה וקובץ לניהול תלות (לדוגמה, requirements.txt, pom.xml או package.json). אתם יכולים להנחות את הסוכן לבצע את השינויים במקום או ליצור תיקייה חדשה.

תרחיש 2: חיפוש פונקציונליות מקבילה

יש לכם אפליקציה קיימת שמשתמשת ב-Content API for Shopping ואתם צריכים לעדכן אותה. אפשר לשאול על שיטה ספציפית מדור קודם כדי לקבל פרטים על ההטמעה החדשה וקוד לדוגמה רלוונטי.

הנחיה למשתמש:

"מה המקבילה של Merchant API לשיטה accountstatuses.get ב-Content API for Shopping?"

שירות ה-MCP מספק הקשר ממדריכי ההעברה הרשמיים וממסמכי העיון, ומאפשר לעוזר הדיגיטלי להשיב תשובה מפורטת, כולל שם ה-API החדש, accounts.issues.

תרחיש 3: חיפוש דוגמת קוד

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

הנחיה למשתמש:

"תראה לי קוד לדוגמה ב-Python להוספת שירות משלוחים חדש באמצעות Merchant API".

שירות ה-MCP מאחזר דוגמאות קוד רלוונטיות ממאגרי GitHub הרשמיים של Google וממדריכי המפתחים. לאחר מכן, העוזר הדיגיטלי יכול להציג בלוק קוד מלא ומוכן להתאמה.

תרחיש 4: הבנת מושגים שקשורים ל-API

נתקלתם במושג חדש או שאתם רוצים להבין את המבנה של משאב או את הדפוס הכללי של Merchant API.

הנחיה למשתמש:

"איך מעדכנים את המלאי של מוצר באמצעות Merchant API?"

שירות ה-MCP מחזיר הקשר מתיעוד משאבי המוצרים וממדריכים רלוונטיים. העוזר הדיגיטלי יכול להסביר איך להשתמש בשיטה accounts.productInputs.insert ולספק את משאב המוצר החלקי שמכיל רק את productId ואת השדות שקשורים למלאי שצריך לעדכן.

"איך מאשרים את הקריאות ל-API של האפליקציה באמצעות Merchant API?"

שירות ה-MCP מאחזר הקשר ממדריכי האימות הרשמיים, שכוללים שיטות שונות למתן הרשאות. לאחר מכן, העוזר הדיגיטלי יכול להסביר את האפשרויות העיקריות שזמינות, כמו שימוש בחשבון שירות לאינטראקציות משרת לשרת או מזהה לקוח OAuth 2.0 כשפועלים בשם משתמש.

תרחיש 5: הסתגלות לשינויים ב-API

ב-Merchant API יש דפוסים חדשים – כמו בקשות באצווה – ששונים מ-Content API for Shopping. ב-Content API for Shopping נעשה שימוש בשיטות ספציפיות של custombatch, ואילו ב-Merchant API נעשה שימוש בתכונה מובנית וגנרית של HTTP batching.

הנחיה למשתמש:

"מהי הדרך החדשה לבצע products.custombatch ב-Merchant API?"

שירות ה-MCP מאחזר הקשר מתוך Refactor code for concurrent requests (שינוי מבנה הקוד לבקשות מקבילות), ומסביר ששיטות custombatch ייעודיות לא קיימות ב-Merchant API. במקום זאת, הוא מספק תיעוד על שימוש ב-HTTP batching עם Content-Type של multipart. לאחר מכן, העוזר הדיגיטלי יכול להסביר איך ליצור בקשת HTTP אחת שמכילה כמה קריאות ל-API, שנשלחת לנקודת הקצה https://merchantapi.googleapis.com/batch/{sub-api}/v1, ולספק דוגמה לאופן שבו צריך לבנות את הבקשה מרובת החלקים. כך הופכים משימת העברה שעלולה להיות מבלבלת לתהליך מודרך.

תרחיש 6: תרגום של שאילתת דיווח

אתם יכולים לבקש מהסוכן לתרגם שאילתת דיווח מ-Content API for Shopping ל-Merchant API.

הנחיה למשתמש:

‫"Migrate this reporting query from Content API to Merchant API: SELECT metrics.impressions, metrics.clicks, metrics.ctr FROM MerchantPerformanceView WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-30'"

שירות ה-MCP מאחזר את מסמכי העיון העדכניים ביותר בנושא דיווח, מדריכים למפתחים ומדריכים להעברה. על סמך המידע הזה, המערכת משנה את השאילתה למבנה החדש ומעדכנת את השדות לשמות ולערכים החדשים שלהם.

Merchant API Agent Skills

מפרט Agent Skills הוא תקן פתוח שאומץ בכלים לפיתוח AI. אתם יכולים להשתמש ב-Agent Skills כדי לשפר את חוויית הפיתוח שלכם ולבצע אופטימיזציה של שני התהליכים הבאים: מעבר מ-Content API for Shopping ויצירת שילובים חדשים. חבילות של כישורי סוכן Merchant API כוללות ידע וכלים ספציפיים לתחום, כדי לשפר את היכולות של סוכני AI. הן מספקות עזרה ממומחים לפי דרישה בשאלות לגבי תיעוד, יצירת קוד ופתרון בעיות.

התכונות של Merchant API Agent תואמות למגוון כלים מבוססי-AI לשורת פקודה ולסביבות פיתוח משולבות (IDE) כמו Antigravity ו-Claude Code.

איך זה עובד

מיומנויות הסוכן של Merchant API הן חבילת מומחיות ייעודית שמבוססת על תקן מיומנויות הסוכן הפתוח. הכישורים של הסוכן שלנו mapi-developer-assistant פועלים כשכבה חכמה בין כלי הפיתוח של ה-AI לבין שרת ה-MCP של Merchant API Dev Doc. הוא משלב מומחיות בתחום והנחיות לגבי תהליכים, ויש לו את המאפיינים הבאים:

  • הגדרה אפס: ניהול אוטומטי של חיבורי שרת MCP, ללא צורך בהגדרת נקודת קצה ידנית.
  • תהליכי עבודה של מומחים: משפר את ההנחיות של המשתמשים לשאילתות אופטימליות כדי לאחזר את המידע הרלוונטי ביותר בצורה יעילה.
  • ניהול הקשר ויעילות השימוש בטוקנים: המערכת משתמשת ב'חשיפה הדרגתית' כדי לטעון מידע לפי דרישה ולשמור על חלון ההקשר של ה-AI.
  • שיפור הפורמט של הפלט: מספק הוראות לעיצוב ולמבנה של הפלט כדי לקבל תשובות עקביות, קריאות ופרקטיות.

תהליך עבודה לדוגמה:

  1. אתם שואלים שאלה לגבי Merchant API בכלי לפיתוח AI.
  2. היכולת של Merchant API Agent Skill היא לנתח את הכוונה שלכם, ליצור שאילתה מדויקת ולהחיל את הידע הפרוצדורלי שלה על הבקשה.
  3. הסוכן הווירטואלי שולח בקשה להקשר לשרת Merchant API Dev Doc MCP שנמצא בכתובת merchantapi.googleapis.com/devdocs/mcp/.
  4. שירות ה-MCP מחפש באוסף המאונדקס שלו של מסמכים רשמיים, מדריכים ודוגמאות קוד של Merchant API.
  5. סוכן ה-AI משתמש במידע הזה כדי לספק תשובה מסוכמת ופרקטית.

תחילת העבודה

במסמך Merchant API Agent Skills README מפורטות הוראות שלב אחר שלב בנושאים הבאים:

  • דרישות מוקדמות לכלים כמו כלי שורת הפקודה Antigravity.
  • הפעלת התמיכה בכישורי נציגים בכלי שבחרתם.
  • התקנת מיומנות mapi-developer-assistant ממאגר GitHub לפי ההוראות בקובץ ה-README.
  • אימות ההתקנה.
  • פקודות בסיסיות לניהול מיומנויות.

הוראות מפורטות להתקנה ולהגדרה של כלי AI שונים, כולל כלי שורת הפקודה Antigravity,‏ Claude Code ועוד, מופיעות בקובץ ה-README.

הנחיות לדוגמה

אחרי שמתקינים את ה-skill ומפעילים אותו בכלי הפיתוח של ה-AI, הוא מופעל בדרך כלל באופן אוטומטי כששואלים שאלות שקשורות ל-Merchant API.mapi-developer-assistant

"איך מוסיפים מוצר באמצעות Merchant API ב-Python?"

"מה המקבילה ב-Merchant API לשיטה accountstatuses.get של Content API?"

‫"Show me a Java example for handling authentication with Merchant API."

"מוצגת לי השגיאה '400 הבקשה שגויה' עם שגיאת אימות כשמתקשרים אל productInputs.insert. איך אפשר לפתור את הבעיה?"

"מה ההבדל בין ProductInput לבין Product ב-Merchant API?"

מקורות מידע במאגר הידע

שירות ה-MCP בונה את בסיס הידע שלו באופן בלעדי ממקורות ציבוריים ורשמיים כדי לוודא שההקשר שהוא מספק מדויק ומהימן. השירות מבצע אינדוקס של כל התוכן במאגר הדוגמאות לקוד ובאתר הרשמי למפתחים, כולל: