توفّر 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مباشرةً. All methods operating on theHomepageresource return this resource, providing immediate feedback on the current state. في 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 في 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) |
| معرّف الموارد المنتظم (URI) للصفحة الرئيسية | لا ينطبق (ضمني على مورد 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. |