این سند توضیح می دهد که چگونه می توانید از Content API نسخه 2.1 به Merchant API مهاجرت کنید.
نمای کلی تغییرات از Content API نسخه 2.1 به Merchant API
Merchant API بهبودهای قابل توجهی را نسبت به Content API نسخه 2.1 معرفی می کند که هدف آن افزایش قابلیت استفاده، سازگاری و انعطاف پذیری برای توسعه دهندگان و مشاغل است.
ساختار منابع دانه ای
منابع در Merchant API مفاهیم واحدی مانند account ، businessDetails ، user ، homepage و program را نشان می‌دهند. آنها به صورت سلسله مراتبی سازماندهی شده اند تا روابطشان را منعکس کنند. به عنوان مثال، یک account منبع والد یک user است.
خدمات حساب یکپارچه
همه خدمات حساب (به عنوان مثال، تجمیع حساب برای MCA ها و حساب های فرعی آنها یا بین ارائه دهندگان خدمات شخص ثالث و حساب ها) از طریق یک منبع accountService یکپارچه مدیریت می شوند. ارائه دهندگان خدمات می توانند روابط خود را با استفاده از منبع accountRelationship مدیریت کنند.
ساختار URL ساده شده
اکنون نشانی‌های وب از یک شناسه حساب واحد (مثلا merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId} ) به‌جای چندین شناسه استفاده می‌کنند. مسیرهای URL ساختار منبع دانه ای را منعکس می کنند.
سایر پیشرفت ها
- برنامه پیشرفته و مدیریت کاربر : برنامه هایی مانند تبلیغات خرید و لیست های رایگان تحت یک منبع
programواحد ادغام می شوند. منبعuserشامل قابلیت های مدیریت جامع با حقوق دسترسی گرانول است. - اطلاعات کسب و کار ساختاریافته و هویت تجاری : منابع اختصاصی برای
businessInfoوbusinessIdentityوجود دارد. آنها شامل پشتیبانی انطباق با فیلدها برای داده های خاص منطقه هستند. به عنوان مثال، شماره ثبت کسب و کار کره ای. - ادعای صفحه اصلی ساده شده : یک منبع
homepageاختصاصی URL صفحه اصلی فروشگاه را مدیریت می کند. روش‌هایی مانندclaimوunclaim، ادعای وب‌سایت را مستقیماً از طریق API مدیریت می‌کنند. - مطابقت با دستورالعمل‌های Google API : Merchant API قصد دارد با پیشنهادات بهبود API Google هماهنگ شود.
مهاجرت مدیریت حساب
می‌توانید از منبع accounts برای ایجاد و مدیریت حساب تجاری خود استفاده کنید. برای اطلاعات بیشتر، مرور کلی API حساب‌های تجاری را ببینید.
در این صفحه نحوه انتقال مدیریت حساب از Content API به Merchant API توضیح داده شده است.
درخواست ها
از فرمت URL درخواست زیر برای API حساب‌های تجاری استفاده کنید:
POST https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts
در اینجا نمونه‌ای از مقایسه Content API برای خرید با Merchant Accounts API برای درخواست‌های ایجاد و مدیریت حساب آمده است:
| Content API برای خرید | API حساب‌های تجاری | |
|---|---|---|
| URL | https://shoppingcontent.googleapis.com/content/v2.1/ merchantId /accounts/ accountId / | https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId |
| شناسه ها | merchantId /accounts/ accountId | accounts/ شناسه حساب |
منابع
داده‌های حساب با استفاده از منبع Account در Content API برای خرید ارسال می‌شوند. Merchant Accounts API منابع متعددی را برای انتقال داده های حساب فراهم می کند. این منابع شامل منابع Account ، User ، BusinessInfo و BusinessIdentity است.
جدول زیر مقایسه ای بین منبع Account در Content API برای خرید و منبع Account در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
id | name |
name | accountName |
kind | در دسترس نیست |
websiteUrl | فیلد uri در منبع Homepage |
adultContent | adultContent |
sellerId | قسمت accountIdAlias در منبع AccountRelationship |
users | در منبع [User](/merchant/api/reference/rest/v1/accounts.v1beta.accounts.users) |
youtubeChannelLinks | هنوز در دسترس نیست |
googleMyBusinessLink | هنوز در دسترس نیست |
businessInformation | در منبع [businessInfo](/merchant/api/reference/rest/v1/BusinessInfo) |
businessIdentity | در منبع [businessIdentity](/merchant/api/reference/rest/v1/BusinessIdentity) |
automaticImprovements | هنوز در دسترس نیست |
adsLinks | قسمت campaignsManagement در منبع AccountService |
cssId | فقط در CSS API موجود است |
labelIds | فقط در CSS API موجود است |
accountManagement | قسمت accountManagement در منبع AccountService |
automaticLabelIds | فقط در CSS API موجود است |
conversionSettings | هنوز در دسترس نیست |
جدول زیر مقایسه ای بین منبع AccountUser در Content API برای خرید و منبع User در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
emailAddress | ایمیل بخشی از name است ( accounts/{account}/users/{email} ). |
admin | user#accessRights.ADMIN |
orderManager | در دسترس نیست |
paymentsManager | در دسترس نیست |
paymentsAnalyst | در دسترس نیست |
reportingManager | user#accessRights.PERFORMANCE_REPORTING |
جدول زیر مقایسه ای بین منبع AccountBusinessInformation در Content API for Shopping و منبع معادل آن businessInfo در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
businessInformation | businessInfo |
phoneNumber | phone |
phoneVerificationStatus | phoneVerificationState |
customerService | customerService |
koreanBusinessRegistrationNumber | koreanBusinessRegistrationNumber |
جدول زیر مقایسه ای بین منبع AccountBusinessIdentity در Content API for Shopping و منبع businessIdentity در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
blackOwned | blackOwned |
womenOwned | womenOwned |
veteranOwned | veteranOwned |
latinoOwned | latinoOwned |
smallBusiness | smallBusiness |
includeForPromotions | promotionsConsent |
- true به معنای PROMOTION_CONSENT_GIVEN است | |
- false به معنای PROMOTION_CONSENT_DENIED است |
منبع AccountIdentityType در Content API با نوع IdentityAttribute و identityDeclaration فیلد آن Declaration در MerchantAPI نشان داده می شود.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
self_identified | identityDeclaration |
- true به معنای SELF_IDENTIFIES_AS است | |
- false نشان دهنده DOES_NOT_SELF_IDENTIFY_AS است |
روش ها
روش‌های زیر در API حساب‌های تجاری معرفی شده‌اند:
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
accounts.authinfo | GET https://merchantapi.googleapis.com/accounts/v1beta/accounts |
accounts.claimwebsite | POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId /homepage:claim |
| برای اطلاعات بیشتر، روش: accounts.v1beta.accounts.homepage.claim را ببینید | |
accounts.custombatch | در دسترس نیست. دسته سفارشی در Merchant API پشتیبانی نمی‌شود. |
accounts.delete | DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId |
accounts.get | GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId را دریافت کنید |
accounts.insert | POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure |
| برای اطلاعات بیشتر، به ایجاد و پیکربندی یک حساب تجاری مراجعه کنید | |
accounts.link | منبع AccountService |
accounts.list | GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId :listSubaccounts |
accounts.listlinks | GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId /services |
accounts.update | به درخواست به‌روزرسانی برای منبعی که فیلد یا مجموعه‌ای از فیلدهای مورد نیاز تعریف شده است، نقشه می‌دهد. |
این سند توضیح می دهد که چگونه می توانید از Content API نسخه 2.1 به Merchant API مهاجرت کنید.
نمای کلی تغییرات از Content API نسخه 2.1 به Merchant API
Merchant API بهبودهای قابل توجهی را نسبت به Content API نسخه 2.1 معرفی می کند که هدف آن افزایش قابلیت استفاده، سازگاری و انعطاف پذیری برای توسعه دهندگان و مشاغل است.
ساختار منابع دانه ای
منابع در Merchant API مفاهیم واحدی مانند account ، businessDetails ، user ، homepage و program را نشان می‌دهند. آنها به صورت سلسله مراتبی سازماندهی شده اند تا روابطشان را منعکس کنند. به عنوان مثال، یک account منبع والد یک user است.
خدمات حساب یکپارچه
همه خدمات حساب (به عنوان مثال، تجمیع حساب برای MCA ها و حساب های فرعی آنها یا بین ارائه دهندگان خدمات شخص ثالث و حساب ها) از طریق یک منبع accountService یکپارچه مدیریت می شوند. ارائه دهندگان خدمات می توانند روابط خود را با استفاده از منبع accountRelationship مدیریت کنند.
ساختار URL ساده شده
اکنون نشانی‌های وب از یک شناسه حساب واحد (مثلا merchantapi.googleapis.com/accounts/v1beta/accounts/{accountId} ) به‌جای چندین شناسه استفاده می‌کنند. مسیرهای URL ساختار منبع دانه ای را منعکس می کنند.
سایر پیشرفت ها
- برنامه پیشرفته و مدیریت کاربر : برنامه هایی مانند تبلیغات خرید و لیست های رایگان تحت یک منبع
programواحد ادغام می شوند. منبعuserشامل قابلیت های مدیریت جامع با حقوق دسترسی گرانول است. - اطلاعات کسب و کار ساختاریافته و هویت تجاری : منابع اختصاصی برای
businessInfoوbusinessIdentityوجود دارد. آنها شامل پشتیبانی انطباق با فیلدها برای داده های خاص منطقه هستند. به عنوان مثال، شماره ثبت کسب و کار کره ای. - ادعای صفحه اصلی ساده شده : یک منبع
homepageاختصاصی URL صفحه اصلی فروشگاه را مدیریت می کند. روش‌هایی مانندclaimوunclaim، ادعای وب‌سایت را مستقیماً از طریق API مدیریت می‌کنند. - مطابقت با دستورالعمل‌های Google API : Merchant API قصد دارد با پیشنهادات بهبود API Google هماهنگ شود.
مهاجرت مدیریت حساب
می‌توانید از منبع accounts برای ایجاد و مدیریت حساب تجاری خود استفاده کنید. برای اطلاعات بیشتر، مرور کلی API حساب‌های تجاری را ببینید.
در این صفحه نحوه انتقال مدیریت حساب از Content API به Merchant API توضیح داده شده است.
درخواست ها
از فرمت URL درخواست زیر برای API حساب‌های تجاری استفاده کنید:
POST https://merchantapi.googleapis.com/accounts/v1beta/{accountId}/accounts
در اینجا نمونه‌ای از مقایسه Content API برای خرید با Merchant Accounts API برای درخواست‌های ایجاد و مدیریت حساب آمده است:
| Content API برای خرید | API حساب‌های تجاری | |
|---|---|---|
| URL | https://shoppingcontent.googleapis.com/content/v2.1/ merchantId /accounts/ accountId / | https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId |
| شناسه ها | merchantId /accounts/ accountId | accounts/ شناسه حساب |
منابع
داده‌های حساب با استفاده از منبع Account در Content API برای خرید ارسال می‌شوند. Merchant Accounts API منابع متعددی را برای انتقال داده های حساب فراهم می کند. این منابع شامل منابع Account ، User ، BusinessInfo و BusinessIdentity است.
جدول زیر مقایسه ای بین منبع Account در Content API برای خرید و منبع Account در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
id | name |
name | accountName |
kind | در دسترس نیست |
websiteUrl | فیلد uri در منبع Homepage |
adultContent | adultContent |
sellerId | قسمت accountIdAlias در منبع AccountRelationship |
users | در منبع [User](/merchant/api/reference/rest/v1/accounts.v1beta.accounts.users) |
youtubeChannelLinks | هنوز در دسترس نیست |
googleMyBusinessLink | هنوز در دسترس نیست |
businessInformation | در منبع [businessInfo](/merchant/api/reference/rest/v1/BusinessInfo) |
businessIdentity | در منبع [businessIdentity](/merchant/api/reference/rest/v1/BusinessIdentity) |
automaticImprovements | هنوز در دسترس نیست |
adsLinks | قسمت campaignsManagement در منبع AccountService |
cssId | فقط در CSS API موجود است |
labelIds | فقط در CSS API موجود است |
accountManagement | قسمت accountManagement در منبع AccountService |
automaticLabelIds | فقط در CSS API موجود است |
conversionSettings | هنوز در دسترس نیست |
جدول زیر مقایسه ای بین منبع AccountUser در Content API برای خرید و منبع User در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
emailAddress | ایمیل بخشی از name است ( accounts/{account}/users/{email} ). |
admin | user#accessRights.ADMIN |
orderManager | در دسترس نیست |
paymentsManager | در دسترس نیست |
paymentsAnalyst | در دسترس نیست |
reportingManager | user#accessRights.PERFORMANCE_REPORTING |
جدول زیر مقایسه ای بین منبع AccountBusinessInformation در Content API for Shopping و منبع معادل آن businessInfo در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
businessInformation | businessInfo |
phoneNumber | phone |
phoneVerificationStatus | phoneVerificationState |
customerService | customerService |
koreanBusinessRegistrationNumber | koreanBusinessRegistrationNumber |
جدول زیر مقایسه ای بین منبع AccountBusinessIdentity در Content API for Shopping و منبع businessIdentity در Merchant Accounts API ارائه می دهد.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
blackOwned | blackOwned |
womenOwned | womenOwned |
veteranOwned | veteranOwned |
latinoOwned | latinoOwned |
smallBusiness | smallBusiness |
includeForPromotions | promotionsConsent |
- true به معنای PROMOTION_CONSENT_GIVEN است | |
- false به معنای PROMOTION_CONSENT_DENIED است |
منبع AccountIdentityType در Content API با نوع IdentityAttribute و identityDeclaration فیلد آن Declaration در MerchantAPI نشان داده می شود.
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
self_identified | identityDeclaration |
- true به معنای SELF_IDENTIFIES_AS است | |
- false نشان دهنده DOES_NOT_SELF_IDENTIFY_AS است |
روش ها
روش‌های زیر در API حساب‌های تجاری معرفی شده‌اند:
| Content API برای خرید | API حساب‌های تجاری |
|---|---|
accounts.authinfo | GET https://merchantapi.googleapis.com/accounts/v1beta/accounts |
accounts.claimwebsite | POST https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId /homepage:claim |
| برای اطلاعات بیشتر، روش: accounts.v1beta.accounts.homepage.claim را ببینید | |
accounts.custombatch | در دسترس نیست. دسته سفارشی در Merchant API پشتیبانی نمی‌شود. |
accounts.delete | DELETE https://merchantapi.googleapis.com/accounts/v1beta/accounts/ accountId |
accounts.get | GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId را دریافت کنید |
accounts.insert | POST https://merchantapi.googleapis.com/accounts/v1beta/accounts:createAndConfigure |
| برای اطلاعات بیشتر، به ایجاد و پیکربندی یک حساب تجاری مراجعه کنید | |
accounts.link | منبع AccountService |
accounts.list | GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId :listSubaccounts |
accounts.listlinks | GET https://merchantapi.googleapis.com/accounts/v1beta/ accountId /services |
accounts.update | به درخواست به‌روزرسانی برای منبعی که فیلد مورد نیاز یا مجموعه‌ای از فیلدها تعریف شده است، نقشه می‌دهد. |