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.

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 Đối tượng này. Định dạng: properties/{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 người dùng sẽ ở trong một Đối tượng. Bạn không thể đặt giá trị nà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 NPA và bị loại trừ khỏi tính nă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 giá trị này, 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)

Không thể thay đổi. Chỉ định thời lượng của tiêu chí loại trừ đối với những người dùng đáp ứng bộ lọc loại trừ. Giá trị 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 nào trong Đối tượng.
filterClauses[]

object (AudienceFilterClause)

Bắt buộc. Không thể thay đổi. Danh sách không theo thứ tự. Các mệnh đề bộ lọc xác định Đối tượng. Tất cả mệnh đề sẽ được liên kết với nhau.
createTime

string (Timestamp format)

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

Sử dụng RFC 3339, trong đó đầu ra được tạo sẽ luôn được chuẩn hoá theo Z và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các độ dời khác "Z" cũng được chấp nhận.Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".

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 lại sự kiện.

LogCondition

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

Enum
LOG_CONDITION_UNSPECIFIED Chưa chỉ định điều kiện nhật ký.
AUDIENCE_JOINED Sự kiện chỉ được ghi lại khi người dùng tham gia.
AUDIENCE_MEMBERSHIP_RENEWED Sự kiện phải được ghi lại bất cứ khi nào điều kiện về Đố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 thời lượng của 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 mệnh đề 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ột mệnh đề để xác định bộ lọc đơn giản hoặc bộ lọc trình tự. Bộ lọc có thể bao gồm (Ví dụ: những người dùng đáp ứng mệnh đề bộ lọc sẽ được đưa vào Đối tượng) hoặc loại trừ (Ví dụ: những người dùng đáp ứng mệnh đề 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 hợp nhất filter.

filter chỉ có thể là một trong những giá trị 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)

Bộ lọc phải xảy ra theo một 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 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 một Đối tượng.

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

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 hợp hợp nhất 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 giá trị sau:
andGroup

object (AudienceFilterExpressionList)

Danh sách các biểu thức sẽ được nối với nhau bằng toán tử AND. Nó chỉ có thể chứa AudienceFilterExpressions với orGroup. Bạn phải đặt giá trị này cho AudienceFilterExpression cấp cao nhất.
orGroup

object (AudienceFilterExpressionList)

Danh sách các biểu thức để OR với nhau. Biểu thức này không được chứa AudienceFilterExpressions có andGroup hoặc orGroup.
notExpression

object (AudienceFilterExpression)

Biểu thức bộ lọc cần được phủ định (Ví dụ: đảo ngược, bổ sung). Phương diện này chỉ có thể chứa một dimensionOrMetricFilter. Bạn không thể đặt giá trị này trên AudienceFilterExpression cấp cao nhất.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

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

object (AudienceEventFilter)

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

AudienceFilterExpressionList

Danh sách biểu thức bộ 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 biểu thức bộ lọc Đối tượng.

AudienceDimensionOrMetricFilter

Một 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ố để 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ì hệ thống sẽ thêm một tiền tố phạm vi vào đầu phương diện hoặc tên 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ề API Dữ liệu Google Analytics.
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 giá trị 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 giá trị 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 giá trị này, thì dữ liệu về đối tượng sẽ được đánh giá dựa trên dữ liệu trong suốt thời gian hoạt động (ví dụ: khung thời gian vô hạn).

Ví dụ: nếu bạn đặt thành 1 ngày, thì chỉ 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 là false.

Bạn chỉ có thể đặt giá trị này 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 hợp nhất one_filter. Một trong các bộ lọc ở trên. one_filter chỉ có thể là một trong những giá trị sau:
stringFilter

object (StringFilter)

Bộ lọc cho một phương diện thuộc 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 tuỳ chọn cụ thể.
numericFilter

object (NumericFilter)

Bộ lọc cho 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 nằm giữa một số giá trị nhất định trên một phương diện hoặc chỉ số.

StringFilter

Bộ lọc cho một phương diện thuộc 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. Kiểu khớp 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 là true, kết quả so khớp sẽ phân biệt chữ hoa chữ thường. Nếu giá trị là false, thì kết quả so 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 với 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 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ể so khớp. Không được để trống.
caseSensitive

boolean

Không bắt buộc. Nếu là true, kết quả so khớp sẽ phân biệt chữ hoa chữ thường. Nếu giá trị là false, thì kết quả so khớp sẽ không phân biệt chữ hoa chữ thường.

NumericFilter

Bộ lọc cho 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. Thao tác áp dụng cho bộ lọc số.
value

object (NumericValue)

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

Hoạt động

Thao tác áp dụng cho bộ lọc số.

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

NumericValue

Để biểu thị 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 hợp nhất one_value. Một trong các giá trị dạng số. one_value chỉ có thể là một trong những giá trị sau:
int64Value

string (int64 format)

Giá trị số nguyên.
doubleValue

number

Giá trị kép.

BetweenFilter

Bộ lọc cho các giá trị số hoặc ngày nằm giữa một số 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, bao gồm cả số này.
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 khớp với 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 tập hợp con sự kiện khớp với cả tên sự kiện đơn lẻ và biểu thức bộ 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 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ẽ so khớp các sự kiện khớp với cả tên sự kiện đơn và biểu thức bộ lọc thông số. Bạn không thể đặt AudienceEventFilter bên trong biểu thức bộ lọc thông số (Ví dụ: không hỗ trợ bộ lọc sự kiện lồng nhau). Đây phải là một andGroup duy nhất của dimensionOrMetricFilter hoặc notExpression; AND của 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ỉ bộ lọc đó mới được xem xét; tất cả bộ lọc khác sẽ bị bỏ qua.

AudienceSequenceFilter

Xác định các bộ lọc phải xảy ra theo một 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, có 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 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 đã 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 giá trị hoặc đặt giá trị là false, thì bước này sẽ gián tiếp theo sau 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. Bước đầu tiên sẽ bỏ qua giá trị này.
constraintDuration

string (Duration format)

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

Thời lượng tính bằng giây, có 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 phương diện Đối tượng, chỉ số hoặc bộ lọ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 đề không xác đị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ữ một Đố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.

list

 Liệt kê Đố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.