Kimliği doğrulanmış kullanıcının gruplandırılmış kişilerindeki, arama sorgusuyla eşleşen kişilerin listesini sağlar. Sorgu, bir kişinin CONTACT
kaynağına ait names
, nickNames
, emailAddresses
, phoneNumbers
ve organizations
alanlarında eşleşiyor.
ÖNEMLİ: Arama yapmadan önce, istemciler önbelleği güncellemek için boş bir sorgu içeren Isınma isteği göndermelidir. https://developers.google.com/people/v1/contacts#search_the_users_contacts adresine göz atın
HTTP isteği
GET https://people.googleapis.com/v1/people:searchContacts
URL, gRPC Kod Dönüştürme söz dizimini kullanır.
Sorgu parametreleri
Parametreler | |
---|---|
query |
Zorunlu. İsteğin düz metin sorgusu. Sorgu, bir kişideki alanların ön ek ifadelerini eşleştirmek için kullanılır. Örneğin, adı "foo name" olan bir kişi "f", "fo", "foo", "foo n", "nam" vb. sorgularla eşleşir ancak "oo n" ile eşleşmez. |
pageSize |
İsteğe bağlı. Döndürülecek sonuç sayısı. Alan ayarlanmazsa varsayılan olarak 10 veya 0 değerine ayarlanırsa varsayılan olarak 10 olur. 30'dan büyük değerler 30 ile sınırlanır. |
readMask |
Zorunlu. Her kişide hangi alanların döndürüleceğini sınırlayan bir alan maskesi. Virgülle ayırarak birden çok alan belirtilebilir. Valid values are:
|
sources[] |
İsteğe bağlı. Döndürülecek kaynak türlerinin maskesi. Ayarlanmamışsa varsayılan değeri |
İstek içeriği
İstek metni boş olmalıdır.
Yanıt metni
Başarılıysa yanıt metni, SearchResponse
öğesinin bir örneğini içerir.
Yetkilendirme kapsamları
Aşağıdaki OAuth kapsamlarından birini gerektirir:
https://www.googleapis.com/auth/contacts
https://www.googleapis.com/auth/contacts.readonly
Daha fazla bilgi için Yetkilendirme kılavuzu'na bakın.