MENU

Soracom

Users

課金詳細情報 CSV リファレンス

ファイルのエンコード

CSV ファイルは、UTF-8(BOM あり)のエンコードとなります。

構造

CSV ファイルは、次のような構造となっています。

CSVファイルの構造

各項目の意味は以下の通りです。

ヘッダー行 (1 行目)

ヘッダー行には、項目名が並びます。 項目名は、大きく分けて「金額項目」と「タグ/グループ項目」に分かれ、金額項目のあとにタグ/グループ項目が出力されます。 「金額項目」「タグ/グループ項目」はいずれも可変のため、プログラムで取り込む場合は「CSV パース時の注意」を参考にしてください。

「金額項目」に表示される項目名は以下のとおりです。

  • imsi
    • SIM の IMSI。SIM 以外の課金項目(VPG や無料枠等)の場合、項目行が空となります。
  • vpgId
    • SORACOM Canal/Direct で使用する Virtual Private Gateway(VPG)の ID。
    • VPG 以外の課金項目(SIM や無料枠等)の場合は項目行が空となります。
    • SORACOM Canal/Direct を使用していない場合は、この項目は CSV に出力されません。
  • date
    • 課金項目については、対象日が yyyyMMdd 形式で設定されます。
    • 無料利用枠については、対象月が yyyyMM 形式で設定されます。
  • billItemName
  • unitPrice
    • 料金の単価
    • 例えばデータ通信料の場合、1byte あたりの費用が出力されます。
  • quantity
    • 課金/割引対象の数量
    • 例えばデータ通信量の場合、通信した byte 数が出力されます。
  • amount
    • 項目の金額。unitPricequantity をかけた値が出力されます。

サンプル

「タグ/グループ項目」には、各 SIM に設定したタグ名と、グループ名が項目名として出力されます。 例えば次のようにタグ名/グループ名を付与すると、項目名とレコード行は次のようになります。

  • SIM
    • 名前 : MySIM
    • タグ名: tag1
    • タグ値: foo
  • グループ
    • グループ ID : d674d68e-da8a-44f6-8868-51d1f069bc06
    • グループ名 : グループ 1
name,tag1,group:groupId,group:name
MySIM,foo,d674d68e-da8a-44f6-8868-51d1f069bc06,グループ 1

ある SIM にタグが付与されていたり、グループに所属したりしている場合は、その SIM のレコード行にタグ値/グループ ID および名前が 出力されるため、この値を使用することで、任意のタグ値やグループ名で集計をできます。

レコード行 (2 行目以降)

2 行目以降は、レコード行となります。 レコード行は「課金レコード」と「割引レコード」に分かれており、課金レコードの次に割引レコードが出力されます。

課金レコードは、IMSI/VPGID ごと、日ごと、課金項目ごとにレコードが作成され、quantity(数量)や金額(amount)は日(UTC)ごとに合算されます。 また IMSI や VPG にタグがついている場合は、タグ/グループ項目部分にその値が出力されます。

割引レコードは、無料利用枠やクーポン利用で利用金額から割引される項目が出力されます。日付(date)項目に対象の月が入ります。また金額(amount)の値として、割引額がマイナスで入ります。

なお、この CSV には消費税および合計金額に該当する項目はないため、請求金額と合わせる場合は、すべての金額(amount)を合算後、消費税率をかけ 小数点以下を切り上げしてください。

billItemName 項目一覧

課金レコード

課金レコード内容
basicCharge-ready基本料金 (SIM 利用料金:ready 時)
basicCharge-active基本料金 (SIM 利用料金:Active 時)
basicCharge-inactive基本料金 (SIM 利用料金:Inactive 時)
basicCharge-suspended基本料金 (SIM 利用料金:Suspended 時)
basicMonthlyChargeForPlanKM1基本料金 (plan-KM1 基本料)
subscriberSuspensionChargeSuspended への変更料金
subscriberActivationChargeStandby からのアクティブ化料金
subscriberContractRenewalChargeSIM の契約更新料金
dataTrafficChargeForPlanKM1データ通信料 (plan-KM1)
subscriberActivationChargeForPlanKM1plan-KM1 ready/suspended からの Activate 料金
contractRenewalChargeForPlanKM1plan-KM1 「準備完了」、「利用開始待ち」の状態で 1 年を経過した場合の契約更新料
uploadDataCharge-xxxx-xxxx日本向け上り (デバイスから SORACOM)へのデータ通信量。速度クラス(s1.fast 等)と時間帯(daytime,nighttime)がハイフン区切りで付与されます。
例)uploadDataCharge-s1.fast-daytime
downloadDataCharge-xxxx-xxxx日本向け下り (SORACOM からデバイス)へのデータ通信量。速度クラス(s1.fast 等)と時間帯(daytime,nighttime)がハイフン区切りで付与されます。
例)downloadDataCharge-s1.fast-nighttime
dataTrafficCharge-xxx-xxxxグローバル向け通信量の利用料金。/地域とサブスクリプションがハイフン区切りで付与されます。
dataTrafficRoundedUpCharge-xxx-xxxxグローバル向け通信量の切り上げ利用料金。国/地域とサブスクリプションがハイフン区切りで付与されます。
subscriptionDeliveryCharge-xxxxサブスクリプション追加費用 (planX1/planX2/planP1)
subscriptionUsageCharge-xxxxサブスクリプション利用料金 (planX1/planP1)
subscriptionContractRenewalCharge-xxxxサブスクリプション年間契約更新料金 (planX1/planP1)
bundleChargeForPlanDU-xxxxplan-DU 月額料金
additionalDataCapacityChargeForPlanDUplan-DU 追加料金 (上り 10GiB/下り 1GiB 単位)
readyStatusChargeForPlanDUplan-DU 準備完了状態時の料金
readyStatusChargeForPlanDWithBundleplan-D バンドルプラン 準備完了状態時の料金(plan-D D-300MB)
suspendedStatusChargeForPlanDWithBundleplan-D バンドルプラン 利用中断中状態時の料金(plan-D D-300MB)
bundleChargeForPlanDWithBundle-xxxxplan-D バンドルプラン 月額料金 (plan-D D-300MB)
additionalDataCapacityChargeForPlanDWithBundleplan-D バンドルプラン 追加料金 (500MiB 単位)(plan-D D-300MB)
soracomArcVirtualSimInitialChargeSORACOM Arc 初回費用
soracomArcVirtualSimWithSimMonthlyChargeSORACOM Arc 月額利用料金 (SORACOM IoT SIM に追加した場合)
soracomArcVirtualSimWithoutSimMonthlyChargeSORACOM Arc 月額利用料金 (単独で作成した場合)
soracomArcVirtualSimDateTrafficChargeデータ通信料 (SORACOM Arc)
chapAuthenticationChargeCHAP 認証の SIM ごとの料金
customDNSChargeCustomDNS の SIM ごとの料金
ussdRequestChargeUSSD リクエスト利用料金
planKM1LocationOptionChargeplan-KM1 位置情報 利用料金
planKM1LocationOptionRequestChargeplan-KM1 位置情報 利用料金 リクエスト利用料金
virtualPrivateGatewaySetupChargeVirtual Private Gateway のセットアップ料金(2016 年 4 月までの分)
virtualPrivateGatewayCanalSetupChargeSORACOM Canal 用の Virtual Private Gateway セットアップ料金
virtualPrivateGatewayDirectSetupChargeSORACOM Direct 用の Virtual Private Gateway セットアップ料金
virtualPrivateGatewayDoorSetupChargeSORACOM Door 用の Virtual Private Gateway セットアップ料金
virtualPrivateGatewayChargeVirtual Private Gateway の SIM ごとの利用料金
soracomCanalVirtualPrivateGatewayChargeSORACOM Canal 用 Virtual Private Gateway の利用料金
soracomCanalVPCPeeringChargeSORACOM Canal の VPCPeering ごとの料金
soracomDirectVirtualPrivateGatewayChargeSORACOM Direct 用 Virtual Private Gateway の料金
soracomDirectVirtualInterfaceChargeSORACOM Direct の Virtual Interfase ごとの料金
soracomDoorVirtualPrivateGatewayChargeSORACOM Door 用 Virtual Private Gateway の料金
soracomDoorVPNConnectionChargeSORACOM Door の VPN 接続ごとの料金
virtualPrivateGatewayFixedGlobalIpAddressOptionChargeVPG 固定 IP アドレスオプション 時間課金
virtualPrivateGatewayTypeESetupChargeVPG Type-E のセットアップ料金
virtualPrivateGatewayTypeEChargeVPG Type-E の VPG の利用料金
virtualPrivateGatewayTypeFSetupChargeVPG Type-F のセットアップ料金
virtualPrivateGatewayTypeFChargeVPG Type-F の VPG の利用料金
soracomBeamRequestCharge-xxxSoracom Beam リクエスト利用料金。プロトコル名がハイフン区切りで付与されます。
soracomEndorseChargeSoracom Endorse 利用料金
soracomFunnelRequestCharge-xxxSoracom Funnel リクエスト利用料金。プロトコル名がハイフン区切りで付与されます。
soracomFunkRequestCharge-xxxSoracom Funk リクエスト利用料金。呼び出し先の Functions 名がハイフン区切りで付与されます。
soracomHarvestChargeSoracom Harvest 利用料金
soracomHarvestFilesStoreChargeSoracom Harvest Files データ保存料金
soracomHarvestRequestChargeSoracom Harvest 利用料金 (2000 リクエスト超過分)
soracomHarvestTermExtensionChargeSoracom Harvest 期間延長オプション料金
soracomHarvestDataExportChargeSoracom Harvest データエクスポート料金
soracomHarvestFilesExportChargeSoracom Harvest Files データエクスポート費用
soracomInventoryDeviceRegistrationChargeSoracom Inventory デバイス登録料金
soracomInventoryMonthlyChargeSoracom Inventory 月額利用料金
soracomJunctionChargeSoracom Junction の料金
soracomJunctionInspectionChargeSoracom Junction インスペクションの料金
soracomKryptonInitialProvisioningChargeSoracom Krypton 初回プロビジョニング利用料金
soracomKryptonMonthlyProvisioningChargeSoracom Krypton 月額セットアップ利用料金
soracomLagoonMonthlyCharge-xxxSoracom Lagoon 月額費用。プラン名がハイフン区切りで入ります
soracomLagoonLicensePackCharge-xxxSoracom Lagoon ライセンスパック料金。パック名がハイフン区切りで付与されます。
soracomNapterChargeSoracom Napter 利用料金
soracomNapterAuditLogChargeSoracom Napter 監査ログ利用料金
soracomNapterAuditLogExportChargeSoracom Napter 監査ログ エクスポート料金
soracomOrbitChargeSoracom Orbit 料金
soracomOrbitRequestChargeSoracom Orbit リクエスト料金
soracomPeekChargeForVPGSoracom Peek 料金 for VPG
soracomPeekDataExportChargeSoracom Peek データエクスポート料金
soracomPeekDataStoreChargeForVPGSoracom Peek データ保存 料金 for VPG
soracomLTEMButtonPoweredByAWSRenewalChargeSORACOM LTE-M Button powered by AWS の契約更新料金
loRaGatewayOwnedModelFirstUnitMonthlyChargeLoRa ゲートウェイ専有モデル月額費用(1 台目)
loRaGatewayOwnedModelAdditionalUnitMonthlyChargeLoRa ゲートウェイ専有モデル月額費用(2 台目以降)
loRaGatewaySharedServiceModelMonthlyChargeLoRa ゲートウェイ共有モデル月額費用(1 台目)
sigfoxMessageChargeSigfox メッセージ利用料金。契約内容や利用国などがハイフン区切りで付与されます。
sigfoxDeviceRegistrationChargeSigfox デバイス登録料金
sigfoxAnnualConnectivityChargeSigfox デバイス年間接続料金
docomoSMSChargeSMS 料金(DOCOMO 回線)
docomoInternatinalSMSCharge国際 SMS 料金(DOCOMO 回線)
kddiSMSCharge-yyyyMMSMS 料金(KDDI 回線) yyyyMM に利用月が入ります。
kddiInternatinalSMSCharge-yyyyMM国際 SMS 料金(KDDI 回線) yyyyMM に利用月が入ります。
soracomSmsDeliveryChargeSoracom SMS 配信利用料金
soracomSmsSubmitChargeSoracom SMS 送信利用料金
apiAuditLogEnterpriseOptionCharge監査ログ エンタープライズ オプション料金
apiAuditLogExportCharge監査ログエクスポート料金 (10G / 月 超過分)

割引レコード

割引レコード内容
dataTrafficFreeTierデータ通信無料利用枠
soracomArcVirtualSimInitialChargeFreeTierSORACOM Arc 仮想 SIM 初期費用無料利用枠
soracomArcVirtualSimWithSimMonthlyChargeFreeTierSORACOM Arc 月額料金無料利用枠 (SORACOM IoT SIM に追加した場合)
soracomArcVirtualSimWithoutSimMonthlyChargeFreeTierSORACOM Arc 月額料金無料利用枠 (単独で作成した場合)
soracomBeamRequestFreeTierSoracom Beam リクエスト無料利用枠
soracomEndorseFreeTierSoracom Endorse 無料利用枠
soracomFunnelRequestFreeTierSoracom Funnel リクエスト無料利用枠
soracomFunkRequestFreeTierSoracom Funk リクエスト無料利用枠
soracomHarvestFreeTierSoracom Hearvest 無料利用枠
soracomInventoryFreeTierSoracom Inventory リクエスト無料利用枠
soracomNapterFreeTierSoracom Napter 無料利用枠
dataTrafficCouponデータ通信へのクーポン充当枠
soracomBeamRequestCouponSoracom Beam リクエスト利用料へのクーポン充当枠
soracomEndorseCouponSoracom Endorse 利用料へのクーポン充当枠
soracomFunnelRequestCouponSoracom Funnel 利用料へのクーポン充当枠
chargeCouponSORACOM 利用料全体へのクーポン充当枠
soracomAirBasicChargeVolumeDiscount基本料金のボリュームディスカウント

CSV パース時の注意点

BOM つきの UTF-8 でエンコードされていますので、UTF-8 で読み込みを行ってください。

  • タグ/グループの値にカンマ(,)が入っている場合は、値がダブルコーテーションで括られます。
  • またダブルコーテーション(")が入っている場合は、ダブルコーテーションでエスケープされます。

これらの文字を利用する場合は、エスケープを考慮できる CSV パーサを利用してください。

項目は可変のため、また今後 ICCID など新規項目が追加になる可能性があるため、ヘッダー行とレコード行を合わせて読みこむようにしてください。

例えば CSV の 1 項目目が IMSI、2 項目が date という形で固定で読み込むプログラムの実装した場合、SORACOM Canal/Direct を使用して vpgId が CSV に出力されたり、将来的に ICCID などが追加されると正しくデータを取得できなくなるため、 CSV を一度オブジェクトや Hash、連想配列など、レコード行をキー/値であつかえる形に変換した後、データを取り扱ってください。