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

توفّر واجهة 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 مخصّصة.
  • تجاهل المطالبة: تتيح كلتا واجهتَي برمجة التطبيقات المَعلمة overwrite أثناء عملية المطالبة لتجاهل مطالبة من حساب آخر إذا كان من الممكن إثبات الملكية.

الطلبات

تستخدِم Merchant API نقاط نهاية RESTful مميّزة لإدارة جوانب مختلفة من الصفحة الرئيسية.

وصف الطلب ‫Content API for Shopping Merchant API
الحصول على تفاصيل الصفحة الرئيسية accounts.get (لقراءة Account.website_urlaccountstatuses.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_urlaccountstatuses.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) لصفحة المتجر الرئيسية. في 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.