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

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

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

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

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

הצגת כל התוכניות

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