日付または用語でグループ化されたサブスクリプション分析を取得する

  • [アーティクル]

適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター

日付または用語でグループ化された顧客のサブスクリプション分析情報を取得する方法。

前提条件

  • パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、ユーザー資格情報のみを使用した認証がサポートされています。

REST 要求

要求の構文

認証方法 要求 URI
GET {baseURL}/partner/v1/analytics/subscriptions?groupby={groupby_queries}

URI パラメーター

次の必須パス パラメーターを使用して、organizationを識別し、結果をグループ化します。

名前 Type 必須 説明
groupby_queries 文字列と dateTime のペア はい 結果をフィルター処理する用語と日付。

GroupBy 構文

group by パラメーターは、一連のコンマ区切りのフィールド値として構成する必要があります。

エンコードされていない場合、 のようになります。

?groupby=termField1,dateField1,termField2

次の表は、group by でサポートされているフィールドの一覧を示しています。

フィールド Type 説明
customerTenantId string 顧客テナントを識別する GUID 形式の文字列。
customerName string 顧客の名前。
customerMarket string 顧客がビジネスを行う国/地域。
id string サブスクリプションを識別する GUID 形式の文字列。
status string サブスクリプションのステータス。 サポートされる値は、"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 サブスクリプション トランザクションが間接リセラーの場合、プロバイダー名はサブスクリプションを購入した間接プロバイダーです。
creationDate UTC 日時形式の文字列 サブスクリプションが作成された日付。
effectiveStartDate UTC 日時形式の文字列 サブスクリプションが開始される日付。
commitmentEndDate UTC 日時形式の文字列 サブスクリプションが終了する日付。
currentStateEndDate UTC 日時形式の文字列 サブスクリプションの現在の状態が変更される日付。
trialToPaidConversionDate UTC 日時形式の文字列 サブスクリプションが試用版から有料版に変換される日付。 既定値は、null です。
trialStartDate UTC 日時形式の文字列 サブスクリプションの試用期間が開始された日付。 既定値は、null です。
lastUsageDate UTC 日時形式の文字列 サブスクリプションが最後に使用された日付。 既定値は、null です。
deprovisionedDate UTC 日時形式の文字列 サブスクリプションがプロビジョニング解除された日付。 既定値は、null です。
lastRenewalDate UTC 日時形式の文字列 サブスクリプションが最後に更新された日付。 既定値は、null です。

フィルター フィールド

次の表に、オプションのフィルター フィールドとその説明を示します。

フィールド Type 説明
top int 要求で返すデータの行数です。 値が指定されていない場合、最大値と既定値は 10000 です。 クエリにこれを上回る行がある場合は、応答本文に次リンクが含まれ、そのリンクを使ってデータの次のページを要求できます。
skip int クエリでスキップする行数です。 大きなデータ セットを操作するには、このパラメーターを使用します。 たとえば、top=10000 と skip=0 は最初の 10000 行のデータを取得し、top=10000 と skip=10000 は次の 1,0000 行のデータを取得します。
filter string 応答内の行をフィルター処理する 1 つまたは複数のステートメントです。 各フィルター ステートメントには、応答本文のフィールド名と、特定のフィールドの 、ne、または 演算子に関連付eqけられている値がcontains含まれます。 ステートメントは、 または orを使用してand組み合わせることができます。 filter パラメーターでは、文字列値を単一引用符で囲む必要があります。 フィルター処理できるフィールドの一覧と、それらのフィールドでサポートされている演算子については、次のセクションを参照してください。
aggregationLevel string 集計データを取得する時間範囲を指定します。 次のいずれかの文字列を指定できます。day、week、または month。 値が指定されていない場合、既定値は dateRange です。 注: このパラメーターは、日付フィールドが groupBy パラメーターの一部として渡される場合にのみ適用されます。
Groupby string 指定したフィールドのみにデータ集計を適用するステートメントです。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

[要求本文]

なし。

要求の例

GET https://api.partnercenter.microsoft.com/partner/v1/analytics/subscriptions?groupBy=subscriptionType
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-CorrelationId: ec8f62e5-1d92-47e9-8d5d-1924af105123
Content-Type: application/json
Content-Length: 0

REST 応答

成功した場合、応答本文には、指定した用語と日付でグループ化された サブスクリプション リソースのコレクションが含まれます。

応答の成功とエラーのコード

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、エラー コードに関するページを参照してください。

応答の例

HTTP/1.1 200 OK
Content-Length: 177
Content-Type: application/json; charset=utf-8
MS-CorrelationId: ca7c39f7-1a80-43bc-90d8-ee7d1cad3123
MS-RequestId: ec8f62e5-1d92-47e9-8d5d-1924af105123
{
  "Value": [
    {
      "subscriptionType": "Azure",
      "subscriptionCount": "63",
      "licenseCount": "0"
    },
    {
      "subscriptionType": "Dynamics",
      "subscriptionCount": "62",
      "licenseCount": "405"
    },
    {
      "subscriptionType": "EMS",
      "subscriptionCount": "39",
      "licenseCount": "193"
    },
    {
      "subscriptionType": "M365",
      "subscriptionCount": "2",
      "licenseCount": "5"
    },
    {
      "subscriptionType": "Office",
      "subscriptionCount": "906",
      "licenseCount": "7485"
    },
    {
      "subscriptionType": "UNKNOWN",
      "subscriptionCount": "104",
      "licenseCount": "439"
    },
    {
      "subscriptionType": "Windows",
      "subscriptionCount": "2",
      "licenseCount": "2"
    }
  ],
  "@nextLink": null,
  "TotalCount": 7
}

関連項目

パートナー センターの分析 - リソース