Method: subscriptions.list

רשימות מינויים שמנוהלות על ידי המפיץ. הרשימה יכולה לכלול את כל המינויים, כל המינויים של הלקוח או כל המינויים של הלקוח שניתנים להעברה.

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

בקשת HTTP

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של שאילתה

פרמטרים
customerAuthToken

string

כשיוצרים חשבון של מפיץ שמעביר מינוי של לקוח ישיר, או מינוי של לקוח מפיץ אחר לניהול המפיץ שלך, צריך להזין את מחרוזת השאילתה customerAuthToken. זהו אסימון אימות הקסדצימלי שנדרש כדי להשלים את העברת המינוי. מידע נוסף זמין במרכז העזרה לאדמינים.
customerId

string

המזהה הזה יכול להיות שם הדומיין הראשי של הלקוח או המזהה הייחודי של הלקוח. אם שם הדומיין של הלקוח משתנה, לא ניתן להשתמש בשם הדומיין הישן כדי לגשת ללקוח, אבל תמיד אפשר להשתמש במזהה הייחודי של הלקוח (כפי שמוחזר על ידי ה-API). מומלץ לשמור את המזהה הייחודי במערכות, היכן שהדבר רלוונטי.
customerNamePrefix

string

באחזור כל המינויים והסינון שלך עבור לקוחות ספציפיים, אפשר להזין קידומת לשם לקוח. דוגמה לקבוצת לקוחות שכוללת את exam.com, את example20.com ואת example.com:

  • exa -- מחזירה את כל שמות הלקוחות שמתחילים ב-'exa', שיכולים לכלול את exam.com, example20.com ו-example.com. קידומת של שם דומה לשימוש בכוכבית של הביטוי הרגולרי exa*.
  • example -- מחזירה את הערך example20.com ו-example.com.
maxResults

integer (uint32 format)

בעת אחזור רשימה גדולה, הערך maxResults הוא מספר התוצאות המקסימלי לדף. הערך nextPageToken מעביר אותך לדף הבא. ברירת המחדל היא 20.
pageToken

string

אסימון לציון הדף הבא ברשימה

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התגובה

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

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "kind": string,
  "subscriptions": [
    {
      object (Subscription)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

מזהה את המשאב כאוסף של מינויים. ערך: מפיץ#subscriptions
subscriptions[]

object (Subscription)

המינויים בדף התוצאות הזה.
nextPageToken

string

אסימון ההמשך, משמש למעבר בין קבוצות גדולות של תוצאות. צריך לספק את הערך הזה בבקשה עוקבת שתחזיר את דף התוצאות הבא.

היקפי הרשאות

כדי להשתמש בתכונה הזו יש צורך באחד מההיקפים הבאים של OAuth:

  • https://www.googleapis.com/auth/apps.order
  • https://www.googleapis.com/auth/apps.order.readonly

למידע נוסף, ניתן לעיין במדריך ההרשאות.