Method: users.list

Geçerli kullanıcının erişebildiği kullanıcıları listeler. Aynı iş ortağı veya reklamverende kullanıcı rolleri olan iki kullanıcı birbirine erişebilir.

Bu yöntemin benzersiz kimlik doğrulama koşulları vardır. Bu yöntemi kullanmadan önce Kullanıcıları Yönetme Kılavuzumuzdaki ön koşulları okuyun.

"Bu yöntemi deneyin" özelliği bu yöntem için çalışmaz.

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. Belirtilmezse varsayılan olarak 100 olur.
pageToken

string

Sunucunun döndürmesi gereken sonuç sayfasını tanımlayan bir jeton. Bu genellikle users.list yöntemine yapılan önceki çağrıdan döndürülen nextPageToken değeridir. Belirtilmezse sonuçların ilk sayfası döndürülür.
orderBy

string

Listenin sıralanacağı alan. Kabul edilen değerler şunlardır:

  • displayName (varsayılan)

Varsayılan sıralama düzeni artandır. Bir alan için azalan sırayı 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ıtlama, {field} {operator} {value} biçimindedir.
  • displayName ve email alanlarında HAS (:) operatörü kullanılmalıdır.
  • lastLoginTime alanı, LESS THAN OR EQUAL TO (<=) veya GREATER THAN OR EQUAL TO (>=) operatörünü kullanmalıdır.
  • Diğer tüm alanlarda EQUALS (=) operatörü kullanılmalıdır.

Desteklenen alanlar:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Bu, filtreleme için kullanılan AssignedUserRole'nin 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 AssignedUserRole öğesinin sentetik bir alanıdır. Kullanıcı rolünün atandığı varlığın ü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" dizesini içeren displayName kimlikli kullanıcı: displayName:"foo"
  • "bar" dizesini içeren email kimlikli kullanıcı: email:"bar"
  • Standart kullanıcı rollerine sahip tüm kullanıcılar: assignedUserRole.userRole="STANDARD"
  • 123 numaralı iş ortağı için kullanıcı rolleri olan tüm kullanıcılar: assignedUserRole.partnerId="123"
  • 123 numaralı reklamverenin kullanıcı rollerine sahip tüm kullanıcılar: assignedUserRole.advertiserId="123"
  • İş ortağı düzeyinde kullanıcı rollerine sahip tüm kullanıcılar: entityType="PARTNER"
  • 123 kimlikli iş ortağı ve 123 kimlikli iş ortağı altındaki reklamverenler için kullanıcı rollerine sahip tüm kullanıcılar: parentPartnerId="123"
  • En son 2023-01-01T00:00:00Z (ISO 8601 biçimi) tarihinde veya bu tarihten sonra giriş yapan tüm kullanıcılar: lastLoginTime>="2023-01-01T00:00:00Z"

Bu alanın uzunluğu 500 karakteri aşmamalıdır.

Daha fazla bilgi için filtre LIST istekleri 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.

Liste boşsa gösterilmez.
nextPageToken

string

Sonuçların sonraki sayfasını almak için kullanılan jeton. Sonraki sonuç sayfasını almak için users.list yöntemine yapılan sonraki çağrıda bu değeri pageToken alanına 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.