Method: users.list

Mevcut kullanıcının erişebileceği kullanıcıları listeler. İki kullanıcının aynı iş ortağı veya reklamveren üzerinde kullanıcı rolleri varsa birbirlerine erişebilirler.

Bu yöntemin benzersiz kimlik doğrulama şartları 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/v5/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 kullanılır.

pageToken

string

Sunucunun döndürmesi gereken sonuç sayfasını 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 edilen değerler şunlardır:

  • displayName (varsayılan)

Varsayılan sıralama ölçütü artandır. Bir alan için azalan sıralama belirtmek istiyorsanız alan adına "desc" son eki 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, mantıksal operatör AND ile 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 alanlarda EQUALS (=) operatörü kullanılmalı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ığın türünü tanımlar. Geçerli değerler Partner ve Advertiser'dir.
  • assignedUserRole.parentPartnerId: Bu, filtreleme için kullanılan yapay bir AssignedUserRole 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 veya YYYY-MM-DDTHH:MM:SSZ olarak girin)

Ö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ı rolüne 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ı reklamveren 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"
  • 123 numaralı iş ortağı ve 123 numaralı iş ortağının 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 sonrasında 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 İstekleri LIST filtreleme kılavuzumuzu inceleyin.

İstek metni

İ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.

Bu liste boşsa gösterilmez.

nextPageToken

string

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

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ını inceleyin.