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

ב-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. כל השיטות שפועלות על המשאב 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 המשאב המפורש ב-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 (שדה בוליאני לקריאה בלבד במשאב Homepage)	מציין אם בוצעה תביעת בעלות על uri והוא אומת. הסטטוס הזה זמין ישירות במשאב Homepage שמוחזר מכל השיטות המשויכות שלו ב-Merchant API.
לא רלוונטי	UpdateHomepageRequest.update_mask פרמטר של גוף הבקשה accounts.homepage.updateHomepage	אנונימיזציה אופציונלית של שדות ב-homepage.update כדי לציין אילו שדות (לדוגמה, מתבצע עדכון של uri מתוך Homepage משאבים.