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

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

object (Subscription)

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

string

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

היקפי ההרשאות

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

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

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