REST Resource: properties.audiences

리소스: 잠재고객

GA4 잠재고객을 나타내는 리소스 메시지입니다.

JSON 표현 
{
  "name": string,
  "displayName": string,
  "description": string,
  "membershipDurationDays": integer,
  "adsPersonalizationEnabled": boolean,
  "eventTrigger": {
    object (AudienceEventTrigger)
  },
  "exclusionDurationMode": enum (AudienceExclusionDurationMode),
  "filterClauses": [
    {
      object (AudienceFilterClause)
    }
  ],
  "createTime": string
}
필드
name

string

출력 전용입니다. 이 잠재고객 리소스의 리소스 이름입니다. 형식: property/{propertyId}/audiences/{audienceId}
displayName

string

필수 항목입니다. 잠재고객의 표시 이름입니다.
description

string

필수 항목입니다. 잠재고객에 대한 설명입니다.
membershipDurationDays

integer

필수 항목입니다. 변경할 수 없습니다. 사용자가 잠재고객에 머물러야 하는 기간입니다. 540일을 초과할 수 없습니다.
adsPersonalizationEnabled

boolean

출력 전용입니다. NPA 잠재고객이며 광고 개인 최적화에서 제외된 경우 GA에서 자동으로 false로 설정됩니다.
eventTrigger

object (AudienceEventTrigger)

선택사항입니다. 사용자가 잠재고객에 참여할 때 로깅할 이벤트를 지정합니다. 설정하지 않으면 사용자가 잠재고객에 참여할 때 이벤트가 기록되지 않습니다.
exclusionDurationMode

enum (AudienceExclusionDurationMode)

변경할 수 없습니다. 제외 필터를 충족하는 사용자의 제외 지속 기간을 지정합니다. 모든 EXCLUDE 필터 절에 적용되며 잠재고객에 EXCLUDE 필터 절이 없으면 무시됩니다.
filterClauses[]

object (AudienceFilterClause)

필수 항목입니다. 변경할 수 없습니다. 순서가 지정되지 않은 목록입니다. 잠재고객을 정의하는 필터 절입니다. 모든 절은 AND로 연결됩니다.
createTime

string (Timestamp format)

출력 전용입니다. 잠재고객이 생성된 시간입니다.

RFC3339 UTC 'Zulu' 형식의 타임스탬프입니다(나노초 단위, 소수점 이하 9자리). 예를 들면 "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z"입니다.

AudienceEventTrigger

사용자가 잠재고객에 참여할 때 로깅할 이벤트를 지정합니다.

JSON 표현 
{
  "eventName": string,
  "logCondition": enum (LogCondition)
}
필드
eventName

string

필수 항목입니다. 로깅될 이벤트 이름입니다.
logCondition

enum (LogCondition)

필수 항목입니다. 이벤트를 기록할 시간입니다.

LogCondition

이벤트를 기록할 시기를 결정합니다.

열거형
LOG_CONDITION_UNSPECIFIED 로그 조건이 지정되지 않았습니다.
AUDIENCE_JOINED 사용자 참여 시에만 이벤트가 로깅되어야 합니다.
AUDIENCE_MEMBERSHIP_RENEWED 사용자가 이미 잠재고객의 구성원인 경우에도 잠재고객 조건이 충족될 때마다 이벤트가 로깅되어야 합니다.

AudienceExclusionDurationMode

제외 필터를 충족하는 사용자의 제외 지속 기간을 지정합니다.

열거형
AUDIENCE_EXCLUSION_DURATION_MODE_UNSPECIFIED 지정되지 않음
EXCLUDE_TEMPORARILY 사용자가 필터 절을 충족하는 기간 동안 잠재고객에서 사용자를 제외합니다.
EXCLUDE_PERMANENTLY 사용자가 필터 절을 충족한 적이 있다면 잠재고객에서 제외합니다.

AudienceFilterClause

단순 필터 또는 시퀀스 필터를 정의하는 절입니다. 필터는 포괄적일 수 있고 (예: 필터 절을 충족하는 사용자는 잠재고객에 포함됨) 또는 배타적 (예: 필터 절을 충족하는 사용자는 잠재고객에서 제외됨)일 수 있습니다.

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.
}
필드
clauseType

enum (AudienceClauseType)

필수 항목입니다. 포함 또는 제외 필터 절인지 여부를 지정합니다.

통합 필드 filter.

filter는 다음 중 하나여야 합니다.
simpleFilter

object (AudienceSimpleFilter)

사용자가 잠재고객의 구성원이 되기 위해 충족해야 하는 간단한 필터입니다.
sequenceFilter

object (AudienceSequenceFilter)

사용자가 잠재고객에 포함되기 위해 특정 순서로 발생해야 하는 필터입니다.

AudienceSimpleFilter

사용자가 잠재고객이 되기 위해 충족해야 하는 간단한 필터를 정의합니다.

JSON 표현 
{
  "scope": enum (AudienceFilterScope),
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
필드
scope

enum (AudienceFilterScope)

필수 항목입니다. 변경할 수 없습니다. 이 필터의 범위를 지정합니다.
filterExpression

object (AudienceFilterExpression)

필수 항목입니다. 변경할 수 없습니다. 잠재고객 측정기준, 측정항목 또는 이벤트 필터의 논리적 표현식입니다.

AudienceFilterScope

잠재고객에 가입하기 위해 사용자를 평가하는 방법을 지정합니다.

열거형
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 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.
}
필드
통합 필드 expr. 필터에 적용된 표현식입니다. expr은 다음 중 하나여야 합니다.
andGroup

object (AudienceFilterExpressionList)

AND로 결합할 표현식 목록입니다. 또는 AudienceFilterExpressions(또는 그룹)만 포함할 수 있습니다. 최상위 AudienceFilterExpression에 대해 설정해야 합니다.
orGroup

object (AudienceFilterExpressionList)

OR로 결합할 표현식 목록입니다. andGroup 또는 orGroup과 함께 AudienceFilterExpressions를 포함할 수 없습니다.
notExpression

object (AudienceFilterExpression)

NOT'할 필터 표현식 (예: 반전, 보완) dimensionOrMetricFilter만 포함할 수 있습니다. 최상위 AudienceFilterExpression에는 설정할 수 없습니다.
dimensionOrMetricFilter

object (AudienceDimensionOrMetricFilter)

단일 측정기준 또는 측정항목에 대한 필터입니다. 최상위 AudienceFilterExpression에는 설정할 수 없습니다.
eventFilter

object (AudienceEventFilter)

특정 이벤트와 일치하는 필터를 만듭니다. 최상위 AudienceFilterExpression에는 설정할 수 없습니다.

AudienceFilterExpressionList

잠재고객 필터 표현식의 목록입니다.

JSON 표현 
{
  "filterExpressions": [
    {
      object (AudienceFilterExpression)
    }
  ]
}
필드
filterExpressions[]

object (AudienceFilterExpression)

잠재고객 필터 표현식의 목록입니다.

AudienceDimensionOrMetricFilter

단일 측정기준 또는 측정항목에 대한 특정 필터입니다.

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.
}
필드
fieldName

string

필수 항목입니다. 변경할 수 없습니다. 필터링할 측정기준 이름 또는 측정항목 이름입니다. 필드 이름이 맞춤 측정기준 또는 측정항목을 참조하는 경우 범위 접두사가 맞춤 측정기준 또는 측정항목 이름의 앞에 추가됩니다. 범위 접두사 또는 맞춤 측정기준/측정항목에 대한 자세한 내용은 Google Analytics Data API 문서를 참조하세요.
atAnyPointInTime

boolean

선택사항입니다. 이 필터에 동적 평가가 필요한지 여부를 나타냅니다. true로 설정하면 사용자가 조건을 충족한 적이 있는 경우 잠재고객에 가입됩니다 (정적 평가). 설정하지 않거나 false로 설정하면 잠재고객에 대한 사용자 평가가 동적으로 이루어집니다. 사용자가 조건을 충족하면 잠재고객에 추가되고 더 이상 조건을 충족하지 않으면 삭제됩니다.

잠재고객 범위가 ACROSS_ALL_SESSIONS인 경우에만 설정할 수 있습니다.
inAnyNDayPeriod

integer

선택사항입니다. 설정하는 경우 데이터를 평가할 기간을 일 단위로 지정합니다. 설정하지 않으면 전체 기간 데이터 (예: 무한한 기간)를 기준으로 잠재고객 데이터가 평가됩니다.

예를 들어 1일로 설정하면 현재 날짜의 데이터만 평가됩니다. 기준점은 atAnyPointInTime이 설정되지 않거나 false인 현재 날짜입니다.

잠재고객 범위가 ACROSS_ALL_SESSIONS이고 60일을 초과할 수 없는 경우에만 설정할 수 있습니다.
통합 필드 one_filter. 위의 필터 중 하나입니다. one_filter은 다음 중 하나여야 합니다.
stringFilter

object (StringFilter)

특정 패턴과 일치하는 문자열 유형 측정기준에 대한 필터입니다.
inListFilter

object (InListFilter)

특정 옵션 목록과 일치하는 문자열 측정기준에 대한 필터입니다.
numericFilter

object (NumericFilter)

측정기준 또는 측정항목의 숫자 또는 날짜 값에 대한 필터입니다.
betweenFilter

object (BetweenFilter)

측정기준 또는 측정항목의 특정 값 사이에 있는 숫자 또는 날짜 값에 대한 필터입니다.

StringFilter

특정 패턴과 일치하는 문자열 유형 측정기준에 대한 필터입니다.

JSON 표현 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
필드
matchType

enum (MatchType)

필수 항목입니다. 문자열 필터의 일치 유형입니다.
value

string

필수 항목입니다. 일치시킬 문자열 값입니다.
caseSensitive

boolean

선택사항입니다. true인 경우 일치는 대소문자를 구분합니다. false인 경우 일치는 대소문자를 구분하지 않습니다.

MatchType

문자열 필터의 일치 유형입니다.

열거형
MATCH_TYPE_UNSPECIFIED 미지정
EXACT 문자열 값과 정확하게 일치하는 값입니다.
BEGINS_WITH 문자열 값으로 시작합니다.
ENDS_WITH 문자열 값으로 끝납니다.
CONTAINS 문자열 값을 포함합니다.
FULL_REGEXP 전체 정규 표현식은 문자열 값과 일치합니다.

InListFilter

특정 옵션 목록과 일치하는 문자열 측정기준에 대한 필터입니다.

JSON 표현 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
필드
values[]

string

필수 항목입니다. 일치시킬 수 있는 문자열 값의 목록입니다. 비어 있지 않아야 합니다.
caseSensitive

boolean

선택사항입니다. true인 경우 일치는 대소문자를 구분합니다. false인 경우 일치는 대소문자를 구분하지 않습니다.

NumericFilter

측정기준 또는 측정항목의 숫자 또는 날짜 값에 대한 필터입니다.

JSON 표현 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
필드
operation

enum (Operation)

필수 항목입니다. 숫자 필터에 적용된 연산입니다.
value

object (NumericValue)

필수 항목입니다. 대조할 숫자 또는 날짜 값입니다.

작업

숫자 필터에 적용된 연산입니다.

열거형
OPERATION_UNSPECIFIED 지정되지 않았습니다.
EQUAL 같음
LESS_THAN 보다 작음
GREATER_THAN 보다 큼

NumericValue

숫자를 나타냅니다.

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.
}
필드
통합 필드 one_value. 숫자 값 중 하나입니다. one_value은 다음 중 하나여야 합니다.
int64Value

string (int64 format)

정수 값.
doubleValue

number

Double 값입니다.

BetweenFilter

측정기준 또는 측정항목의 특정 값 사이에 있는 숫자 또는 날짜 값에 대한 필터입니다.

JSON 표현 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
필드
fromValue

object (NumericValue)

필수 항목입니다. 이 숫자(포함)로 시작합니다.
toValue

object (NumericValue)

필수 항목입니다. 이 숫자(양 끝값 포함)로 끝납니다.

AudienceEventFilter

단일 이벤트 이름의 이벤트와 일치하는 필터입니다. 이벤트 매개변수가 지정된 경우 단일 이벤트 이름 및 매개변수 필터 표현식 모두와 일치하는 이벤트의 하위 집합만 이 이벤트 필터와 일치합니다.

JSON 표현 
{
  "eventName": string,
  "eventParameterFilterExpression": {
    object (AudienceFilterExpression)
  }
}
필드
eventName

string

필수 항목입니다. 변경할 수 없습니다. 일치시킬 이벤트의 이름입니다.
eventParameterFilterExpression

object (AudienceFilterExpression)

선택사항입니다. 지정된 경우 이 필터는 단일 이벤트 이름 및 매개변수 필터 표현식 모두와 일치하는 이벤트와 일치합니다. 매개변수 필터 표현식 내의 AudienceEventFilter를 설정할 수 없습니다 (예: 중첩 이벤트 필터는 지원되지 않음). 이 dSYM은 측정기준은 또는 MetricFilter 또는 notExpression의 단일 andGroup이어야 합니다. OR의 AND는 지원되지 않습니다. 또한 'eventCount'에 대한 필터가 포함된 경우 해당 필터만 고려됩니다. 다른 모든 필터는 무시됩니다.

AudienceSequenceFilter

사용자가 잠재고객에 포함되기 위해 특정 순서로 발생해야 하는 필터를 정의합니다.

JSON 표현 
{
  "scope": enum (AudienceFilterScope),
  "sequenceMaximumDuration": string,
  "sequenceSteps": [
    {
      object (AudienceSequenceStep)
    }
  ]
}
필드
scope

enum (AudienceFilterScope)

필수 항목입니다. 변경할 수 없습니다. 이 필터의 범위를 지정합니다.
sequenceMaximumDuration

string (Duration format)

선택사항입니다. 전체 시퀀스가 발생해야 하는 기간을 정의합니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
sequenceSteps[]

object (AudienceSequenceStep)

필수 항목입니다. 순서가 지정된 일련의 단계입니다. 사용자가 시퀀스 필터에 참여하려면 각 단계를 완료해야 합니다.

AudienceSequenceStep

이 사용자가 시퀀스와 일치하도록 지정된 단계 순서대로 발생해야 하는 조건입니다.

JSON 표현 
{
  "scope": enum (AudienceFilterScope),
  "immediatelyFollows": boolean,
  "constraintDuration": string,
  "filterExpression": {
    object (AudienceFilterExpression)
  }
}
필드
scope

enum (AudienceFilterScope)

필수 항목입니다. 변경할 수 없습니다. 이 단계의 범위를 지정합니다.
immediatelyFollows

boolean

선택사항입니다. true인 경우 이 단계를 충족하는 이벤트는 이벤트가 마지막 단계를 충족하는 바로 다음 이벤트여야 합니다. 설정하지 않거나 false인 경우 이 단계는 이전 단계를 간접적으로 따릅니다. 예를 들어 이전 단계와 이 단계 사이에 이벤트가 있을 수 있습니다. 첫 번째 단계에서는 무시됩니다.
constraintDuration

string (Duration format)

선택사항입니다. 설정된 경우 이 단계는 이전 단계의 constraintsDuration 내에서 충족되어야 합니다 (예: t[i] - t[i-1] <= constraintsDuration). 설정하지 않으면 기간 요구사항이 없습니다 (기간은 사실상 무제한입니다). 첫 번째 단계에서는 무시됩니다.

소수점 아래가 최대 9자리까지이고 's'로 끝나는 초 단위 기간입니다. 예를 들면 "3.5s"입니다.
filterExpression

object (AudienceFilterExpression)

필수 항목입니다. 변경할 수 없습니다. 각 단계에서 잠재고객 측정기준, 측정항목 또는 이벤트 필터의 논리적 표현식입니다.

AudienceClauseType

포함 또는 제외 필터 절인지 여부를 지정합니다.

열거형
AUDIENCE_CLAUSE_TYPE_UNSPECIFIED 지정되지 않은 절 유형입니다.
INCLUDE 필터 절이 충족되면 사용자가 잠재고객에 포함됩니다.
EXCLUDE 필터 절이 충족되면 사용자가 잠재고객에서 제외됩니다.

메서드

archive

 속성의 잠재고객을 보관처리합니다.

create

 잠재고객을 만듭니다.

get

 단일 잠재고객을 조회합니다.

list

 속성의 잠재고객을 나열합니다.

patch

 속성의 잠재고객을 업데이트합니다.