نظرة عامة على واجهة برمجة التطبيقات الفرعية لبرنامج "الإعلانات على شبكة البحث"

تتيح لك البرامج التحكّم في الترويج لمنتجاتك وتحسين ميزات حسابك على مختلف مساحات العرض في Google.

ومن الأمثلة على ذلك برنامج بيانات المنتجات المجانية الذي يتيح عرض منتجات من متجرك على الإنترنت على خدمات Google بدون أي رسوم.

تتيح لك واجهة برمجة التطبيقات الفرعية "البرامج" استرداد مشاركتك في كل برامج التسوّق المتاحة وتعديلها.

لاسترداد البرامج وتفعيلها وإيقافها، يمكنك استخدام الطرق التالية:

عرض قائمة بجميع البرامج

لاسترداد جميع البرامج للحساب، استخدِم الطريقة 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}"
}