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

仅限输出。此属性的资源名称。格式:property/{property_id} 示例:“properties/1000”

propertyType

enum (PropertyType)

不可变。此 Property 资源的属性类型。创建属性时,如果类型为“PROPERTY_TYPE_UNSPECIFIED”,则设置为“ORDINARY_PROPERTY”

createTime

string (Timestamp format)

仅限输出。实体最初创建的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

updateTime

string (Timestamp format)

仅限输出。上次更新实体载荷字段的时间。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"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

必需。报告时区,用作报告的日期范围(无论数据来自何处)。如果该时区遵循夏令时,Google 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 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

expireTime

string (Timestamp format)

仅限输出。如果设置,则此已删除媒体资源将被永久删除的时间。如果未设置,则此属性目前不在垃圾箱中,并且也不打算删除。

时间戳采用 RFC3339 世界协调时间(UTC,即“祖鲁时”)格式,精确到纳秒,最多九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

account

string

不可变。父级账号的资源名称,格式:accounts/{account_id} 示例:“accounts/123”

PropertyType

Property 资源的类型。

枚举
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

更新此媒体资源的单例数据保留设置。