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

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

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

برنامه های فرعی API به شما امکان می دهد مشارکت خود را در همه برنامه های خرید موجود بازیابی و به روز کنید.

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

لیست همه برنامه ها

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

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

HTTP

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

CURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1beta/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 استفاده کنید.

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

HTTP

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

CURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1beta/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 استفاده کنید. برای اجرای این مجوز باید دسترسی مدیر داشته باشید.

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

HTTP

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

CURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1beta/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 استفاده کنید. برای اجرای این مجوز باید دسترسی مدیر داشته باشید.

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

HTTP

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

CURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1beta/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}"
}
،

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

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

برنامه های فرعی API به شما امکان می دهد مشارکت خود را در همه برنامه های خرید موجود بازیابی و به روز کنید.

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

لیست همه برنامه ها

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

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

HTTP

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

CURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1beta/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 استفاده کنید.

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

HTTP

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

CURL

  curl \
  'https://merchantapi.googleapis.com/accounts/v1beta/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 استفاده کنید. برای اجرای این مجوز باید دسترسی مدیر داشته باشید.

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

HTTP

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

CURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1beta/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 استفاده کنید. برای اجرای این مجوز باید دسترسی مدیر داشته باشید.

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

HTTP

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

CURL

  curl --request POST \
  'https://merchantapi.googleapis.com/accounts/v1beta/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}"
}