Untuk daftar metode untuk resource ini, lihat bagian akhir halaman ini.
Representasi resource
Laporan DoubleClick Search. Objek ini berisi permintaan laporan, beberapa metadata laporan seperti kode mata uang, dan baris laporan atau file laporan yang dibuat.
{ "kind": "doubleclicksearch#report", "id": string, "isReportReady": boolean, "request": { "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 }, "statisticsCurrencyCode": string, "statisticsTimeZone": string, "rowCount": integer, "files": [ { "url": string, "byteCount": long } ], "rows": [ { (key): (value) } ] }
Nama properti | Nilai | Deskripsi | Catatan |
---|---|---|---|
files[] |
list |
Hanya laporan asinkron. Berisi daftar file laporan yang dibuat setelah laporan berhasil diselesaikan. | |
files[].byteCount |
long |
Ukuran file laporan ini dalam byte. | |
files[].url |
string |
Gunakan URL ini untuk mendownload file laporan. | |
id |
string |
Hanya laporan asinkron. ID laporan. | |
isReportReady |
boolean |
Hanya laporan asinkron. Benar jika dan hanya jika laporan berhasil diselesaikan dan file laporan siap didownload. | |
kind |
string |
Mengidentifikasi ini sebagai resource Laporan. Nilai: string tetap doubleclicksearch#report . |
|
request |
nested object |
Permintaan yang membuat laporan. Kolom opsional yang tidak ditentukan dalam permintaan awal akan diisi dengan nilai default. | |
request.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. |
|
request.columns[].columnName |
string |
Nama kolom DoubleClick Search yang akan disertakan dalam laporan. | |
request.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. |
|
request.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. | |
request.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 . |
|
request.columns[].groupByColumn |
boolean |
Hanya laporan sinkron. Tetapkan ke true untuk mengelompokkan menurut kolom ini. Nilai defaultnya adalah false . |
|
request.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. |
|
request.columns[].platformSource |
string |
Platform yang digunakan untuk menyediakan data untuk dimensi kustom. Nilai yang dapat diterima adalah "floodlight". | |
request.columns[].productReportPerspective |
string |
Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima:
|
|
request.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. | |
request.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 . |
|
request.downloadFormat |
string |
Format yang digunakan untuk menampilkan laporan. Saat ini csv atau tsv didukung. |
|
request.filters[] |
list |
Daftar filter yang akan diterapkan ke laporan. Jumlah filter maksimum per permintaan adalah 300. |
|
request.filters[].column |
nested object |
Kolom untuk menjalankan filter. Kolom ini dapat berupa kolom DoubleClick Search atau kolom yang disimpan. | |
request.filters[].column.columnName |
string |
Nama kolom DoubleClick Search yang akan disertakan dalam laporan. | |
request.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. |
|
request.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. | |
request.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 . |
|
request.filters[].column.groupByColumn |
boolean |
Hanya laporan sinkron. Tetapkan ke true untuk mengelompokkan menurut kolom ini. Nilai defaultnya adalah false . |
|
request.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. |
|
request.filters[].column.platformSource |
string |
Platform yang digunakan untuk menyediakan data untuk dimensi kustom. Nilai yang dapat diterima adalah "floodlight". | |
request.filters[].column.productReportPerspective |
string |
Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima:
|
|
request.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. | |
request.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 . |
|
request.filters[].operator |
string |
Operator yang akan digunakan dalam filter. Lihat referensi filter untuk daftar operator yang tersedia. | |
request.filters[].values[] |
list |
Daftar nilai untuk memfilter nilai kolom. Jumlah maksimum nilai filter per permintaan adalah 300. |
|
request.includeDeletedEntities |
boolean |
Menentukan apakah entitas yang dihapus harus disertakan dalam laporan. Default-nya adalah false . Tidak digunakan lagi, sebagai gantinya gunakan includeRemovedEntities . |
|
request.includeRemovedEntities |
boolean |
Menentukan apakah entitas yang dihapus harus disertakan dalam laporan. Default-nya adalah false . |
|
request.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. |
|
request.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. |
|
request.orderBy[].column |
nested object |
Kolom untuk melakukan penyortiran. Kolom ini dapat berupa kolom yang ditentukan DoubleClick Search atau kolom yang disimpan. | |
request.orderBy[].column.columnName |
string |
Nama kolom DoubleClick Search yang akan disertakan dalam laporan. | |
request.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. |
|
request.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. | |
request.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 . |
|
request.orderBy[].column.groupByColumn |
boolean |
Hanya laporan sinkron. Tetapkan ke true untuk mengelompokkan menurut kolom ini. Nilai defaultnya adalah false . |
|
request.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. |
|
request.orderBy[].column.platformSource |
string |
Platform yang digunakan untuk menyediakan data untuk dimensi kustom. Nilai yang dapat diterima adalah "floodlight". | |
request.orderBy[].column.productReportPerspective |
string |
Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima:
|
|
request.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. | |
request.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 . |
|
request.orderBy[].sortOrder |
string |
Arah pengurutan, yaitu ascending atau descending . |
|
request.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. | |
request.reportScope.adGroupId |
long |
ID grup iklan DS. | |
request.reportScope.adId |
long |
ID iklan DS. | |
request.reportScope.advertiserId |
long |
ID pengiklan DS. | |
request.reportScope.agencyId |
long |
ID agensi DS. | |
request.reportScope.campaignId |
long |
ID kampanye DS. | |
request.reportScope.engineAccountId |
long |
ID akun mesin DS. | |
request.reportScope.keywordId |
long |
ID kata kunci DS. | |
request.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. |
|
request.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 . |
|
request.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 . |
|
request.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). |
|
request.timeRange |
object |
Jika metrik diminta dalam laporan, argumen ini akan digunakan untuk membatasi metrik ke rentang waktu tertentu. | |
request.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. |
|
request.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. |
|
request.timeRange.endDate |
string |
Tanggal inklusif dalam format YYYY-MM-DD. | |
request.timeRange.startDate |
string |
Tanggal inklusif dalam format YYYY-MM-DD. | |
request.verifySingleTimeZone |
boolean |
Jika true , laporan hanya akan dibuat jika semua data statistik yang diminta berasal dari satu zona waktu. Nilai defaultnya adalah false . |
|
rowCount |
integer |
Jumlah baris laporan yang dibuat oleh laporan, tidak termasuk header. | |
rows[] |
list |
Hanya laporan sinkron. Baris laporan yang dihasilkan. | |
rows[].(key) |
any value |
Menunjukkan kolom yang diwakili dalam baris ini. Artinya, setiap kunci sesuai dengan kolom dengan sel yang tidak kosong di baris ini. | |
statisticsCurrencyCode |
string |
Kode mata uang dari semua nilai moneter yang dihasilkan dalam laporan, termasuk nilai yang ditetapkan oleh pengguna (misalnya, setelan bid kata kunci) dan metrik (misalnya, biaya dan pendapatan). Kode mata uang laporan ditentukan oleh kolom statisticsCurrency dalam permintaan laporan. |
|
statisticsTimeZone |
string |
Jika semua statistik laporan berasal dari zona waktu yang sama, ini adalah contoh yang tepat. Jika tidak, kolom ini tidak akan ditetapkan. |
Metode
- buat
- Segera membuat dan menampilkan laporan.
- dapatkan
- Polling untuk mengetahui status permintaan laporan.
- getFile
- Mendownload file laporan yang dienkode dalam UTF-8.
- getIdMappingFile
- Mendownload file CSV (dienkode dalam UTF-8) yang berisi pemetaan ID antara Search Ads 360 versi sebelumnya dan Search Ads 360 versi baru. Untuk pengiklan yang diminta, file tersebut mencakup semua entitas turunan (misalnya, akun mesin, kampanye, grup iklan, dll.) yang ada di Search Ads 360 versi sebelumnya dan Search Ads 360 versi baru.
- permintaan
- Menyisipkan permintaan laporan ke dalam sistem pelaporan.