انتقال تنظیمات صفحه اصلی

Merchant API یک منبع اختصاصی Homepage را معرفی می کند. این منبع روش‌های جدیدی را برای مدیریت ادعای صفحه اصلی شما ارائه می‌کند و قابلیت‌هایی فراتر از Content API کلاسیک برای خرید ارائه می‌کند.

دسترسی به ویژگی‌های فروشگاه آنلاین شما یک فرآیند دو مرحله‌ای است: ابتدا تأیید مالکیت، سپس ادعای سایت برای حساب خود. برای تکمیل مرحله نهایی، از accounts.homepage.claim استفاده کنید.

تفاوت های کلیدی

Merchant API در مقایسه با Content API برای خرید چندین تغییر مرتبط با صفحه اصلی ایجاد می کند:

  • منبع اختصاصی : 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 (URL صفحه اصلی) و وضعیت claimed به طور مستقیم است. همه روش‌هایی که در منبع Homepage کار می‌کنند، این منبع را برمی‌گردانند و بازخورد فوری در مورد وضعیت فعلی ارائه می‌دهند. در Content API for Shopping، accounts.claimwebsite وضعیت به روز شده را برنگرداند. تماس های جداگانه لازم بود.
  • سلب مسئولیت صریح : در Content API برای خرید، سلب مسئولیت معمولاً با به‌روزرسانی Account.website_url به یک رشته خالی انجام می‌شود. Merchant API یک روش اختصاصی homepage.unclaim را ارائه می دهد.
  • بازنویسی ادعا : هر دو API از یک پارامتر overwrite در طول فرآیند ادعا پشتیبانی می‌کنند تا در صورت تأیید مالکیت، ادعایی را از حساب دیگری دریافت کنند.

درخواست ها

Merchant API از نقاط پایانی متمایز RESTful برای مدیریت جنبه‌های مختلف صفحه اصلی استفاده می‌کند.

درخواست توضیحات Content API برای خرید برای خرید 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 برای خرید Merchant API
شناسه حساب برای دسترسی به منابع merchantId (حساب پیشرفته) و accountId (حساب فرعی) در مسیر account (بخشی از قسمت name ، مانند accounts/{account_id}/homepage )
شناسه منبع صفحه اصلی غیر قابل اجرا (به طور ضمنی برای منبع Account ) name : accounts/{account_id}/homepage (منبع فرعی Homepage مشخص می‌کند)

روش ها

روش accounts.claimwebsite از Content API برای خرید، که بر عمل ادعا متمرکز بود، اکنون بخشی از مجموعه گسترده‌تری از عملکردها در منبع Homepage Merchant API است.

Content API برای روش خرید روش 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 برای خرید Merchant 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 (فیلد بولین_فقط خروجی در منبع Homepage ) نشان می دهد که آیا uri ادعا شده و تأیید شده است. این وضعیت مستقیماً در منبع Homepage که توسط همه روش‌های Merchant API مرتبط با آن بازگردانده شده است در دسترس است.
N/A UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage پارامتر بدنه درخواست صفحه اصلی) یک فیلد ماسک اختیاری برای homepage.update برای تعیین اینکه کدام فیلدها (به عنوان مثال، uri ) از منبع Homepage در حال به روز رسانی هستند.
قبلی
Migrate user and access management
بعدی
Migrate region management