Referensi atribut interaksi

Referensi field untuk objek interaksi dan respons yang dikembalikan oleh endpoint interaksi.

Objek interaksi dikembalikan oleh Daftar interaksi untuk lokasi, Dapatkan interaksi agregat, dan Dapatkan interaksi berdasarkan ID. Kedua endpoint dengan paginasi membungkus objek tersebut dalam koneksi bergaya Relay: data.interactions (per lokasi) dan data.rollupInteractions (agregat dalam satu akun) masing-masing memuat edges[].node, pageInfo, dan totalCount. Pengambilan berdasarkan ID tidak menggunakan paginasi; data.interactionDetails adalah objek { "interactions": [ ... ] } biasa tanpa edges, pageInfo, atau totalCount.

Field interaksi

FieldTipeDeskripsi
idStringUUID interaksi. Berikan sebagai interactionId saat memberikan respons
interactionIdStringUUID yang sama dengan id
sourceStringNama host situs ulasan/media sosial (e.g, maps.google.com, yelp.com)
titleStringJudul interaksi, jika disediakan oleh sumber
contentStringTeks isi ulasan atau postingan
authorNameStringNama tampilan penulis
ratingIntegerPeringkat bintang, 1–5 (hanya ulasan)
dateStringStempel waktu interaksi dalam format ISO 8601
permalinkStringTautan langsung ke interaksi di situs sumber
categoryStringKelompok tingkat atas, e.g, Review atau Social
typeStringTipe interaksi spesifik, Review, Question, Comment, Recommendation, Post, Photo, Message, Response
respondedBooleanApakah terdapat respons dari pemilik
notesStringCatatan pribadi pemilik akun
responsesArrayRespons pemilik yang terkait dengan interaksi ini (lihat di bawah)
responseCountIntegerJumlah respons yang terkait
canRespondBooleanApakah respons dapat diposting melalui Listings API untuk sumber ini
locationIdIntegerID numerik dalam basis data untuk lokasi pemilik interaksi
flaggedReasonStringAlasan interaksi ditandai, jika ada

Field objek respons

Setiap item dalam array responses pada interaksi (dan objek yang dikembalikan oleh Berikan respons terhadap interaksi):

FieldTipeDeskripsi
idStringID respons unik (berikan sebagai responseId saat mengedit atau mengarsipkan)
interactionIdStringID interaksi yang terkait dengan respons ini
contentStringTeks respons
authorNameStringNama yang ditampilkan sebagai pemberi respons
dateStringStempel waktu pembuatan respons
respondedWithStringID templat respons yang digunakan, jika ada
respondedByIntegerID pengguna Listings API yang mengirimkan respons
interactionStatusStringStatus siklus hidup, CREATED, FAILED, COMPLETED, atau CONFIRMED
editedResponseBooleanApakah respons ini telah diedit sejak pertama kali diposting
remarksStringKeterangan sistem (e.g, detail kegagalan)

Alur status respons

Field interactionStatus melacak respons selama proses posting ke situs sumber:

  • CREATED → COMPLETED: diposting ke platform publikasi; konfirmasi kedua tidak tersedia di platform tersebut
  • CREATED → COMPLETED → CONFIRMED: diposting lalu dikonfirmasi oleh platform publikasi
  • CREATED → FAILED: pengiriman ke platform publikasi tidak berhasil; lihat remarks

Enum filter

Endpoint dengan paginasi menerima nilai enum berikut sebagai filter:

  • responseStatus: RESPONDED, PENDING
  • sortOrder: NEWEST_FIRST, OLDEST_FIRST, LAST_RESPONDED
  • category: REVIEW (dan kelompok tingkat atas lainnya yang tersedia per akun)