סקירה כללית על ממשק ה-API המשני של Programs

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

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

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

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

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

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

אחזור של תוכנית אחת

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

הפעלת תוכנית

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

השבתת תוכנית

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