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

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

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

באמצעות ה-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}"
          ]
        }
      ]
    }
  ]
}

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

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