REST Resource: properties.audiences

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

Thông báo về tài nguyên đại diện cho Đố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)
    }
  ]
}
Trường
name

string

Chỉ có đầu ra. Tên tài nguyên cho tài nguyên Đố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. Không thể thay đổi. Khoảng thời gian mà một người dùng sẽ lưu lại trong Đối tượng. Bạn không thể đặt phạm vi ngày thành hơn 540 ngày.
adsPersonalizationEnabled

boolean

Chỉ có đầu ra. GA sẽ tự động đặt giá trị này thành false nếu đây là Đố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 nhật ký khi người dùng tham gia Đối tượng. Nếu bạn không đặt chính sách này, thì sẽ không có sự kiện nào được ghi lại khi người dùng tham gia Đối tượng.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

Không thể thay đổi. Chỉ định khoảng thời gian áp dụng một tiêu chí loại trừ đối với những người dùng đáp ứng bộ lọc loại trừ. Thuộc tính này được áp dụng cho mọi mệnh đề của 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. Không thể thay đổi. Danh sách không theo thứ tự. Lọc các mệnh đề xác định Đối tượng. Tất cả các mệnh đề sẽ được kết hợp với nhau.

AudienceEventTrigger

Chỉ định một sự kiện để ghi nhật ký 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 lại sự kiện.

LogCondition

Xác định thời điểm ghi lại sự kiện.

Enum
LOG_CONDITION_UNSPECIFIED Điều kiện nhật ký chưa được chỉ định.
AUDIENCE_JOINED Sự kiện này chỉ được ghi lại khi có người dùng tham gia.
AUDIENCE_MEMBERSHIP_RENEWED Sự kiện này phải được ghi lại bất cứ khi nào điều kiện Đối tượng được đáp ứ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 một tiêu chí loại trừ đối với 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 điều khoản lọc.

AudienceFilterClause

Mệnh đề để xác định một bộ lọc đơn giản hoặc bộ lọc trình tự. Bộ lọc có thể là bộ lọc 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 hợp filter.

filter chỉ có thể là một trong những trạng thái sau:
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 xuất hiện 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. Không thể thay đổi. Chỉ định phạm vi cho bộ lọc này.
filterExpression

object (AudienceFilterExpression)

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

AudienceFilterScope

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

Enum
AUDIENCE_FILTER_SCOPE_UNSPECIFIED Phạm vi chưa được chỉ định.
AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT Người dùng 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 tham gia Đối tượng nếu đáp ứng điều kiện lọc trong một phiên.
AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS Người dùng tham gia Đối tượng nếu sự kiện bất kỳ trong phiên hoạt động đáp ứng điều kiện lọc.

AudienceFilterExpression

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

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 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:
andGroup

object (AudienceFilterExpressionList)

Danh sách các biểu thức sẽ được kết hợp với nhau. Nhóm này chỉ có thể chứa AudienceFilterExpressions có orGroup. Bạn phải đặt thuộc tính này cho AudienceFilterExpression cấp cao nhất.
orGroup

object (AudienceFilterExpressionList)

Danh sách các biểu thức tương ứng với OR. Vùng chứa không được chứa AudienceFilterExpressions với andGroup hoặc orGroup.
notExpression

object (AudienceFilterExpression)

Một biểu thức bộ lọc không được dùng (Ví dụ: đảo ngược, bổ sung). Bộ lọc chỉ có thể bao gồmdimensionOrMetricFilter. Không thể đặt tuỳ chọn này ở cấp cao nhất AudienceFilterExpression.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

Bộ lọc theo một phương diện hoặc chỉ số. Không thể đặt tuỳ chọn này ở cấp cao nhất AudienceFilterExpression.
eventFilter

object (AudienceEventFilter)

Tạo bộ lọc khớp với một sự kiện cụ thể. Không thể đặt tuỳ chọn này ở cấp cao nhất AudienceFilterExpression.

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ố.

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. Không thể thay đổi. 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 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á người dùng cho một Đối tượng sẽ diễn ra tự độ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ế độ này khi phạm vi Đối tượng là ACROSS_ALL_SESSIONS.
inAnyNDayPeriod

integer

Không bắt buộc. Nếu bạn đặ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 về đối tượng sẽ được đánh giá dựa trên dữ liệu vòng đời (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 không đượ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 lớn hơn 60 ngày.
Trường 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:
stringFilter

object (StringFilter)

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

object (InListFilter)

Bộ lọc cho phương diện chuỗi khớp với danh sách tuỳ 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 các giá trị số hoặc ngày giữa các giá trị nhất định của một phương diện hoặc chỉ số.

StringFilter

Bộ lọc cho phương diện kiểu 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. Kiểu khớp cho bộ lọc chuỗi.
value

string

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

boolean

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

MatchType

Kiểu khớp cho bộ lọc chuỗi.

Enum
MATCH_TYPE_UNSPECIFIED Không xác định
EXACT Khớp chính xác 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 phương diện chuỗi khớp với danh sách tuỳ 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ể khớp. Không được để trống.
caseSensitive

boolean

Không bắt buộc. Nếu đúng, kết quả trùng khớp có phân biệt chữ hoa chữ thường. Nếu sai, kết quả trùng khớp sẽ 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 để 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 Nhỏ 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 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:
int64Value

string (int64 format)

Giá trị số nguyên.
doubleValue

number

Nhân đôi giá trị.

BetweenFilter

Bộ lọc các giá trị số hoặc ngày giữa các giá trị nhất định của 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, toàn bộ.
toValue

object (NumericValue)

Bắt buộc. Kết thúc bằng số này (bao gồm cả số này).

AudienceEventFilter

Bộ lọc so khớp các sự kiện thuộc 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 đơn lẻ 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. Không thể thay đổi. Tên của sự kiện để so khớp.
eventParameterFilterExpression

object (AudienceFilterExpression)

Không bắt buộc. Nếu được chỉ định, bộ lọc này sẽ so khớp những sự kiện khớp với cả tên sự kiện đơn lẻ và biểu thức lọc thông số. Bạn không thể đặt AudienceEventFilter bên trong biểu thức lọc thông số (Ví dụ: các 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; VÀ của các OR không được hỗ trợ. Ngoài ra, nếu bộ lọc này bao gồm một bộ lọc cho "eventCount", thì chỉ có bộ lọc đó được xem xét; 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 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. Không thể thay đổi. 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ố thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
sequenceSteps[]

object (AudienceSequenceStep)

Bắt buộc. Một trình tự các bước theo thứ tự. Người dùng phải hoàn thành 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 đã 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. Không thể thay đổi. Chỉ định phạm vi cho bước này.
immediatelyFollows

boolean

Không bắt buộc. Nếu đúng, sự kiện đáp ứng 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 không đặt hoặc đặt thành false (sai), bước này sẽ gián tiếp tuân theo bước trước đó; ví dụ: có thể có cá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 cancelDuration của bước trước (ví dụ: t[i] - t[i-1] <==bindingDuration). Nếu bạn không đặt chính sách này, thì 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ố thập phân, kết thúc bằng "s". Ví dụ: "3.5s".
filterExpression

object (AudienceFilterExpression)

Bắt buộc. Không thể thay đổi. Biểu thức logic của các bộ lọc phương diện Đối tượng, chỉ số hoặc sự kiện 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 đề chưa chỉ định.
INCLUDE Người dùng sẽ được đưa vào Đối tượng nếu đáp ứng mệnh đề bộ lọc.
EXCLUDE Người dùng sẽ bị loại trừ khỏi Đối tượng nếu đáp ứng mệnh đề bộ lọc.

Phương thức

archive

 Lưu trữ Đối tượng trên một thuộc tính.

create

 Tạo Đối tượng.

get

 Tìm một Đối tượng.

list

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

patch

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