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

ב-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, הפעולה accounts.claimwebsite משמשת לתביעת בעלות, הפעולה accounts.update משמשת להגדרת כתובת ה-URL (ולביטול התביעה על ידי הגדרת כתובת URL ריקה), והפעולות accounts.get/accountstatuses.get משמשות לאחזור כתובת ה-URL וסטטוס התביעה, בהתאמה.
• מידע מרוכז: המשאב Homepage של Merchant API מכיל ישירות גם את uri (כתובת דף הבית) וגם את הסטטוס של claimed. כל ה-methods שפועלות על המשאב Homepage מחזירות את המשאב הזה, ומספקות משוב מיידי על המצב הנוכחי. ב-Content API for Shopping, השיטה accounts.claimwebsite לא החזירה את הסטטוס המעודכן, והיה צורך בקריאות נפרדות.
• הסרה מפורשת: ב-Content API for Shopping, כדי להסיר את המאפיין בדרך כלל היה צריך לעדכן את Account.website_url למחרוזת ריקה. ב-Merchant API יש שיטה ייעודית: homepage.unclaim .
• החלפת תביעת בעלות: שני ממשקי ה-API תומכים בפרמטר overwrite במהלך תהליך התביעה כדי להשתלט על תביעת בעלות מחשבון אחר, אם אפשר לאמת את הבעלות.

בקשות

ל-Merchant API יש נקודות קצה (endpoints) נפרדות של 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

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

שיטת Content API for Shopping	‫Merchant API Method	זמינות והערות
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 המפורש ב-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 (ערך בוליאני בגוף של ContentAccountsClaimwebsiteRequest ו-AccountsCustomBatchRequestEntry)	‫ClaimHomepageRequest.overwrite (ערך בוליאני בגוף הבקשה של 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 מתעדכנים.