Method: mediaItems.search

Koleksiyonlar ile düzeninizi koruyun İçeriği tercihlerinize göre kaydedin ve kategorilere ayırın.

Kullanıcının Google Fotoğraflar kitaplığındaki medya öğelerini arar. Hiçbir filtre ayarlanmazsa kullanıcının kitaplığındaki tüm medya öğeleri döndürülür. Bir albüm ayarlanırsa belirtilen albümdeki tüm medya öğeleri döndürülür. Filtreler belirtilirse kullanıcının kitaplığındaki filtrelerle eşleşen medya öğeleri listelenir. Hem albümü hem de filtreleri ayarlarsanız istek bir hatayla sonuçlanır.

HTTP isteği

POST https://photoslibrary.googleapis.com/v1/mediaItems:search

URL, gTB Kod Geçişi söz dizimini kullanır.

İstek metni

İstek gövdesi aşağıdaki yapıya sahip verileri içerir:

JSON gösterimi 
{
  "albumId": string,
  "pageSize": integer,
  "pageToken": string,
  "filters": {
    object (Filters)
  },
  "orderBy": string
}
Alanlar
albumId

string

Albümün tanımlayıcısı. Doldurulursa belirtilen albümdeki tüm medya öğeleri listelenir. Herhangi bir filtreyle birlikte ayarlanamaz.
pageSize

integer

Yanıtta döndürülecek maksimum medya öğesi sayısı. Belirtilen sayıdan daha az medya öğesi döndürülebilir. Varsayılan pageSize 25, maksimum 100'dür.
pageToken

string

Sonuçların sonraki sayfasını almak için kullanılan bir devam jetonu. Bunu isteğe eklediğinizde pageToken karakterinden sonraki satırlar döndürülür. pageToken, searchMediaItems isteğine verilen yanıtta nextPageToken parametresinde döndürülen değer olmalıdır.
filters

object (Filters)

İstek için geçerli olacak filtreler. Bir albumId ile bağlantılı olarak ayarlanamaz.
orderBy

string

Arama sonuçlarının sıralama düzenini belirtmek için kullanılan isteğe bağlı bir alan. orderBy alanı yalnızca dateFilter kullanıldığında çalışır. Bu alan belirtilmediğinde sonuçlar, creationTime tarihinden önce en yeni, en eski olan şeklinde gösterilir. MediaMetadata.creation_time sağlandığında arama sonuçları, en tersi en eskiden en yeniye doğru sıralanmış halde gösterilir. En yeni ve en eski olanı görmek için desc bağımsız değişkenini aşağıdaki gibi ekleyin: MediaMetadata.creation_time desc.

Bu parametreyle yalnızca includeArchivedMedia ve excludeNonAppCreatedData filtreleri kullanılabilir. Başka filtre desteklenmiyor.

Yanıt metni

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

Arama parametreleriyle eşleşen medya öğelerinin listesi.

JSON gösterimi 
{
  "mediaItems": [
    {
      object (MediaItem)
    }
  ],
  "nextPageToken": string
}
Alanlar
mediaItems[]

object (MediaItem)

Yalnızca çıkış. Arama parametreleriyle eşleşen medya öğelerinin listesi.
nextPageToken

string

Yalnızca çıkış. Sonraki medya öğesi grubunu almak için bu jetonu kullanın. Varlığı, sonraki istekte daha fazla medya öğesinin kullanılabilir olduğunun tek güvenilir göstergesidir.

Yetkilendirme Kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/photoslibrary
  • https://www.googleapis.com/auth/photoslibrary.readonly
  • https://www.googleapis.com/auth/photoslibrary.readonly.appcreateddata

Filtreler

Medya öğesi aramasına uygulanabilecek filtreler. Birden fazla filtre seçeneği belirtilirse, bunlar birbirleriyle VE olarak değerlendirilir.

JSON gösterimi 
{
  "dateFilter": {
    object (DateFilter)
  },
  "contentFilter": {
    object (ContentFilter)
  },
  "mediaTypeFilter": {
    object (MediaTypeFilter)
  },
  "featureFilter": {
    object (FeatureFilter)
  },
  "includeArchivedMedia": boolean,
  "excludeNonAppCreatedData": boolean
}
Alanlar
dateFilter

object (DateFilter)

Medya öğelerini, oluşturulma tarihlerine göre filtreler.
contentFilter

object (ContentFilter)

Medya öğelerini içeriklerine göre filtreler.
mediaTypeFilter

object (MediaTypeFilter)

Medya öğelerini medya türüne göre filtreler.
featureFilter

object (FeatureFilter)

Medya öğelerini özelliklerine göre filtreler.
includeArchivedMedia

boolean

Ayarlanırsa sonuçlar, kullanıcının arşivlediği medya öğelerini içerir. Varsayılan olarak yanlış değerini içerir (arşivlenmiş medya öğeleri dahil değildir).
excludeNonAppCreatedData

boolean

Ayarlandığında, sonuçlar bu uygulama tarafından oluşturulmayan medya öğelerini hariç tutar. Varsayılan olarak yanlış değerini alır (tüm medya öğeleri döndürülür). photoslibrary.readonly.appcreateddata kapsamı kullanılırsa bu alan yoksayılır.

Tarih Filtresi

Bu filtre, döndürülen medya için izin verilen tarihleri veya tarih aralıklarını tanımlar. Belirli bir tarih grubu ve tarih aralığı grubu seçilebilir.

JSON gösterimi 
{
  "dates": [
    {
      object (Date)
    }
  ],
  "ranges": [
    {
      object (DateRange)
    }
  ]
}
Alanlar
dates[]

object (Date)

Medya öğeleriyle eşleşen tarihlerin listesi' oluşturma tarihi. İstek başına en fazla 5 tarih eklenebilir.
ranges[]

object (DateRange)

Medya öğeleriyle eşleşen tarih aralıklarının listesi ve oluşturulma tarihi. İstek başına en fazla 5 tarih aralığı dahil edilebilir.

Tarih

Tüm bir takvim tarihini temsil eder. Yalnızca ay ve yıl önemli olduğunda (örneğin, Aralık 2018'in tamamında) day değerini 0 olarak ayarlayın. Yalnızca yıl önemliyse (örneğin 2018'in tamamı) day ve month değerlerini 0 olarak ayarlayın. Yalnızca gün ve ay önemliyse (örneğin, yıl dönümü veya doğum günü) year değerini 0 olarak ayarlayın.

Desteklenmeyenler: Tüm değerler 0, yalnızca month veya 0 olarak ayarlanmış ya da hem day hem de year 0 olarak ayarlanmış.

JSON gösterimi 
{
  "year": integer,
  "month": integer,
  "day": integer
}
Alanlar
year

integer

Tarihin yılı. 1 ile 9999 arasında veya yıl olmadan bir tarih belirtmek için 0 olmalıdır.
month

integer

Yılın ayı. 1 ile 12 arasında veya ay ve gün içermeyen bir yıl belirtmek için 0 olmalıdır.
day

integer

Ayın günü. 1 ile 31 arasında ve yıl ile ay için geçerli olmalıdır. Günün önemli olmadığı bir yıl/ay belirtiyorsanız 0 olmalıdır.

DateRange

Tarih aralığını tanımlar. Her iki tarih de aynı biçimde olmalıdır. Daha fazla bilgi için Date adresini ziyaret edin.

JSON gösterimi 
{
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  }
}
Alanlar
startDate

object (Date)

Belirtilen biçimlerden birinde başlangıç tarihi (aralığın parçası olarak dahil edilir).
endDate

object (Date)

Bitiş tarihi (aralığa dahil). Başlangıç tarihiyle aynı biçimde belirtilmelidir.

İçerikFiltreleme

Bu filtre, içerik türüne göre medya öğeleri döndürmenizi sağlar.

Eklenecek kategorilerin ve/veya hariç tutulacak kategorilerin listesini belirtmek mümkündür. Her listede, kategoriler bir VEYA değeriyle birleştirilir.

İçerik filtresi includedContentCategories: [c1, c2, c3], aşağıdakileri içeren medya öğelerini alır (c1 VEYA c2 VEYA c3).

excludedContentCategories içerik filtresi: [c1, c2, c3], (c1 VEYA c2 VEYA c3) ifadesini içeren medya öğelerini ALMAZ.

Bazı kategorileri dahil ederken bazı kategorileri de dahil edebilirsiniz: includedContentCategories: [c1, c2], excludedContentCategories: [c3, c4]

Önceki örnek, (c1 OR c2) VE DEĞİL (c3 VEYA c4) içeren medya öğelerini alır. includedContentategories içinde görünen bir kategori excludedContentCategories içinde görünmemelidir.

JSON gösterimi 
{
  "includedContentCategories": [
    enum (ContentCategory)
  ],
  "excludedContentCategories": [
    enum (ContentCategory)
  ]
}
Alanlar
includedContentCategories[]

enum (ContentCategory)

Medya öğesi arama sonuçlarına dahil edilecek kategori grubu. Gruptaki öğeler ORed olarak ayarlanır. İstek başına en fazla 10 includedContentCategories olabilir.
excludedContentCategories[]

enum (ContentCategory)

Medya öğesi arama sonuçlarına dahil edilmeyen kategori kümesi. Gruptaki öğeler ORed olarak ayarlanır. İstek başına en fazla 10 excludedContentCategories olabilir.

İçerikKategorisi

Bu, filtreleme yapabileceğiniz önceden tanımlanmış içerik kategorileri grubudur.

Sıralamalar
NONE Varsayılan içerik kategorisi. Filtrede başka bir kategori kullanıldığında bu kategori yok sayılır.
LANDSCAPES Yatay içeren medya öğeleri.
RECEIPTS Makbuz içeren medya öğeleri.
CITYSCAPES Şehir manzaraları içeren medya öğeleri.
LANDMARKS Önemli noktaları içeren medya öğeleri.
SELFIES Selfie olan medya öğeleri.
PEOPLE Kişi içeren medya öğeleri.
PETS Evcil hayvan içeren medya öğeleri.
WEDDINGS Düğünlerden medya ürünleri.
BIRTHDAYS Doğum günlerindeki medya öğeleri.
DOCUMENTS Doküman içeren medya öğeleri.
TRAVEL Seyahat sırasında alınan medya öğeleri.
ANIMALS Hayvanlar içeren medya öğeleri.
FOOD Gıda içeren medya öğeleri.
SPORT Spor etkinliklerinden medya öğeleri.
NIGHT Gece alınan medya öğeleri.
PERFORMANCES Performanslardaki medya öğeleri.
WHITEBOARDS Beyaz tahta içeren medya öğeleri.
SCREENSHOTS Ekran görüntüsü olan medya öğeleri.
UTILITY Faydalı olduğu kabul edilen medya öğeleri. Bunlarla sınırlı olmamakla birlikte dokümanlar, ekran görüntüleri, beyaz tahtalar vb. bu kapsamda yer alır.
ARTS Sanat eseri içeren medya öğeleri.
CRAFTS El sanatları içeren medya öğeleri.
FASHION Modayla ilgili medya öğeleri.
HOUSES Evleri içeren medya öğeleri.
GARDENS Bahçeler içeren medya öğeleri.
FLOWERS Çiçek içeren medya öğeleri.
HOLIDAYS Tatil günlerinden alınan medya öğeleri.

MedyaTürü Filtresi

Bu filtre, döndürülecek medya öğelerinin (ör. videolar veya fotoğraflar) türünü tanımlar. Yalnızca bir medya türü desteklenir.

JSON gösterimi 
{
  "mediaTypes": [
    enum (MediaType)
  ]
}
Alanlar
mediaTypes[]

enum (MediaType)

Dahil edilecek medya öğelerinin türleri. Bu alan yalnızca tek bir medya türüyle doldurulmalıdır. Birden fazla medya türü belirtirseniz hata oluşur.

MedyaTürü

Aranabilecek medya türleri grubu.

Sıralamalar
ALL_MEDIA Hiçbir filtre uygulanmamış gibi ele alınır. Tüm medya türleri dahil edilir.
VIDEO Video olarak kabul edilen tüm medya öğeleri. Kullanıcının Google Fotoğraflar uygulamasını kullanarak oluşturduğu filmler de buna dahildir.
PHOTO Fotoğraf olarak kabul edilen tüm medya öğeleri. Buna .bmp, .gif, .ico, .jpg (ve diğer yazımlar), .tiff, .webp dosyaları ve iOS canlı fotoğrafları, Android hareketli fotoğraflar, panoramalar, fotoğraf Küreleri gibi özel fotoğraf türleri dahildir.

ÖzellikFiltresi

Bu filtre, medya öğelerinin sahip olması gereken özellikleri tanımlar.

JSON gösterimi 
{
  "includedFeatures": [
    enum (Feature)
  ]
}
Alanlar
includedFeatures[]

enum (Feature)

Medya öğesi arama sonuçlarına dahil edilecek özellikler grubu. Gruptaki öğeler ORed'dir ve belirtilen özelliklerden herhangi biriyle eşleşebilir.

Özellik

Filtre uygulayabileceğiniz özellikler grubu.

Sıralamalar
NONE Hiçbir filtre uygulanmamış gibi ele alınır. Tüm özellikler dahildir.
FAVORITES Kullanıcının Google Fotoğraflar uygulamasında favori olarak işaretlediği medya öğeleri.