Method: users.list

Mevcut kullanıcı tarafından erişilebilen kullanıcıları listeler. İki kullanıcının aynı iş ortağında veya reklamverende kullanıcı rolü varsa birbirlerine erişebilirler.

Bu yöntemin benzersiz kimlik doğrulama gereksinimleri 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öntemde ç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. Belirtilmemişse varsayılan olarak 100 kullanılır.
pageToken

string

Sunucunun döndürmesi gereken sonuçların bulunduğu sayfayı tanımlayan jeton. Genellikle bu, 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 edilebilir değerler şunlardır:

  • displayName (varsayılan)

Varsayılan sıralama düzeni artan düzendedir. Bir alan için azalan sıralamayı belirtmek üzere alan adına "azalan" son eki eklenmelidir. Ö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ıtlama {field} {operator} {value} biçimindedir.
  • displayName ve email alanları HAS (:) operatörünü kullanmalı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 alanlar EQUALS (=) operatörünü kullanmalıdır.

Desteklenen alanlar:

  • assignedUserRole.advertiserId
  • assignedUserRole.entityType: Bu, filtreleme için kullanılan sentetik AssignedUserRole alanıdır. Kullanıcı rolünün atandığı varlığın 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ığı tüzel kişinin ana iş ortağını tanımlar.
  • assignedUserRole.partnerId
  • assignedUserRole.userRole
  • displayName
  • email
  • lastLoginTime (ISO 8601 biçiminde giriş yapın veya YYYY-MM-DDTHH:MM:SSZ)

Örnekler:

  • displayName alanında "foo" içeren kullanıcı: displayName:"foo"
  • email içinde "bar" bulunan kullanıcı: email:"bar"
  • Standart kullanıcı rollerine sahip tüm kullanıcılar: assignedUserRole.userRole="STANDARD"
  • İş ortağı 123 için kullanıcı rollerine sahip tüm kullanıcılar: assignedUserRole.partnerId="123"
  • Reklamveren 123 için 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"
  • İş ortağı 123 ve iş ortağı 123 altındaki reklamverenler için kullanıcı rollerine sahip olan tüm kullanıcılar: parentPartnerId="123"
  • En son 01.01.2023 tarihinde veya bu tarihten sonra giriş yapan tüm kullanıcılar (ISO 8601 biçimi) lastLoginTime>="2023-01-01T00:00:00Z"

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

Boşsa bu liste yer almayacak.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Bir sonraki sonuç sayfasını almak için bu değeri, bir sonraki users.list yöntemi çağrısında pageToken alanına geçirin. Döndürülecek başka sonuç olmazsa 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'a Genel Bakış başlıklı makaleye bakın.