REST Resource: customers.userLists

리소스: UserList

Ads Data Hub에서 관리하는 사용자 목록을 정의합니다.

JSON 표현 
{
  "name": string,
  "userListId": string,
  "adsDataCustomerId": string,
  "title": string,
  "description": string,
  "type": enum (UserListType),
  "createEmail": string,
  "listSize": string,
  "populateTime": string,
  "recipientAdsDataLinks": [
    string
  ],
  "state": enum (State),

  // Union field user_list can be only one of the following:
  "frequencyList": {
    object (FrequencyBasedListInfo)
  },
  "remarketingList": {
    object (RemarketingListInfo)
  }
  // End of list of possible types for union field user_list.
}
필드
name

string

출력 전용. Ads Data Hub 사용자 목록을 고유하게 식별하는 이름입니다. customer/[customerId]/userLists/[userListId] 형식을 사용합니다.
userListId

string (int64 format)

출력 전용. 사용자 목록 ID입니다. 이 필드는 서비스에 의해 생성되며 UserList를 채우는 데 사용됩니다.
adsDataCustomerId

string (int64 format)

변경할 수 없습니다. 이 사용자 목록과 연결된 연결된 Ads Data Hub 고객 ID입니다. 이 사용자 목록을 사용하여 UserListQuery 작업을 실행할 때 이 ID를 adsDataCustomerId로 지정해야 합니다. 없는 경우 상위 고객이 사용됩니다. 목록을 만든 후에는 변경할 수 없습니다.
title

string

필수 항목입니다. 지정된 adsDataCustomerId에 고유한 사용자 목록 제목
description

string

필수 항목입니다. 사용자 목록 설명
type

enum (UserListType)

출력 전용. UserList 유형 값은 userList와 일치해야 합니다. 이 값은 읽기 전용이며 가져오기/나열 요청 시 액세스할 수 있습니다.
createEmail

string

출력 전용. 이 사용자 목록을 만든 사용자의 이메일 주소입니다.
listSize

string (int64 format)

출력 전용. 사용자 목록의 사용자 수입니다. 목록 크기 업데이트가 지연될 수 있습니다.
populateTime

string (Timestamp format)

출력 전용. 목록이 마지막으로 채워진 시간입니다.

RFC3339 UTC "Zulu' 형식의 타임스탬프로, 나노초 해상도와 최대 9자리 소수를 나타냅니다. 예: "2014-10-02T15:01:23Z" 및 "2014-10-02T15:01:23.045123456Z".
state

enum (State)

출력 전용. 사용자 목록의 상태입니다 (활성/삭제됨). 이 값은 읽기 전용이며 가져오기/나열 요청 시 액세스할 수 있습니다.

통합 필드 user_list는 사용자 목록 유형에 따른 추가 구성

정확히 1개를 설정해야 합니다. user_list는 다음 중 하나여야 합니다.
frequencyList

object (FrequencyBasedListInfo)

최대 게재빈도 설정의 사용자 목록입니다.
remarketingList

object (RemarketingListInfo)

리마케팅 목록

사용자 목록 유형

사용자 목록 종류. 타겟팅 시 사용자 목록 구성 및 사용법은 이 열거형에 따라 다릅니다. 목록 생성 후에는 목록 유형을 전환할 수 없습니다.

열거형
USER_LIST_TYPE_UNSPECIFIED 기본값: 사용할 수 없습니다.
REMARKETING ADH에서 SQL 쿼리로 생성된 리마케팅 잠재고객 리마케팅 목록은 포함 타겟팅과 제외 타겟팅 모두에 사용할 수 있습니다.
FREQUENCY_BASED 게재빈도가 제한된 잠재고객 이러한 종류의 잠재고객은 제외 타겟팅으로 제한됩니다.

빈도 기반 목록 정보

빈도 기반 사용자 목록의 메타데이터입니다.

JSON 표현 
{
  "dv360LineitemIds": [
    string
  ],
  "cmCampaignIds": [
    string
  ],
  "googleAdsCampaignIds": [
    string
  ],
  "eventMatchers": [
    {
      object (EventMatcher)
    }
  ],
  "frequencyConstraint": {
    object (FrequencyConstraint)
  },
  "slidingWindowDays": integer
}
필드
dv360LineitemIds[]
(deprecated)

string (int64 format)

게재빈도에 영향을 주는 DV360 광고 항목의 ID입니다.
cmCampaignIds[]
(deprecated)

string (int64 format)

게재빈도에 영향을 주는 CM 캠페인 ID입니다.
googleAdsCampaignIds[]
(deprecated)

string (int64 format)

게재빈도에 영향을 주는 Google Ads 캠페인 ID입니다.
eventMatchers[]

object (EventMatcher)

빈도에 영향을 주는 이벤트 빈도 기반 사용자 목록을 만들 때는 빈도에 영향을 주는 이벤트를 지정하는 데 eventMatchers가 선호됩니다. eventMatchers가 비어 있으면 dv360LineitemIds, cmCampaignIds, googleAdsCampaignIds가 사용됩니다.
frequencyConstraint

object (FrequencyConstraint)

사용자가 목록에 추가되는 시점을 설명합니다.
slidingWindowDays

integer

필수 항목입니다. 각 이벤트의 빈도를 계산할 때 사용되는 기간 크기입니다. 일 단위로 측정됩니다.

EventMatcher

빈도에 기여하는 일반 이벤트입니다.

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

enum (MatchType)

빈도 수에 포함될 제약조건 유형입니다.
value

string

제약조건의 값입니다. 예를 들어 Google Ads 캠페인 ID = 1234를 지정하는 경우 matchType은 GOOGLE_ADS_CAMPAIGN_ID이고 값은 '1234'입니다. 각 MatchType에 이 값이 있는 이벤트는 게재빈도 계산에 포함됩니다.

MatchType

최대 게재빈도 수에 지원되는 제약조건 유형입니다. 나중에 추가 제약 조건을 지원하기 위해 이 열거형에 더 많은 유형이 추가될 수 있습니다. ExplainValidFrequencyLimitingEventMatchersRequest의 MatchType에 필터를 지정하여 결과에 반환된 이벤트 매처를 API에서 지원하는 이벤트 매처로만 제한할 수 있습니다. 예를 들어 필터를 "eventMatcher.match_type= CM_CAMPAIGN_ID OR eventMatcher.match_type=GOOGLE_ADS_CAMPAIGN_ID"로 설정하면 두 가지 유형의 EventMatcher만 반환됩니다.

열거형
MATCH_TYPE_UNSPECIFIED 기본값 이 값은 사용되지 않습니다.
CM_CAMPAIGN_ID Campaign Manager 캠페인 ID를 나타내는 제약 조건 유형입니다.
DV360_INSERTION_ORDER_ID DV360 게재 신청서 ID를 나타내는 제약 조건 유형입니다.
DV360_LINE_ITEM_ID DV360 광고 항목 ID를 나타내는 제약 조건 유형입니다.
GOOGLE_ADS_CAMPAIGN_ID Google Ads 캠페인 ID를 나타내는 제약조건 유형입니다.

빈도 제약조건

상한의 최소 이벤트 수를 지정합니다.

JSON 표현 
{
  "eventType": enum (EventType),
  "thresholdEventCount": string
}
필드
eventType

enum (EventType)

변경할 수 없습니다. 기준액 이벤트 카운트를 기준으로 계산되는 이벤트 유형입니다. 지금은 모두 GREATER_OR_EQUAL이라고 가정하여 비교 제약 조건을 명시적으로 나타내지 않습니다.
thresholdEventCount

string (int64 format)

필수 항목입니다. 각 사용자는 최소 K개의 이벤트에 표시되어야 합니다.

EventType

빈도를 계산하는 데 사용할 수 있는 이벤트 유형입니다.

열거형
EVENT_TYPE_UNSPECIFIED 기본값: 사용할 수 없습니다.
IMPRESSIONS 모든 노출수를 집계합니다.

리마케팅 목록 정보

리마케팅 목록의 메타데이터입니다.

JSON 표현 
{
  "userListQuery": string,
  "populatingUserListQueries": [
    string
  ]
}
필드
userListQuery

string

변경할 수 없습니다. 사용자가 이 잠재고객에 추가되는 방법을 지정하는 Ads Data Hub 사용자 목록 쿼리 리소스입니다. 고객 유형: customer/[customerId]/userListQuery/[query_resource_id]
populatingUserListQueries[]

string

출력 전용. Ads Data Hub 사용자는 이 잠재고객을 채운 쿼리 리소스를 나열합니다. 1:1 userlist:query 제한이 적용되기 전에 여러 쿼리로 채워진 사용자 목록을 지원하기 위한 기존 필드입니다. 고객 유형: customer/[customerId]/userListQuery/[query_resource_id]

상태

사용자 목록의 상태입니다.

열거형
STATE_UNSPECIFIED 기본값 / 설정되지 않은 값
STATE_ACTIVE 사용자 목록이 아직 열려 있습니다.
STATE_DELETED 사용자 목록이 삭제됨으로 표시되어 더 이상 타겟팅에 사용할 수 없습니다.

메소드

addEventMatchers

 빈도 기반 사용자 목록에 이벤트 매처를 추가합니다.

addRecipients

 Ads Data Hub에서 관리하는 사용자 목록의 수신자에게 항목을 추가합니다.

create

 Ads Data Hub에서 관리하는 사용자 목록을 만듭니다.

delete

 요청한 Ads Data Hub 관리 사용자 목록을 삭제합니다.

generateFrequencyListMemberships

 UserList에 대한 멤버십을 생성합니다.

get

 요청된 Ads Data Hub 관리 사용자 목록을 검색합니다.

list

 지정된 Ads Data Hub 고객이 관리하는 사용자 목록을 나열합니다.

patch

 요청한 Ads Data Hub 관리 사용자 목록을 업데이트합니다.

removeRecipients

 Ads Data Hub에서 관리하는 사용자 목록의 수신자에서 항목을 삭제합니다.