- แหล่งข้อมูล: กลุ่มเป้าหมาย
- AudienceEventTrigger
- LogCondition
- AudienceExclusionDurationMode
- AudienceFilterClause
- AudienceSimpleFilter
- AudienceFilterScope
- AudienceFilterExpression
- AudienceFilterExpressionList
- AudienceDimensionOrMetricFilter
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- การดำเนินการ
- NumericValue
- BetweenFilter
- AudienceEventFilter
- AudienceSequenceFilter
- AudienceSequenceStep
- AudienceClauseType
- เมธอด
แหล่งข้อมูล: กลุ่มเป้าหมาย
ข้อความทรัพยากรที่แสดงกลุ่มเป้าหมาย
การแสดง JSON |
---|
{ "name": string, "displayName": string, "description": string, "membershipDurationDays": integer, "adsPersonalizationEnabled": boolean, "eventTrigger": { object ( |
ช่อง | |
---|---|
name |
เอาต์พุตเท่านั้น ชื่อทรัพยากรสําหรับทรัพยากรกลุ่มเป้าหมายนี้ รูปแบบ: properties/{propertyId}/audiences/{audienceId} |
display |
ต้องระบุ ชื่อที่แสดงของกลุ่มเป้าหมาย |
description |
ต้องระบุ คําอธิบายกลุ่มเป้าหมาย |
membership |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ระยะเวลาที่ผู้ใช้ควรอยู่ในกลุ่มเป้าหมาย แต่จะตั้งค่าให้นานกว่า 540 วันไม่ได้ |
ads |
เอาต์พุตเท่านั้น GA จะตั้งค่าเป็นเท็จโดยอัตโนมัติหากเป็นกลุ่มเป้าหมาย NPA และยกเว้นการปรับโฆษณาตามโปรไฟล์ของผู้ใช้ |
event |
ไม่บังคับ ระบุเหตุการณ์ที่จะบันทึกเมื่อผู้ใช้เข้าร่วมกลุ่มเป้าหมาย หากไม่ได้ตั้งค่า ระบบจะไม่บันทึกเหตุการณ์เมื่อผู้ใช้เข้าร่วมกลุ่มเป้าหมาย |
exclusion |
เปลี่ยนแปลงไม่ได้ ระบุระยะเวลาของการยกเว้นสําหรับผู้ใช้ที่ตรงกับตัวกรองการยกเว้น ซึ่งจะมีผลกับประโยคตัวกรอง EXCLUDE ทั้งหมดและระบบจะไม่สนใจหากไม่มีประโยคตัวกรอง EXCLUDE ในกลุ่มเป้าหมาย |
filter |
ต้องระบุ เปลี่ยนแปลงไม่ได้ รายการที่ไม่เรียงลําดับ กรองประโยคที่กําหนดกลุ่มเป้าหมาย ประโยคทั้งหมดจะรวมกันโดยใช้ & |
create |
เอาต์พุตเท่านั้น เวลาที่สร้างกลุ่มเป้าหมาย ใช้ RFC 3339 ซึ่งเอาต์พุตที่สร้างขึ้นจะเป็นรูปแบบ Z-normalized เสมอ และใช้ตัวเลขทศนิยม 0, 3, 6 หรือ 9 ระบบยังยอมรับออฟเซตที่ไม่ใช่ "Z" ด้วย เช่น |
AudienceEventTrigger
ระบุเหตุการณ์ที่จะบันทึกเมื่อผู้ใช้เข้าร่วมกลุ่มเป้าหมาย
การแสดง JSON |
---|
{
"eventName": string,
"logCondition": enum ( |
ช่อง | |
---|---|
event |
ต้องระบุ ชื่อเหตุการณ์ที่จะบันทึก |
log |
ต้องระบุ กรณีที่ควรบันทึกเหตุการณ์ |
LogCondition
กำหนดเวลาบันทึกเหตุการณ์
Enum | |
---|---|
LOG_CONDITION_UNSPECIFIED |
ไม่ได้ระบุเงื่อนไขการบันทึก |
AUDIENCE_JOINED |
ระบบควรบันทึกเหตุการณ์เฉพาะเมื่อมีผู้ใช้เข้าร่วมเท่านั้น |
AUDIENCE_MEMBERSHIP_RENEWED |
ระบบควรบันทึกเหตุการณ์ทุกครั้งที่เป็นไปตามเงื่อนไขกลุ่มเป้าหมาย แม้ว่าผู้ใช้จะเป็นสมาชิกกลุ่มเป้าหมายอยู่แล้วก็ตาม |
AudienceExclusionDurationMode
ระบุระยะเวลาของการยกเว้นสําหรับผู้ใช้ที่ตรงกับตัวกรองการยกเว้น
Enum | |
---|---|
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED |
ไม่ได้ระบุ |
EXCLUDE_TEMPORARILY |
ยกเว้นผู้ใช้จากกลุ่มเป้าหมายในช่วงเวลาที่ผู้ใช้มีคุณสมบัติตรงตามประโยคตัวกรอง |
EXCLUDE_PERMANENTLY |
ยกเว้นผู้ใช้จากกลุ่มเป้าหมายหากเคยมีคุณสมบัติตรงตามประโยคตัวกรอง |
AudienceFilterClause
ประโยคสําหรับกําหนดตัวกรองแบบง่ายหรือตัวกรองลําดับ ตัวกรองอาจเป็นแบบรวม (เช่น ผู้ใช้ที่ตรงกับอนุประโยคตัวกรองจะรวมอยู่ในกลุ่มเป้าหมาย) หรือแบบยกเว้น (เช่น ผู้ใช้ที่ตรงกับอนุประโยคตัวกรองจะยกเว้นจากกลุ่มเป้าหมาย)
การแสดง JSON |
---|
{ "clauseType": enum ( |
ช่อง | |
---|---|
clause |
ต้องระบุ ระบุว่าเป็นเงื่อนไขตัวกรองแบบรวมหรือยกเว้น |
ฟิลด์สหภาพ
|
|
simple |
ตัวกรองง่ายๆ ที่ผู้ใช้ต้องมีคุณสมบัติตรงตามจึงจะถือเป็นสมาชิกของกลุ่มเป้าหมาย |
sequence |
ตัวกรองที่ต้องเกิดขึ้นตามลําดับที่เจาะจงเพื่อให้ผู้ใช้เป็นสมาชิกของกลุ่มเป้าหมาย |
AudienceSimpleFilter
กําหนดตัวกรองแบบง่ายที่ผู้ใช้ต้องมีคุณสมบัติตรงตามจึงจะถือเป็นสมาชิกของกลุ่มเป้าหมาย
การแสดง JSON |
---|
{ "scope": enum ( |
ช่อง | |
---|---|
scope |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ระบุขอบเขตสําหรับตัวกรองนี้ |
filter |
ต้องระบุ เปลี่ยนแปลงไม่ได้ นิพจน์เชิงตรรกะของมิติข้อมูลกลุ่มเป้าหมาย เมตริก หรือตัวกรองเหตุการณ์ |
AudienceFilterScope
ระบุวิธีประเมินผู้ใช้เพื่อเข้าร่วมกลุ่มเป้าหมาย
Enum | |
---|---|
AUDIENCE_FILTER_SCOPE_UNSPECIFIED |
ไม่ได้ระบุขอบเขต |
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT |
ผู้ใช้เข้าร่วมกลุ่มเป้าหมายหากเป็นไปตามเงื่อนไขตัวกรองภายในเหตุการณ์เดียว |
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION |
ผู้ใช้เข้าร่วมกลุ่มเป้าหมายหากเป็นไปตามเงื่อนไขตัวกรองภายในเซสชันเดียว |
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS |
ผู้ใช้จะเข้าร่วมกลุ่มเป้าหมายหากเหตุการณ์ใดก็ตามในเซสชันใดก็ตามตรงกับเงื่อนไขตัวกรอง |
AudienceFilterExpression
นิพจน์เชิงตรรกะของมิติข้อมูลกลุ่มเป้าหมาย เมตริก หรือตัวกรองเหตุการณ์
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ expr นิพจน์ที่ใช้กับตัวกรอง expr ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
and |
รายการนิพจน์ที่จะใช้ AND ร่วมกัน โดยจะมีได้เฉพาะ AudienceFilterExpressions ที่มี orGroup เท่านั้น ต้องตั้งค่านี้สําหรับ AudienceFilterExpression ระดับบนสุด |
or |
รายการนิพจน์ที่จะใช้ OR ร่วมกัน โดยต้องไม่มี AudienceFilterExpressions ที่มี andGroup หรือ orGroup |
not |
นิพจน์ตัวกรองที่จะใส่เครื่องหมาย "NOT" (เช่น กลับค่า เติมเต็ม) โดยจะมีได้เฉพาะ dimensionOrMetricFilter เท่านั้น ตั้งค่านี้ใน AudienceFilterExpression ระดับบนสุดไม่ได้ |
dimension |
ตัวกรองมิติข้อมูลหรือเมตริกรายการเดียว ตั้งค่านี้ใน AudienceFilterExpression ระดับบนสุดไม่ได้ |
event |
สร้างตัวกรองที่ตรงกับเหตุการณ์ที่เฉพาะเจาะจง ตั้งค่านี้ใน AudienceFilterExpression ระดับบนสุดไม่ได้ |
AudienceFilterExpressionList
รายการนิพจน์ตัวกรองกลุ่มเป้าหมาย
การแสดง JSON |
---|
{
"filterExpressions": [
{
object ( |
ช่อง | |
---|---|
filter |
รายการนิพจน์ตัวกรองกลุ่มเป้าหมาย |
AudienceDimensionOrMetricFilter
ตัวกรองที่เฉพาะเจาะจงสําหรับมิติข้อมูลหรือเมตริกเดียว
การแสดง JSON |
---|
{ "fieldName": string, "atAnyPointInTime": boolean, "inAnyNDayPeriod": integer, // Union field |
ช่อง | |
---|---|
field |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อมิติข้อมูลหรือชื่อเมตริกที่จะกรอง หากชื่อช่องหมายถึงมิติข้อมูลหรือเมตริกที่กําหนดเอง ระบบจะเพิ่มคำนำหน้าขอบเขตไว้ที่ด้านหน้าชื่อมิติข้อมูลหรือเมตริกที่กําหนดเอง ดูข้อมูลเพิ่มเติมเกี่ยวกับคำนำหน้าขอบเขตหรือมิติข้อมูล/เมตริกที่กําหนดเองได้ที่เอกสารประกอบของ Google Analytics Data API |
at |
ไม่บังคับ ระบุว่าตัวกรองนี้จำเป็นต้องมีการประเมินแบบไดนามิกหรือไม่ หากตั้งค่าเป็น "จริง" ผู้ใช้จะเข้าร่วมกลุ่มเป้าหมายหากเคยมีคุณสมบัติตรงตามเงื่อนไข (การประเมินแบบคงที่) หากไม่ได้ตั้งค่าหรือตั้งค่าเป็น "เท็จ" การประเมินผู้ใช้สําหรับกลุ่มเป้าหมายจะเป็นแบบไดนามิก กล่าวคือระบบจะรวมเอาผู้ใช้ที่มีคุณสมบัติตรงกับเงื่อนไขเข้าไปด้วย และเมื่อใดก็ตามที่ผู้ใช้ดังกล่าวมีคุณสมบัติไม่เข้าเงื่อนไข ระบบก็จะนำออกจากกลุ่มเป้าหมาย คุณจะตั้งค่านี้ได้ก็ต่อเมื่อขอบเขตกลุ่มเป้าหมายเป็น ACROSS_ALL_SESSIONS เท่านั้น |
in |
ไม่บังคับ หากตั้งค่าไว้ จะระบุกรอบเวลาในการประเมินข้อมูลเป็นจํานวนวัน หากไม่ได้ตั้งค่า ระบบจะประเมินข้อมูลกลุ่มเป้าหมายเทียบกับข้อมูลตลอดอายุการใช้งาน (เช่น กรอบเวลาแบบไม่จำกัด) เช่น หากตั้งค่าเป็น 1 วัน ระบบจะประเมินเฉพาะข้อมูลของวันปัจจุบัน จุดอ้างอิงคือวันปัจจุบันเมื่อไม่ได้ตั้งค่า atAnyPointInTime หรือเป็นเท็จ โดยจะตั้งค่าได้ก็ต่อเมื่อขอบเขตกลุ่มเป้าหมายเป็น ACROSS_ALL_SESSIONS และจะต้องไม่เกิน 60 วัน |
ฟิลด์สหภาพ one_filter ตัวกรองอย่างใดอย่างหนึ่งข้างต้น one_filter ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
string |
ตัวกรองสําหรับมิติข้อมูลประเภทสตริงที่ตรงกับรูปแบบหนึ่งๆ |
in |
ตัวกรองสําหรับมิติข้อมูลสตริงที่ตรงกับรายการตัวเลือกที่เฉพาะเจาะจง |
numeric |
ตัวกรองสําหรับค่าตัวเลขหรือวันที่ในมิติข้อมูลหรือเมตริก |
between |
ตัวกรองสำหรับค่าตัวเลขหรือวันที่ระหว่างค่าที่ระบุในมิติข้อมูลหรือเมตริก |
StringFilter
ตัวกรองสําหรับมิติข้อมูลประเภทสตริงที่ตรงกับรูปแบบหนึ่งๆ
การแสดง JSON |
---|
{
"matchType": enum ( |
ช่อง | |
---|---|
match |
ต้องระบุ ประเภทการทำงานของตัวกรองสตริง |
value |
ต้องระบุ ค่าสตริงที่จะจับคู่ |
case |
ไม่บังคับ หากเป็น "จริง" การจับคู่จะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากเป็นเท็จ การจับคู่จะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ |
MatchType
ประเภทการทำงานของตัวกรองสตริง
Enum | |
---|---|
MATCH_TYPE_UNSPECIFIED |
ไม่ระบุ |
EXACT |
การทำงานแบบตรงทั้งหมดของค่าสตริง |
BEGINS_WITH |
ขึ้นต้นด้วยค่าสตริง |
ENDS_WITH |
ลงท้ายด้วยค่าสตริง |
CONTAINS |
มีค่าสตริง |
FULL_REGEXP |
นิพจน์ทั่วไปตรงกับค่าสตริงทั้งหมด |
InListFilter
ตัวกรองสําหรับมิติข้อมูลสตริงที่ตรงกับรายการตัวเลือกที่เฉพาะเจาะจง
การแสดง JSON |
---|
{ "values": [ string ], "caseSensitive": boolean } |
ช่อง | |
---|---|
values[] |
ต้องระบุ รายการค่าสตริงที่เป็นไปได้ที่จะจับคู่ ต้องระบุข้อมูล |
case |
ไม่บังคับ หากเป็น "จริง" การจับคู่จะคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากเป็นเท็จ การจับคู่จะไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ |
NumericFilter
ตัวกรองสําหรับค่าตัวเลขหรือวันที่ในมิติข้อมูลหรือเมตริก
การแสดง JSON |
---|
{ "operation": enum ( |
ช่อง | |
---|---|
operation |
ต้องระบุ การดำเนินการที่ใช้กับตัวกรองตัวเลข |
value |
ต้องระบุ ค่าตัวเลขหรือวันที่ที่จะจับคู่ |
การดำเนินการ
การดำเนินการที่ใช้กับตัวกรองตัวเลข
Enum | |
---|---|
OPERATION_UNSPECIFIED |
ไม่ระบุ |
EQUAL |
เท่ากับ |
LESS_THAN |
น้อยกว่า |
GREATER_THAN |
มากกว่า |
NumericValue
เพื่อแสดงตัวเลข
การแสดง JSON |
---|
{ // Union field |
ช่อง | |
---|---|
ฟิลด์สหภาพ one_value ค่าตัวเลข one_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น |
|
int64 |
ค่าจำนวนเต็ม |
double |
ค่า Double |
BetweenFilter
ตัวกรองสำหรับค่าตัวเลขหรือวันที่ระหว่างค่าที่ระบุในมิติข้อมูลหรือเมตริก
การแสดง JSON |
---|
{ "fromValue": { object ( |
ช่อง | |
---|---|
from |
ต้องระบุ ขึ้นต้นด้วยตัวเลขนี้โดยรวม |
to |
ต้องระบุ ลงท้ายด้วยหมายเลขนี้ |
AudienceEventFilter
ตัวกรองที่จับคู่เหตุการณ์ที่มีชื่อเหตุการณ์เดียว หากระบุพารามิเตอร์เหตุการณ์ เฉพาะเหตุการณ์ย่อยที่ตรงกับทั้งชื่อเหตุการณ์เดียวและนิพจน์ตัวกรองพารามิเตอร์เท่านั้นที่จะตรงกับตัวกรองเหตุการณ์นี้
การแสดง JSON |
---|
{
"eventName": string,
"eventParameterFilterExpression": {
object ( |
ช่อง | |
---|---|
event |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ชื่อเหตุการณ์ที่จะจับคู่ |
event |
ไม่บังคับ หากระบุไว้ ตัวกรองนี้จะจับคู่เหตุการณ์ที่ตรงกับทั้งชื่อเหตุการณ์เดียวและนิพจน์ตัวกรองพารามิเตอร์ ตั้งค่า AudienceEventFilter ภายในนิพจน์ตัวกรองพารามิเตอร์ไม่ได้ (เช่น ระบบไม่รองรับตัวกรองเหตุการณ์ที่ซ้อนกัน) รายการนี้ควรเป็น andGroup รายการเดียวของ dimensionOrMetricFilter หรือ notExpression ระบบไม่รองรับ AND ของ OR นอกจากนี้ หากมีตัวกรองสําหรับ "eventCount" ระบบจะพิจารณาเฉพาะตัวกรองนั้นและละเว้นตัวกรองอื่นๆ ทั้งหมด |
AudienceSequenceFilter
กำหนดตัวกรองที่ต้องเกิดขึ้นตามลําดับที่เฉพาะเจาะจงเพื่อให้ผู้ใช้เป็นสมาชิกของกลุ่มเป้าหมาย
การแสดง JSON |
---|
{ "scope": enum ( |
ช่อง | |
---|---|
scope |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ระบุขอบเขตสําหรับตัวกรองนี้ |
sequence |
ไม่บังคับ กําหนดระยะเวลาที่ทั้งลําดับเหตุการณ์ต้องเกิดขึ้น ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย |
sequence |
ต้องระบุ ลำดับขั้นตอนที่เรียงตามลําดับ ผู้ใช้ต้องทําแต่ละขั้นตอนให้เสร็จสมบูรณ์จึงจะเข้าร่วมตัวกรองลําดับได้ |
AudienceSequenceStep
เงื่อนไขที่ต้องเกิดขึ้นตามลําดับขั้นตอนที่ระบุเพื่อให้ผู้ใช้รายนี้ตรงกับลําดับ
การแสดง JSON |
---|
{ "scope": enum ( |
ช่อง | |
---|---|
scope |
ต้องระบุ เปลี่ยนแปลงไม่ได้ ระบุขอบเขตสําหรับขั้นตอนนี้ |
immediately |
ไม่บังคับ หากเป็น "จริง" เหตุการณ์ที่ตรงกับขั้นตอนนี้ต้องเป็นเหตุการณ์ถัดไปหลังจากเหตุการณ์ที่ตรงกับขั้นตอนสุดท้าย หากไม่ได้ตั้งค่าไว้หรือเป็นเท็จ ขั้นตอนนี้จะไม่ได้เกิดขึ้นต่อทันทีจากขั้นตอนก่อนหน้า เช่น อาจมีเหตุการณ์เกิดขึ้นระหว่างขั้นตอนก่อนหน้ากับขั้นตอนนี้ ระบบจะละเว้นค่านี้ในขั้นตอนแรก |
constraint |
ไม่บังคับ เมื่อตั้งค่าแล้ว ขั้นตอนนี้ต้องเป็นไปตาม constraintDuration ของขั้นตอนก่อนหน้า (เช่น t[i] - t[i-1] <= constraintDuration) หากไม่ได้ตั้งค่า ระบบจะไม่กำหนดระยะเวลา (ระยะเวลาจะถือว่าไม่มีขีดจำกัด) ระบบจะละเว้นค่านี้ในขั้นตอนแรก ระยะเวลาเป็นวินาทีที่มีเศษทศนิยมได้สูงสุด 9 หลัก โดยลงท้ายด้วย |
filter |
ต้องระบุ เปลี่ยนแปลงไม่ได้ นิพจน์เชิงตรรกะของมิติข้อมูลกลุ่มเป้าหมาย เมตริก หรือตัวกรองเหตุการณ์ในแต่ละขั้นตอน |
AudienceClauseType
ระบุว่าเป็นเงื่อนไขตัวกรองแบบรวมหรือยกเว้น
Enum | |
---|---|
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED |
ประเภทประโยคที่ไม่ได้ระบุ |
INCLUDE |
ระบบจะรวมผู้ใช้ไว้ในกลุ่มเป้าหมายหากเป็นไปตามเงื่อนไขตัวกรอง |
EXCLUDE |
ระบบจะยกเว้นผู้ใช้ออกจากกลุ่มเป้าหมายหากเป็นไปตามเงื่อนไขตัวกรอง |
เมธอด |
|
---|---|
|
เก็บกลุ่มเป้าหมายในพร็อพเพอร์ตี้ |
|
สร้างกลุ่มเป้าหมาย |
|
ค้นหากลุ่มเป้าหมายเดียว |
|
แสดงรายการกลุ่มเป้าหมายในพร็อพเพอร์ตี้ |
|
อัปเดตกลุ่มเป้าหมายในพร็อพเพอร์ตี้ |