REST Resource: properties.audiences

Tài nguyên: Đối tượng

Thông báo tài nguyên đại diện cho một Đối tượng GA4.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên cho tài nguyên về Đối tượng này. Định dạng: thuộc tính/{propertyId}/audiences/{audienceId}
displayName

string

Bắt buộc. Tên hiển thị của Đối tượng.
description

string

Bắt buộc. Nội dung mô tả về Đối tượng.
membershipDurationDays

integer

Bắt buộc. Bất biến. Khoảng thời gian mà một người dùng thuộc Đối tượng. Bạn không được đặt khoảng thời gian này quá 540 ngày.
adsPersonalizationEnabled

boolean

Chỉ có đầu ra. Giá trị này sẽ tự động được GA đặt thành false nếu đây là một Đối tượng quảng cáo không được cá nhân hoá và bị loại trừ khỏi hoạt động cá nhân hoá quảng cáo.
eventTrigger

object (AudienceEventTrigger)

Không bắt buộc. Chỉ định một sự kiện để ghi lại khi người dùng tham gia Đối tượng. Nếu bạn không đặt chính sách này, thì hệ thống sẽ không ghi lại sự kiện nào khi người dùng tham gia Đối tượng.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Bất biến. Chỉ định khoảng thời gian áp dụng quy tắc loại trừ cho những người dùng đáp ứng bộ lọc loại trừ. Bộ lọc này được áp dụng cho tất cả mệnh đề bộ lọc EXCLUDE và bị bỏ qua khi không có mệnh đề bộ lọc EXCLUDE trong Đối tượng.
filterClauses[]

object (AudienceFilterClause)

Bắt buộc. Bất biến. Danh sách không theo thứ tự. Lọc các mệnh đề xác định Đối tượng. Tất cả mệnh đề sẽ kết hợp với nhau.
createTime

string (Timestamp format)

Chỉ có đầu ra. Thời điểm tạo Đối tượng.

Dấu thời gian theo múi giờ "Zulu" RFC3339 (giờ UTC) với độ phân giải nano giây và lên đến 9 chữ số phân số. Ví dụ: "2014-10-02T15:01:23Z" và "2014-10-02T15:01:23.045123456Z".

AudienceEventTrigger

Chỉ định một sự kiện để ghi lại khi người dùng tham gia Đối tượng.

Biểu diễn dưới dạng JSON 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
Trường
eventName

string

Bắt buộc. Tên sự kiện sẽ được ghi lại.
logCondition

enum (LogCondition)

Bắt buộc. Thời điểm ghi nhật ký sự kiện.

LogCondition

Xác định thời điểm ghi nhật ký sự kiện.

Enum
LOG_CONDITION_UNSPECIFIED Điều kiện nhật ký chưa được chỉ định.
AUDIENCE_JOINED Sự kiện chỉ được ghi lại khi người dùng tham gia.
AUDIENCE_MEMBERSHIP_RENEWED Bạn phải ghi lại sự kiện này bất cứ khi nào đáp ứng Điều kiện về đối tượng, ngay cả khi người dùng đã là thành viên của Đối tượng đó.

AudienceExclusionDurationMode

Chỉ định khoảng thời gian áp dụng quy tắc loại trừ cho những người dùng đáp ứng bộ lọc loại trừ.

Enum
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED Chưa chỉ định.
EXCLUDE_TEMPORARILY Loại trừ người dùng khỏi Đối tượng trong các khoảng thời gian mà họ đáp ứng điều khoản bộ lọc.
EXCLUDE_PERMANENTLY Loại trừ người dùng khỏi Đối tượng nếu họ đã từng đáp ứng mệnh đề bộ lọc.

AudienceFilterClause

Mệnh đề để xác định bộ lọc đơn giản hoặc bộ lọc tuần tự. Một bộ lọc có thể là bao gồm (Ví dụ: người dùng đáp ứng điều khoản bộ lọc được đưa vào Đối tượng) hoặc loại trừ (Ví dụ: người dùng đáp ứng điều khoản bộ lọc sẽ bị loại trừ khỏi Đối tượng).

Biểu diễn dưới dạng JSON 
{
  "clauseType": enum (AudienceClauseType),

  // Union field filter can be only one of the following:
  "simpleFilter": {
    object (AudienceSimpleFilter)
  },
  "sequenceFilter": {
    object (AudienceSequenceFilter)
  }
  // End of list of possible types for union field filter.
}
Trường
clauseType

enum (AudienceClauseType)

Bắt buộc. Chỉ định xem đây là mệnh đề bộ lọc bao gồm hay loại trừ.

Trường kết hợp filter.

filter chỉ có thể là một trong những trạng thái sau đây:
simpleFilter

object (AudienceSimpleFilter)

Một bộ lọc đơn giản mà người dùng phải đáp ứng để trở thành thành viên của Đối tượng.
sequenceFilter

object (AudienceSequenceFilter)

Các bộ lọc phải xảy ra theo thứ tự cụ thể để người dùng trở thành thành viên của Đối tượng.

AudienceSimpleFilter

Xác định một bộ lọc đơn giản mà người dùng phải đáp ứng để trở thành thành viên của Đối tượng.

Biểu diễn dưới dạng JSON 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Trường
scope

enum (AudienceFilterScope)

Bắt buộc. Bất biến. Chỉ định phạm vi cho bộ lọc này.
filterExpression

object (AudienceFilterExpression)

Bắt buộc. Bất biến. Biểu thức logic của bộ lọc sự kiện, chỉ số hoặc phương diện Đối tượng.

AudienceFilterScope

Chỉ định cách đánh giá người dùng để tham gia Đối tượng.

Enum
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Phạm vi chưa được xác định.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Người dùng sẽ tham gia Đối tượng nếu đáp ứng điều kiện lọc trong một sự kiện.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION Người dùng sẽ tham gia Đối tượng nếu điều kiện lọc được đáp ứng trong một phiên.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Người dùng tham gia Đối tượng nếu điều kiện lọc được đáp ứng bởi bất kỳ sự kiện nào trong bất kỳ phiên nào.

AudienceFilterExpression

Biểu thức logic của bộ lọc sự kiện, chỉ số hoặc phương diện Đối tượng.

Biểu diễn dưới dạng JSON 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (AudienceFilterExpressionList)
  },
  "orGroup": {
    object (AudienceFilterExpressionList)
  },
  "notExpression": {
    object (AudienceFilterExpression)
  },
  "dimensionOrMetricFilter": {
    object (AudienceDimensionOrMetricFilter)
  },
  "eventFilter": {
    object (AudienceEventFilter)
  }
  // End of list of possible types for union field expr.
}
Trường
Trường kết hợp expr. Biểu thức được áp dụng cho một bộ lọc. expr chỉ có thể là một trong những trạng thái sau đây:
andGroup

object (AudienceFilterExpressionList)

Danh sách biểu thức cần kết hợp AND. Tệp này chỉ có thể chứa AudienceFilterExpressions có orGroup. Bạn phải đặt giá trị này cho AudienceFilterExpression cấp cao nhất.
orGroup

object (AudienceFilterExpressionList)

Danh sách biểu thức để kết hợp OR. Tệp này không được chứa AudienceFilterExpression với andGroup hoặc orGroup.
notExpression

object (AudienceFilterExpression)

Biểu thức bộ lọc KHÔNG được phép (Ví dụ: đảo ngược, bổ sung). Chỉ số này chỉ có thể bao gồm phương diệnOrMetricFilter. Bạn không thể đặt giá trị này ở cấp AudienceFilterExpression cấp cao nhất.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Bộ lọc trên một phương diện hoặc chỉ số duy nhất. Bạn không thể đặt giá trị này ở cấp AudienceFilterExpression cấp cao nhất.
eventFilter

object (AudienceEventFilter)

Tạo bộ lọc khớp với một sự kiện cụ thể. Bạn không thể đặt giá trị này ở cấp AudienceFilterExpression cấp cao nhất.

AudienceFilterExpressionList

Danh sách các biểu thức lọc Đối tượng.

Biểu diễn dưới dạng JSON 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
Trường
filterExpressions[]

object (AudienceFilterExpression)

Danh sách các biểu thức lọc Đối tượng.

AudienceDimensionOrMetricFilter

Bộ lọc cụ thể cho một phương diện hoặc chỉ số duy nhất.

Biểu diễn dưới dạng JSON 
{
  "fieldName": string,
  "atAnyPointInTime": boolean,
  "inAnyNDayPeriod": integer,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  }
  // End of list of possible types for union field one_filter.
}
Trường
fieldName

string

Bắt buộc. Bất biến. Tên phương diện hoặc tên chỉ số cần lọc. Nếu tên trường đề cập đến một phương diện hoặc chỉ số tuỳ chỉnh, thì tiền tố phạm vi sẽ được thêm vào phía trước tên phương diện hoặc chỉ số tuỳ chỉnh. Để biết thêm thông tin về tiền tố phạm vi hoặc phương diện/chỉ số tuỳ chỉnh, hãy tham khảo tài liệu về Google Analytics Data API.
atAnyPointInTime

boolean

Không bắt buộc. Cho biết bộ lọc này có cần đánh giá động hay không. Nếu bạn đặt chính sách này thành true, thì người dùng sẽ tham gia Đối tượng nếu họ đã từng đáp ứng điều kiện (phương thức đánh giá tĩnh). Nếu bạn không đặt hoặc đặt thành false, thì hoạt động đánh giá của người dùng cho một Đối tượng sẽ diễn ra linh động; người dùng được thêm vào Đối tượng khi đáp ứng các điều kiện và sau đó bị xoá khi không còn đáp ứng các điều kiện đó nữa.

Bạn chỉ có thể đặt chế độ cài đặt này khi phạm vi Đối tượng là ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Không bắt buộc. Nếu được đặt, hãy chỉ định khoảng thời gian đánh giá dữ liệu theo số ngày. Nếu bạn không đặt chính sách này, thì dữ liệu đối tượng sẽ được đánh giá dựa trên dữ liệu toàn thời gian (Ví dụ: khoảng thời gian vô hạn).

Ví dụ: nếu bạn đặt thành 1 ngày, thì chỉ có dữ liệu của ngày hiện tại mới được đánh giá. Điểm tham chiếu là ngày hiện tại khi atAnyPointInTime chưa được đặt hoặc có giá trị false.

Bạn chỉ có thể đặt phạm vi đối tượng khi phạm vi Đối tượng là ACROSS_ALL_SESSIONS và không được nhiều hơn 60 ngày.
Trường kết hợp one_filter. Một trong các bộ lọc ở trên. one_filter chỉ có thể là một trong những trạng thái sau đây:
stringFilter

object (StringFilter)

Bộ lọc cho phương diện loại chuỗi khớp với một mẫu cụ thể.
inListFilter

object (InListFilter)

Bộ lọc cho một phương diện chuỗi khớp với một danh sách lựa chọn cụ thể.
numericFilter

object (NumericFilter)

Bộ lọc cho các giá trị số hoặc ngày trên một phương diện hoặc chỉ số.
betweenFilter

object (BetweenFilter)

Bộ lọc cho các giá trị số hoặc ngày giữa các giá trị nhất định trên một phương diện hoặc chỉ số.

StringFilter

Bộ lọc cho phương diện loại chuỗi khớp với một mẫu cụ thể.

Biểu diễn dưới dạng JSON 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Trường
matchType

enum (MatchType)

Bắt buộc. Loại đối sánh cho bộ lọc chuỗi.
value

string

Bắt buộc. Giá trị chuỗi cần so khớp.
caseSensitive

boolean

Không bắt buộc. Nếu đúng, kết quả khớp có phân biệt chữ hoa chữ thường. Nếu sai, thì kết quả khớp không phân biệt chữ hoa chữ thường.

MatchType

Loại đối sánh cho bộ lọc chuỗi.

Enum
MATCH_TYPE_UNSPECIFIED Không xác định
EXACT Khớp chính xác của giá trị chuỗi.
BEGINS_WITH Bắt đầu bằng giá trị chuỗi.
ENDS_WITH Kết thúc bằng giá trị chuỗi.
CONTAINS Chứa giá trị chuỗi.
FULL_REGEXP Biểu thức chính quy đầy đủ khớp với giá trị chuỗi.

InListFilter

Bộ lọc cho một phương diện chuỗi khớp với một danh sách lựa chọn cụ thể.

Biểu diễn dưới dạng JSON 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Trường
values[]

string

Bắt buộc. Danh sách các giá trị chuỗi có thể dùng để so khớp. Không được để trống.
caseSensitive

boolean

Không bắt buộc. Nếu đúng, kết quả khớp có phân biệt chữ hoa chữ thường. Nếu sai, thì kết quả khớp không phân biệt chữ hoa chữ thường.

NumericFilter

Bộ lọc cho các giá trị số hoặc ngày trên một phương diện hoặc chỉ số.

Biểu diễn dưới dạng JSON 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Trường
operation

enum (Operation)

Bắt buộc. Toán tử được áp dụng cho bộ lọc số.
value

object (NumericValue)

Bắt buộc. Giá trị số hoặc ngày tháng để so khớp.

Hoạt động

Toán tử được áp dụng cho bộ lọc số.

Enum
OPERATION_UNSPECIFIED Không xác định.
EQUAL Bằng nhau.
LESS_THAN Ít hơn.
GREATER_THAN Lớn hơn.

NumericValue

Để biểu diễn một số.

Biểu diễn dưới dạng JSON 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Trường
Trường kết hợp one_value. Một trong các giá trị số. one_value chỉ có thể là một trong những trạng thái sau đây:
int64Value

string (int64 format)

Giá trị số nguyên.
doubleValue

number

Gấp đôi giá trị.

BetweenFilter

Bộ lọc cho các giá trị số hoặc ngày giữa các giá trị nhất định trên một phương diện hoặc chỉ số.

Biểu diễn dưới dạng JSON 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Trường
fromValue

object (NumericValue)

Bắt buộc. Bắt đầu bằng số này.
toValue

object (NumericValue)

Bắt buộc. Kết thúc bằng số này.

AudienceEventFilter

Bộ lọc so khớp các sự kiện của một tên sự kiện. Nếu bạn chỉ định một thông số sự kiện, thì chỉ một nhóm nhỏ sự kiện khớp với cả tên sự kiện và biểu thức lọc thông số mới khớp với bộ lọc sự kiện này.

Biểu diễn dưới dạng JSON 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
Trường
eventName

string

Bắt buộc. Bất biến. Tên của sự kiện cần so khớp.
eventParameterFilterExpression

object (AudienceFilterExpression)

Không bắt buộc. Nếu được chỉ định, bộ lọc này sẽ khớp với các sự kiện khớp với cả tên sự kiện và biểu thức lọc thông số. Không thể đặt AudienceEventFilter bên trong biểu thức bộ lọc thông số (Ví dụ: bộ lọc sự kiện lồng nhau không được hỗ trợ). Đây phải là một andGroup ofdimensionOrMetricFilter hoặc notExpression; Không hỗ trợ toán tử AND (VÀ) cho OR. Ngoài ra, nếu bộ lọc này có chứa "eventCount" thì chỉ có bộ lọc đó mới được xem xét; thì tất cả các bộ lọc khác sẽ bị bỏ qua.

AudienceSequenceFilter

Xác định các bộ lọc phải diễn ra theo thứ tự cụ thể để người dùng trở thành thành viên của Đối tượng.

Biểu diễn dưới dạng JSON 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
Trường
scope

enum (AudienceFilterScope)

Bắt buộc. Bất biến. Chỉ định phạm vi cho bộ lọc này.
sequenceMaximumDuration

string (Duration format)

Không bắt buộc. Xác định khoảng thời gian mà toàn bộ trình tự phải xảy ra.

Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng "s". Ví dụ: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Bắt buộc. Trình tự các bước theo thứ tự. Người dùng phải hoàn tất từng bước để tham gia bộ lọc trình tự.

AudienceSequenceStep

Một điều kiện phải xảy ra theo thứ tự bước được chỉ định để người dùng này khớp với trình tự.

Biểu diễn dưới dạng JSON 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
Trường
scope

enum (AudienceFilterScope)

Bắt buộc. Bất biến. Chỉ định phạm vi cho bước này.
immediatelyFollows

boolean

Không bắt buộc. Nếu đúng, sự kiện thoả mãn bước này phải là sự kiện tiếp theo sau sự kiện đáp ứng bước cuối cùng. Nếu bạn đặt chính sách này thành sai hoặc không đặt, thì bước này gián tiếp đứng sau bước trước đó; ví dụ: có thể có sự kiện giữa bước trước đó và bước này. Thuộc tính này sẽ bị bỏ qua trong bước đầu tiên.
constraintDuration

string (Duration format)

Không bắt buộc. Khi thiết lập, bước này phải được đáp ứng trong giới hạn limitedDuration của bước trước (Ví dụ: t[i] – t[i-1] <= ConstrainttDuration). Nếu bạn không đặt chính sách này thì sẽ không có yêu cầu về thời lượng (thời lượng thực sự là không giới hạn). Thuộc tính này sẽ bị bỏ qua trong bước đầu tiên.

Thời lượng tính bằng giây với tối đa 9 chữ số phân số, kết thúc bằng "s". Ví dụ: "3.5s".
filterExpression

object (AudienceFilterExpression)

Bắt buộc. Bất biến. Biểu thức logic của bộ lọc sự kiện, chỉ số hoặc phương diện Đối tượng trong mỗi bước.

AudienceClauseType

Chỉ định xem đây là mệnh đề bộ lọc bao gồm hay loại trừ.

Enum
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED Loại mệnh đề không xác định.
INCLUDE Người dùng sẽ được đưa vào Đối tượng nếu điều khoản bộ lọc được đáp ứng.
EXCLUDE Người dùng sẽ bị loại trừ khỏi Đối tượng nếu đáp ứng điều khoản bộ lọc.

Phương thức

archive

 Lưu trữ Đối tượng trên một tài sản.

create

 Tạo Đối tượng.

get

 Tìm kiếm một Đối tượng duy nhất.

list

 Liệt kê các đối tượng trên một tài sản.

patch

 Cập nhật Đối tượng trên một tài sản.