REST Resource: properties.customDimensions

ทรัพยากร: CustomDimension

คำจำกัดความของ CustomDimension

การแสดง JSON
{
  "name": string,
  "parameterName": string,
  "displayName": string,
  "description": string,
  "scope": enum (DimensionScope),
  "disallowAdsPersonalization": boolean
}
ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรสำหรับทรัพยากร CustomDimension นี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/customDimensions/{customDimension}

parameterName

string

ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อพารามิเตอร์การติดแท็กสำหรับมิติข้อมูลที่กำหนดเองนี้

หากนี่เป็นมิติข้อมูลระดับผู้ใช้ นี่จะเป็นชื่อพร็อพเพอร์ตี้ผู้ใช้ หากนี่เป็นมิติข้อมูลที่กําหนดขอบเขตระดับเหตุการณ์ พารามิเตอร์นี้จะเป็นชื่อพารามิเตอร์เหตุการณ์

หากเป็นมิติข้อมูลระดับสินค้า พารามิเตอร์นี้จะเป็นชื่อพารามิเตอร์ในอาร์เรย์สินค้าอีคอมเมิร์ซ

ใช้ได้เฉพาะอักขระที่เป็นตัวอักษรและตัวเลขคละกันและขีดล่างโดยขึ้นต้นด้วยตัวอักษร ความยาวสูงสุด 24 อักขระสําหรับมิติข้อมูลที่กําหนดขอบเขตระดับผู้ใช้ และ 40 อักขระสําหรับมิติข้อมูลที่กําหนดขอบเขตระดับเหตุการณ์

displayName

string

ต้องระบุ ชื่อที่แสดงของมิติข้อมูลที่กำหนดเองนี้ตามที่แสดงใน UI ของ Analytics ความยาวสูงสุด 82 อักขระ ได้แก่ ตัวอักษรและตัวเลขคละกัน รวมถึงช่องว่าง และขีดล่างเริ่มต้นด้วยตัวอักษร ชื่อที่แสดงซึ่งระบบสร้างขึ้นแบบเดิมอาจมีวงเล็บเหลี่ยม แต่การอัปเดตฟิลด์นี้จะไม่อนุญาตให้ใช้เครื่องหมายวงเล็บเหลี่ยม

description

string

ไม่บังคับ คำอธิบายสำหรับมิติข้อมูลที่กำหนดเองนี้ ความยาวสูงสุด 150 อักขระ

scope

enum (DimensionScope)

ต้องระบุ เปลี่ยนแปลงไม่ได้ ขอบเขตของมิติข้อมูลนี้

disallowAdsPersonalization

boolean

ไม่บังคับ หากตั้งค่าเป็น "จริง" ให้ตั้งค่ามิติข้อมูลนี้เป็น NPA แล้วยกเว้นมิติข้อมูลจากการปรับโฆษณาตามโปรไฟล์ของผู้ใช้

ปัจจุบันมิติข้อมูลดังกล่าวรองรับเฉพาะมิติข้อมูลที่กําหนดเองระดับผู้ใช้เท่านั้น

DimensionScope

ค่าที่ถูกต้องสำหรับขอบเขตของมิติข้อมูลนี้

Enum
DIMENSION_SCOPE_UNSPECIFIED ไม่รู้จักหรือไม่ได้ระบุขอบเขต
EVENT มิติข้อมูลมีขอบเขตอยู่ที่เหตุการณ์
USER มิติข้อมูลที่กำหนดขอบเขตที่ผู้ใช้
ITEM มิติข้อมูลที่กำหนดขอบเขตไว้ที่รายการอีคอมเมิร์ซ

เมธอด

archive

เก็บ CustomDimension ในพร็อพเพอร์ตี้

create

สร้าง CustomDimension

get

ค้นหา CustomDimension เดียว

list

แสดงรายการมิติข้อมูลที่กำหนดเองในพร็อพเพอร์ตี้

patch

อัปเดต CustomDimension ในพร็อพเพอร์ตี้