ガイドAPIリファレンス
ガイド

請求タグの追加と使用方法

このチュートリアルでは、請求タグの追加と使用方法を説明します。請求タグを使用すると、使用量とコストを追跡するコンポーネント間でプラットフォームの使用量を追跡できます。請求タグを使用すると、請求書のコストを結合するために使用する文字列を作成できます。たとえば、特定のコストを強調するプロジェクトまたはアクティビティ用に、複数のパイプラインをまとめてグループ化できます。

ユーザー定義の請求タグを追加する

ユーザー定義の請求タグをクエリに追加できます。

ユーザー定義の請求タグには、次のルールがあります。

  • 4~16文字 大文字と小文字を区別
  • 使用できる文字は英数字のASCII文字[a - zA - Z0 - 9]および次の特殊文字:[ - ] [ _ ]
  • 請求タグの先頭または末尾に次の特殊文字を使用することはできない:[ - ] [ _ ]
  • 最大6つの請求タグを**+**で連結して長い文字列を作成可能。例:tag1+tag2+tag3+tag4+tag5+tag6

無効な請求タグにより発生したエラー:

{
  "title": "billingTag is invalid",                    
  "status": 400,                                                      
  "code": "<to be defined by the service>",                            
  "cause": "The billingTag passed does not meet validation rules",
  "action": "Please provide a valid billingTag according to service specification",
  "correlationId": "4199533b-6290-41db-8d79-edf4f4019a74"          
}

有効な文字と無効な文字

「技術会計」として知られるアカウント管理のパラダイムでは、不正な請求タグから無効な文字が削除されます。例:「My#In%validTag_ThatIsVeryLong」→「MyInvalidTag_Tha」。

Account management paradigm

次の表には、クエリに有効な請求タグの追加方法の例が記載されています。

サンプルのテキスト
https://samplehost/sampleresource?billingTag=ABCD&other_tag=123D
https://samplehost/sampleresource?billingTag=DEFG+GHI1&other_tag=123A
https://samplehost/sampleresource?billingTag=ABC2&other_tag=123B
https://samplehost/sampleresource?billingTag=DEF2+GHI2&other_tag=olp-test-123C

1つの請求タグの正規表現

1つの請求タグの正規表現

複数の連結された請求タグの正規表現

複数の請求タグの正規表現

プロジェクトの請求タグ

アカウント管理の「プロジェクト」と呼ばれる部分は、次のように識別されます。

目的
name一意ではない、UI目的のもの"Happy Project"
id組織内の一意性を表す名前から構築。"project/happy-project"
hrnグローバルに一意な識別子。"hrn:here:authorization::org123456789:project/happy-project"
scopeトークン内の範囲=hrn。"hrn:here:authorization::org123456789:project/happy-project"

プロジェクトのコスト割り当ては内部的なものであり、ユーザー定義の請求タグから独立しています。トークンから範囲が抽出され、billingTagとして使用されます。たとえば、hrn:here:authorization::org123456789:project/happy-projectとなります。前の表に示すように、プロジェクトhappy-projectは請求タグです。

プロジェクト関連の請求タグは、特定のプロジェクトのコストを表すために請求書に表示されます。

詳細については、コスト管理の使用量API v2 APIリファレンスを参照してください。

関連トピック