אחזור ועדכון של מינוי

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

אחזור מינוי

כדי לאחזר מינוי שהוזמן או הועבר בהצלחה, צריך להשתמש בעקבות GETבקשת HTTP.

GET https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID

מחליפים את מה שכתוב בשדות הבאים:

לפעולה זו אין פרמטרים בגוף הבקשה.

תגובה מוצלחת תחזיר סטטוס HTTP 200 ואת הגדרות המינוי. בדוגמה הבאה לתגובה, נכס isInTrial הוא false אבל אין trialEndTime, כלומר הלקוח הזה מעולם לא היה תקופת ניסיון בחינם למשך 30 יום בתוכנית הזו.

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "billingMethod": "ONLINE",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "RENEW_CURRENT_USERS_MONTHLY_PAY"
  },
  "purchaseOrderId": "example.com_annual_1",
  "status": "ACTIVE",
  "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
  "skuName": "Google Workspace Business Standard"
}

אחזור כל המינויים של לקוח

כדי לאחזר את כל המינויים של לקוח מפיץ ספציפי שנרשמו הוזמן או הועבר בהצלחה, צריך להשתמש בבקשת ה-HTTP הבאה מסוג GET כוללים את אסימון ההרשאה:

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID value&pageToken=START_DATE&maxResults=MAX_NUMBER

מחליפים את מה שכתוב בשדות הבאים:

  • CUSTOMER_ID: הדומיין הראשי של הלקוח השם או המזהה הייחודי של הלקוח.
  • START_DATE: תאריך ההתחלה בפורמט YYYY-MM-DD.
  • MAX_NUMBER: המספר המקסימלי של תוצאות שהוחזרו בדף תגובה.

לפעולה זו אין פרמטרים בגוף הבקשה.

תגובה מוצלחת תחזיר את קוד הסטטוס 200 של HTTP ורשימה של למינויים ולהגדרות של הלקוח. רשימת המינויים עשויה לכלול מוצרים שאינם מנוהלים בגרסה הזו של ממשק ה-API למפיצים.

אם הלקוח הזה לא בניהולך, שגיאת 403 "Forbidden" היא הוחזרו.

אחזור כל המינויים של לקוח שניתן להעביר

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

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerId=CUSTOMER_ID&customerAuthToken=AUTH_TOKEN&pageToken=START_DATE&maxResults=MAX_NUMBER

מחליפים את מה שכתוב בשדות הבאים:

  • CUSTOMER_ID: הדומיין הראשי של הלקוח השם או המזהה הייחודי של הלקוח.
  • AUTH_TOKEN: אסימון העברה שסופק על ידי שהוא ספציפי למזהה המפיץ שלך. אחרי שהוא נוצר על ידי לקוח, תוקף ההצעה הוא 30 יום. למידע נוסף על האופן שבו הלקוחות יוצרים את האסימון, העברת חשבון Google Workspace למפיץ. אם הערך הזה לא חוקי או שהתוקף שלו פג, תגובת ה-API תחזיר שגיאה אחת (403 "Forbidden").
  • START_DATE: תאריך ההתחלה בפורמט YYYY-MM-DD.
  • MAX_NUMBER: המספר המקסימלי של תוצאות שהוחזרו בדף תגובה.

לפעולה זו אין פרמטרים בגוף הבקשה.

תגובה מוצלחת תחזיר את קוד הסטטוס 200 של HTTP ורשימה של מינויים של לקוח שניתן להעביר עם תאריך התפוגה של ההעברה ואת מספר העמדות המינימלי שנדרש להזמנת ההעברה. לקוח/ה עשויים להחזיק מינויים נוספים שלא ניתנים להעברה.

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "432",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1331647980142",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "maximumNumberOfSeats": 500,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183980142",
        "minimumTransferableSeats": "20"
      },
      "purchaseOrderId": "PO_890",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-6543",
      "subscriptionId": "140",
      "skuId": "1010020028",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "transferInfo": {
        "transferabilityExpirationTime": "1333183780159",
        "minimumTransferableSeats": "10"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

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

אחזור כל המינויים של המפיצים

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

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=PREFIX &pageToken=TOKEN&maxResults=MAX_NUMBER

מחליפים את מה שכתוב בשדות הבאים:

  • PREFIX: תחילת השם של הלקוח המינויים שחיפשת.
  • TOKEN: אסימון שמזהה דף ספציפי של תוצאות שהשרת אמור להחזיר.
  • MAX_NUMBER: המספר המקסימלי של תוצאות שהוחזרו בדף תגובה.

הפעולה הזו יכולה להשתמש בהיקף הגישה לקריאה בלבד ב-OAuth. customerNamePrefix, pageToken ו-maxResults הן מחרוזות שאילתה אופציונליות.

הדוגמה הבאה מאחזרת את כל המינויים של מפיץ ששייכים אל לקוחות ששמם מתחיל ב-'exam':

GET https://reseller.googleapis.com/apps/reseller/v1/subscriptions?customerNamePrefix=exam

{
  "kind": "reseller#subscriptions",
  "subscriptions": [
    {
      "kind": "subscriptions#subscription",
      "customerId": "C0123456",
      "subscriptionId": "123",
      "skuId": "1010020028",
      "creationTime": "1331647980142",
      "billingMethod": "ONLINE",
      "plan": {
        "planName": "ANNUAL",
        "isCommitmentPlan": true,
        "commitmentInterval": {
          "startTime": "1331647980142",
          "endTime": "1363183980142"
        }
      },
      "seats": {
        "kind": "subscriptions#seats",
        "numberOfSeats": 10,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
      },
      "purchaseOrderId": "PO_135",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
    {
      "kind": "subscriptions#subscription",
      "customerId": "custId-5678",
      "subscriptionId": "1404686",
      "skuId": "1010020028",
      "billingMethod": "ONLINE",
      "creationTime": "1329389322728",
      "plan": {
        "planName": "FLEXIBLE",
        "isCommitmentPlan": false
      },
      "seats": {
        "kind": "subscriptions#seats",
        "maximumNumberOfSeats": 50,
        "licensedNumberOfSeats": 10
      },
      "trialSettings": {
        "isInTrial": false,
        "trialEndTime": "1331877480016"
      },
      "renewalSettings": {
        "kind": "subscriptions#renewalSettings",
        "renewalType": "AUTO_RENEW"
      },
      "purchaseOrderId": "",
      "status": "ACTIVE",
      "resourceUiUrl": "URL to customer's Subscriptions page in the Admin console",
      "skuName": "Google Workspace Business Standard"
    },
  ],
  "nextPageToken": "token"
}

עדכון של תוכנית מנויים

העדכון של תוכניות Google Workspace משתנה בהתאם לתוכנית. לפני העדכון תוכנית, קחו בחשבון את הגורמים הבאים:

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

  • אתם יכולים לעדכן תוכנית גמישה לתוכנית עם התחייבות שנתית.

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

  • לא כל התוכניות פועלות עם כל המוצרים. לקבלת מידע נוסף על שבהם משתמשים בתוכניות האלה: מוצרים מק"טים.

כדי לעדכן תוכנית לתקופת ניסיון למשך 30 יום או ממינוי שנתי לתוכנית גמישה תוכנית התחייבות, צריך להשתמש בבקשת ה-HTTP POST הבאה:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changePlan

מחליפים את מה שכתוב בשדות הבאים:

בדוגמה הבאה מתבצע עדכון של המינוי עם subscriptionId עם כערך של 123. הערך של customerId הוא C0123456.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changePlan

גוף הבקשה כולל את הפרטים הבאים:

{
  "kind": "reseller#changePlanRequest",
  "planName": "ANNUAL_MONTHLY_PAY",
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10
  },
  "purchaseOrderId": "123_March2012"
}

תגובה מוצלחת תחזיר קוד סטטוס HTTP 201 ומחזירה את קוד הסטטוס המעודכן הגדרות של תוכנית המנויים:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 10,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "purchaseOrderId": "123_March2012",
  "status": "ACTIVE",
  "skuName": "Google Workspace Business Standard"
}

עדכון מושבים במינוי

לעדכון המינוי לתוכנית בהתחייבות שנתית נעשה שימוש במינוי אחר יותר מעדכון המינוי של תוכנית גמישה של Google Workspace.

עדכון המושבים במינוי שנתי

כדי לעדכן את הגדרות רישיון המשתמש של מינוי לתוכנית שנתית, יש להשתמש באפשרויות הבאות בקשת HTTP של POST:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeSeats

מחליפים את מה שכתוב בשדות הבאים:

בדוגמה הבאה מתבצע עדכון של המינוי עם מספר subscriptionId 123. המספר customerId הוא C0123456. גוף הבקשה משתנה בהתאם סוג התוכנית:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/changeSeats

במינוי בתוכנית מחויבות שנתית ל-Google Workspace נעשה שימוש בגוף הבקשה הזה כדי לעדכן את מספר רישיונות המשתמשים. הערך numberOfSeats הוא סה"כ. לדוגמה, אם היו לך בעבר 10 רישיונות משתמש ויש לך הזמנת לקוח עבור 5 רישיונות חדשים, הסכום הכולל בגוף הבקשה עבור numberOfSeats הוא 15, כמו בדוגמה הבאה:

{
    "kind": "subscriptions#seats",
    "numberOfSeats": 15
}

עדכון המושבים במינוי לתוכנית גמישה

מינוי של תוכנית גמישה של Google Workspace משתמש בגוף הבקשה לעדכון את רישיונות המשתמש. הערך maximumNumberOfSeats הוא הסכום הכולל של הרישיונות הקיימים והרישיונות החדשים. זה המספר המקסימלי של משתמשים רישיונות שהחשבון יכול להקצות.

{
  "kind": "subscriptions#seats",
  "maximumNumberOfSeats": 15
}

תגובה מוצלחת תחזיר קוד סטטוס HTTP 201, הגדרות של רישיון מינוי:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "FLEXIBLE",
    "isCommitmentPlan": false
  },
  "seats": {
    "kind": "subscriptions#seats",
    "maximumNumberOfSeats": 15,
    "licensedNumberOfSeats": 10
  },
  "trialSettings": {
    "isInTrial": false
  },
  "skuName": "Google Workspace Business Standard"
}

עדכון הגדרות החידוש של מינוי

כדי לעדכן את הגדרות החידוש של מינוי בהתחייבות שנתית, צריך להשתמש ב בעקבות בקשת HTTP אחת (POST):

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/changeRenewalSettings

מחליפים את מה שכתוב בשדות הבאים:

לפניכם דוגמה לגוף הבקשה:

{
  "kind": "subscriptions#renewalSettings",
  "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
}

הערך של המאפיין renewalType יכול להיות כל אחת מהאפשרויות הבאות:

  • AUTO_RENEW_YEARLY_PAY: בסיום התקופה של תוכנית ההתחייבות השנתית, יחדש אוטומטית את תוכנית המינוי כ-ANNUAL_YEARLY_PAY עם אותו numberOfSeats.
  • AUTO_RENEW_MONTHLY_PAY: בסיום תוכנית התחייבות שנתית לחדש את תוכנית המינויים באופן אוטומטי בתור ANNUAL_MONTHLY_PAY עם אותו numberOfSeats.
  • RENEW_CURRENT_USERS_YEARLY_PAY: בסיום תוכנית התחייבות שנתית עליך לחדש את תוכנית המינוי כ-ANNUAL_YEARLY_PAY, אבל להשתמש המספר הכולל של רישיונות המשתמשים הפעילים הנוכחיים. זוהי ברירת המחדל לגבי תוכניות פעילות בהתחייבות שנתית (תשלום שנתי).
  • RENEW_CURRENT_USERS_MONTHLY_PAY: בסיום תוכנית התחייבות שנתית עליך לחדש את תוכנית המינוי כ-ANNUAL_MONTHLY_PAY, אבל להשתמש המספר הכולל של רישיונות המשתמשים הפעילים הנוכחיים. זוהי ברירת המחדל לגבי תוכניות פעילות בהתחייבות שנתית (בתשלום חודשי).
  • RENEW_ON_PROPOSED_OFFER: בסוף תוכנית ההתחייבות הנוכחית רווח, חידוש בהצעת החידוש האחרונה עם numberOfSeats כמספר של רישיונות משתמשים פעילים קיימים או של התחייבות להצעה, לפי הצורך גבוהה יותר.
  • SWITCH_TO_PAY_AS_YOU_GO: בסיום תוכנית התחייבות שנתית לשנות את תוכנית ההתחייבות השנתית לתוכנית גמישה.
  • CANCEL: בסיום פרק הזמן של תוכנית ההתחייבות השנתית, המינוי מושעה. כדי להבין איך לבטל השעיה, אפשר לעיין בקטע מרכז העזרה לאדמינים.

תגובה מוצלחת תחזיר קוד סטטוס HTTP 201, הגדרות חידוש המינוי:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

התחלת שירות בתשלום ממינוי לתקופת ניסיון בחינם

כדי להעביר באופן מיידי מינוי לתקופת ניסיון בחינם למשך 30 יום לשירות בתשלום. מינוי, אם כבר הוגדרה תוכנית תמחור ותשלומים לתקופת הניסיון מינוי, צריך להשתמש בבקשת ה-HTTP הבאה POST. 

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions/SUBSCRIPTION_ID/startPaidService

מחליפים את מה שכתוב בשדות הבאים:

בדוגמה הבאה המספר C0123456 הוא customerId וגם הערך subscriptionId של 123:

POST https://reseller.googleapis.com/apps/reseller/v1/customers/C0123456/subscriptions/123/startPaidService

לפעולה זו אין פרמטרים בגוף הבקשה.

תשובה מוצלחת תחזיר את קוד הסטטוס 201 של HTTP ואת הגדרות המינוי המעודכנות:

{
  "kind": "reseller#subscription",
  "customerId": "C0123456",
  "subscriptionId": "123",
  "skuId": "1010020028",
  "creationTime": "1331647980142",
  "plan": {
    "planName": "ANNUAL",
    "isCommitmentPlan": true,
    "commitmentInterval": {
      "startTime": "1331647980142",
      "endTime": "1363183980142"
    }
  },
  "seats": {
    "kind": "subscriptions#seats",
    "numberOfSeats": 15,
    "licensedNumberOfSeats": 15
  },
  "trialSettings": {
    "isInTrial": false
  },
  "renewalSettings": {
    "kind": "subscriptions#renewalSettings",
    "renewalType": "SWITCH_TO_PAY_AS_YOU_GO"
  },
  "skuName": "Google Workspace Business Standard"
}

שדרוג או שדרוג לאחור של מינוי

אי אפשר לשדרג לאחור תוכניות שנתיות באמצע התקופה, ולא ניתן לשדרג לאחור תוכניות שנתיות. לתזמן שדרוג לאחור באמצעות הגדרות החידוש. מומלץ להגדיר הגדרות החידוש כדי לעבור אל FLEXIBLE ולאחר מכן לשדרג לאחור אחרי מועד החידוש.

כדי לשדרג או לשדרג לאחור מינוי, צריך ליצור מינוי חדש ב-skuId שאליו רוצים לשדרג או לשדרג לאחור.

POST https://reseller.googleapis.com/apps/reseller/v1/customers/CUSTOMER_ID/subscriptions

מחליפים את מה שכתוב בשדות הבאים:

  • CUSTOMER_ID: הדומיין הראשי של הלקוח השם או המזהה הייחודי של הלקוח.

השיחה הזו גורמת לסיום המינוי הקודם וליצירה של מינוי חדש.

מידע נוסף על שדרוגים ושדרוגים לאחור בדף 'מוצרים' דף המק"טים.