지정된 Ads Data Hub 고객이 관리하는 사용자 목록을 나열합니다.
HTTP 요청
GET https://adsdatahub.googleapis.com/v1/{parent=customers/*}/userLists
URL은 gRPC 트랜스코딩 구문을 사용합니다.
경로 매개변수
매개변수 | |
---|---|
parent |
필수 항목입니다. 상위 고객 리소스 이름(예: 'customers/123'')입니다. |
쿼리 매개변수
매개변수 | |
---|---|
pageSize |
반환할 최대 상품 수입니다. 0이면 서버에서 반환할 사용자 목록 수를 결정합니다. |
pageToken |
이전 호출에서 반환된 페이지 토큰으로 결과의 다음 페이지를 요청하는 데 사용됩니다. |
filter |
예시 필터: title = "user*" AND title = "*name*" AND -type = FREQUENCY_BASED AND createEmail = "creator@email.com" AND listSize > 10 AND fillTime > "2012-04-21T1:11 |
view |
각 사용자 목록에 포함할 필드를 지정합니다. |
showDeleted |
true로 설정하면 삭제된 사용자 목록이 응답에 포함됩니다. |
요청 본문
요청 본문은 비어 있어야 합니다.
응답 본문
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
userLists.list 요청에 대한 응답입니다. 지정된 Ads Data Hub 고객이 관리하는 사용자 목록이 포함되어 있습니다.
JSON 표현 |
---|
{
"userLists": [
{
object ( |
필드 | |
---|---|
userLists[] |
사용자 목록 목록입니다. |
nextPageToken |
다음 결과 페이지를 요청하는 데 사용할 수 있는 토큰입니다. 추가 결과가 없는 경우 이 필드는 비어 있습니다. |
승인 범위
다음 OAuth 범위가 필요합니다.
https://www.googleapis.com/auth/adsdatahub
사용자 목록 보기
[userLists.list] API에서 반환된 각 사용자 목록에 어떤 필드를 포함할지 나타내는 열거형입니다.
열거형 | |
---|---|
USER_LIST_VIEW_UNSPECIFIED |
기본값 / 설정되지 않은 값 API는 기본적으로 전체 뷰로 설정됩니다. |
BASIC |
[수신자광고데이터링크]를 제외한 입력란을 포함합니다. |
FULL |
모든 항목을 포함합니다. |