با Merchant API شروع کنید

این صفحه توضیح می دهد که چگونه می توانید یک حساب Merchant Center ایجاد کنید و یک محصول نمونه را با استفاده از Merchant API آپلود کنید.

قبل از شروع

Merchant API را در پروژه Google Cloud خود فعال کنید.

اگر از ادغام API در AppScript با استفاده از سرویس محتوای خرید استفاده می‌کنید، یک پروژه Google Cloud پیش‌فرض ایجاد می‌کند و سرویس Merchant API را به‌طور خودکار فعال می‌کند. با این حال، هنوز هم باید قبل از استفاده از Merchant API یک بار ثبت نام توسعه دهنده را تکمیل کنید. برای اطلاعات بیشتر، استفاده از Merchant API Service در Apps Script را ببینید.

به Google Cloud بروید

یک حساب کاربری ایجاد کنید

برای استفاده از Merchant API، باید یک حساب Merchant Center داشته باشید. برای ایجاد یکی، به شروع با Merchant Center مراجعه کنید.

به Merchant Center بروید

به عنوان یک توسعه دهنده ثبت نام کنید

برای استفاده از Merchant API، باید پیوندی بین پروژه Google Cloud و حساب Merchant Center اصلی خود ایجاد کنید. برای هر پروژه Google Cloud که با Merchant API استفاده می‌کنید، این ثبت‌نام یک‌باره الزامی است.

ثبت نام به عنوان یک توسعه دهنده دو چیز را انجام می دهد:

  • این پروژه Google Cloud شما را به حساب Merchant Center اصلی شما پیوند می دهد و یک اتصال رسمی ایجاد می کند.
  • با اختصاص نقش API_DEVELOPER به یک کاربر در حساب Merchant Center شما، یک مخاطب فنی ایجاد می‌کند. این به Google اجازه می‌دهد تا به‌روزرسانی‌های مهم API، مانند اطلاعیه‌های سرویس و اطلاعات درباره ویژگی‌های جدید را برای شما ارسال کند.

پروژه Google Cloud خود را ثبت کنید

برای ثبت نام با متد developerRegistration.registerGcp تماس بگیرید. این تماس پروژه Google Cloud را که برای برقراری تماس استفاده می‌کنید، با حساب Merchant Center که در درخواست مشخص کرده‌اید پیوند می‌دهد.

در بدنه درخواست، باید یک آدرس ایمیل توسعه دهنده را برای استفاده به عنوان مخاطب فنی ارائه دهید. این آدرس باید با یک حساب Google (حساب Google Workspace یا حساب Gmail)، به عنوان مثال sampleuser@gmail.com مرتبط باشد.

  • اگر آدرس ایمیل قبلاً متعلق به کاربری در حساب Merchant Center باشد، به آن کاربر نقش API_DEVELOPER اعطا می شود.
  • اگر آدرس ایمیل متعلق به یک کاربر موجود نباشد، یک دعوت نامه به آن آدرس ارسال می شود. گیرنده باید دعوت نامه را بپذیرد تا به عنوان یک کاربر جدید با نقش API_DEVELOPER اضافه شود.

در اینجا یک نمونه درخواست وجود دارد:

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/developerRegistration:registerGcp

{
  "developerEmail": "{DEVELOPER_EMAIL}"
}

یک تماس موفق یک منبع DeveloperRegistration را برمی‌گرداند که پیوند بین پروژه و حساب شما را تأیید می‌کند.

{
  "name": "accounts/{ACCOUNT_ID}/developerRegistration",
  "gcpIds": [
    "123456789012345"
  ]
}

مخاطبین و مجوزهای توسعه دهنده را مدیریت کنید

پس از ثبت نام، توصیه می کنیم چندین برنامه نویس اضافه کنید و به آنها حقوق دسترسی بیشتری بدهید.

مجوزهای اضافی اعطا کنید

نقش API_DEVELOPER برای دریافت اعلان‌های مهم لازم است، اما حداقل مجوزها را در Merchant Center دارد. برای اینکه این کاربر بتواند تماس‌های API دیگری انجام دهد یا تنظیمات را در رابط کاربری Merchant Center مدیریت کند، باید نقش‌های دیگری مانند STANDARD یا ADMIN را به او اعطا کنید. برای اطلاعات بیشتر، به انواع دسترسی مراجعه کنید.

می توانید حقوق دسترسی کاربر را با روش accounts.users.patch به روز کنید.

مثال زیر نشان می دهد که چگونه می توان یک کاربر را برای اعطای هر دو نقش ADMIN و API_DEVELOPER به روز کرد. این به آنها اجازه می دهد تا حساب را به طور کامل مدیریت کنند و همچنین ارتباطات مربوط به API را دریافت خواهند کرد.

PATCH https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/users/{DEVELOPER_EMAIL}?update_mask=access_rights
{
  "access_rights": [
    "ADMIN",
    "API_DEVELOPER"
  ]
}

توسعه دهندگان پشتیبان را اضافه کنید

برای جلوگیری از مختل شدن دسترسی API شما در صورت خروج مخاطب برنامه‌نویس اصلی شما، باید حداقل یک توسعه‌دهنده پشتیبان اضافه کنید.

می‌توانید با روش accounts.users.create یک کاربر اضافه کنید یا یک کاربر موجود را با روش accounts.users.patch به‌روزرسانی کنید. توصیه می کنیم به این کاربر هر دو نقش ADMIN و API_DEVELOPER بدهید.

یک منبع داده محصولات اولیه ایجاد کنید

برای درج یک محصول، به منبع داده محصولات اولیه نیاز دارید. درخواست زیر نحوه ایجاد یک منبع داده را نشان می دهد که می توانید از آن برای درج محصول در حساب خود استفاده کنید:

POST https://merchantapi.googleapis.com/datasources/v1/accounts/{ACCOUNT_ID}/dataSources HTTP/1.1

{
  "primaryProductDataSource": {
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "feedLabel": "US"
  },
  "name": "primary-data-source",
  "displayName": "Primary Products Data Source"
}

{ACCOUNT_ID} را با شناسه حساب Merchant Center که ایجاد کردید جایگزین کنید.

پس از اجرای موفقیت آمیز این درخواست، باید پاسخ زیر را مشاهده کنید:

{
  "name": "accounts/{ACCOUNT_ID}/dataSources/{DATASOURCE_ID}",
  "dataSourceId": "{DATASOURCE_ID}",
  "displayName": "Primary Products Data Source",
  "primaryProductDataSource": {
    "feedLabel": "US",
    "contentLanguage": "en",
    "countries": [
      "US"
    ],
    "defaultRule": {
      "takeFromDataSources": [
        {
          "self": true
        }
      ]
    }
  },
  "input": "API"
}

مقدار فیلد name را کپی کنید. برای قرار دادن محصول به آن نیاز خواهید داشت.

می‌توانید این منبع داده را در رابط کاربری Merchant Center مشاهده کنید. برای اطلاعات بیشتر، نحوه یافتن برگه منابع داده را ببینید.

درج یک محصول

برای درج نمونه محصول در حساب خود، درخواست زیر را اجرا کنید:

POST https://merchantapi.googleapis.com/products/v1/accounts/{ACCOUNT_ID}/productInputs:insert?dataSource={DATASOURCE_NAME} HTTP/1.1

{
  "contentLanguage": "en",
  "feedLabel": "US",
  "name": "Red T-shirt",
  "attributes": {
    "gender": "Male",
    "brand": "New brand"
  },
  "offerId": "tshirt-123"
}

مقداری را که قبلاً کپی کردید جایگزین {DATASOURCE_NAME} کنید.

پس از اجرای موفقیت آمیز این درخواست، باید پاسخ زیر را مشاهده کنید:

{
  "name": "accounts/{ACCOUNT_ID}/productInputs/en~US~tshirt-123",
  "product": "accounts/{ACCOUNT_ID}/products/en~US~tshirt-123",
  "offerId": "tshirt-123",
  "contentLanguage": "en",
  "feedLabel": "US",
  "attributes": {
    "brand": "New brand",
    "gender": "Male"
  }
}

شناسه محصول برای محصول جدید ایجاد شده en~US~tshirt-123 است. برای بازیابی جزئیات این محصول می توانید از روش accounts.products.get استفاده کنید. همچنین می توانید از رابط کاربری Merchant Center برای مشاهده این محصول استفاده کنید. مشاهده اطلاعات محصول خود را ببینید.