העברת ההגדרות של דף הבית

ב-Merchant API יש משאב ייעודי Homepage. במאמר הזה מוסבר על שיטות חדשות לניהול התביעה על דף הבית, עם יכולות שחורגות מהיכולות של Content API for Shopping בגרסה הקלאסית.

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

ההבדלים העיקריים

ב-Merchant API בוצעו כמה שינויים שקשורים לדף הבית בהשוואה ל-Content API for Shopping:

• משאב ייעודי: ב-Merchant API יש משאב נפרד Homepage (accounts.homepage) לכל הפעולות שקשורות לדף הבית. (ב-Content API for Shopping, השתמשתם ב-accounts.claimwebsite כדי לבצע את פעולת התביעה, כתובת ה-URL של דף הבית (website_url) הייתה חלק מהמשאב Account, וסטטוס התביעה (website_claimed) היה חלק מהמשאב AccountStatus).
• שיטות מפורטות: Merchant API מציע שיטות ספציפיות לביצוע הפעולות הבאות:
  • אחזור פרטים של דף הבית: accounts.homepage.getHomepage
  • מעדכנים את ה-URI של דף הבית: accounts.homepage.updateHomepage
  • הצהרת בעלות על דף הבית: accounts.homepage.claim
  • ביטול הבעלות על דף הבית: accounts.homepage.unclaim ‫Content API for Shopping used accounts.claimwebsite for the claim action, accounts.update to set the URL (and effectively disclaim by setting an empty URL), and accounts.get/accountstatuses.get to retrieve URL and claim status respectively.
• מידע מרכזי: במאמר בנושא Merchant API Homepage מפורטים גם uri (כתובת דף הבית) וגם הסטטוס claimed. כל ה-methods שפועלות על המשאב Homepage מחזירות את המשאב הזה, ומספקות משוב מיידי על המצב הנוכחי. ב-Content API for Shopping, accounts.claimwebsite לא הוחזר הסטטוס המעודכן, והיה צורך לבצע קריאות נפרדות.
• הצהרה מפורשת: ב-Content API for Shopping, כדי להצהיר על מוצר, בדרך כלל מעדכנים את הערך של Account.website_url למחרוזת ריקה. ‫Merchant API כולל את ה-method הייעודי homepage.unclaim.
• החלפת תביעה: שני ממשקי ה-API תומכים בפרמטר overwrite במהלך תהליך התביעה, כדי להשתלט על תביעה מחשבון אחר אם אפשר לאמת את הבעלות.

בקשות

ב-Merchant API נעשה שימוש בנקודות קצה שונות של RESTful לניהול היבטים שונים של דף הבית.

תיאור הבקשה	‫Content API for Shopping	Merchant API
קבלת פרטים על דף הבית	‫accounts.get (כדי לקרוא את Account.website_url), accountstatuses.get (כדי לקרוא את AccountStatus.website_claimed)	GET /accounts/v1/accounts/{account}/homepage
עדכון של ה-URI של דף הבית	accounts.update (הגדרה Account.website_url)	PATCH /accounts/v1/accounts/{account}/homepage
תביעת בעלות על דף הבית או אימות מחדש שלו	POST /content/v2.1/{merchantId}/accounts/{accountId}/claimwebsite (בוצעה פעולה ב-Account.website_url שהוגדר באמצעות accounts.update)	POST /accounts/v1/accounts/{account}/homepage:claim
הצהרת כתב ויתור בדף הבית	accounts.update (ההגדרה Account.website_url למחרוזת ריקה)	POST /accounts/v1/accounts/{account}/homepage:unclaim

מזהים

זיהוי המשאבים ב-Merchant API עבר אופטימיזציה.

תיאור המזהה	Content API for Shopping	Merchant API
מזהה החשבון לגישה למשאבים	‫merchantId (חשבון מתקדם) ו-accountId (חשבון משנה) בנתיב	‫account (חלק מהשדה name, כמו accounts/{account_id}/homepage)
מזהה המשאב של דף הבית	לא רלוונטי (משתמע מהמשאב Account)	‫name: accounts/{account_id}/homepage (מזהה את משאב המשנה Homepage)

Methods

השיטה accounts.claimwebsite מ-Content API for Shopping, שהתמקדה בפעולת התביעה, היא עכשיו חלק ממערך רחב יותר של פונקציות במשאב Homepage של Merchant API.

ה-Method ב-Content API for Shopping	ה-Method ב-Merchant API	זמינות והערות
accounts.claimwebsite	accounts.homepage.claim	הפעולה מתחילה ישירות תהליך של הצהרת בעלות על אתר או מאמתת מחדש הצהרת בעלות על אתר. פועל על uri שהוגדר קודם באמצעות homepage.update. כולל פרמטר overwrite. הפונקציה מחזירה את משאב Homepage עם הסטטוס הנוכחי של uri ושל claimed.
‫accounts.get (כדי לקרוא את Account.website_url), accountstatuses.get (כדי לקרוא את AccountStatus.website_claimed)	accounts.homepage.getHomepage	שיטה ייעודית חדשה לאחזור דף הבית הנוכחי uri והסטטוס שלו claimed בקריאה אחת.
accounts.update (כדי להגדיר Account.website_url)	accounts.homepage.updateHomepage	שיטה חדשה ייעודית להגדרת דף הבית או לשינוי שלו uri.
accounts.update (הגדרת Account.website_url למחרוזת ריקה כפתרון עקיף לביטול תביעת בעלות)	accounts.homepage.unclaim	שיטה ייעודית חדשה לביטול התביעה על דף הבית.

שינויים מפורטים בשדות

השתנה באופן משמעותי האופן שבו המידע בדף הבית בנוי והגישה אליו, ועכשיו הוא מבוסס על Homepage resource ב-Merchant API.

Content API for Shopping	Merchant API	תיאור
‫merchantId (פרמטר של הנתיב ל-accounts.claimwebsite)	‫name (פרמטר של הנתיב לשיטות Homepage, פורמט: accounts/{account}/homepage)	החלק account במחרוזת name ב-Merchant API תואם ל-accountId מ-Content API for Shopping.
‫accountId (פרמטר של הנתיב ל-accounts.claimwebsite)	‫name (פרמטר של הנתיב לשיטות Homepage, פורמט: accounts/{account}/homepage)	המזהה של החשבון הספציפי שדף הבית שלו מנוהל.
‫overwrite (boolean ב-ContentAccountsClaimwebsiteRequest body ו-AccountsCustomBatchRequestEntry)	‫ClaimHomepageRequest.overwrite (boolean בגוף הבקשה homepage.claim)	אופציונלי. אם true ינסה לתבוע בעלות על האתר, יכול להיות שתבוטל תביעת בעלות קיימת מחשבון אחר אם החשבון ששלח את הבקשה יוכל לאמת את הבעלות.
‫Account.website_url (שדה במשאב Account, מוגדר באמצעות accounts.update, נקרא באמצעות accounts.get)	Homepage.uri (שדה במשאב Homepage)	כתובת ה-URI (כתובת ה-URL) של דף הבית של החנות. ב-Merchant API, זהו שדה מפורש במקור המידע Homepage. הערך מוגדר באמצעות accounts.homepage.updateHomepage ומוחזר על ידי כל השיטות של Homepage.
‫AccountStatus.website_claimed (שדה במשאב AccountStatus, קריאה באמצעות accountstatuses.get)	‫Homepage.claimed (שדה בוליאני מסוג output_only במשאב Homepage)	מציין אם התחום uri נרשם ואומת. הסטטוס הזה זמין ישירות במשאב Homepage שמוחזר על ידי כל השיטות המשויכות שלו ב-Merchant API.
לא רלוונטי	UpdateHomepageRequest.update_mask פרמטר של גוף הבקשה accounts.homepage.updateHomepage	אנונימיזציה אופציונלית של שדות לעדכון homepage.update כדי לציין אילו שדות (לדוגמה, uri) במשאב Homepage מתעדכנים.