GET/partners/customers/{domainId}/option-product-usages

オプション商品の利用内訳リストを取得する。

Authorization

oauth2

Access Token を指定します。 指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

partner
partner.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/partners/customers/{domainId}/option-product-usages

Path Parameters

ParameterTypeDescription
domainId integer 

ドメイン ID


required
example : 10000001 

Query Parameters

ParameterTypeDescription
year integer 

取得年


required
example : 2021 
month integer 

取得月


required
minimum : 1
maximum : 12
example : 6 
productGroupId string 

商品グループ ID

  • WORKS : LINE WORKSサービス
  • ROGER : LINE WORKSラジャーサービス
  • NOTE_AI : LINE WORKS AiNoteサービス
  • JP_PAPER_ON : LINE WORKS PaperOnサービス
  • JP_AI_STUDIO : LINE WORKS AiStudioサービス

Allowed values : WORKS, NOTE_AI, ROGER, JP_PAPER_ON, JP_AI_STUDIO 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
optionProductUsages array (OptionProductUsages) 
 

OptionProductUsages

PropertyTypeDescription
productGroupId string 

商品グループ ID

  • WORKS : LINE WORKSサービス
  • ROGER : LINE WORKSラジャーサービス
  • NOTE_AI : LINE WORKS AiNoteサービス
  • JP_PAPER_ON : LINE WORKS PaperOnサービス
  • JP_AI_STUDIO : LINE WORKS AiStudioサービス

required
Allowed values : WORKS, NOTE_AI, ROGER, JP_PAPER_ON, JP_AI_STUDIO 
optionProductId string 

オプション商品 ID

  • LINE WORKSサービスのオプション商品
    • ACV : アーカイブ (旧商品)
    • SSTG : 共有ストレージ (旧商品)
    • ACV2 : アーカイブ (トーク)
    • ACV3 : アーカイブ (メール)
    • DRV : Drive
    • SSTG2 : 追加ストレージ
    • BCT : アドレス帳登録数拡張
    • CST_S : CXトーク 対応者5席の窓口
    • CST_M : CXトーク 対応者30席の窓口
    • CST_L : CXトーク 対応者100席の窓口
  • LINE WORKS AiNoteサービスのオプション商品
    • QTA_O1 : 追加文字起こし時間 100分(単月追加)
    • QTA_O2 : 追加文字起こし時間 6,000分(単月追加)
    • QTA_M1 : 追加文字起こし時間 100分(毎月追加)
    • QTA_M2 : 追加文字起こし時間 6,000分(毎月追加)
  • LINE WORKS PaperOnサービスのオプション商品
    • JP_PPO_O : 読み取り回数追加(単月追加)
    • JP_PPO_M : 読み取り回数追加(毎月追加)
  • LINE WORKS AiStudioサービスのオプション商品
    • JP_AIS_O : 追加トークン(単月追加)
    • JP_AIS_M : 追加トークン(毎月追加)

required
Allowed values : ACV, SSTG, ACV2, ACV3, DRV, SSTG2, BCT, CST_S, CST_M, CST_L, QTA_O1, QTA_O2, QTA_M1, QTA_M2, JP_PPO_O, JP_PPO_M, JP_AIS_O, JP_AIS_M 
subOptionId string 

サブオプション商品 ID

  • LINE WORKSサービスのオプション商品

    • オプション商品 ID が ACV2 の場合
      • ACV200 : アーカイブ (トーク) Trial
      • ACV201 : アーカイブ (トーク)
    • オプション商品 ID が ACV3 の場合
      • ACV300 : アーカイブ (メール) Trial
      • ACV301 : アーカイブ (メール)
    • オプション商品 ID が DRV の場合
      • DRV00: Drive Trial (for STD)
      • DRV01: Drive (for STD)
      • DRV_PS_T: Drive Plus Trial (for STD)
      • DRV_PS: Drive Plus (for STD)
      • DRV_PA_T: Drive Plus Trial (for ADV)
      • DRV_PA: Drive Plus (for ADV)
    • オプション商品 ID が SSTG2 の場合
      • SSTG201 : 追加ストレージ (1TB)
      • SSTG202 : 追加ストレージ (5TB)
      • SSTG203 : 追加ストレージ (10TB)
      • SSTG204 : 追加ストレージ (25TB)
      • SSTG205 : 追加ストレージ (50TB)
      • SSTG206 : 追加ストレージ (100TB)
      • SSTG207 : 追加ストレージ (500TB)
    • オプション商品 ID が BCT の場合
      • BCT01 : アドレス帳登録数拡張 (25 万件まで)
      • BCT02 : アドレス帳登録数拡張 (50 万件まで)
      • BCT03 : アドレス帳登録数拡張 (150 万件まで)
      • BCT04 : アドレス帳登録数拡張 (500 万件まで)
    • オプション商品 ID が CST_S の場合
      • CST_S00 : CXトーク 対応者5席の窓口 Trial
      • CST_S01 : CXトーク 対応者5席の窓口
    • オプション商品 ID が CST_M の場合
      • CST_M00 : CXトーク 対応者30席の窓口 Trial
      • CST_M01 : CXトーク 対応者30席の窓口
    • オプション商品 ID が CST_L の場合
      • CST_L00 : CXトーク 対応者100席の窓口 Trial
      • CST_L01 : CXトーク 対応者100席の窓口

  • LINE WORKS AiNoteサービスのオプション商品

    • オプション商品 ID が QTA_O1 の場合
      • QTA_O101 : 追加文字起こし時間 100分(単月追加)
    • オプション商品 ID が QTA_O2 の場合
      • QTA_O201 : 追加文字起こし時間 6,000分(単月追加)
    • オプション商品 ID が QTA_M1 の場合
      • QTA_M101 : 追加文字起こし時間 100分(毎月追加)
    • オプション商品 ID が QTA_M2 の場合
      • QTA_M201 : 追加文字起こし時間 6,000分(毎月追加)

  • LINE WORKS PaperOnサービスのオプション商品

    • オプション商品 ID が JP_PPO_O の場合
      • JP_PPO_O01 : 読み取り回数追加(単月追加)
    • オプション商品 ID が JP_PPO_M の場合
      • JP_PPO_M01 : 読み取り回数追加(毎月追加)

  • LINE WORKS AiStudioサービスのオプション商品

    • オプション商品 ID が JP_AIS_O の場合
      • JP_AIS_O01 : 追加トークン(単月追加)
    • オプション商品 ID が JP_AIS_M の場合
      • JP_AIS_M01 : 追加トークン(毎月追加)

required
Allowed values : ACV200, ACV201, ACV300, ACV301, DRV00, DRV01, DRV_PS_T, DRV_PS, DRV_PA_T, DRV_PA, SSTG201, SSTG202, SSTG203, SSTG204, SSTG205, SSTG206, SSTG207, BCT01, BCT02, BCT03, BCT04, CST_S00, CST_S01, CST_M00, CST_M01, CST_L00, CST_L01, QTA_O101, QTA_O201, QTA_M101, QTA_M201, JP_PPO_O01, JP_PPO_M01, JP_AIS_O01, JP_AIS_M01 
usedDate string 

日付


required
format : date
readOnly : true 
plan string 

プラン (契約タイプ)

  • FREE : フリー
  • FREE_LICENSE : フリー ライセンス
  • TRIAL : トライアル
  • TRIAL_LICENSE : トライアル ライセンス
  • MONTHLY : 月額契約 後払い
  • MONTHLY_LICENSE : 月額契約 後払い ライセンス
  • ANNUAL : 年額契約 月払い
  • ANNUAL_LICENSE : 年額契約 月払い ライセンス
  • ANNUAL_PREPAY : 年額契約 一括払い
  • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス

商品グループ別の適用可能なプラン

  • LINE WORKSサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKSラジャーサービス
    • FREE_LICENSE : フリー ライセンス
    • TRIAL_LICENSE : トライアル ライセンス
    • MONTHLY_LICENSE : 月額契約 後払い ライセンス
    • ANNUAL_LICENSE : 年額契約 月払い ライセンス
    • ANNUAL_PREPAY_LICENSE : 年額契約 一括払い ライセンス
  • LINE WORKS AiNoteサービス
    • FREE : フリー
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS PaperOnサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い
    • ANNUAL_PREPAY : 年額契約 一括払い
  • LINE WORKS AiStudioサービス
    • TRIAL : トライアル
    • MONTHLY : 月額契約 後払い
    • ANNUAL : 年額契約 月払い

required
Allowed values : FREE, TRIAL, MONTHLY, ANNUAL, ANNUAL_PREPAY, FREE_LICENSE, TRIAL_LICENSE, MONTHLY_LICENSE, ANNUAL_LICENSE, ANNUAL_PREPAY_LICENSE 
memberCount integer 

利用ユーザー数


readOnly : true 
licenseCount integer 

ライセンス数


readOnly : true
nullable : true 
quantity integer 

契約数

  • optionProductId が SSTG の場合、単位は TB
  • その他は null

readOnly : true
nullable : true 
usageCount integer 

利用数


nullable : true 

Response Example

LINE WORKSメールアーカイブオプション商品の年間ライセンス使用履歴照会

1{2  "optionProductUsages": [3    {4      "productGroupId": "WORKS",5      "optionProductId": "ACV3",6      "subOptionId": "ACV301",7      "usedDate": "2025-02-01",8      "plan": "ANNUAL_LICENSE",9      "memberCount": 1,10      "licenseCount": 1,11      "quantity": null,12      "usageCount": null13    },14    {15      "productGroupId": "WORKS",16      "optionProductId": "ACV3",17      "subOptionId": "ACV301",18      "usedDate": "2025-02-02",19      "plan": "ANNUAL_LICENSE",20      "memberCount": 1,21      "licenseCount": 1,22      "quantity": null,23      "usageCount": null24    },25    {26      "productGroupId": "WORKS",27      "optionProductId": "ACV3",28      "subOptionId": "ACV301",29      "usedDate": "2025-02-03",30      "plan": "ANNUAL_LICENSE",31      "memberCount": 1,32      "licenseCount": 1,33      "quantity": null,34      "usageCount": null35    },36    {37      "productGroupId": "WORKS",38      "optionProductId": "ACV3",39      "subOptionId": "ACV301",40      "usedDate": "2025-02-04",41      "plan": "ANNUAL_LICENSE",42      "memberCount": 1,43      "licenseCount": 1,44      "quantity": null,45      "usageCount": null46    },47    {48      "productGroupId": "WORKS",49      "optionProductId": "ACV3",50      "subOptionId": "ACV301",51      "usedDate": "2025-02-05",52      "plan": "ANNUAL_LICENSE",53      "memberCount": 1,54      "licenseCount": 1,55      "quantity": null,56      "usageCount": null57    },58    {59      "productGroupId": "WORKS",60      "optionProductId": "ACV3",61      "subOptionId": "ACV301",62      "usedDate": "2025-02-06",63      "plan": "ANNUAL_LICENSE",64      "memberCount": 1,65      "licenseCount": 1,66      "quantity": null,67      "usageCount": null68    },69    {70      "productGroupId": "WORKS",71      "optionProductId": "ACV3",72      "subOptionId": "ACV301",73      "usedDate": "2025-02-07",74      "plan": "ANNUAL_LICENSE",75      "memberCount": 1,76      "licenseCount": 1,77      "quantity": null,78      "usageCount": null79    }80  ]81}