مروری بر برنامه های فرعی API، نمای کلی برنامه های فرعی API

برنامه‌ها به شما امکان می‌دهند تبلیغات محصولات خود را کنترل کنید و ویژگی‌های حساب خود را در سطوح مختلف گوگل ارتقا دهید.

یک نمونه بارز از این مورد، برنامه فهرست‌بندی رایگان محصولات است که به محصولات فروشگاه آنلاین شما امکان می‌دهد بدون هیچ هزینه‌ای در سراسر گوگل نمایش داده شوند.

زیر-API برنامه‌ها به شما امکان می‌دهد مشارکت خود را در تمام برنامه‌های خرید موجود بازیابی و به‌روزرسانی کنید.

برای بازیابی، فعال و غیرفعال کردن برنامه‌ها، می‌توانید از روش‌های زیر استفاده کنید:

فهرست کردن همه برنامه‌ها

برای بازیابی تمام برنامه‌های مربوط به حساب کاربری، از متد accounts.programs.list استفاده کنید.

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

اچ‌تی‌پی 

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs

حلقه 

  curl \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs?key=[YOUR_API_KEY]' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --compressed

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

{
  "programs": [
    {
      "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
      "documentationUri": "{URI}",
      "state": "{ACCOUNT_STATE}",
      "unmetRequirements": [
        {
          "title": "{TITLE}",
          "documentationUri": "{URI}",
          "affectedRegionCodes": [
            "{REGION_CODE}"
          ]
        }
      ]
    }
  ]
}

بازیابی یک برنامه واحد

برای بازیابی یک برنامه خاص، از متد accounts.programs.get استفاده کنید.

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

اچ‌تی‌پی 

GET https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings

حلقه 

  curl \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing?key=[YOUR_API_KEY]' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --compressed

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

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

فعال کردن یک برنامه

برای فعال کردن مشارکت در برنامه مشخص شده برای حساب، از متد accounts.programs.enable استفاده کنید. برای اجرای این مجوز باید دسترسی مدیر (administrator) داشته باشید.

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

اچ‌تی‌پی 

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings:enable

حلقه 

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing:enable?key=[YOUR_API_KEY]' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

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

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}",
  "unmetRequirements": [
    {
      "title": "{TITLE}",
      "documentationUri": "{URI}",
      "affectedRegionCodes": [
        "{REGION_CODE}"
      ]
    }
  ]
}

غیرفعال کردن یک برنامه

برای غیرفعال کردن مشارکت در برنامه مشخص شده برای حساب، از متد accounts.programs.disable استفاده کنید. برای اجرای این مجوز باید دسترسی مدیر (administrator) داشته باشید.

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

اچ‌تی‌پی 

POST https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listings:disable

حلقه 

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1/accounts/{ACCOUNT_ID}/programs/free-listing:disable?key=[YOUR_API_KEY]' \
  --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{}' \
  --compressed

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

{
  "name": "accounts/{ACCOUNT_ID}/programs/free-listings",
  "documentationUri": "{URI}",
  "state": "{ACCOUNT_STATE}"
}