Method: users.list

현재 사용자가 액세스할 수 있는 사용자를 나열합니다. 두 사용자가 동일한 파트너 또는 광고주에 대한 사용자 역할을 보유하는 경우 서로에게 액세스할 수 있습니다.

이 메서드에는 고유한 인증 요구사항이 있습니다. 이 메서드를 사용하기 전에 사용자 관리 가이드의 기본 요건을 읽어보세요.

이 방법에는 '이 방법 시도' 기능이 작동하지 않습니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v3/users

URL은 gRPC 트랜스코딩 구문을 사용합니다.

쿼리 매개변수

매개변수
pageSize

integer

요청한 페이지 크기입니다. 1~200의 값이어야 합니다. 지정하지 않으면 기본값은 100입니다.
pageToken

string

서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이는 users.list 메서드에 대한 이전 호출에서 반환된 nextPageToken 값입니다. 지정하지 않으면 결과의 첫 번째 페이지가 반환됩니다.
orderBy

string

목록을 정렬할 필드입니다. 사용 가능한 값:

  • displayName(기본)

기본 정렬 순서는 오름차순입니다. 필드에서 내림차순으로 지정하려면 서픽스 'desc'를 필드 이름에 추가해야 합니다. 예를 들면 displayName desc입니다.
filter

string

사용자 필드로 필터링할 수 있습니다.

지원되는 문법:

  • 필터 표현식은 하나 이상의 제한사항으로 구성됩니다.
  • 제한사항은 논리 연산자 AND로 결합할 수 있습니다.
  • 제한사항은 {field} {operator} {value} 형식입니다.
  • displayName 및 email 필드는 HAS (:) 연산자를 사용해야 합니다.
  • lastLoginTime 필드는 LESS THAN OR EQUAL TO (<=) 또는 GREATER THAN OR EQUAL TO (>=) 연산자를 사용해야 합니다.
  • 다른 모든 필드는 EQUALS (=) 연산자를 사용해야 합니다.

지원되는 필드:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: 필터링에 사용되는 AssignedUserRole의 합성 필드입니다. 사용자 역할이 할당된 엔티티의 유형을 식별합니다. 유효한 값은 Partner 및 Advertiser입니다.
  • assignedUserRole.parentPartnerId: 필터링에 사용되는 AssignedUserRole의 합성 필드입니다. 사용자 역할이 할당된 항목의 상위 파트너를 식별합니다.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ISO 8601 형식 또는 YYYY-MM-DDTHH:MM:SSZ으로 입력)

예:

  • displayName에 'foo'가 포함된 사용자: displayName:"foo"
  • 'bar'가 포함된 email가 있는 사용자: email:"bar"
  • 표준 사용자 역할이 있는 모든 사용자: assignedUserRole.userRole="STANDARD"
  • 파트너 123의 사용자 역할이 있는 모든 사용자: assignedUserRole.partnerId="123"
  • 광고주 123의 사용자 역할이 있는 모든 사용자: assignedUserRole.advertiserId="123"
  • 파트너 수준 사용자 역할이 있는 모든 사용자: entityType="PARTNER"
  • 파트너 123 및 파트너 123에 속한 광고주의 사용자 역할이 있는 모든 사용자: parentPartnerId="123"
  • 2023-01-01T00:00:00Z (ISO 8601 형식) 이후에 마지막으로 로그인한 모든 사용자: lastLoginTime>="2023-01-01T00:00:00Z"

이 필드의 길이는 500자(영문 기준)를 초과할 수 없습니다.

자세한 내용은 필터 LIST 요청 가이드를 참고하세요.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
필드
users[]

object (User)

사용자 목록입니다.

비어 있으면 이 목록이 없습니다.
nextPageToken

string

결과의 다음 페이지를 검색하는 토큰입니다. 결과의 다음 페이지를 가져오려면 users.list 메서드에 대한 후속 호출의 pageToken 필드에 이 값을 전달하세요. 더 이상 반환할 결과가 없는 경우 이 토큰은 없습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

  • https://www.googleapis.com/auth/display-video-user-management

자세한 내용은 OAuth 2.0 Overview를 참조하세요.