REST Resource: properties

リソース: Property

Google アナリティクスの GA4 プロパティを表すリソース メッセージ。

JSON 表現 
{
  "name": string,
  "propertyType": enum (PropertyType),
  "createTime": string,
  "updateTime": string,
  "parent": string,
  "displayName": string,
  "industryCategory": enum (IndustryCategory),
  "timeZone": string,
  "currencyCode": string,
  "serviceLevel": enum (ServiceLevel),
  "deleteTime": string,
  "expireTime": string,
  "account": string
}
フィールド
name

string

出力専用。このプロパティのリソース名。形式: properties/{property_id} 例: 「properties/1000」
propertyType

enum (PropertyType)

変更不可。このプロパティ リソースのプロパティ タイプ。プロパティを作成するときに、型が「PROPERTY_TYPE_UNSPECIFIED」の場合は「ORDINARY_PROPERTY」が暗黙的に指定されます。
createTime

string (Timestamp format)

出力専用。エンティティが最初に作成された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。エンティティ ペイロード フィールドが最後に更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
parent

string

変更不可。このプロパティの論理的な親のリソース名。

注: プロパティ移動 UI を使用して親を変更できます。形式: accounts/{account}, properties/{property} 例: 「accounts/100」、「properties/101」
displayName

string

必須。このプロパティの、人が読める形式の表示名。

表示名の最大文字数は UTF-16 コードユニットで 100 です。
industryCategory

enum (IndustryCategory)

この宿泊施設に関連する業種（例: AUTOMOTIVE、FOOD_AND_DRINK）
timeZone

string

必須。レポートのタイムゾーン。データの取得元に関係なく、レポートの日付の区切りとして使用されます。タイムゾーンが DST に準拠している場合、アナリティクスでは変更に合わせて自動的に調整されます。

注: タイムゾーンの変更は、それ以降に収集されるデータにのみ影響し、過去にさかのぼって適用されることはありません。

形式: https://www.iana.org/time-zones 例: 「America/Los_Angeles」
currencyCode

string

金額に関するレポートで使用される通貨タイプ。

形式: https://en.wikipedia.org/wiki/ISO_4217 例: 「USD」、「EUR」、「JPY」
serviceLevel

enum (ServiceLevel)

出力専用。このプロパティに適用される Google アナリティクスのサービスレベル。
deleteTime

string (Timestamp format)

出力専用。設定されている場合、このプロパティがゴミ箱に移動した時刻。設定されていない場合、このプロパティは現在ゴミ箱にはありません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
expireTime

string (Timestamp format)

出力専用。設定されている場合、このゴミ箱内のプロパティが完全に削除される時刻。設定されていない場合、このプロパティは現在ゴミ箱にないため、削除される予定はありません。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
account

string

変更不可。親アカウントのリソース名。形式: accounts/{account_id} 例: 「accounts/123」

PropertyType

プロパティ リソースのタイプ。

列挙型
PROPERTY_TYPE_UNSPECIFIED 不明または未指定のプロパティ タイプ
PROPERTY_TYPE_ORDINARY 通常の GA4 プロパティ
PROPERTY_TYPE_SUBPROPERTY GA4 サブプロパティ
PROPERTY_TYPE_ROLLUP GA4 統合プロパティ

IndustryCategory

この宿泊施設に対して選択されたカテゴリ。業界のベンチマークに使用されます。

列挙型
INDUSTRY_CATEGORY_UNSPECIFIED 業種が指定されていません
AUTOMOTIVE 自動車
BUSINESS_AND_INDUSTRIAL_MARKETS ビジネス、製造
FINANCE 金融
HEALTHCARE ヘルスケア
TECHNOLOGY テクノロジー
TRAVEL 旅行
OTHER Other
ARTS_AND_ENTERTAINMENT アート、エンターテインメント
BEAUTY_AND_FITNESS 美容、フィットネス
BOOKS_AND_LITERATURE 書籍、文学
FOOD_AND_DRINK 飲食店
GAMES ゲーム
HOBBIES_AND_LEISURE 趣味、レジャー
HOME_AND_GARDEN 家庭、園芸
INTERNET_AND_TELECOM インターネット、通信
LAW_AND_GOVERNMENT 法律、行政
NEWS ニュース
ONLINE_COMMUNITIES オンライン コミュニティ
PEOPLE_AND_SOCIETY 人々、社会
PETS_AND_ANIMALS ペット、動物
REAL_ESTATE 不動産
REFERENCE リファレンス
SCIENCE 科学
SPORTS スポーツ
JOBS_AND_EDUCATION 人材募集、職業訓練
SHOPPING ショッピング

ServiceLevel

Google アナリティクスのさまざまなレベルのサービス。

列挙型
SERVICE_LEVEL_UNSPECIFIED サービスレベルが指定されていないか無効です。
GOOGLE_ANALYTICS_STANDARD Google アナリティクスの標準版です。
GOOGLE_ANALYTICS_360 Google アナリティクスの有料のプレミアム バージョン。

Methods

acknowledgeUserDataCollection

 指定されたプロパティのユーザーデータ収集に関する利用規約に同意します。

create

 指定した場所と属性で「GA4」プロパティを作成します。

delete

 対象のプロパティを削除済み（復元可能）としてマークして返します（ゴミ箱あり）。

get

 1 つの「GA4」プロパティを検索します。

getDataRetentionSettings

 このプロパティのシングルトン データ保持設定を返します。

list

 指定された親アカウントの子プロパティを返します。

patch

 プロパティを更新します。

runAccessReport

 データアクセス レコードのカスタム レポートを返します。

updateDataRetentionSettings

 このプロパティのシングルトン データ保持設定を更新します。