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

ב-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 ישירות. כל השיטות שפועלות על המשאב Homepage מחזירות את המשאב הזה, ומספקות משוב מיידי על המצב הנוכחי. ב-Content API for Shopping,‏ accounts.claimwebsite לא החזיר את הסטטוס המעודכן, והיה צורך לבצע קריאות נפרדות.
• הצהרה על ויתור: ב-Content API for Shopping, בדרך כלל מוותרים על זכויות יוצרים על ידי עדכון הערך של Account.website_url למחרוזת ריקה. ב-Merchant API יש שיטה ייעודית 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 in ContentAccountsClaimwebsiteRequest body and 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 מתעדכנים.