REST Resource: properties

資源:Property

代表 Google Analytics (分析) 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} 範例:"property/1000"

propertyType

enum (PropertyType)

不可變動。這項資源資源的資源類型。建立資源時,如果類型為「PROPERTY_TYPE_UNSPECIFIED」,則代表「ORDINARY_PROPERTY」。「SUBPROPERTY&」和「ROLLUP_PROPERTY」格式無法透過 Google Analytics Admin API 建立。

createTime

string (Timestamp format)

僅供輸出。實體最初的建立時間。

RFC3339 UTC 的「Zulu」格式時間戳記,單位為奈秒解析度,最多可達九位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

僅供輸出。實體酬載欄位的上次更新時間。

RFC3339 UTC 的「Zulu」格式時間戳記,單位為奈秒解析度,最多可達九位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

parent

string

不可變動。這項資源的資源名稱。

注意:資源移動使用者介面可用於變更上層。格式:accounts/{account},property/{property}

displayName

string

必要,這項資源的顯示名稱,方便使用者理解。

顯示名稱的長度上限為 100 個 UTF-16 代碼單位。

industryCategory

enum (IndustryCategory)

與此資源相關聯的產業,例如:AUTOMOTIVE、FOOD_AND_DRINK

timeZone

string

必要,報表時區,無論報表的來源為何,都可以做為報表的日期界線。如果時區符合 DST 規定,Analytics (分析) 會自動配合調整。

注意事項:變更時區只會影響該變更生效後收集的報表資料,不會溯及既往。

格式:https://www.iana.org/time-zones 範例:"America/Los_Angeles"

currencyCode

string

報表中使用的貨幣類型,涉及金額。

格式:https://zh.wikipedia.org/wiki/ISO_4217

serviceLevel

enum (ServiceLevel)

僅供輸出。適用於這項資源的 Google Analytics (分析) 服務層級。

deleteTime

string (Timestamp format)

僅供輸出。設定後,此資源移至垃圾桶的時間。如果不設定這項政策,則資源目前不在垃圾桶中。

RFC3339 UTC 的「Zulu」格式時間戳記,單位為奈秒解析度,最多可達九位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

expireTime

string (Timestamp format)

僅供輸出。設定後,此移至垃圾桶的資源將永久刪除,如果不設定這項政策,表示這項資源目前不在垃圾桶中,因此無法刪除。

RFC3339 UTC 的「Zulu」格式時間戳記,單位為奈秒解析度,最多可達九位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

account

string

不可變動。家長帳戶的資源名稱,格式為:accounts/{account_id},例如:「quoaccounts;accounts/123"」

屬性類型

資源資源類型。

列舉
PROPERTY_TYPE_UNSPECIFIED 不明或未指定的資源類型
PROPERTY_TYPE_ORDINARY 一般的 GA4 資源
PROPERTY_TYPE_SUBPROPERTY GA4 子資源
PROPERTY_TYPE_ROLLUP GA4 綜覽資源

產業類別

為這項資源選取的類別,用於產業基準。

列舉
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 Google 購物

服務水準

Google Analytics (分析) 提供多種服務層級。

列舉
SERVICE_LEVEL_UNSPECIFIED 未指定服務層級或無效。
GOOGLE_ANALYTICS_STANDARD 標準版 Google Analytics (分析)。
GOOGLE_ANALYTICS_360 付費版的 Google Analytics (分析)。

方法

acknowledgeUserDataCollection

確認指定資源的使用者資料收集條款。

create

建立含有指定位置和屬性的「GA4」屬性。

delete

將目標屬性標示為轉址式 (例如「&trated&&tt」) 並傳回。

get

請找出單一「GA4」資源。

getDataRetentionSettings

傳回這項資源的單例模式資料保留設定。

list

傳回指定父項帳戶底下的子資源。

patch

更新屬性。

updateDataRetentionSettings

更新這項資源的單例模式資料保留設定。