Method: users.list

Geçerli kullanıcının erişebildiği kullanıcıları listeler. İki kullanıcı aynı iş ortağında veya reklamverende kullanıcı rollerine sahipse birbirlerine erişebilirler.

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/v2/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çların yer aldığı sayfayı tanımlayan jeton. Genellikle bu, users.list yöntemine ö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 edilebilir değerler şunlardır:

  • displayName (varsayılan)

Varsayılan sıralama düzeni artan düzendir. Bir alan için azalan sırayı belirtmek için "desc" son eki alan adına eklenmesi gerekir. Örneğin, displayName desc.
filter

string

Kullanıcı alanlarına göre filtrelemeye izin verir.

Desteklenen söz dizimi:

  • Filtre ifadeleri, bir veya daha fazla kısıtlamadan oluşur.
  • Kısıtlamalar, AND mantıksal operatörü tarafından 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 sentetik alanıdır. Kullanıcı rolünün atandığı varlık 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ığı varlığın ana iş ortağını tanımlar.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ISO 8601 biçiminde giriş veya YYYY-MM-DDTHH:MM:SSZ)

Örnekler:

  • displayName alanında "foo" ifadesini içeren kullanıcı: displayName:"foo"
  • "bar" değerini içeren email özelliğine 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ı rollerine sahip tüm kullanıcılar: entityType="PARTNER"
  • İş ortağı 123 ve iş ortağı 123'ün altındaki reklamverenler için kullanıcı rollerine sahip tüm kullanıcılar: parentPartnerId="123"
  • 01.01.2023T00:00:00Z (ISO 8601 biçimi) tarihinde veya sonrasında en son giriş yapan tüm kullanıcılar: lastLoginTime>="2023-01-01T00:00:00Z"

Bu alanın uzunluğu 500 karakterden fazla olmamalı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 mevcut olmayacak.
nextPageToken

string

Sonuçların sonraki sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, users.list yöntemine yapılan bir sonraki çağrıda pageToken alanına iletin. Döndürülecek başka sonuç yoksa bu jeton eksik olur.

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 (OAuth 2.0'a Genel Bakış) sayfasına göz atın.