REST Resource: accountTypes.accounts.userLists

리소스: UserList

사용자 목록 리소스입니다.

JSON 표현 
{
  "name": string,
  "id": string,
  "readOnly": boolean,
  "membershipDuration": string,
  "accessReason": enum (AccessReason),
  "sizeInfo": {
    object (SizeInfo)
  },
  "targetNetworkInfo": {
    object (TargetNetworkInfo)
  },
  "displayName": string,
  "description": string,
  "membershipStatus": enum (MembershipStatus),
  "integrationCode": string,
  "closingReason": enum (ClosingReason),
  "accountAccessStatus": enum (AccessStatus),

  // Union field user_list_info can be only one of the following:
  "ingestedUserListInfo": {
    object (IngestedUserListInfo)
  }
  // End of list of possible types for union field user_list_info.
}
필드
name

string

식별자. 사용자 목록의 리소스 이름입니다. 형식: accountTypes/{accountType}/accounts/{account}/userLists/{userList}
id

string (int64 format)

출력 전용입니다. 사용자 목록의 고유 ID입니다.
readOnly

boolean

출력 전용입니다. 사용자가 목록을 수정할 수 있는지 여부를 나타내는 옵션입니다.
membershipDuration

string (Duration format)

선택사항입니다. 사용자가 사용자 목록에 남아 있는 기간입니다. 유효한 기간은 24시간 (86,400초)의 정확한 배수입니다. 정확히 24시간의 배수가 아닌 값을 제공하면 INVALID_ARGUMENT 오류가 발생합니다.

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

enum (AccessReason)

출력 전용입니다. 이 계정에 목록 액세스 권한이 부여된 이유입니다.
sizeInfo

object (SizeInfo)

출력 전용입니다. 다양한 타겟팅 네트워크에서 이 사용자 목록에 포함된 예상 회원 수입니다.
targetNetworkInfo

object (TargetNetworkInfo)

선택사항입니다. 다양한 타겟 네트워크의 자격 요건 정보입니다.
displayName

string

필수 항목입니다. 사용자 목록의 표시 이름입니다.
description

string

선택사항입니다. 사용자 목록에 대한 설명입니다.
membershipStatus

enum (MembershipStatus)

선택사항입니다. 이 사용자 목록의 멤버십 상태입니다.
integrationCode

string

선택사항입니다. 외부 시스템의 ID입니다. 사용자 목록 판매자가 시스템의 ID를 상호 연관시키는 데 사용됩니다.
closingReason

enum (ClosingReason)

출력 전용입니다. 이 사용자 목록 멤버십 상태가 종료된 이유입니다.
accountAccessStatus

enum (AccessStatus)

선택사항입니다. 이 공유가 아직 사용 설정되어 있는지 여부를 나타냅니다. 사용자 목록이 계정과 공유되면 이 필드는 ENABLED로 설정됩니다. 나중에 사용자 목록 소유자는 공유를 취소하고 DISABLED로 설정할 수 있습니다.
통합 필드 user_list_info. 사용자 목록에 관한 추가 정보입니다. user_list_info은 다음 중 하나여야 합니다.
ingestedUserListInfo

object (IngestedUserListInfo)

선택사항입니다. 사용자가 수집한 데이터로 채워진 사용자 목록을 나타냅니다.

MembershipStatus

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

열거형
MEMBERSHIP_STATUS_UNSPECIFIED 지정되지 않음
OPEN 열림 상태 - 사용자 목록에 회원이 추가되고 있으며 타겟팅할 수 있습니다.
CLOSED 닫힘 상태 - 새 회원이 추가되지 않습니다.

ClosingReason

사용자 목록이 닫힌 이유를 나타냅니다. 이 열거형은 목록이 시스템에 의해 자동으로 닫히는 경우에만 사용됩니다.

열거형
CLOSING_REASON_UNSPECIFIED 지정되지 않음
UNUSED 최근에 타겟팅에 사용되지 않아 사용자 목록이 닫혔습니다. 자세한 내용은 https://support.google.com/google-ads/answer/2472738을 참고하세요.

AccessReason

가능한 액세스 이유를 설명하는 열거형입니다.

열거형
ACCESS_REASON_UNSPECIFIED 지정되지 않음
OWNED 리소스가 사용자 소유입니다.
SHARED 리소스가 사용자에게 공유됩니다.
LICENSED 사용자에게 리소스의 라이선스가 부여되었습니다.
SUBSCRIBED 사용자가 리소스를 구독했습니다.
AFFILIATED 사용자가 리소스에 액세스할 수 있습니다.

AccessStatus

이 클라이언트가 목록에 계속 액세스할 수 있는지 여부를 나타냅니다.

열거형
ACCESS_STATUS_UNSPECIFIED 지정되지 않음
ENABLED 액세스가 사용 설정되어 있습니다.
DISABLED 액세스가 사용 중지되었습니다.

SizeInfo

다양한 타겟팅 네트워크에서 이 사용자 목록에 포함된 예상 회원 수입니다.

JSON 표현 
{
  "displayNetworkMembersCount": string,
  "searchNetworkMembersCount": string,
  "youtubeMembersCount": string,
  "gmailMembersCount": string
}
필드
displayNetworkMembersCount

string (int64 format)

출력 전용입니다. Google 디스플레이 네트워크에서 이 사용자 목록에 있는 회원 수의 추정치입니다.
searchNetworkMembersCount

string (int64 format)

출력 전용입니다. google.com 도메인에서 이 사용자 목록에 있는 예상 회원 수입니다. 검색 캠페인에서 타겟팅할 수 있는 구성원입니다.
youtubeMembersCount

string (int64 format)

출력 전용입니다. YouTube에서 이 사용자 목록에 포함된 것으로 추정되는 회원 수입니다.
gmailMembersCount

string (int64 format)

출력 전용입니다. Gmail의 이 사용자 목록에 있는 예상 회원 수입니다.

TargetNetworkInfo

다양한 타겟 네트워크의 자격 요건 정보입니다.

JSON 표현 
{
  "eligibleForDisplay": boolean,
  "eligibleForSearch": boolean
}
필드
eligibleForDisplay

boolean

출력 전용입니다. 이 사용자 목록이 Google 디스플레이 네트워크에 적합함을 나타냅니다.

IngestedUserListInfo

사용자가 제공한 데이터로 채워진 사용자 목록을 나타냅니다.

JSON 표현 
{
  "uploadKeyTypes": [
    enum (UploadKeyType)
  ],
  "contactIdInfo": {
    object (ContactIdInfo)
  },
  "mobileIdInfo": {
    object (MobileIdInfo)
  },
  "userIdInfo": {
    object (UserIdInfo)
  },
  "pairIdInfo": {
    object (PairIdInfo)
  },
  "pseudonymousIdInfo": {
    object (PseudonymousIdInfo)
  },
  "partnerAudienceInfo": {
    object (PartnerAudienceInfo)
  }
}
필드
uploadKeyTypes[]

enum (UploadKeyType)

필수 항목. 변경할 수 없습니다. 이 사용자 목록의 업로드 키 유형입니다.
contactIdInfo

object (ContactIdInfo)

선택사항입니다. CONTACT_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.
mobileIdInfo

object (MobileIdInfo)

선택사항입니다. MOBILE_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.
userIdInfo

object (UserIdInfo)

선택사항입니다. USER_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.
pairIdInfo

object (PairIdInfo)

선택사항입니다. PAIR_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.

이 기능은 데이터 파트너만 사용할 수 있습니다.
pseudonymousIdInfo

object (PseudonymousIdInfo)

선택사항입니다. PSEUDONYMOUS_ID에 대한 추가 정보는 uploadKeyTypes 중 하나입니다.
partnerAudienceInfo

object (PartnerAudienceInfo)

선택사항입니다. 파트너 잠재고객을 위한 추가 정보입니다.

이 기능은 데이터 파트너만 사용할 수 있습니다.

UploadKeyType

사용자 목록의 가능한 업로드 키 유형을 포함하는 enum입니다.

열거형
UPLOAD_KEY_TYPE_UNSPECIFIED 지정되지 않음
CONTACT_ID 이메일 주소, 전화번호, 실제 주소와 같은 고객 정보
MOBILE_ID 모바일 광고 ID입니다.
USER_ID 서드 파티에서 제공한 사용자 ID입니다.
PAIR_ID 게시자와 광고주의 식별 정보 매칭 솔루션 ID입니다.
PSEUDONYMOUS_ID 데이터 관리 플랫폼 ID: - Google 사용자 ID - 파트너 제공 ID - 게시자 제공 ID - iOS IDFA - Android 광고 ID - Roku ID - Amazon Fire TV ID - Xbox 또는 Microsoft ID

ContactIdInfo

CONTACT_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.

JSON 표현 
{
  "matchRatePercentage": integer,
  "dataSourceType": enum (DataSourceType)
}
필드
matchRatePercentage

integer

출력 전용입니다. 고객 매치 타겟팅 사용자 목록의 일치율입니다.
dataSourceType

enum (DataSourceType)

선택사항입니다. 변경할 수 없습니다. 업로드 데이터의 소스

DataSourceType

업로드 데이터의 소스를 나타냅니다.

열거형
DATA_SOURCE_TYPE_UNSPECIFIED 지정되지 않음
DATA_SOURCE_TYPE_FIRST_PARTY 업로드된 데이터는 퍼스트 파티 데이터입니다.
DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU 업로드된 데이터는 서드 파티 신용 기관에서 가져온 것입니다.
DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE 업로드된 데이터는 서드 파티 유권자 파일에서 가져온 것입니다.
DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA 업로드된 데이터는 서드 파티 파트너 데이터입니다.

MobileIdInfo

MOBILE_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.

JSON 표현 
{
  "dataSourceType": enum (DataSourceType),
  "keySpace": enum (KeySpace),
  "appId": string
}
필드
dataSourceType

enum (DataSourceType)

선택사항입니다. 변경할 수 없습니다. 업로드 데이터의 소스입니다.
keySpace

enum (KeySpace)

필수 항목입니다. 변경할 수 없습니다. 모바일 ID의 키 공간입니다.
appId

string

필수 항목입니다. 변경할 수 없습니다. 데이터가 수집된 모바일 애플리케이션을 고유하게 식별하는 문자열입니다.

KeySpace

모바일 ID의 키 스페이스입니다.

열거형
KEY_SPACE_UNSPECIFIED 지정되지 않음
IOS iOS 키 스페이스입니다.
ANDROID Android 키 스페이스입니다.

UserIdInfo

USER_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.

JSON 표현 
{
  "dataSourceType": enum (DataSourceType)
}
필드
dataSourceType

enum (DataSourceType)

선택사항입니다. 변경할 수 없습니다. 업로드 데이터의 소스입니다.

PairIdInfo

PAIR_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.

이 기능은 데이터 파트너만 사용할 수 있습니다.

JSON 표현 
{
  "publisherId": string,
  "publisherName": string,
  "matchRatePercentage": integer,
  "advertiserIdentifierCount": string,
  "cleanRoomIdentifier": string
}
필드
publisherId

string (int64 format)

필수 항목. 변경할 수 없습니다. 게시자와 광고주의 식별 정보 매칭 사용자 목록이 매칭되는 게시자를 식별합니다. 이 필드는 클린룸 제공업체에서 제공하며 해당 클린룸 범위 내에서만 고유합니다. 이 값은 여러 클린룸에서 전역 식별자로 사용할 수 없습니다.
publisherName

string

필수 항목입니다. 타겟팅 환경을 개선하기 위해 UI에 표시할 게시자의 설명이 포함된 이름입니다.
matchRatePercentage

integer

필수 항목입니다. 이 필드는 이 사용자 목록과 해당 게시자의 퍼스트 파티 데이터의 멤버십 일치 비율을 나타냅니다. 0~100(포함) 사이여야 합니다.
advertiserIdentifierCount

string (int64 format)

선택사항입니다. 데이터 클린룸 제공업체에 업로드된 광고주의 퍼스트 파티 데이터 레코드 수입니다. 이는 페어링 사용자 목록의 크기를 나타내지 않습니다.
cleanRoomIdentifier

string

필수 항목입니다. 변경할 수 없습니다. 하나의 데이터 클린룸 제공업체 또는 여러 데이터 클린룸 제공업체 간의 고유한 광고주-게시자 관계를 식별합니다.

PseudonymousIdInfo

PSEUDONYMOUS_ID이 uploadKeyTypes 중 하나인 경우의 추가 정보입니다.

JSON 표현 
{
  "syncStatus": enum (SyncStatus),
  "billableRecordCount": string
}
필드
syncStatus

enum (SyncStatus)

출력 전용입니다. 사용자 목록의 동기화 상태입니다.
billableRecordCount

string (int64 format)

선택사항입니다. 변경할 수 없습니다. 청구 가능한 레코드 수 (예: 업로드 또는 일치)입니다.

SyncStatus

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

열거형
SYNC_STATUS_UNSPECIFIED 지정되지 않음
CREATED 사용자 목록이 자리표시자로 생성되었습니다. 콘텐츠 또는 메타데이터가 아직 동기화되고 있습니다. 사용자 목록을 사용할 수 없습니다.
READY_FOR_USE 사용자 목록을 사용할 수 있습니다. 콘텐츠와 쿠키가 올바르게 동기화되었습니다.
FAILED 사용자 목록 콘텐츠 또는 메타데이터를 동기화하는 중에 오류가 발생했습니다. 사용자 목록을 사용할 수 없습니다.

PartnerAudienceInfo

파트너 잠재고객을 위한 추가 정보입니다.

이 기능은 데이터 파트너만 사용할 수 있습니다.

JSON 표현 
{
  "partnerAudienceSource": enum (PartnerAudienceSource),
  "commercePartner": string
}
필드
partnerAudienceSource

enum (PartnerAudienceSource)

필수 항목. 변경할 수 없습니다. 파트너 잠재고객의 소스입니다.
commercePartner

string

선택사항입니다. 상거래 파트너 이름입니다. partnerAudienceSource이 COMMERCE_AUDIENCE인 경우에만 허용됩니다.

PartnerAudienceSource

파트너 잠재고객 소스입니다.

열거형
PARTNER_AUDIENCE_SOURCE_UNSPECIFIED 지정되지 않음
COMMERCE_AUDIENCE 파트너 잠재고객 소스는 상거래 잠재고객입니다.
LINEAR_TV_AUDIENCE 파트너 잠재고객 소스가 일반 TV 잠재고객입니다.
AGENCY_PROVIDER_AUDIENCE 파트너 잠재고객 소스는 대행사/제공업체 잠재고객입니다.

메서드

create

 UserList를 만듭니다.

delete

 UserList를 삭제합니다.

get

 UserList를 가져옵니다.

list

 UserList를 나열합니다.

patch

 UserList를 업데이트합니다.