Method: mediaItems.search

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 hatayla sonuçlanır.

HTTP isteği

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

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

İstek içeriği

İsteğin gövdesi, aşağıdaki yapıya sahip veriler içerir:

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

string

Bir albümün tanımlayıcısı. Doldurulduğunda, belirtilen albümdeki tüm medya öğelerini listeler. 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 değeri 25, maksimum değer 100'dür.

pageToken

string

Sonuçların sonraki sayfasını almak için bir devam jetonu. İsteğe bu dizenin eklenmesi, pageToken öğesinden sonraki satırları döndürür. pageToken, searchMediaItems isteğine verilen yanıttaki nextPageToken parametresinde döndürülen değer olmalıdır.

filters

object (Filters)

İsteğe uygulanacak filtreler. albumId ile birlikte 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 en yeni, en eski, en son creationTime olacak şekilde görüntülenir. MediaMetadata.creation_time sağlandığında arama sonuçları ters sırada görüntülenir; en eskiden en yeniye, sonra en yeniye göre sıralanır. Önce en yeni, sonra en eski sonuçları görüntülemek için desc bağımsız değişkenini şu şekilde ekleyin: MediaMetadata.creation_time desc.

Bu parametreyle kullanılabilecek ek filtreler yalnızca includeArchivedMedia ve excludeNonAppCreatedData'dir. Diğer filtreler desteklenmez.

Yanıt gövdesi

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

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

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ış. Bir sonraki medya öğesi grubunu almak için bu jetonu kullanın. Bu öğenin varlığı, bir sonraki istekte daha fazla medya öğesinin kullanılabilir olduğuna dair tek güvenilir göstergedir.

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 çok filtre seçeneği belirtilirse, bunlar birbiriyle VE olarak ele alınır.

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ğerine ayarlanır (arşivlenen medya öğeleri dahil edilmez).

excludeNonAppCreatedData

boolean

Politika ayarlanırsa sonuçlarda bu uygulama tarafından oluşturulmayan medya öğeleri hariç tutulur. Varsayılan olarak yanlış değerine ayarlanır (tüm medya öğeleri döndürülür). photoslibrary.readonly.appcreateddata kapsamı kullanılırsa bu alan yoksayılır.

DateFilter

Bu filtre, döndürülen medya için izin verilen tarihleri veya tarih aralıklarını tanımlar. Belirli tarihler ve tarih aralıkları kümesi seçebilirsiniz. Medya öğesinin yakalandığı tarihi belirten meta veriler olmadan yüklenen medya öğeleri, tarih filtreleri kullanan sorgularda döndürülmez. Bu durumda Google Fotoğraflar sunucu yükleme saati yedek olarak kullanılmaz.

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

object (Date)

Medya öğelerinin oluşturulma tarihiyle eşleşen tarihlerin listesi. İstek başına en fazla 5 tarih eklenebilir.

ranges[]

object (DateRange)

Medya öğelerinin oluşturulma tarihiyle eşleşen tarih aralıklarının listesi. İstek başına en fazla 5 tarih aralığı eklenebilir.

Tarih

Tüm takvim tarihini temsil eder. Yalnızca ay ve yıl önemliyse (ör. Aralık 2018'in tamamı) 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 (ör. yıl dönümü veya doğum günü) year değerini 0 olarak ayarlayın.

Desteklenmez: Tüm değerlerin 0, yalnızca month değerinin 0 veya hem day hem de year değerlerinin aynı anda 0 olarak ayarlanması.

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

integer

Tarihin yılı. 1 ile 9999 arasında veya yıl içermeyen 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 olup yıl ve ay için geçerli olmalıdır veya günün önemli olmadığı bir yıl/ay belirtiyorsa 0 olmalıdır.

DateRange

Tarih aralığı tanımlar. Her iki tarih de aynı biçimde olmalıdır. Daha fazla bilgi için Date başlıklı makaleyi inceleyin.

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

object (Date)

Açıklanan biçimlerden birindeki başlangıç tarihi (aralığın bir parçası olarak dahildir).

endDate

object (Date)

Bitiş tarihi (aralığın bir parçası olarak dahildir). Bu değer, başlangıç tarihiyle aynı biçimde belirtilmelidir.

ContentFilter

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

Dahil edilecek kategorilerin ve/veya hariç tutulacak kategorilerin listesini belirtebilirsiniz. Her listede, kategoriler bir VEYA ifadesiyle birleştirilir.

includedContentCategories içerik filtresi: [c1, c2, c3], (c1 OR c2 OR c3) içeren medya öğelerini alır.

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

Ayrıca, şu örnekte olduğu gibi bazı kategorileri hariç tutarken bazılarını dahil edebilirsiniz: includedContentCategories: [c1, c2], excludedContentCategories: [c3, c4]

Önceki örnek, (c1 OR c2) AND NOT (c3 OR 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 kümesi. Kümedeki öğelerde OR işlemi uygulanır. İstek başına en fazla 10 includedContentCategories olabilir.

excludedContentCategories[]

enum (ContentCategory)

Medya öğesi arama sonuçlarına dahil edilmeyecek kategori kümesi. Kümedeki öğelerde OR işlemi uygulanır. İstek başına en fazla 10 excludedContentCategories olabilir.

ContentCategory

Bu, filtre uygulayabileceğiniz önceden tanımlanmış bir içerik kategorileri kümesidir.

Sıralamalar
NONE Varsayılan içerik kategorisi. Filtrede başka bir kategori kullanılıyorsa bu kategori yoksayılır.
LANDSCAPES Yatay içeren medya öğeleri.
RECEIPTS Makbuzları 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şileri içeren medya öğeleri.
PETS Evcil hayvan içeren medya öğeleri.
WEDDINGS Düğünlerden medya öğeleri.
BIRTHDAYS Doğum günlerinden medya öğeleri.
DOCUMENTS Doküman içeren medya öğeleri.
TRAVEL Seyahat sırasında alınan medya öğeleri.
ANIMALS Hayvan içeren medya öğeleri.
FOOD Yiyecek içeren medya öğeleri.
SPORT Spor etkinliklerine ait medya öğeleri.
NIGHT Gece alınan medya öğeleri.
PERFORMANCES Performanslardan medya öğeleri.
WHITEBOARDS Beyaz tahta içeren medya öğeleri.
SCREENSHOTS Ekran görüntüsü olan medya öğeleri.
UTILITY Yardımcı olarak kabul edilen medya öğeleri. Bu görüntülere dokümanlar, ekran görüntüleri, beyaz tahtalar vb. dahildir, ancak bunlarla sınırlı değildir.
ARTS Sanat eseri içeren medya öğeleri.
CRAFTS El işi içeren medya öğeleri.
FASHION Modayla ilgili medya öğeleri.
HOUSES Ev içeren medya öğeleri.
GARDENS Bahçe içeren medya öğeleri.
FLOWERS Çiçek içeren medya öğeleri.
HOLIDAYS Tatil dönemlerinde alınan medya öğeleri.

MediaTypeFilter

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 bir medya türüyle doldurulmalıdır. Birden çok medya türü belirtirseniz hata oluşur.

MediaType

Aranabilecek medya türleri kümesi.

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

FeatureFilter

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

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

enum (Feature)

Medya öğesi arama sonuçlarına dahil edilecek özellik kümesi. Kümedeki öğeler OR'dedir ve belirtilen özelliklerin herhangi biriyle eşleşebilir.

Öne Çıkarın

Filtre uygulayabileceğiniz özellik grubu.

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