REST Resource: accounts.programs

משאב: תוכנית

מגדיר את ההשתתפות בתוכנית נתונה של החשבון שצוין.

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

ייצוג JSON 
{
  "name": string,
  "documentationUri": string,
  "state": enum (State),
  "activeRegionCodes": [
    string
  ],
  "unmetRequirements": [
    {
      object (Requirement)
    }
  ]
}
שדות
name

string

מזהה. שם המשאב של התוכנה. פורמט: accounts/{account}/programs/{program}
documentationUri

string

פלט בלבד. כתובת ה-URL של דף עזרה ב-Merchant Center שמתאר את התוכנית.
state

enum (State)

פלט בלבד. סטטוס ההשתתפות של החשבון בתוכנית.
activeRegionCodes[]

string

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

קודי האזורים מוגדרים באמצעות CLDR. במדינה הזו התוכנית חלה באופן ספציפי על מדינה זו או על 001 אם התוכנית חלה בכל העולם.
unmetRequirements[]

object (Requirement)

פלט בלבד. הדרישות שהחשבון עדיין לא עמד בהן ומשפיעות על ההשתתפות בתוכנית.

ארץ

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

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
NOT_ELIGIBLE החשבון לא עומד בדרישות ההשתתפות בתוכנית.
ELIGIBLE החשבון עומד בדרישות להשתתפות בתוכנית.
ENABLED התוכנית מופעלת עבור החשבון.

דרישה

מגדיר דרישה שצוינה להשתתפות בתוכנית.

ייצוג JSON 
{
  "title": string,
  "documentationUri": string,
  "affectedRegionCodes": [
    string
  ]
}
שדות
title

string

פלט בלבד. שם הדרישה.
documentationUri

string

פלט בלבד. כתובת ה-URL של דף עזרה שמתאר את הדרישה.
affectedRegionCodes[]

string

פלט בלבד. האזורים שמושפעים כרגע מהדרישה הזו לא מתקיימים.

קודי האזורים מוגדרים באמצעות CLDR. במדינה הזו התוכנית חלה באופן ספציפי על מדינה זו או על 001 אם התוכנית חלה בכל העולם.

שיטות

disable

 להשבית את ההשתתפות בתוכנית שצוינה עבור החשבון.

enable

 להפעיל את ההשתתפות בתוכנית שצוינה בחשבון.

get

 אחזור של התוכנית שצוינה עבור החשבון.

list

 אחזור כל התוכניות של החשבון.