REST Resource: properties

資源:屬性

代表 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」的時間戳記格式,解析度不超過奈秒,最多 9 個小數位數。範例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

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

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

parent

string

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

注意:資源移動使用者介面可用於變更父項。格式:accounts/{account}、property/{property} (例如:「accounts/100」、「properties/101」)

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://en.wikipedia.org/wiki/ISO_4217,例如「USD」、「EUR」、「JPY」

serviceLevel

enum (ServiceLevel)

僅供輸出。套用至這項資源的 Google Analytics 服務層級。

deleteTime

string (Timestamp format)

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

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

expireTime

string (Timestamp format)

僅供輸出。如果設定這項限制,系統會永久刪除已移至垃圾桶的資源的時間。如果未設定,表示該屬性目前不在垃圾桶中,因此沒有意願刪除。

RFC3339 世界標準時間「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 其他
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」屬性並帶有指定的位置和屬性。

createConnectedSiteTag

為通用 Analytics 資源建立已連結的網站代碼。

createRollupProperty

建立綜覽資源和所有綜覽資源來源連結。

delete

將目標屬性標示為虛刪除 (例如「垃圾桶」) 並傳回。

deleteConnectedSiteTag

刪除通用 Analytics 資源已連結的網站代碼。

fetchAutomatedGa4ConfigurationOptOut

擷取通用 Analytics 資源的自動化 GA4 設定程序的停用狀態。

fetchConnectedGa4Property

根據指定的通用 Analytics 資源,查詢與該資源連結的 GA4 資源。

get

查詢單一「GA4」資源。

getAttributionSettings

查詢 AttributionSettings 單例。

getDataRetentionSettings

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

getGoogleSignalsSettings

查詢資源的 Google 信號設定。

list

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

listConnectedSiteTags

列出通用 Analytics 資源的已連結的網站代碼。

patch

可更新屬性。

provisionSubproperty

然後建立子資源,以及套用到所建立子資源的子資源事件篩選器。

runAccessReport

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

setAutomatedGa4ConfigurationOptOut

為通用 Analytics 資源的自動化 GA4 設定程序啟用停用狀態。

updateAttributionSettings

更新資源的歸因設定。

updateDataRetentionSettings

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

updateGoogleSignalsSettings

更新資源的 Google 信號設定。