REST Resource: properties.customDimensions

ทรัพยากร: CustomDimension

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

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

string

เอาต์พุตเท่านั้น ชื่อทรัพยากรของทรัพยากร CustomDimension นี้ รูปแบบ: พร็อพเพอร์ตี้/{property}/customได้อีกต่อไป/{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 ในพร็อพเพอร์ตี้