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

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

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

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

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

عرض جميع البرامج

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

إليك مثال على الطلب الذي يمكنك إرساله:

HTTP

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

cURL

  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 طريقة.

إليك مثال على الطلب الذي يمكنك إرساله:

HTTP

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

cURL

  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 طريقة. يجب أن يكون لديك إذن وصول إداري لتنفيذ هذا الإذن.

إليك مثال على الطلب الذي يمكنك إرساله:

HTTP

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

cURL

  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. يجب أن يكون لديك إذن وصول إداري لتنفيذ هذا الإذن.

إليك مثال على الطلب الذي يمكنك إرساله:

HTTP

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

cURL

  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}"
}