Method: users.list

Geçerli kullanıcı tarafından erişilebilen kullanıcıları listeler. İki kullanıcının aynı iş ortağında veya reklamverende kullanıcı rolleri varsa birbirlerine erişebilirler.

HTTP isteği

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

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

Sorgu parametreleri

Parametreler
pageSize

integer

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

string

Sunucunun döndürmesi gereken sonuçların yer aldığı sayfayı tanımlayan bir 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ın azalan sırasını belirtmek için alan adına "azalan" son eki eklenmelidir. Örneğin, displayName desc.
filter

string

Kullanıcı özelliklerine 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ü ile birleştirilebilir.
  • Kısıtlama {field} {operator} {value} biçimindedir.
  • Operatör CONTAINS (:) veya EQUALS (=) olmalıdır.
  • Operatör, aşağıdaki alanlar için CONTAINS (:) olmalıdır:
    • displayName
    • email
  • Operatör, aşağıdaki alanlar için EQUALS (=) olmalıdır:
    • assignedUserRole.userRole
    • assignedUserRole.partnerId
    • assignedUserRole.advertiserId
    • assignedUserRole.entityType: Filtreleme için kullanılan AssignedUserRole özelliğinin sentetik alanı. Kullanıcı rolünün atandığı varlığın türünü tanımlar. Geçerli değerler Partner ve Advertiser'dir.
    • assignedUserRole.parentPartnerId: Filtreleme için kullanılan AssignedUserRole özelliğinin sentetik alanı. Kullanıcı rolünün atandığı tüzel kişinin ana iş ortağını tanımlar."

Örnekler:

  • foo değerini içeren görünen ada sahip kullanıcı: displayName:"foo"
  • bar içeren e-posta adresine sahip 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ğı seviyesinde kullanıcı rollerine sahip olan tüm kullanıcılar: entityType="PARTNER"
  • İş ortağı 123 ve iş ortağı 123 altındaki reklamverenler için kullanıcı rollerine sahip tüm kullanıcılar: parentPartnerId="123"

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

İ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ş bırakılırsa bu liste görünmez.
nextPageToken

string

Sonraki sonuç sayfasını almak için jeton. Sonraki sonuç sayfasını almak için bu değeri, users.list yöntemine yapılan sonraki çağrıdaki 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.