REST Resource: anomalies

リソース: 異常

データセット内で検出された異常を表します。

Google の異常検出システムは、過去のデータから派生した、想定外の範囲にあるデータポイントにフラグを付けます。期待値の範囲には上限と下限がありますが、データが予期せず悪化した場合にのみ、異常を指摘します。これは通常、指標が上限を超えるケースに相当します。

想定外の 1 つのタイムライン内の複数のデータポイントが 1 つの異常値にグループ化されている。したがって、異常は指標のタイムラインのセグメントを効果的に表します。timelineSpec、dimensions、metric に保存された情報を使用して、コンテキストを長期間拡大し、タイムライン全体を取得できます。

必要な権限: このリソースにアクセスするには、呼び出し元のアプリにアプリ情報の閲覧（読み取り専用）権限が必要です。

JSON 表現 
{
  "name": string,
  "metricSet": string,
  "timelineSpec": {
    object (TimelineSpec)
  },
  "dimensions": [
    {
      object (DimensionValue)
    }
  ],
  "metric": {
    object (MetricValue)
  }
}
フィールド
name

string

異常の名前。

形式: apps/{app}/anomalies/{anomaly}
metricSet

string

異常が検出された指標セット リソース。
timelineSpec

object (TimelineSpec)

異常をカバーするタイムラインの仕様。
dimensions[]

object (DimensionValue)

異常が検出されたディメンションの組み合わせ。
metric

object (MetricValue)

異常が検出された指標と異常値。

タイムラインの仕様

タイムラインの時間関連集計パラメータの指定。

タイムラインには、指標を集計する方法を定義する集計期間（DAILY、HOURLY など）があります。

タイムライン内のポイントは、集計期間の開始の DateTime で定義されます。期間は AggregationPeriod で暗黙的に指定されます。

時間ベースの集計は、指標セットでサポートされる場合、常に夏時間（UTC）で指定され、夏時間への移行時（DST を適用する際に 1 時間スキップされ、DST を破棄する際に繰り返されます）のあいまいさを回避できます。たとえば、タイムスタンプ「2021-11-07 01:00:00 America/Los_Angeles」は、「2021-11-07 08:00:00 UTC」や「2021-11-07 09:00:00 UTC」に対応するため曖昧です。

日単位の集計期間では、開始時刻と終了時刻を正確に表すタイムゾーンを指定する必要があります。すべての指標セットがすべてのタイムゾーンをサポートしているわけではないため、クエリしたい指標セットがどのタイムゾーンでサポートされているかを確認してください。

JSON 表現 
{
  "aggregationPeriod": enum (AggregationPeriod),
  "startTime": {
    object (DateTime)
  },
  "endTime": {
    object (DateTime)
  }
}
フィールド
aggregationPeriod

enum (AggregationPeriod)

タイムライン内のデータポイントの集計期間のタイプ。

間隔は、間隔の開始日時で識別されます。
startTime

object (DateTime)

タイムラインの開始時点のデータポイント。集計期間を次のように調整する必要があります。

  • 毎時: 分、秒、ナノフィールドは設定解除する必要があります。timeZone は未設定のままにすることも（デフォルトは UTC）、明示的に「UTC」に設定することも可能です。他の utcOffset または timezone ID を設定すると、検証エラーが発生します。
  • 日単位: [hours]、[minutes]、[seconds]、[seconds] フィールドは設定しないでください。指標セットが異なると、サポートされるタイムゾーンも異なります。指標セットで指定されたデフォルトのタイムゾーンを使用する場合は、未設定のままにできます。

出発地のタイムゾーンは開始地点のタイムゾーンと一致する必要があります。
endTime

object (DateTime)

タイムラインの終了データポイント。制限の startTime をご覧ください。出発地のタイムゾーンは開始地点のタイムゾーンと一致する必要があります。

DimensionValue

1 つのディメンションの値を表します。

JSON 表現 
{
  "dimension": string,
  "valueLabel": string,

  // Union field value can be only one of the following:
  "stringValue": string,
  "int64Value": string
  // End of list of possible types for union field value.
}
フィールド
dimension

string

ディメンションの名前。
valueLabel

string

（省略可）人間が理解しやすい値のラベルで、常に英語で表記されます。たとえば、スペインの国コードには「スペイン」を指定します。

ディメンション値は安定版ですが、この値ラベルは変更される可能性があります。(value, valueLabel) の関係が安定しているとは限りません。たとえば、ISO 国コード「MK」は最近、名前を「北マケドニア」に変更しました。
共用体フィールド value。ディメンションの実際の値。種類によって異なります。value は次のいずれかになります。
stringValue

string

文字列で表される実際の値。
int64Value

string (int64 format)

int64 として表される実際の値。

MetricValue

指標の値を表します。

JSON 表現 
{
  "metric": string,

  // Union field value can be only one of the following:
  "decimalValue": {
    object (Decimal)
  }
  // End of list of possible types for union field value.

  // Union field confidence_interval can be only one of the following:
  "decimalValueConfidenceInterval": {
    object (DecimalConfidenceInterval)
  }
  // End of list of possible types for union field confidence_interval.
}
フィールド
metric

string

指標の名前。
共用体フィールド value。指標の実際の値。種類によって異なります。value は次のいずれかになります。
decimalValue

object (Decimal)

10 進数で表される実際の値。
共用体フィールド confidence_interval。指定する場合、値の信頼区間を表します。confidence_interval は次のいずれかになります。
decimalValueConfidenceInterval

object (DecimalConfidenceInterval)

type.Decimal 型の値の信頼区間。

DecimalConfidenceInterval

指標の信頼区間を表します。

JSON 表現 
{
  "lowerBound": {
    object (Decimal)
  },
  "upperBound": {
    object (Decimal)
  }
}
フィールド
lowerBound

object (Decimal)

信頼区間の下限。
upperBound

object (Decimal)

信頼区間の上限。

Methods

list

 いずれかのデータセットの異常を一覧表示します。