REST Resource: properties

リソース: プロパティ

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

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

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

propertyType

enum (PropertyType)

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

createTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

updateTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

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

必須。レポートのタイムゾーン。データの提供元に関係なく、レポートの日付の基準として使用されます。タイムゾーンで夏時間が採用されている場合、アナリティクスで自動的に時間調整が行われます。

注: タイムゾーンの変更は、それ以降に収集されるデータのみに反映され、過去のデータには適用されません。

形式: 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)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

expireTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

account

string

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

PropertyType

Property リソースのタイプ。

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

IndustryCategory

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

列挙型
INDUSTRY_CATEGORY_UNSPECIFIED 業種が指定されていません
AUTOMOTIVE 自動車
BUSINESS_AND_INDUSTRIAL_MARKETS ビジネス、製造
FINANCE 金融
HEALTHCARE 医療
TECHNOLOGY テクノロジー
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 リファレンス
SCIENCE 科学
SPORTS スポーツ
JOBS_AND_EDUCATION 人材募集、職業訓練
SHOPPING ショッピング

ServiceLevel

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

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

メソッド

acknowledgeUserDataCollection

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

create

指定したロケーションと属性で Google アナリティクスのプロパティを作成します。

createRollupProperty

統合プロパティとすべての統合プロパティ ソースリンクを作成します。

delete

ターゲット プロパティをソフト削除(つまり「ゴミ箱に移動」)としてマークし、返します。

get

単一の GA プロパティを検索します。

getAttributionSettings

AttributionSettings シングルトンを検索します。

getDataRetentionSettings

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

getGoogleSignalsSettings

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

getReportingIdentitySettings

このプロパティのレポート用識別子の設定を返します。

getUserProvidedDataSettings

プロパティのユーザー提供データに関連する設定を検索します。

list

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

patch

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

provisionSubproperty

サブプロパティと、作成したサブプロパティに適用されるサブプロパティ イベント フィルタを作成します。

runAccessReport

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

submitUserDeletion

プロパティのユーザー削除リクエストを送信します。

updateAttributionSettings

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

updateDataRetentionSettings

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

updateGoogleSignalsSettings

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