Method: mediaItems.search

Kullanıcının Google Fotoğraflar kitaplığında medya öğelerini arar. Hiçbir filtre ayarlanmamışsa 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

İstek metni aşağıdaki yapıyla birlikte 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ıdır. Doldurulmuşsa belirtilen albümdeki tüm medya öğelerini listeler. Filtrelerle birlikte ayarlanamaz.
pageSize

integer

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

string

Sonuçların bir sonraki sayfasını almak için bir devam jetonu. Bu parametre isteğe eklendiğinde pageToken'ten sonraki satırlar döndürülür. pageToken, searchMediaItems isteğinin yanıtındaki 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 sırasını belirtmek için isteğe bağlı bir alan. orderBy alanı yalnızca bir dateFilter kullanıldığında çalışır. Bu alan belirtilmediğinde sonuçlar, creationTime değerlerine göre önce en yeni, sonra en eski olacak şekilde gösterilir. MediaMetadata.creation_time sağlandığında arama sonuçları ters sırada (en eskisi önce, en yenisi en son) gösterilir. Sonuçları en yeniden en eskiye doğru görüntülemek için desc bağımsız değişkenini aşağıdaki gibi ekleyin: MediaMetadata.creation_time desc.

Bu parametreyle kullanılabilecek tek ek filtreler includeArchivedMedia ve excludeNonAppCreatedData'dur. 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ış. Sonraki medya öğesi grubunu almak için bu jetonu kullanın. Bu özelliğin varlığı, sonraki istekte daha fazla medya öğesinin mevcut 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 aramaları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şturuldukları tarihe 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 false değerini alır (arşivlenen medya öğeleri dahil edilmez).
excludeNonAppCreatedData

boolean

Ayarlanırsa sonuçlar bu uygulama tarafından oluşturulmayan medya öğelerini hariç tutar. Varsayılan olarak yanlıştı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 bir tarih grubu ve tarih aralığı grubu seçebilirsiniz. Medya öğesinin çekildiği tarihi belirten meta veriler olmadan yüklenen medya öğeleri, tarih filtreleri kullanılan sorgularda döndürülmez. Bu durumda, Google Fotoğraflar sunucusundaki yükleme süresi 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ı listesi. İstek başına en fazla 5 tarih aralığı eklenebilir.

Tarih

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

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

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

integer

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

integer

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

integer

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

DateRange

Bir tarih aralığını tanımlar. Her iki tarih de aynı biçimde olmalıdır. Daha fazla bilgi için Date sayfasına bakın.

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

object (Date)

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

object (Date)

Bitiş tarihi (aralık kapsamındadır). Bitiş tarihi, başlangıç tarihiyle aynı biçimde belirtilmelidir.

ContentFilter

Bu filtre, medya öğelerini içerik türüne göre döndürmenize olanak tanır.

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

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

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

Bazı kategorileri dahil ederken diğerlerini hariç tutabilirsiniz. Örneğin: includedContentCategories: [c1, c2], excludedContentCategories: [c3, c4]

Önceki örnekte, (c1 VEYA c2) VE (c3 VEYA c4) içermeyen medya öğeleri elde edilir. includedContentategories'te görünen bir kategori excludedContentCategories'te görünmemelidir.

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

enum (ContentCategory)

Medya öğesi arama sonuçlarına dahil edilecek kategoriler grubu. Kümedeki öğeler VEYA bağlamında birleştirilir. İstek başına en fazla 10 includedContentCategories olabilir.
excludedContentCategories[]

enum (ContentCategory)

Medya öğesi arama sonuçlarına dahil edilmeyecek kategoriler grubu. Kümedeki öğeler VEYA operatörüyle birleştirilir. İstek başına en fazla 10 excludedContentCategories olabilir.

ContentCategory

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

Sıralamalar
NONE Varsayılan içerik kategorisi. Filtrede başka bir kategori kullanıldığında bu kategori yoksayılır.
LANDSCAPES Manzaralar içeren medya öğeleri.
RECEIPTS Makbuz içeren medya öğeleri.
CITYSCAPES Şehir manzaraları içeren medya öğeleri
LANDMARKS Önemli yerleri içeren medya öğeleri.
SELFIES Selfie olan medya öğeleri.
PEOPLE İnsan içeren medya öğeleri.
PETS Evcil hayvan içeren medya öğeleri
WEDDINGS Düğünlerden alınan medya öğeleri.
BIRTHDAYS Doğum günlerinden medya öğeleri.
DOCUMENTS Belge içeren medya öğeleri.
TRAVEL Seyahat sırasında çekilen medya öğeleri.
ANIMALS Hayvan içeren medya öğeleri
FOOD Yiyecek içeren medya öğeleri
SPORT Spor etkinliklerinden medya öğeleri.
NIGHT Gece çekilen medya öğeleri.
PERFORMANCES Performanslardan alınan medya öğeleri.
WHITEBOARDS Beyaz tahta içeren medya öğeleri.
SCREENSHOTS Ekran görüntüsü olan medya öğeleri.
UTILITY Yardımcı program olarak kabul edilen medya öğeleri. Belgeler, ekran görüntüleri, beyaz tahtalar vb. bu kapsamdadır ancak liste bunlarla sınırlı değildir.
ARTS Poster içeren medya öğeleri.
CRAFTS El işleri içeren medya öğeleri.
FASHION Modayla ilgili medya öğeleri.
HOUSES Ev içeren medya öğeleri.
GARDENS Bahçeler içeren medya öğeleri.
FLOWERS Çiçek içeren medya öğeleri.
HOLIDAYS Tatillerde çekilen medya öğeleri.

MediaTypeFilter

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

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

enum (MediaType)

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

MediaType

Aranabilir medya türleri grubu.

Sıralamalar
ALL_MEDIA Filtre uygulanmamış gibi değerlendirilir. Tüm medya türleri dahildir.
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. .bmp, .gif, .ico, .jpg (ve diğer yazım biçimleri), .tiff, .webp ve iOS Live Photos, Android hareketli fotoğraflar, panoramalar, fotoğraf küreleri gibi özel fotoğraf türleri bu kapsamdadır.

FeatureFilter

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 özellik grubu. Gruptaki öğeler OR (VEYA) işlevine tabi tutulur ve belirtilen özelliklerden herhangi biriyle eşleşebilir.

Özellik

Filtre uygulayabileceğiniz özellik grubu.

Sıralamalar
NONE Filtre uygulanmamış gibi değerlendirilir. Tüm özellikler dahildir.
FAVORITES Kullanıcının Google Fotoğraflar uygulamasında favori olarak işaretlediği medya öğeleri.