אפשר לקבל מידע הקשרי על Merchant API מהעוזר לתכנות שתבחרו. בסביבת הפיתוח המשולבת (IDE), עכשיו אפשר לגשת לשילוב של מסמכי התיעוד למפתחים באמצעות שירות Model Context Protocol (MCP). השירות הזה מספק לעוזר התכנות שלכם הקשר מהימן מתוך מסמכי ה-API הרשמיים של Google, כדי להאיץ את תהליך הפיתוח של שילובי נתונים ותהליכי העברה.
מידע נוסף על הפרוטוקול עצמו זמין בתקן Model Context Protocol.
סקירה כללית
כשעוברים מ-Content API for Shopping ל-Merchant API או כשיוצרים שילוב חדש, צריך להבין את המבנים החדשים של השירות, את שמות המשאבים ואת השיטות. שירות ה-MCP מפשט את התהליך הזה על ידי מתן תיעוד רשמי ודוגמאות קוד לעוזר התכנות.
השירות משתמש בקצה עורפי (backend) של RAG (שליפה משופרת של דורות) שהוא מאוד ייחודי. כששואלים את העוזר לתכנות ב-IDE עם תמיכה ב-MCP שאלה לגבי Merchant API, השירות מאחזר את קטעי הטקסט והקוד הכי רלוונטיים ממקורות רשמיים של Google ומחזיר אותם כהקשר לעוזר לתכנות. כך העוזר הדיגיטלי יכול לספק תשובות מדויקות ועדכניות בלי שתצטרכו לצאת מסביבת הפיתוח.
איך זה עובד
שילוב של תיעוד למפתחים באמצעות MCP משתלב בתהליך עבודה מודרני לפיתוח בעזרת AI:
- אתם שואלים שאלה ב-Agent או בכלי עזר לתכנות שתואם ל-MCP. אפשר לשאול שאלה בשפה טבעית או לבקש דוגמה לקוד להטמעה של שיטות Merchant API.
- עוזר התכנות שולח בקשה להקשר לנקודת הקצה של MCP.
- שירות ה-MCP מחפש בנתונים המאונדקסים שלו, שכוללים מסמכים רשמיים של Merchant API, מדריכים ודוגמאות קוד, כדי למצוא את המידע הכי רלוונטי.
- השירות מחזיר את קטעי הקוד המוסמכים האלה כהקשר לעוזר התכנות.
- עוזר התכנות משתמש בהקשר האיכותי הזה כדי ליצור תשובה מדויקת ומועילה לשאלה המקורית.
תחילת העבודה
כדי להשתמש ב-MCP, צריך סביבת פיתוח משולבת (IDE) או עוזר לתכנות שתומכים בפרוטוקול Model Context Protocol עם העברת HTTP שניתנת להזרמה.
הגדרת נקודת קצה
כדי לחבר את הכלי לשירות, צריך להשתמש בפרטים של נקודת הקצה המרוחקת שסופקו. יכול להיות שתצטרכו להזין את כתובת ה-URL הישירה של השירות או את ההגדרה של MCP, בהתאם להגדרות של הכלי.
כתובת ה-URL של השירות היא:
MCP Server Name: "MAPI Docs MCP"
MCP Server URL: "https://merchantapi.googleapis.com/devdocs/mcp/"
תרחישים לדוגמה לשימוש
ה-MCP יכול להאיץ את תהליך העבודה בתרחישים הנפוצים הבאים.
תרחיש 1: העברה של קריאה ל-API מדור קודם
יש לכם אפליקציה קיימת שמשתמשת ב-Content API for Shopping ואתם רוצים לעדכן אותה. אפשר לשאול על שיטה ספציפית מדור קודם כדי לקבל פרטים על ההטמעה החדשה וקוד לדוגמה רלוונטי.
הנחיה למשתמש:
"מה המקבילה של השיטה accountstatuses.get ב-Content API for Shopping ב-Merchant API?"
שירות ה-MCP מספק הקשר מתוך מדריכי ההעברה הרשמיים ומתוך מסמכי העזר, וכך מאפשר לעוזר הדיגיטלי להשיב תשובה מפורטת, כולל שם ה-API החדש, accounts.issues.
תרחיש 2: חיפוש של דוגמת קוד
אתם מטמיעים תכונה חדשה וצריכים דוגמה מעשית לפעולה.
הנחיה למשתמש:
"Show me a Python code sample for adding a new shipping service using Merchant API."
שירות ה-MCP מאחזר דוגמאות קוד רלוונטיות ממאגרי Google GitHub הרשמיים וממדריכי המפתחים. לאחר מכן, העוזר הדיגיטלי יכול להציג בלוק קוד מלא ומוכן להתאמה.
תרחיש 3: הבנת מושגים שקשורים ל-API
נתקלתם במושג חדש או שאתם רוצים להבין את המבנה של משאב או את הדפוס הכללי של Merchant API.
הנחיה למשתמש:
"איך מעדכנים את המלאי של מוצר באמצעות Merchant API?"
שירות ה-MCP מחזיר הקשר מתוך מסמכי התיעוד של משאבי המוצרים ומתוך מדריכים רלוונטיים. העוזר הדיגיטלי יכול להסביר איך להשתמש בשיטה accounts.productInputs.insert ולספק את משאב המוצר החלקי שמכיל רק את productId ואת השדות שקשורים למלאי שצריך לעדכן.
"איך מאשרים את הקריאות לאפליקציה באמצעות Merchant API?"
שירות ה-MCP מאחזר הקשר ממדריכי האימות הרשמיים, שכוללים שיטות שונות למתן הרשאות. לאחר מכן, העוזר הדיגיטלי יכול להסביר את האפשרויות העיקריות שזמינות, כמו שימוש בחשבון שירות לאינטראקציות משרת לשרת או שימוש במזהה לקוח OAuth 2.0 כשפועלים בשם משתמש.
תרחיש 4: הסתגלות לשינויים ב-API
ב-Merchant API יש דפוסים חדשים – כמו בקשות באצווה – ששונים מאלה של Content API for Shopping. ב-Content API for Shopping נעשה שימוש בשיטות ספציפיות של custombatch, ואילו ב-Merchant API נעשה שימוש בתכונה מובנית וכללית של אצווה HTTP.
הנחיה למשתמש:
"מהי הדרך החדשה להשתמש ב-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, ולספק דוגמה לאופן שבו צריך לבנות את הבקשה מרובת החלקים. כך הופכים משימת העברה שעלולה להיות מבלבלת לתהליך מודרך.
מקורות של מאגר ידע
שירות ה-MCP בונה את בסיס הידע שלו באופן בלעדי ממקורות ציבוריים ורשמיים כדי להבטיח שההקשר שהוא מספק יהיה מדויק ומהימן. השירות מבצע אינדוקס של כל התוכן במאגר של דוגמאות הקוד ובאתר הרשמי למפתחים, כולל:
- האתר למפתחי Merchant API: כל המדריכים, חומרי העזר והמסמכים.
- Merchant API Apps Script service: דוגמה לשימוש ב-Merchant API מ-Apps Script.
- דוגמאות קוד רשמיות: כל דוגמאות הקוד הרשמיות שסופקו על ידי Google ל-Merchant API ממאגר GitHub.
- ספריות לקוח: כל ספריות הלקוח הרשמיות שנתמכות על ידי Merchant