Etkileşim öznitelikleri başvuru kılavuzu

Etkileşim endpoint'lerinin döndürdüğü etkileşim ve yanıt nesnelerine ait alanların başvuru kılavuzu.

Etkileşim nesneleri, Bir konumun etkileşimlerini listeleme, Toplu etkileşimleri alma ve Etkileşimleri kimliklerine göre alma tarafından döndürülür. Sayfalama kullanan iki endpoint, bu nesneleri Relay tarzı bir bağlantı yapısıyla sarmalar: data.interactions (konum başına) ve data.rollupInteractions (hesap genelindeki toplu sonuçlar) yapılarının her biri edges[].node, pageInfo ve totalCount içerir. Kimliklere göre getirme işleminde sayfalama kullanılmaz; data.interactionDetails, edges, pageInfo veya totalCount içermeyen düz bir { "interactions": [ ... ] } nesnesidir.

Etkileşim alanları

AlanTürAçıklama
idStringEtkileşimin UUID'si. Yanıt verirken interactionId olarak iletin
interactionIdStringid ile aynı UUID
sourceStringYorum sitesinin veya sosyal sitenin ana makine adı (e.g. maps.google.com, yelp.com)
titleStringKaynak tarafından sağlanıyorsa etkileşim başlığı
contentStringYorumun veya gönderinin gövde metni
authorNameStringYazarın görünen adı
ratingIntegerYıldız puanı, 1–5 (yalnızca yorumlar için)
dateStringEtkileşimin ISO 8601 biçimindeki zaman damgası
permalinkStringKaynak sitedeki etkileşime doğrudan bağlantı
categoryStringÜst düzey kategori, e.g. Review veya Social
typeStringBelirli etkileşim türü, Review, Question, Comment, Recommendation, Post, Photo, Message, Response
respondedBooleanİşletme sahibinin yanıtının bulunup bulunmadığı
notesStringHesap sahibinin özel notları
responsesArrayBu etkileşime eklenen işletme sahibi yanıtları (aşağıya bakın)
responseCountIntegerEklenen yanıtların sayısı
canRespondBooleanBu kaynak için Listings API üzerinden yanıt yayımlanıp yayımlanamayacağı
locationIdIntegerEtkileşimin ait olduğu konumun sayısal veritabanı kimliği
flaggedReasonStringVarsa, etkileşimin işaretlenme nedeni

Yanıt nesnesinin alanları

Bir etkileşimin responses dizisindeki her öğe (ve Bir etkileşime yanıt verme tarafından döndürülen nesne):

AlanTürAçıklama
idStringBenzersiz yanıt kimliği (düzenlerken veya arşivlerken responseId olarak iletin)
interactionIdStringBu yanıtın ait olduğu etkileşimin kimliği
contentStringYanıtın metni
authorNameStringYanıtlayan olarak gösterilen ad
dateStringYanıtın oluşturulduğu anın zaman damgası
respondedWithStringVarsa, kullanılan yanıt şablonunun kimliği
respondedByIntegerYanıtı gönderen Listings API kullanıcısının kimliği
interactionStatusStringYaşam döngüsü durumu, CREATED, FAILED, COMPLETED veya CONFIRMED
editedResponseBooleanBu yanıtın ilk yayımlandığından bu yana düzenlenip düzenlenmediği
remarksStringSistem açıklamaları (e.g. hata ayrıntısı)

Yanıt durumu akışı

interactionStatus alanı, kaynak siteye yayımlanma süreci boyunca yanıtı takip eder:

  • CREATED → COMPLETED: yayın platformunda yayımlandı; bu platformda ikinci bir doğrulama yapılamaz
  • CREATED → COMPLETED → CONFIRMED: yayımlandı ve ardından yayın platformu tarafından doğrulandı
  • CREATED → FAILED: yayın platformuna gönderim başarılı olmadı; remarks alanına bakın

Filtre enum değerleri

Sayfalama kullanan endpoint'ler şu enum değerlerini filtre olarak kabul eder:

  • responseStatus: RESPONDED, PENDING
  • sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
  • category: REVIEW (ve her hesap için sunulan diğer üst düzey kategoriler)