REST Resource: properties.reportingDataAnnotations

リソース: ReportingDataAnnotation

レポートデータのアノテーションは、レポートデータの特定の日付に関連付けられたコメントです。

JSON 表現 
{
  "name": string,
  "title": string,
  "description": string,
  "color": enum (Color),
  "systemGenerated": boolean,

  // Union field target can be only one of the following:
  "annotationDate": {
    object (Date)
  },
  "annotationDateRange": {
    object (DateRange)
  }
  // End of list of possible types for union field target.
}
フィールド
name

string

必須。ID。このレポートデータ アノテーションのリソース名。形式: 'properties/{property_id}/reportingDataAnnotations/{reportingDataAnnotation}' 形式: 'properties/123/reportingDataAnnotations/456'
title

string

必須。このレポートデータ アノテーションのタイトル（人が読める形式）。
description

string

省略可。このレポートデータ アノテーションの説明。
color

enum (Color)

必須。このレポートデータ アノテーションの表示に使用される色。
systemGenerated

boolean

出力専用。true の場合、このアノテーションは Google アナリティクス システムによって生成されたものです。システム生成のアノテーションは更新または削除できません。
共用体フィールド target。このレポートデータ アノテーション target のターゲットは、次のいずれかになります。
annotationDate

object (Date)

設定されている場合、レポートデータ アノテーションは、このフィールドで表される特定の日付に関するものです。日付は、年、月、日が設定された有効な日付である必要があります。過去、現在、未来の日付を指定できます。
annotationDateRange

object (DateRange)

設定されている場合、レポートデータ アノテーションは、このフィールドで表される期間のものです。

日付

誕生日などのように、カレンダーの日付全体またはその一部を表します。時間帯とタイムゾーンは、他の場所で指定されているか、重要ではありません。日付はグレゴリオ暦を基準にしています。これは次のいずれかを表します。

  • ゼロ以外の年、月、日の値を含む完全な日付。
  • 年の値がゼロである月と日（記念日など）。
  • 月と日の値がゼロである単独の年。
  • 日がゼロである年と月（クレジット カードの有効期限など）

関連するタイプ:

JSON 表現 
{
  "year": integer,
  "month": integer,
  "day": integer
}
フィールド
year

integer

その日付の年。1～9999、または年のない日付を指定する場合は 0 にする必要があります。
month

integer

1 年の中の月。1～12、または月と日のない年を指定する場合は 0 にする必要があります。
day

integer

1 月の中の日付。1～31 で、その年と月に対して有効である必要があります。または、日が重要でない場合に、年のみか年と月を指定するには 0 にする必要があります。

DateRange

レポートデータ アノテーションの期間を表します。開始日と終了日の両方が含まれます。タイムゾーンは親プロパティに基づいています。

JSON 表現 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
フィールド
startDate

object (Date)

必須。この期間の開始日。年、月、日が設定された有効な日付を指定する必要があります。過去、現在、未来の日付を指定できます。
endDate

object (Date)

必須。この期間の終了日。年、月、日が設定された有効な日付を指定する必要があります。この日付は、開始日以降にする必要があります。

色

このレポートデータ アノテーションに使用できる色

列挙型
COLOR_UNSPECIFIED 色が不明または指定されていません。
PURPLE 紫色。
BROWN 茶色。
BLUE 青色。
GREEN 緑色。
RED 赤色。
CYAN シアン色。
ORANGE オレンジ色。（システム生成のアノテーションにのみ使用）

メソッド

create

 レポート データのアノテーションを作成します。

delete

 レポート データのアノテーションを削除します。

get

 単一のレポートデータ アノテーションを検索します。

list

 プロパティのすべてのレポートデータ アノテーションを一覧表示します。

patch

 レポート データ アノテーションを更新します。