REST Resource: properties

リソース: プロパティ

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」が暗黙的に指定されます。「SUBPROPERTY」と「ROLLUP_PROPERTY」のタイプは、Google アナリティクス Admin API ではまだ作成できません。
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

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

表示名の長さの上限は 100 UTF-16 コードユニットです。
industryCategory

enum (IndustryCategory)

このプロパティに関連付けられた業界例: AUTOMOTIVE、FOOD_AND_DRINK
timeZone

string

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

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

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

string

金銭的価値を含むレポートで使用される通貨の種類。

形式: https://ja.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"

プロパティ タイプ

Property リソースのタイプ。

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

業種

このプロパティに選択されたカテゴリ。業界のベンチマークに使用されます。

列挙型
INDUSTRY_CATEGORY_UNSPECIFIED 業種が指定されていません
AUTOMOTIVE Automotive
BUSINESS_AND_INDUSTRIAL_MARKETS ビジネス、製造
FINANCE 金融
HEALTHCARE ヘルスケア
TECHNOLOGY テクノロジー
TRAVEL Travel
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 Reference
SCIENCE 科学
SPORTS スポーツ
JOBS_AND_EDUCATION 人材募集、職業訓練
SHOPPING ショッピング

サービスレベル

Google アナリティクスの各種サービスレベル。

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

Methods

acknowledgeUserDataCollection

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

create

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

createConnectedSiteTag

 ユニバーサル アナリティクス プロパティの接続済みのサイトタグを作成します。

delete

 ターゲット プロパティをソフト削除（「ゴミ箱」など）としてマークして返します。

deleteConnectedSiteTag

 ユニバーサル アナリティクス プロパティの接続済みのサイトタグを削除します。

fetchAutomatedGa4ConfigurationOptOut

 UA プロパティの自動 GA4 設定プロセスのオプトアウト ステータスを取得します。

fetchConnectedGa4Property

 指定された UA プロパティが指定された GA4 プロパティを検索します。

get

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

getAttributionSettings

 AttributionSettings シングルトンの検索。

getDataRetentionSettings

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

getGoogleSignalsSettings

 プロパティの Google シグナル設定の検索。

list

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

listConnectedSiteTags

 ユニバーサル アナリティクス プロパティの接続済みのサイトタグを一覧表示します。

patch

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

runAccessReport

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

setAutomatedGa4ConfigurationOptOut

 UA プロパティの自動化された GA4 設定プロセスのオプトアウト ステータスを設定します。

updateAttributionSettings

 プロパティのアトリビューション設定を更新します。

updateDataRetentionSettings

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

updateGoogleSignalsSettings

 プロパティの Google シグナル設定を更新します。