نقل إعدادات الصفحة الرئيسية

تقدّم 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 (عنوان URL للصفحة الرئيسية) والحالة claimed مباشرةً. تعرض جميع الطرق التي تعمل على مرجع Homepage هذا المرجع، ما يقدّم ملاحظات فورية حول الحالة الحالية. في Content API for Shopping، لم تعرض طريقة accounts.claimwebsite الحالة المعدَّلة، وكان من الضروري إجراء طلبات منفصلة.
  • إخلاء المسؤولية بشكل صريح: في Content API for Shopping، كان يتم عادةً إخلاء المسؤولية من خلال تعديل Account.website_url إلى سلسلة فارغة. يوفّر Merchant API طريقة مخصّصة هي homepage.unclaim.
  • الكتابة فوق المط101البة: تتيح كلتا واجهتَي برمجة التطبيقات مَعلمة 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)

الطُرق

تُعدّ طريقة accounts.claimwebsite من Content API for Shopping، التي كانت تركّز على إجراء المطالبة، الآن جزءًا من مجموعة أوسع من الوظائف ضِمن مرجع Homepage في Merchant API.

طريقة Content API for Shopping طريقة 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 (قيمة منطقية في نص 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 الذي تعرضه جميع طُرق Merchant API المرتبطة به.
لا ينطبق UpdateHomepageRequest.update_mask accounts.homepage.updateHomepage معلمة نص طلب) قناع حقل اختياري لـ homepage.update لتحديد الحقول (مثل uri) التي يتم تعديلها في مرجع Homepage
السابق
Migrate user and access management
التالي
Migrate region management