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 אם התוכנית חלה באופן גלובלי.

Methods

disable

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

enable

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

get

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

list

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