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

ב-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 כדי לבצע את פעולת התלונה, כתובת דף הבית (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 וסטטוס ההצהרה בהתאמה.
• מידע מרכזי: במאמר בנושא 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 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 מתעדכנים.