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},範例:「properties/1000」

propertyType

enum (PropertyType)

不可變動。此資源資源的屬性類型。建立屬性時,如果類型為「PROPERTY_TYPE_UNSPECIFIED」,則系統會隱含「ORDINARY_PROPERTY」。

createTime

string (Timestamp format)

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

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

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

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

parent

string

不可變動。此屬性邏輯父項的資源名稱。

注意:屬性移動 UI 可用來變更父項。格式:accounts/{account}、property/{property} 範例:「accounts/100」、「properties/101」

displayName

string

必要欄位。這項屬性的顯示名稱。

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

industryCategory

enum (IndustryCategory)

與這項資源相關的產業範例:AUTOMOTIVE、FOOD_AND_DRINK

timeZone

string

必要欄位。報表時區是報表日的邊界,不論資料來源為何。如果時區採用日光節約時間,Analytics (分析) 會自動根據變更做出調整。

注意:更改時區只會影響日後的報表資料,不會溯及既往。

格式: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 Analytics (分析) 服務層級。

deleteTime

string (Timestamp format)

僅供輸出。如果有設定,則表示這項資源移至垃圾桶的時間。如果未設定,這個屬性目前不在垃圾桶中。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

expireTime

string (Timestamp format)

僅供輸出。設定後,這項移至垃圾桶資源的時間就會永久刪除。如果未設定,則這個屬性目前不在垃圾桶中,因此無法刪除。

採用 RFC3339 世界標準時間「Zulu」格式的時間戳記,採用奈秒解析度和最多九個小數位數。範例:"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 其他
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 Analytics (分析) 提供多種服務層級。

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

方法

acknowledgeUserDataCollection

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

create

建立含有指定地點和屬性的「GA4」資源。

delete

將目標屬性標示為已虛刪除 (例如「已移至垃圾桶」),並傳回該資源。

get

查詢單一「GA4」資源。

getDataRetentionSettings

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

list

傳回指定上層帳戶下的子資源。

patch

更新屬性。

runAccessReport

傳回資料存取記錄的自訂報表。

updateDataRetentionSettings

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