Reports: request

Menyisipkan permintaan laporan ke dalam sistem pelaporan. Coba sekarang.

Permintaan

Permintaan HTTP

POST https://www.googleapis.com/doubleclicksearch/v2/reports

Otorisasi

Permintaan ini memerlukan otorisasi dengan cakupan berikut:

Cakupan
https://www.googleapis.com/auth/doubleclicksearch

Untuk mengetahui informasi selengkapnya, lihat halaman autentikasi dan otorisasi.

Isi permintaan

Dalam isi permintaan, berikan data dengan struktur berikut:

{
  "reportScope": {
    "agencyId": long,
    "advertiserId": long,
    "engineAccountId": long,
    "campaignId": long,
    "adGroupId": long,
    "keywordId": long,
    "adId": long
  },
  "reportType": string,
  "columns": [
    {
      "columnName": string,
      "savedColumnName": string,
      "customDimensionName": string,
      "customMetricName": string,
      "headerText": string,
      "startDate": string,
      "endDate": string,
      "groupByColumn": boolean,
      "platformSource": string,
      "productReportPerspective": string
    }
  ],
  "timeRange": {
    "startDate": string,
    "endDate": string,
    "changedMetricsSinceTimestamp": datetime,
    "changedAttributesSinceTimestamp": datetime
  },
  "filters": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "operator": string,
      "values": [
        (value)
      ]
    }
  ],
  "orderBy": [
    {
      "column": {
        "columnName": string,
        "savedColumnName": string,
        "customDimensionName": string,
        "customMetricName": string,
        "headerText": string,
        "startDate": string,
        "endDate": string,
        "groupByColumn": boolean,
        "platformSource": string,
        "productReportPerspective": string
      },
      "sortOrder": string
    }
  ],
  "includeDeletedEntities": boolean,
  "includeRemovedEntities": boolean,
  "verifySingleTimeZone": boolean,
  "downloadFormat": string,
  "statisticsCurrency": string,
  "startRow": integer,
  "rowCount": integer,
  "maxRowsPerFile": integer
}
Nama properti Nilai Deskripsi Catatan
reportScope object reportScope adalah kumpulan ID yang digunakan untuk menentukan subkumpulan entitas yang akan ditampilkan dalam laporan. Silsilah lengkap ID dari tingkat cakupan terendah yang diinginkan melalui agensi wajib diisi.
reportScope.agencyId long ID agensi DS.
reportScope.advertiserId long ID pengiklan DS.
reportScope.engineAccountId long ID akun mesin DS.
reportScope.campaignId long ID kampanye DS.
reportScope.adGroupId long ID grup iklan DS.
reportScope.keywordId long ID kata kunci DS.
reportScope.adId long ID iklan DS.
reportType string Menentukan jenis baris yang ditampilkan dalam laporan. Misalnya, jika Anda menentukan reportType: keyword, setiap baris dalam laporan akan berisi data tentang kata kunci. Lihat referensi Jenis Laporan untuk mengetahui kolom yang tersedia untuk setiap jenis.
columns[] list Kolom yang akan disertakan dalam laporan. Hal ini mencakup kolom DoubleClick Search dan kolom yang disimpan. Untuk kolom DoubleClick Search, hanya parameter columnName yang diperlukan. Untuk kolom yang disimpan, hanya parameter savedColumnName yang diperlukan. columnName dan savedColumnName tidak dapat ditetapkan dalam stanza yang sama.

Jumlah maksimum kolom per permintaan adalah 300.
columns[].columnName string Nama kolom DoubleClick Search yang akan disertakan dalam laporan.
columns[].savedColumnName string Nama kolom tersimpan yang akan disertakan dalam laporan. Laporan harus tercakup di pengiklan atau lebih rendah, dan kolom tersimpan ini harus sudah dibuat di UI DoubleClick Search.
columns[].headerText string Teks yang digunakan untuk mengidentifikasi kolom ini dalam output laporan; default ke columnName atau savedColumnName jika tidak ditentukan. Hal ini dapat digunakan untuk mencegah bentrok antara kolom DoubleClick Search dan kolom tersimpan dengan nama yang sama.
columns[].startDate string Tanggal inklusif dalam format YYYY-MM-DD. Jika disediakan, rentang waktu ini akan menggantikan keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan endDate.
columns[].endDate string Hari inklusif dalam format YYYY-MM-DD. Jika disediakan, rentang waktu ini akan menggantikan keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan startDate.
columns[].groupByColumn boolean Hanya laporan sinkron. Tetapkan ke true untuk mengelompokkan menurut kolom ini. Nilai defaultnya adalah false.
timeRange object Jika metrik diminta dalam laporan, argumen ini akan digunakan untuk membatasi metrik ke rentang waktu tertentu.
timeRange.startDate string Tanggal inklusif dalam format YYYY-MM-DD.
timeRange.endDate string Tanggal inklusif dalam format YYYY-MM-DD.
timeRange.changedMetricsSinceTimestamp datetime Stempel waktu UTC inklusif dalam format RFC, misalnya, 2013-07-16T10:16:23.555Z. Lihat referensi tambahan mengenai cara kerja laporan metrik yang diubah.
timeRange.changedAttributesSinceTimestamp datetime Stempel waktu UTC inklusif dalam format RFC, misalnya, 2013-07-16T10:16:23.555Z. Lihat referensi tambahan tentang cara kerja laporan atribut yang diubah.
filters[] list Daftar filter yang akan diterapkan ke laporan.

Jumlah filter maksimum per permintaan adalah 300.
filters[].column nested object Kolom untuk menjalankan filter. Kolom ini dapat berupa kolom DoubleClick Search atau kolom yang disimpan.
filters[].column.columnName string Nama kolom DoubleClick Search yang akan disertakan dalam laporan.
filters[].column.savedColumnName string Nama kolom tersimpan yang akan disertakan dalam laporan. Laporan harus tercakup di pengiklan atau lebih rendah, dan kolom tersimpan ini harus sudah dibuat di UI DoubleClick Search.
filters[].operator string Operator yang akan digunakan dalam filter. Lihat referensi filter untuk daftar operator yang tersedia.
filters[].values[] list Daftar nilai untuk memfilter nilai kolom.

Jumlah maksimum nilai filter per permintaan adalah 300.
orderBy[] list Hanya laporan sinkron. Daftar kolom dan rute yang menentukan pengurutan yang harus dilakukan di baris laporan.

Jumlah maksimum pemesanan per permintaan adalah 300.
orderBy[].column nested object Kolom untuk melakukan penyortiran. Kolom ini dapat berupa kolom yang ditentukan DoubleClick Search atau kolom yang disimpan.
orderBy[].column.columnName string Nama kolom DoubleClick Search yang akan disertakan dalam laporan.
orderBy[].column.savedColumnName string Nama kolom tersimpan yang akan disertakan dalam laporan. Laporan harus tercakup di pengiklan atau lebih rendah, dan kolom tersimpan ini harus sudah dibuat di UI DoubleClick Search.
orderBy[].sortOrder string Arah pengurutan, yaitu ascending atau descending.
includeDeletedEntities boolean Menentukan apakah entitas yang dihapus harus disertakan dalam laporan. Default-nya adalah false. Tidak digunakan lagi, sebagai gantinya gunakan includeRemovedEntities.
verifySingleTimeZone boolean Jika true, laporan hanya akan dibuat jika semua data statistik yang diminta berasal dari satu zona waktu. Nilai defaultnya adalah false.
downloadFormat string Format yang digunakan untuk menampilkan laporan. Saat ini csv atau tsv didukung.
statisticsCurrency string Menentukan mata uang yang akan digunakan untuk mengembalikan uang. Kemungkinan nilainya adalah: usd, agency (valid jika laporan tercakup ke agensi atau yang lebih rendah), advertiser (valid jika laporan memiliki cakupan * pengiklan atau lebih rendah), atau account (valid jika laporan tercakup ke akun mesin atau yang lebih rendah).
startRow integer Hanya laporan sinkron. Indeks berbasis nol dari baris pertama yang akan ditampilkan. Nilai yang dapat diterima adalah 0 hingga 50000, inklusif. Default-nya adalah 0.
rowCount integer Hanya laporan sinkron. Jumlah maksimum baris yang akan ditampilkan; baris tambahan akan dihapus. Nilai yang dapat diterima adalah 0 hingga 10000, inklusif. Default-nya adalah 10000.
maxRowsPerFile integer Hanya laporan asinkron. Jumlah maksimum baris per file laporan. Laporan besar dibagi menjadi beberapa file berdasarkan kolom ini. Nilai yang dapat diterima adalah 1000000 hingga 100000000, inklusif.
includeRemovedEntities boolean Menentukan apakah entitas yang dihapus harus disertakan dalam laporan. Default-nya adalah false.
columns[].customDimensionName string Segmentasikan laporan menurut dimensi kustom. Laporan harus mencakup pengiklan atau lebih rendah, dan dimensi kustom harus sudah disiapkan di DoubleClick Search. Nama dimensi kustom, yang muncul di DoubleClick Search, peka huruf besar/kecil.

Jika digunakan dalam laporan konversi, menampilkan nilai dimensi kustom yang ditentukan untuk konversi tertentu, jika ditetapkan. Kolom ini tidak menyegmentasikan laporan konversi.
columns[].platformSource string Platform yang digunakan untuk menyediakan data untuk dimensi kustom. Nilai yang dapat diterima adalah "floodlight".
filters[].column.customDimensionName string Segmentasikan laporan menurut dimensi kustom. Laporan harus mencakup pengiklan atau lebih rendah, dan dimensi kustom harus sudah disiapkan di DoubleClick Search. Nama dimensi kustom, yang muncul di DoubleClick Search, peka huruf besar/kecil.

Jika digunakan dalam laporan konversi, menampilkan nilai dimensi kustom yang ditentukan untuk konversi tertentu, jika ditetapkan. Kolom ini tidak menyegmentasikan laporan konversi.
filters[].column.headerText string Teks yang digunakan untuk mengidentifikasi kolom ini dalam output laporan; default ke columnName atau savedColumnName jika tidak ditentukan. Hal ini dapat digunakan untuk mencegah bentrok antara kolom DoubleClick Search dan kolom tersimpan dengan nama yang sama.
filters[].column.startDate string Tanggal inklusif dalam format YYYY-MM-DD. Jika disediakan, rentang waktu ini akan menggantikan keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan endDate.
filters[].column.endDate string Hari inklusif dalam format YYYY-MM-DD. Jika disediakan, rentang waktu ini akan menggantikan keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan startDate.
filters[].column.groupByColumn boolean Hanya laporan sinkron. Tetapkan ke true untuk mengelompokkan menurut kolom ini. Nilai defaultnya adalah false.
filters[].column.platformSource string Platform yang digunakan untuk menyediakan data untuk dimensi kustom. Nilai yang dapat diterima adalah "floodlight".
orderBy[].column.customDimensionName string Segmentasikan laporan menurut dimensi kustom. Laporan harus mencakup pengiklan atau lebih rendah, dan dimensi kustom harus sudah disiapkan di DoubleClick Search. Nama dimensi kustom, yang muncul di DoubleClick Search, peka huruf besar/kecil.

Jika digunakan dalam laporan konversi, menampilkan nilai dimensi kustom yang ditentukan untuk konversi tertentu, jika ditetapkan. Kolom ini tidak menyegmentasikan laporan konversi.
orderBy[].column.headerText string Teks yang digunakan untuk mengidentifikasi kolom ini dalam output laporan; default ke columnName atau savedColumnName jika tidak ditentukan. Hal ini dapat digunakan untuk mencegah bentrok antara kolom DoubleClick Search dan kolom tersimpan dengan nama yang sama.
orderBy[].column.startDate string Tanggal inklusif dalam format YYYY-MM-DD. Jika disediakan, rentang waktu ini akan menggantikan keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan endDate.
orderBy[].column.endDate string Hari inklusif dalam format YYYY-MM-DD. Jika disediakan, rentang waktu ini akan menggantikan keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan startDate.
orderBy[].column.groupByColumn boolean Hanya laporan sinkron. Tetapkan ke true untuk mengelompokkan menurut kolom ini. Nilai defaultnya adalah false.
orderBy[].column.platformSource string Platform yang digunakan untuk menyediakan data untuk dimensi kustom. Nilai yang dapat diterima adalah "floodlight".
columns[].customMetricName string Nama metrik kustom yang akan disertakan dalam laporan. Laporan harus mencakup pengiklan atau lebih rendah, dan metrik kustom harus sudah disiapkan di DoubleClick Search. Nama metrik kustom, yang muncul di DoubleClick Search, peka huruf besar/kecil.
filters[].column.customMetricName string Nama metrik kustom yang akan disertakan dalam laporan. Laporan harus mencakup pengiklan atau lebih rendah, dan metrik kustom harus sudah disiapkan di DoubleClick Search. Nama metrik kustom, yang muncul di DoubleClick Search, peka huruf besar/kecil.
orderBy[].column.customMetricName string Nama metrik kustom yang akan disertakan dalam laporan. Laporan harus mencakup pengiklan atau lebih rendah, dan metrik kustom harus sudah disiapkan di DoubleClick Search. Nama metrik kustom, yang muncul di DoubleClick Search, peka huruf besar/kecil.
columns[].productReportPerspective string Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima:
  • "sold": mengembalikan metrik hanya untuk produk yang terjual
  • "advertised": menampilkan metrik hanya untuk produk yang diiklankan di kampanye Shopping, dan yang mungkin sudah terjual atau belum terjual
filters[].column.productReportPerspective string Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima:
  • "sold": mengembalikan metrik hanya untuk produk yang terjual
  • "advertised": menampilkan metrik hanya untuk produk yang diiklankan di kampanye Shopping, dan yang mungkin sudah terjual atau belum terjual
orderBy[].column.productReportPerspective string Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima:
  • "sold": mengembalikan metrik hanya untuk produk yang terjual
  • "advertised": menampilkan metrik hanya untuk produk yang diiklankan di kampanye Shopping, dan yang mungkin sudah terjual atau belum terjual

Respons

Jika berhasil, metode ini akan menampilkan Resource laporan dalam isi respons.

Cobalah!

Gunakan APIs Explorer di bawah untuk memanggil metode ini pada data langsung dan melihat responsnya. Atau, coba mandiri Penjelajah.