適用於:合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府適用的 Microsoft Cloud 合作夥伴中心
分析 API 可讓您以程式設計方式存取使用者體驗中呈現的數據。
必要條件
- 認證,如合作夥伴中心驗證所述。 這些案例僅支援使用使用者認證進行驗證。
CSP 計劃:Azure 使用量分析
下列案例示範如何使用分析 API 來擷取所有合作夥伴中心 Azure 使用量分析資訊。
此案例會在 Azure 使用量資源的集合中傳回您的分析資訊。
Azure 使用量資源
代表 Azure 使用量的所有分析數據。
| 屬性 | 類型 | 描述 |
|---|---|---|
| CustomerTenantId | string | 客戶租用戶標識碼。 |
| customerName | string | 客戶名稱。 |
| subscriptionId | string | 訂用帳戶標識碼。 |
| subscriptionName | string | 訂用帳戶名稱。 |
| usageDate | string | 使用日期。 |
| resourceLocation | string | 例如,數據中心的位置,西歐。 |
| meterCategory | string | 例如,計量類別、數據管理。 |
| meterSubcategory | string | 計量子類別,例如異地備援。 |
| meterUnit | string | 計量單位,例如 GB 或小時。 |
| reservationOrderId | string | Azure VM 保留實例的保留順序。 |
| reservationId | string | 特定 RI 訂單下的保留實例。 |
| serviceType | string | 指出虛擬機類型。 例如,Standard_E4s_v3。 |
| 數量 | long | 指出計量單位中使用的數位。 |
CSP 計劃:間接轉銷商分析
下列案例示範如何使用分析 API 來擷取所有合作夥伴中心間接轉銷商分析資訊。
此案例會在間接轉銷商資源的集合中傳回您的分析資訊。
間接轉銷商資源
代表間接轉銷商的所有分析數據。
| 屬性 | 類型 | 描述 |
|---|---|---|
| partnerTenantId | string | 您想要擷取間接轉銷商數據的合作夥伴租用戶標識碼。 |
| id | string | 間接轉銷商標識碼。 |
| NAME | 字串 | 您想要擷取間接轉銷商數據的合作夥伴名稱。 |
| 市場 | string | 您想要擷取間接轉銷商數據的合作夥伴市場。 |
| firstSubscriptionCreationDate | UTC 日期時間格式的字串 | 第一個訂用帳戶的建立日期,根據您想要擷取間接轉銷商數據的建立日期。 |
| latestSubscriptionCreationDate | UTC 日期時間格式的字串 | 最新訂閱的建立日期。 |
| firstSubscriptionEndDate | UTC 日期時間格式的字串 | 第一次結束任何訂用帳戶。 |
| latestSubscriptionEndDate | UTC 日期時間格式的字串 | 任何訂用帳戶結束的最近日期。 |
| firstSubscriptionSuspendedDate | UTC 日期時間格式的字串 | 第一次暫停任何訂用帳戶。 |
| latestSubscriptionSuspendedDate | UTC 日期時間格式的字串 | 暫停任何訂閱的最新日期。 |
| firstSubscriptionDeprovisionedDate | UTC 日期時間格式的字串 | 第一次取消布建任何訂用帳戶。 |
| latestSubscriptionDeprovisionedDate | UTC 日期時間格式的字串 | 取消布建任何訂用帳戶的最新日期。 |
| subscriptionCount | double | 所有加值轉銷商的訂用帳戶計數 |
| licenseCount | double | 所有加值轉銷商的授權計數 |
| indirectResellerCount | double | 間接轉銷商計數 |
CSP 計劃:訂用帳戶分析
下列案例示範如何使用分析 API 來擷取所有合作夥伴中心訂用帳戶分析資訊、使用搜尋查詢加以篩選,或依日期或字詞分組。
所有這些案例都會在訂用帳戶資源的集合中傳回您的分析資訊。
訂閱資源
代表訂用帳戶的所有分析數據。
| 屬性 | 類型 | 描述 |
|---|---|---|
| customerTenantId | string | 識別客戶租使用者的 GUID 格式字串。 |
| customerName | string | 客戶的名稱。 |
| customerMarket | string | 客戶執行業務的國家/地區。 |
| id | string | 訂用帳戶標識碼。 |
| status | 字串 | 訂用帳戶狀態:「ACTIVE」、“SUSPENDED” 或 「DEPROVISIONED」。。 |
| productName | string | 產品的名稱。 |
| subscriptionType | string | 訂用帳戶類型。 注意:此欄位會區分大小寫。 支援的值為:“Office”、“Azure”、“Microsoft365”、“Dynamics”、“EMS”。 |
| autoRenewEnabled | boolean | 值,指出訂閱是否自動更新。 |
| partnerId | string | PartnerID。 對於直接轉銷商,此參數會是合作夥伴的 PartnerID。 對於間接轉銷商,此參數會是間接轉銷商的 PartnerID。 |
| friendlyName | string | 訂用帳戶的名稱。 |
| partnerName | string | 購買訂用帳戶的合作夥伴名稱 |
| providerName | string | 當訂閱交易是間接轉銷商時,提供者名稱是購買訂閱的間接提供者。 |
| effectiveStartDate | UTC 日期時間格式的字串 | 訂閱開始的日期。 |
| commitmentEndDate | UTC 日期時間格式的字串 | 訂閱結束的日期。 |
| currentStateEndDate | UTC 日期時間格式的字串 | 訂閱目前狀態將會變更的日期。 |
| trialToPaidConversionDate | UTC 日期時間格式的字串 | 訂閱從試用版轉換為付費的日期。 預設值為 null。 |
| trialStartDate | UTC 日期時間格式的字串 | 訂閱試用期開始的日期。 預設值為 null。 |
| trialEndDate | UTC 日期時間格式的字串 | 訂閱試用期結束的日期。 預設值為 null。 |
| lastUsageDate | UTC 日期時間格式的字串 | 上次使用訂閱的日期。 預設值為 null。 |
| deprovisionedDate | UTC 日期時間格式的字串 | 取消布建訂閱的日期。 預設值為 null。 |
| lastRenewalDate | UTC 日期時間格式的字串 | 上次更新訂閱的日期。 預設值為 null。 |
| licenseCount | number | 授權總數。 |
| subscriptionCount | number | 訂用帳戶數目。 注意:此值只會出現在匯總查詢的回應中。 |
搜尋分析
注意
取得搜尋分析不需要 CSP 計劃成員資格。
下列案例示範如何使用分析 API 來擷取所有合作夥伴中心搜尋分析資訊。
此案例會在搜尋資源的集合中傳回您的分析資訊。
搜尋資源
代表搜尋的所有分析數據。
| 屬性 | 類型 | 描述 |
|---|---|---|
| companyName | string | 計費公司名稱。 |
| contactButtonClicked | 布林值 | 指出是否已按兩下聯繫人按鈕。 |
| keywordCountry | string | 搜尋中指定的國家/地區。 |
| detailsViewed | 布林值 | 指出是否已檢視搜尋詳細數據。 |
| keywordIndustryFocus | string | 要在其中搜尋的產業,例如醫療保健。 |
| partnerId | string | PartnerID。 對於直接轉銷商,此參數會是合作夥伴的 PartnerID。 對於間接轉銷商,此參數會是間接轉銷商的 PartnerID。 |
| partnerMarket | string | 合作夥伴進行業務的地區設定。 |
| keywordProduct | string | 搜尋中指定的產品。 |
| referralSubmitted | 布林值 | 指出是否已提交轉介。 |
| searchDate | UTC 日期時間格式的字串 | 搜尋查詢發生的日期。 |
| keywordSearchText | string | 搜尋中指定的文字。 |
| searchResultPageViews | long | 合作夥伴在搜尋結果中出現次數。 僅匯總回應的一部分。 |
| contactClicks | long | 按下聯繫人按鈕的次數。 僅匯總回應的一部分。 |
| referralCount | long | 搜尋所產生的轉介數目。 僅匯總回應的一部分。 |
| profileViews | long | 檢視合作夥伴配置檔的次數。 僅匯總回應的一部分。 |
推薦分析
注意
不需要 CSP 方案成員資格,即可取得推薦分析。
下列案例示範如何使用分析 API 來擷取所有合作夥伴中心推薦分析資訊。
此案例會傳迴轉介資源集合中的分析資訊。
注意
21Vianet 營運的合作夥伴中心無法使用推薦分析。
轉介資源
代表轉介的所有分析數據。
| 屬性 | 類型 | 描述 |
|---|---|---|
| id | string | 客戶租用戶標識碼。 |
| status | 字串 | 指出推薦是否導致客戶。 |
| customerMarket | string | 客戶執行業務的國家/地區。 |
| customerName | string | 客戶的名稱。 |
| customerOrgSize | string | 範圍,指出客戶組織中的員工數目。 例如,“10to50employees”。 |
| acceptedDate | UTC 日期時間格式的字串 | 已接受轉介的日期。 |
| acknowledgedDate | UTC 日期時間格式的字串 | 認可轉介的日期。 |
| archivedDate | UTC 日期時間格式的字串 | 轉介封存的日期。 |
| declinedDate | UTC 日期時間格式的字串 | 轉介遭到拒絕的日期。 |
| expiredDate | UTC 日期時間格式的字串 | 轉介過期的日期。 |
| lostDate | UTC 日期時間格式的字串 | 轉介遺失的日期。 |
| missedDate | UTC 日期時間格式的字串 | 轉介錯過的日期。 |
| createdDate | UTC 日期時間格式的字串 | 建立轉介的日期。 |
| skippedDate | UTC 日期時間格式的字串 | 略過轉介的日期。 |
| wonDate | UTC 日期時間格式的字串 | 轉介獲勝的日期。 |
| partnerMarket | string | 合作夥伴執行業務的國家/地區。 |