限制和配額可避免自動化程序以不當方式使用 Reseller API,進而保護 Google 基礎架構。API 發出的要求過多可能是因為無害的筆誤,也可能是因為系統設計效率不彰,導致不必要的 API 呼叫。無論原因為何,當特定來源的流量達到一定程度時,都必須封鎖該來源的流量,才能確保 Google Workspace 系統的整體健康狀態。確保一位開發人員的行為不會對廣大社群造成負面影響。
API 要求失敗
萬一 API 要求失敗,應用程式會收到 HTTP 狀態碼回應。狀態碼 403
含有輸入內容有誤的錯誤資訊,而 HTTP 狀態碼 503
則含有錯誤資訊,指出超出哪些 API 配額。自訂應用程式可透過這些回應偵測錯誤,並採取適當行動。
時間相關錯誤
對於所有以時間為準的錯誤 (每個執行緒每 N 秒最多 N 個項目),尤其是 503
狀態碼錯誤,建議您的程式碼擷取例外狀況,並使用指數輪詢演算法,等待一小段時間後再重試失敗的呼叫。以一個執行緒為例,Reseller API 會等待 5 秒,然後重試失敗的呼叫。如果要求成功,請對其他執行緒重複這個模式。如果第二次要求未成功,應用程式應減少要求頻率,直到呼叫成功為止。舉例來說,您可以將初始 5 秒延遲時間增加至 10 秒,然後再次重試失敗的呼叫。此外,請決定重試次數上限。
舉例來說,應用程式向使用者傳回錯誤前,可以嘗試重新發出要求 5 到 7 次,每次間隔不同的延遲時間。
限制
API 限制類別 | 限制 |
---|---|
訂閱方案 purchaseOrderId |
這個屬性最多可接受 80 個純文字字元。 |
訂閱方案 maxResults |
maxResults 查詢字串可包含 1 到 100 個結果。
預設值為 20 個結果。
|
轉移權杖 (customerAuthToken ) |
客戶的轉移權杖會在產生後 30 天內有效。 |
每個客戶的使用者人數上限 | 視合約而定,使用者人數上限為 50,000 人,或經銷商合約中定義的上限。 |
未授權要求 | Google 不允許未經授權的要求存取 Reseller API。 如果未提供授權權杖,系統會將要求視為未經授權。詳情請參閱「瞭解驗證和授權」。 |
其他限制類型
其他限制類型 | 限制和規範 |
---|---|
資料格式 |
資料格式為 JavaScript Object Notation (JSON)JSON。
JSON 是常見的網際網路格式,可代表任意資料結構。JSON 是一種與語言完全無關的文字格式,但使用的慣例是 C 系列語言 (包括 C、C++、C#、Java、JavaScript、Perl 和 Python) 的程式設計師所熟悉。 |
時間格式 | 所有日期時間均以 Epoch 轉換器的毫秒為單位。這個格式適用於訂閱建立時間、方案的約期開始和結束時間,以及 30 天免費試用期結束時間。 |