نظرة عامة على Programs API

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

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

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

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

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

لاسترداد جميع البرامج للحساب، استخدِم الطريقة accounts.programs.list.

في ما يلي نموذج طلب:

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

في ما يلي نموذج ردّ من طلب ناجح:

{
  "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/v1beta/accounts/{ACCOUNT_ID}/programs/free-listings

في ما يلي نموذج ردّ من طلب ناجح:

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

تفعيل برنامج

لتفعيل المشاركة في البرنامج المحدّد للحساب، استخدِم الطريقة accounts.programs.enable. يجب أن يكون لديك إذن وصول إداري لتشغيل هذا الإذن.

في ما يلي مثال على طلب:

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

في ما يلي نموذج ردّ من طلب ناجح:

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

إيقاف برنامج

لإيقاف المشاركة في البرنامج المحدّد للحساب، استخدِم الطريقة accounts.programs.disable. يجب أن يكون لديك إذن وصول إداري لتشغيل هذا الإذن.

في ما يلي مثال على طلب:

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

في ما يلي نموذج ردّ من طلب ناجح:

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