Ringkasan

Reporting API

Reporting API memungkinkan penjual berinteraksi dengan data performa mereka secara terprogram melalui Bahasa Kueri Merchant Center. Hal ini mirip dengan kemampuan untuk membuat laporan kustom langsung di Merchant Center. Reporting API memiliki manfaat berikut:

  • Memungkinkan penjual besar mengimpor data performa untuk listingan produk ke dalam sistem pelaporan internal atau pihak ketiga mereka.
  • Memungkinkan pengguna, partner pihak ketiga, dan agregator yang mengelola akun Merchant Center mengakses pelaporan.

Pengguna API dapat menentukan data performa yang ingin mereka ambil dalam respons panggilan Penelusuran, seperti:

  • Metrik yang akan ditampilkan (misalnya: Klik, Tayangan)
  • Dimensi untuk menyegmentasikan data (misalnya: OfferId, Date)
  • Ketentuan yang harus dipenuhi (misalnya: Klik > 100)

Bahasa kueri Reporting API dapat mengkueri Content API for Shopping untuk metrik performa (klik, tayangan), yang mungkin disegmentasikan menurut berbagai dimensi (atribut peristiwa yang dilaporkan seperti program dan tanggal, serta atribut produk seperti merek, kategori, dll.), menggunakan metode Search pada layanan Reports.

Hasil dari kueri ke layanan Reports adalah daftar instance ReportRow, dengan setiap ReportRow mewakili nilai metrik yang diminta untuk segmen yang Anda tentukan dalam kueri. Jika tidak ada segmen yang ditentukan, satu baris akan ditampilkan dengan metrik yang digabungkan di semua segmen. Sebaliknya, jika ada segmen yang diminta bersama metrik, respons akan menampilkan satu baris untuk setiap tuple segmen yang unik. Anda dapat memilih beberapa segmen dan beberapa metrik dalam satu kueri.

Kueri untuk metrik

Anda dapat mengajukan kueri untuk metrik (Klik, Tayangan, CTR, dsb.) yang ingin Anda tampilkan. Anda harus menambahkan filter pada rentang tanggal untuk membuat kueri ke layanan Laporan. Contoh kueri di bawah ini menampilkan satu baris: jumlah gabungan klik dalam kondisi tambahan suatu rentang tanggal.

SELECT metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-21';

Contoh respons

Contoh respons kode JSON di bawah ini menunjukkan bagaimana penjual ini mendapatkan 4.440 klik yang dijumlahkan di seluruh produk mereka di semua tujuan antara 1 Desember 2020 dan 21 Desember 2020.

{"results": [
    {
      "metrics": {
        "clicks": "4,440"
      }
    }
]}

Kueri untuk segmen

Selain metrik, Anda juga dapat membuat kueri untuk segmen, yang dapat berupa atribut produk (offer_id, brand, category, dll.) atau atribut peristiwa yang dilaporkan (date, program). Peristiwa yang dilaporkan adalah tayangan atau klik untuk produk.

Segmen bertindak mirip dengan GROUP BY di SQL. Segmen membagi metrik yang dipilih, mengelompokkan berdasarkan setiap segmen dalam klausa SELECT. Kueri sampel di bawah ini menampilkan klik per hari, yang diurutkan berdasarkan klik secara menurun dalam kondisi tambahan untuk rentang tanggal. Hanya baris dengan setidaknya satu metrik yang diminta bukan nol yang akan ditampilkan.

SELECT
  segments.date,
  metrics.clicks
FROM MerchantPerformanceView
WHERE segments.date BETWEEN '2020-12-01' AND '2020-12-03'
ORDER BY metrics.clicks DESC;

Contoh respons

Contoh respons kode JSON di bawah ini menunjukkan bagaimana penjual ini mendapatkan 1.546 klik di semua produk mereka di semua tujuan mereka pada 1 Desember 2020 dan 829 klik di semua produk mereka di semua tujuan mereka pada 2 Desember 2020. Tidak ada objek yang akan ditampilkan untuk 3 Desember 2020 karena penjual tidak memiliki klik pada hari tersebut.

{
  "results": [
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 1
        }
      },
      "metrics": {
        "clicks": "1546"
      }
    },
    {
      "segments": {
        "date": {
          "year": 2020,
          "month": 12,
          "day": 2
        }
      },
      "metrics": {
        "clicks": "829"
      }
    }
]}
Berikutnya
Tata bahasa kueri