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

توفّر Merchant API موردًا مخصّصًا Homepage. يوفّر هذا المرجع طرقًا جديدة لإدارة طلبات الحصول على الصفحة الرئيسية، ويقدّم إمكانات تتجاوز تلك التي توفّرها واجهة Content API for Shopping الكلاسيكية.

للوصول إلى ميزات متجرك على الإنترنت، عليك اتّباع خطوتَين: أولاً، إثبات ملكية الموقع الإلكتروني، ثم المطالبة به لحسابك. لإكمال الخطوة الأخيرة، استخدِم accounts.homepage.claim.

الاختلافات الرئيسية

تُجري Merchant API عدة تغييرات متعلقة بالصفحة الرئيسية مقارنةً بـ Content API في 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.
• إلغاء المطالبة: تتيح كلتا واجهتَي برمجة التطبيقات المَعلمة 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.

وصف المعرّف	واجهة برمجة تطبيقات المحتوى في 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.

واجهة برمجة تطبيقات المحتوى في 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.