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

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

אחזור מינוי

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

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

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

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

תגובה מוצלחת מחזירה את קוד הסטטוס 200 HTTP ואת הגדרות המינוי. בדוגמה הבאה, הנכס 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 ורשימה של המינויים וההגדרות של הלקוח. רשימת המינויים עשויה לכלול מוצרים שאינם מנוהלים בגרסה הזו של Seller 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"
}

תגובה מוצלחת מחזירה את קוד הסטטוס 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": 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: בסיום פרק זמן של תוכנית התחייבות שנתית, המינוי יושעה. כדי להבין איך לבטל השעיה, כדאי לעיין במרכז העזרה לאדמינים.

תגובה מוצלחת מחזירה את קוד הסטטוס 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"
}

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

כדי להעביר באופן מיידי מינוי לתקופת ניסיון בחינם למשך 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

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

תגובה מוצלחת מחזירה קוד סטטוס 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"
}

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

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

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

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

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

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

השיחה תסתיים ותיצור מינוי חדש.

מידע נוסף על שדרוגים ושדרוגים לאחור זמין בדף Products & SKUs.