رابط برنامهنویسی کاربردی فروشگاه (Merchant API) یک منبع اختصاصی Homepage معرفی میکند. این منبع روشهای جدیدی برای مدیریت درخواستهای صفحه اصلی شما ارائه میدهد و قابلیتهایی فراتر از رابط برنامهنویسی کاربردی محتوای کلاسیک برای خرید ارائه میدهد.
دسترسی به امکانات فروشگاه آنلاین شما یک فرآیند دو مرحلهای است: ابتدا تأیید مالکیت، سپس ادعای مالکیت سایت برای حساب کاربری خود. برای تکمیل مرحله آخر، از accounts.homepage.claim استفاده کنید.
تفاوتهای کلیدی
رابط برنامهنویسی کاربردی فروشنده (Merchant API) در مقایسه با رابط برنامهنویسی کاربردی محتوا برای خرید (Content API for Shopping)، چندین تغییر مرتبط با صفحه اصلی ایجاد میکند:
- منبع اختصاصی : رابط برنامهنویسی کاربردی فروشگاه (Merchant API) یک منبع
Homepageمجزا (accounts.homepage) برای تمام عملیات مرتبط با صفحه اصلی فراهم میکند. (در رابط برنامهنویسی کاربردی محتوا برای خرید، شما ازaccounts.claimwebsiteبرای انجام عمل مطالبه استفاده کردید، آدرس صفحه اصلی (website_url) بخشی از منبعAccount) بود و وضعیت مطالبه (website_claimed) بخشی از منبعAccountStatusبود.) - روشهای جزئیتر : رابط برنامهنویسی کاربردی فروشنده (Merchant API) روشهای خاصی را برای موارد زیر ارائه میدهد:
- جزئیات صفحه اصلی را بازیابی کنید:
accounts.homepage.getHomepage - بهروزرسانی آدرس صفحه اصلی:
accounts.homepage.updateHomepage - ادعای مالکیت صفحه اصلی:
accounts.homepage.claim - سلب مسئولیت صفحه اصلی:
accounts.homepage.unclaimAPI محتوا برای خرید ازaccounts.claimwebsiteبرای اقدام مطالبه،accounts.updateبرای تنظیم URL (و عملاً با تنظیم یک URL خالی سلب مسئولیت) وaccounts.get/accountstatuses.getبه ترتیب برای بازیابی URL و وضعیت مطالبه استفاده کرد.
- جزئیات صفحه اصلی را بازیابی کنید:
- اطلاعات متمرکز : منبع
HomepageAPI فروشنده (Merchant API Homepage) مستقیماً شاملuri(آدرس صفحه اصلی) و وضعیتclaimedاست. تمام متدهایی که روی منبعHomepageعمل میکنند، این منبع را برمیگردانند و بازخورد فوری در مورد وضعیت فعلی ارائه میدهند. در API محتوا برای خرید،accounts.claimwebsiteوضعیت بهروز شده را برنمیگرداند؛ فراخوانیهای جداگانهای مورد نیاز بود. - سلب مسئولیت صریح : در API محتوا برای خرید، سلب مسئولیت معمولاً با بهروزرسانی
Account.website_urlبه یک رشته خالی حاصل میشد. API فروشنده یک متد اختصاصیhomepage.unclaimارائه میدهد. - ادعای بازنویسی : هر دو API از یک پارامتر
overwriteدر طول فرآیند ادعا پشتیبانی میکنند تا در صورت تأیید مالکیت، ادعایی را از حساب دیگری تصاحب کنند.
درخواستها
رابط برنامهنویسی کاربردی فروشنده (Merchant API) از نقاط پایانی RESTful متمایزی برای مدیریت جنبههای مختلف صفحه اصلی استفاده میکند.
| درخواست توضیحات | API محتوا برای خرید برای خرید | رابط برنامهنویسی کاربردی (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 (با استفاده از accounts.update روی مجموعه Account.website_url عمل شد) | POST /accounts/v1/accounts/{account}/homepage:claim |
| سلب مسئولیت صفحه اصلی | accounts.update (تنظیم Account.website_url روی یک رشته خالی) | POST /accounts/v1/accounts/{account}/homepage:unclaim |
شناسهها
شناسایی منابع در رابط برنامهنویسی کاربردی فروشنده (Merchant API) سادهسازی شده است.
| توضیحات شناسه | API محتوا برای خرید | رابط برنامهنویسی کاربردی (API) فروشنده |
|---|---|---|
| شناسه حساب برای دسترسی به منابع | merchantId (حساب پیشرفته) و accountId (حساب فرعی) در مسیر | account (بخشی از فیلد name ، مانند accounts/{account_id}/homepage ) |
| شناسه منبع صفحه اصلی | قابل اجرا نیست (به طور ضمنی برای منبع Account ) | name : accounts/{account_id}/homepage (زیرمنبع Homepage را مشخص میکند) |
روشها
متد accounts.claimwebsite از Content API for Shopping، که بر عمل مطالبه متمرکز بود، اکنون بخشی از مجموعه وسیعتری از قابلیتها در منبع Homepage API مربوط به Merchant است.
| API محتوا برای روش خرید | روش 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 حرکت میکند.
| API محتوا برای خرید | رابط برنامهنویسی کاربردی (API) فروشنده | توضیحات |
|---|---|---|
merchantId (پارامتر مسیر برای accounts.claimwebsite ) | name (پارامتر مسیر برای متدهای Homepage ، فرمت: accounts/{account}/homepage ) | بخش account از رشته name در Merchant API با accountId از Content API برای خرید مطابقت دارد. |
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 که توسط تمام متدهای API فروشنده مرتبط با آن برگردانده میشود، در دسترس است. |
| ناموجود | پارامتر بدنه درخواست UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage ) | یک ماسک فیلد اختیاری برای homepage.update تا مشخص کند کدام فیلدها (مثلاً uri ) از منبع Homepage در حال بهروزرسانی هستند. |