אתם יכולים להיעזר במדריך הזה כדי לשלב את Merchant API בהטמעה הקיימת של Content API for Shopping.
שנתחיל?
לפרטים על Merchant API ועל ממשקי המשנה API שלו, ראו עיצוב API ל-Merchant API.
כדי להתחיל להשתמש ב-Merchant API, צריך לשנות את כתובות ה-URL של הבקשות לפורמט הבא:
https://merchantapi.googleapis.com/{sub-API}/{version}/{resource name}/{service}:{method}…
מידע נוסף זמין במדריך למתחילים ובחומר העזר של Merchant API.
תמיכה ב-gRPC
Merchant API תומך ב-gRPC וב-REST. אפשר להשתמש ב-gRPC ל-Merchant API וב-REST ל-Content API for Shopping בו-זמנית.
כדי להשתמש בספריות הלקוח של Merchant API צריך להשתמש ב-gRPC.
מידע נוסף זמין במאמר שימוש ב-gRPC.
תאימות
במדריך הזה מתוארים שינויים כלליים שחלים על כל Merchant API. כדי לבצע שינויים בתכונות ספציפיות, אפשר לעיין במדריכים הבאים:
- העברת ניהול החשבונות
- העברת הגדרות המשלוח
- העברת ניהול מוצרים
- ניהול של מקורות נתונים
- העברת ניהול מלאי שטחי פרסום
- העברה של ניהול מבצעים
- העברת ניהול הדוחות
- העברת ניהול של מקורות המרות
- העברת ניהול שותפות של פידים מקומיים
Merchant API תוכנן לפעול לצד התכונות הקיימות של Content API for Shopping גרסה 2.1.
לדוגמה, תוכלו להשתמש ב-Merchant Inventories API לצד רשימות המלאי הקיימות של Content API for Shopping גרסה 2.1 וההטמעה של products
. אפשר להשתמש ב-Content API for Shopping כדי להעלות מוצר חדש בחנות מקומית (שנמכר בחנות מקומית), ואז להשתמש ב-Merchant Inventories API LocalInventory
כדי לנהל את המידע לגבי המוצר בחנות.
בקשות אצווה
Merchant API לא תומך בשיטה customBatch
שמופיעה ב-Content API for Shopping. במקום זאת, ראו שליחת בקשות באצווה. אם אתם משתמשים ב-customBatch
ואתם צריכים את התכונה הזו ב-Merchant API, במשוב תוכלו לספר לנו למה.
מזהים
כדי לעמוד בעקרונות ה-API לשיפור ה-API של Google, עשינו כמה שינויים במזהים של משאבי Merchant API.
השם מחליף את המזהה
כל המשאבים ב-Merchant API משתמשים בשדה name
בתור המזהה הייחודי שלהם.
הנה דוגמה לשימוש בשדה name
בשיחות:
POST https://merchantapi.googleapis.com/inventories/v1beta/{parent}/regionalInventories:insert
השדה name
החדש מוחזר בתור מזהה המשאב לכל הקריאות לקריאה וכתיבה ב-Merchant API.
הערך שמוחזר בשדות name
הוא בפורמט המזהה החדש.
לדוגמה, להטמיע שיטה getName()
כדי לאחזר את הערך name
ממשאב, ולאחסן את הפלט כמשתנה במקום ליצור את ה-name
ממזהה המוכר וממזהי המשאב בעצמכם.
פורמט חדש של מזהה
ב-Merchant API, מזהי המשאבים מופיעים בפורמט הבא: channel~language~feedLabel~offerId
במשאבי ה-Content API נעשה שימוש ב-:
במקום ב-~
בין כל ערך במזהה:
channel:language:feedLabel:offerId
כל הקריאות ל-Merchant API מחזירות את הפורמט החדש עם ~
בין ערכי
המזהה. מומלץ לשמור את הפורמט החדש מהתשובה ולהשתמש בו בשיחות עתידיות.
שדות הורה למשאבי צאצא
ב-Merchant API, כל משאבי הצאצא כוללים את השדה parent
. במקום להעביר את משאב ההורה במלואו, אפשר להשתמש בשדה parent
כדי לציין את ה-name
של המשאב שאליו רוצים להוסיף את הצאצא. אפשר גם להשתמש בשדה parent
עם methods של list
כדי להציג את רשימת משאבי הצאצא של ה-parent
.
לדוגמה, כדי להציג את מספר המלאים בחנות המקומית של מוצר נתון, מציינים את name
בשדה parent
של ה-method list
. במקרה הזה, product
הנתון הוא parent
של המשאבים שמוחזרים ב-LocalInventory
.
סוגים
לפניכם כמה סוגים נפוצים של ממשקי המשנה של ממשקי ה-API של Merchant API.
מחיר
אלה השינויים שבוצעו ב-Price
בחבילה של Merchant Common:
Content API | ממשק API של Merchant | |
---|---|---|
שדה סכום | value:string |
amountMicros:int64 |
שדה מטבע | currency:string
|
currencyCode:string |
הסכום של Price
מתועד עכשיו במיליוניות השנייה, שבה מיליון מיקרו-שווי ערך ליחידה הרגילה של המטבע.
ב-Content API for Shopping, Price
היה מספר עשרוני בצורת מחרוזת.
השם של שדה הסכום השתנה. השם הישן: value
השם החדש: amountMicros
השם של שדה המטבע השתנה מ-currency
ל-currencyCode
. הפורמט נשאר כ-ISO 4217.