סקירה כללית על Programs API

תוכניות מאפשרות לכם לשלוט בקידום המוצרים ולשפר את התכונות של החשבון בפלטפורמות השונות של Google.

דוגמה אופיינית לכך היא התוכנית כרטיסי מוצר חינמיים, שמאפשרת להציג מוצרים מהחנות הווירטואלית שלכם ב-Google ללא תשלום.

באמצעות Programs API אפשר לאחזר ולעדכן את ההשתתפות שלכם בכל תוכניות השופינג הזמינות.

כדי לאחזר, להפעיל ולהשבית תוכניות, אפשר להשתמש בשיטות הבאות:

הצגת רשימה של כל התוכניות

כדי לאחזר את כל התוכניות בחשבון, משתמשים ב-method‏ 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}"
      ]
    }
  ]
}

הפעלת תוכנית

כדי לאפשר לחשבון להשתתף בתוכנית שצוינה, משתמשים ב-method‏ 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}"
      ]
    }
  ]
}

השבתת תוכנית

כדי להשבית את ההשתתפות בתוכנית שצוינה בחשבון, משתמשים ב-method‏ 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}"
}