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 dihasilkan.
{ "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 |
Laporan asinkron saja. Berisi daftar file laporan yang dihasilkan 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 |
Laporan asinkron saja. ID laporan. | |
isReportReady |
boolean |
Laporan asinkron saja. Berlaku 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 asli diisi dengan nilai default. | |
request.columns[] |
list |
Kolom yang akan disertakan dalam laporan. Ini mencakup kolom DoubleClick Search dan kolom tersimpan. Untuk kolom DoubleClick Search, hanya parameter columnName yang diperlukan. Untuk kolom tersimpan, 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 untuk disertakan dalam laporan. | |
request.columns[].customDimensionName |
string |
Segmentasikan laporan menurut dimensi kustom. Laporan harus mencakup pengiklan atau yang 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 yang 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 diberikan, ini akan mengganti keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan startDate . |
|
request.columns[].groupByColumn |
boolean |
Laporan sinkron saja. 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; setelan defaultnya adalah columnName atau savedColumnName jika tidak ditentukan. Tindakan ini dapat digunakan untuk mencegah konflik antara kolom DoubleClick Search dan kolom yang disimpan dengan nama yang sama. |
|
request.columns[].platformSource |
string |
Platform yang digunakan untuk memberikan data untuk dimensi kustom. Nilai yang dapat diterima adalah "lampu rias". | |
request.columns[].productReportPerspective |
string |
Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima adalah:
|
|
request.columns[].savedColumnName |
string |
Nama kolom tersimpan untuk disertakan dalam laporan. Laporan harus dicakup di pengiklan atau yang 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 diberikan, ini akan mengganti keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan endDate . |
|
request.downloadFormat |
string |
Format laporan yang akan dikembalikan. Saat ini, csv atau tsv didukung. |
|
request.filters[] |
list |
Daftar filter yang akan diterapkan ke laporan. Jumlah maksimum filter per permintaan adalah 300. |
|
request.filters[].column |
nested object |
Kolom untuk menjalankan filter. Ini dapat berupa kolom DoubleClick Search atau kolom tersimpan. | |
request.filters[].column.columnName |
string |
Nama kolom DoubleClick Search untuk disertakan dalam laporan. | |
request.filters[].column.customDimensionName |
string |
Segmentasikan laporan menurut dimensi kustom. Laporan harus mencakup pengiklan atau yang 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 yang 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 diberikan, ini akan mengganti keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan startDate . |
|
request.filters[].column.groupByColumn |
boolean |
Laporan sinkron saja. 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; setelan defaultnya adalah columnName atau savedColumnName jika tidak ditentukan. Tindakan ini dapat digunakan untuk mencegah konflik antara kolom DoubleClick Search dan kolom yang disimpan dengan nama yang sama. |
|
request.filters[].column.platformSource |
string |
Platform yang digunakan untuk memberikan data untuk dimensi kustom. Nilai yang dapat diterima adalah "lampu rias". | |
request.filters[].column.productReportPerspective |
string |
Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima adalah:
|
|
request.filters[].column.savedColumnName |
string |
Nama kolom tersimpan untuk disertakan dalam laporan. Laporan harus dicakup di pengiklan atau yang 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 diberikan, ini akan mengganti 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 mengetahui 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 |
Laporan asinkron saja. Jumlah maksimum baris per file laporan. Laporan besar dibagi menjadi banyak file berdasarkan kolom ini. Nilai yang dapat diterima adalah 1000000 hingga 100000000 , inklusif. |
|
request.orderBy[] |
list |
Laporan sinkron saja. Daftar kolom dan rute yang menentukan pengurutan yang akan dilakukan di baris laporan. Jumlah maksimum pesanan per permintaan adalah 300. |
|
request.orderBy[].column |
nested object |
Kolom untuk mengurutkan. Ini dapat berupa kolom yang ditentukan DoubleClick Search atau kolom yang disimpan. | |
request.orderBy[].column.columnName |
string |
Nama kolom DoubleClick Search untuk disertakan dalam laporan. | |
request.orderBy[].column.customDimensionName |
string |
Segmentasikan laporan menurut dimensi kustom. Laporan harus mencakup pengiklan atau yang 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 yang 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 diberikan, ini akan mengganti keseluruhan rentang waktu laporan untuk kolom ini saja. Harus diberikan bersama dengan startDate . |
|
request.orderBy[].column.groupByColumn |
boolean |
Laporan sinkron saja. 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; setelan defaultnya adalah columnName atau savedColumnName jika tidak ditentukan. Tindakan ini dapat digunakan untuk mencegah konflik antara kolom DoubleClick Search dan kolom yang disimpan dengan nama yang sama. |
|
request.orderBy[].column.platformSource |
string |
Platform yang digunakan untuk memberikan data untuk dimensi kustom. Nilai yang dapat diterima adalah "lampu rias". | |
request.orderBy[].column.productReportPerspective |
string |
Menampilkan metrik hanya untuk jenis aktivitas produk tertentu. Nilai yang diterima adalah:
|
|
request.orderBy[].column.savedColumnName |
string |
Nama kolom tersimpan untuk disertakan dalam laporan. Laporan harus dicakup di pengiklan atau yang 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 diberikan, ini akan mengganti 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 mana yang akan ditampilkan dalam laporan. Diperlukan baris lengkap ID dari tingkat cakupan terendah yang diinginkan melalui agensi. | |
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 kolom yang tersedia bagi setiap jenis. |
|
request.rowCount |
integer |
Laporan sinkron saja. Jumlah baris maksimum yang akan ditampilkan; baris tambahan dihapus. Nilai yang dapat diterima adalah 0 hingga 10000 , inklusif. Nilai defaultnya adalah 10000 . |
|
request.startRow |
integer |
Laporan sinkron saja. Indeks berbasis nol dari baris pertama yang akan ditampilkan. Nilai yang dapat diterima adalah 0 hingga 50000 , inklusif. Nilai defaultnya adalah 0 . |
|
request.statisticsCurrency |
string |
Menentukan mata uang yang akan digunakan untuk mengembalikan uang. Nilai yang mungkin adalah: usd , agency (valid jika laporan dicakup untuk agensi atau yang lebih rendah), advertiser (valid jika laporan dicakup untuk * pengiklan atau yang lebih rendah), atau account (valid jika laporan dicakup untuk 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, mis., 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, mis., 2013-07-16T10:16:23.555Z . Lihat referensi tambahan tentang 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 dihasilkan oleh laporan, tidak termasuk header. | |
rows[] |
list |
Laporan sinkron saja. Baris laporan yang dihasilkan. | |
rows[].(key) |
any value |
Menunjukkan kolom yang direpresentasikan dalam baris ini. Artinya, setiap kunci sesuai dengan kolom yang berisi sel yang tidak kosong di baris ini. | |
statisticsCurrencyCode |
string |
Kode mata uang dari semua nilai uang yang dihasilkan di laporan, termasuk nilai yang ditetapkan oleh pengguna (mis., setelan bid kata kunci) dan metrik (mis., biaya dan pendapatan). Kode mata uang laporan ditentukan oleh kolom statisticsCurrency dari permintaan laporan. |
|
statisticsTimeZone |
string |
Jika semua statistik laporan berasal dari zona waktu yang sama, berarti memang begitu. Jika tidak, kolom ini tidak disetel. |
Metode
- membuat
- Membuat dan menampilkan laporan dengan segera.
- dapatkan
- Polling untuk 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 (mis. 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.