Method: users.list

Geçerli kullanıcının erişebildiği kullanıcıları listeler. Aynı iş ortağı veya reklamverenin kullanıcı rolüne sahip iki kullanıcı birbirine erişebilir.

Bu yöntemin benzersiz kimlik doğrulama şartları vardır. Bu yöntemi kullanmadan önce Kullanıcıları Yönetme kılavuzumuzda yer alan ön koşulları okuyun.

"Bu yöntemi deneyin" özelliği bu yöntem için kullanılamaz.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Sorgu parametreleri

Parametreler
pageSize

integer

İstenen sayfa boyutu. 1 ile 200 arasında olmalıdır. Belirtilmemişse varsayılan olarak 100 olur.
pageToken

string

Sunucunun döndürmesi gereken bir sonuç sayfasını tanımlayan jeton. Genellikle bu, users.list yöntemine yapılan önceki çağrıdan döndürülen nextPageToken değerini ifade eder. Belirtilmemişse sonuçların ilk sayfası döndürülür.
orderBy

string

Listeyi sıralamak için kullanılacak alan. Kabul edilen değerler şunlardır:

  • displayName (varsayılan)

Varsayılan sıralama düzeni artan düzendir. Bir alan için azalan sıra belirtmek üzere alan adına "desc" soneki eklenmelidir. Örneğin, displayName desc.
filter

string

Kullanıcı alanlarına göre filtreleme yapılmasına olanak tanır.

Desteklenen söz dizimi:

  • Filtre ifadeleri bir veya daha fazla kısıtlamadan oluşur.
  • Kısıtlamalar, AND mantıksal operatörüyle birleştirilebilir.
  • Kısıtlamalar {field} {operator} {value} biçimindedir.
  • displayName ve email alanlarında HAS (:) operatörü kullanılmalıdır.
  • lastLoginTime alanında LESS THAN OR EQUAL TO (<=) veya GREATER THAN OR EQUAL TO (>=) operatörü kullanılmalıdır.
  • Diğer tüm alanlar EQUALS (=) operatörünü kullanmalıdır.

Desteklenen alanlar:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Bu, filtreleme için kullanılan AssignedUserRole'un sentetik alanıdır. Kullanıcı rolünün atandığı öğe türünü tanımlar. Geçerli değerler Partner ve Advertiser'dir.
  • assignedUserRole.parentPartnerId: Bu, filtreleme için kullanılan sentetik bir AssignedUserRole alanıdır. Kullanıcı rolünün atandığı öğenin üst iş ortağını tanımlar.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ISO 8601 biçiminde giriş veya YYYY-MM-DDTHH:MM:SSZ)

Örnekler:

  • "foo" içeren displayName değerine sahip kullanıcı: displayName:"foo"
  • "bar" içeren email değerine sahip kullanıcı: email:"bar"
  • Standart kullanıcı rollerine sahip tüm kullanıcılar: assignedUserRole.userRole="STANDARD"
  • 123 iş ortağı için kullanıcı rolüne sahip tüm kullanıcılar: assignedUserRole.partnerId="123"
  • 123 reklamvereni için kullanıcı rolüne sahip tüm kullanıcılar: assignedUserRole.advertiserId="123"
  • İş ortağı düzeyinde kullanıcı rolüne sahip tüm kullanıcılar: entityType="PARTNER"
  • 123 numaralı iş ortağı ve 123 numaralı iş ortağının altındaki reklamverenler için kullanıcı rolüne sahip tüm kullanıcılar: parentPartnerId="123"
  • Son olarak 2023-01-01T00:00:00Z (ISO 8601 biçimi) tarihinde veya sonrasında giriş yapan tüm kullanıcılar: lastLoginTime>="2023-01-01T00:00:00Z"

Bu alanın uzunluğu en fazla 500 karakter olmalıdır.

Daha fazla bilgi için LIST isteklerini filtreleme kılavuzumuza bakın.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
Alanlar
users[]

object (User)

Kullanıcı listesi.

Boşsa bu liste gösterilmez.
nextPageToken

string

Sonuçların bir sonraki sayfasını almak için kullanılan jeton. Sonuçların bir sonraki sayfasını almak için users.list yönteminin sonraki çağrısında pageToken alanında bu değeri iletin. Döndürülecek başka sonuç yoksa bu jeton bulunmaz.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamını gerektirir:

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

Daha fazla bilgi için OAuth 2.0 Overview sayfasına bakın.