Halaman ini menyediakan catatan rilis untuk Google Bid Manager API.
Versi 2
Membuat perubahan struktural pada API, termasuk memperbarui endpoint layanan serta mengganti nama layanan dan metode.
Memperbarui resource Kueri dan Laporan secara signifikan dengan menghapus kolom yang tidak diperlukan, mengatur ulang kolom yang ada, dan mengubah jenis kolom. Hal ini mencakup mengubah jenis kolom untuk menggunakan objek bernama, bukan definisi "objek bertingkat" umum.
Mewajibkan kueri ad-hoc yang berjalan menggunakan metode queries.run
,
bukan menjalankannya secara otomatis setelah dibuat.
Mengganti parameter kueri queries.run
asynchronous
dengan
synchronous
.
Menyederhanakan pengambilan laporan melalui perubahan berikut:
- Penambahan metode
queries.reports.get
. - Penambahan parameter kueri
orderBy
kequeries.reports.list
. - Pembaruan isi respons
queries.run
dari objek kosong menjadi instance resourceReport
yang dihasilkan.
Memperbarui pesan error yang ditampilkan oleh API agar lebih spesifik dan memberikan solusi yang lebih preskriptif.
Ikuti petunjuk yang ditampilkan dalam Panduan Migrasi v2 untuk melakukan migrasi dari v1.1 ke v2.
Fitur baru
Endpoint layanan telah diubah:
Endpoint layanan v1 Endpoint layanan v2 https://www.googleapis.com/doubleclickbidmanager
https://doubleclickbidmanager.googleapis.com
Layanan telah diganti namanya menjadi berikut:
layanan v1 layanan v2 Kueri kueri Laporan queries.reports Metode telah diganti namanya sebagai berikut:
Metode berikut telah ditambahkan:
Layanan Metode queries.reports dapatkan Metode berikut memiliki isi respons baru:
Metode Objek isi respons baru queries.run Laporan Kolom berikut telah dihapus:
Resource Kolom Isi Respons queries.list
kind
Isi Respons queries.reports.list
kind
Kueri kind
reportDataEndTimeMs
reportDataStartTimeMs
timezoneCode
RunQueryRequest reportDataEndTimeMs
reportDataStartTimeMs
timezoneCode
Jenis objek kolom berikut telah diubah menjadi berikut:
Resource Kolom Jenis Objek Kueri Laporan RunQueryRequest Parameter kueri metode berikut telah ditambahkan:
Metode Parameter Kueri queries.list orderBy queries.reports.list orderBy queries.run sinkron Parameter kueri metode berikut telah dihapus:
Metode Parameter Kueri queries.create tidak bersamaan queries.run tidak bersamaan Nilai Filter berikut telah ditambahkan:
Nilai filter FILTER_INVENTORY_MEDIA_COST_TYPE FILTER_TARGETING_EXPANSION Nilai Filter berikut telah dihapus:
Nilai filter FILTER_TRUEVIEW_IAR_REGION Nilai Metrik berikut telah ditambahkan:
Nilai metrik METRIC_STORE_VISIT_VIEW_THROUGH_CONVERSIONS METRIC_UNIQUE_REACH_AVERAGE_VIEWABLE_IMPRESSION_FREQUENCY METRIC_UNIQUE_REACH_IMPRESSION_REACH_ADDED_WITH_CROSS_STACK_FCAP METRIC_UNIQUE_REACH_IMPRESSION_REACH_ADDED_WITH_PG_FMGMT METRIC_UNIQUE_REACH_INCREMENTAL_CLICK_REACH METRIC_UNIQUE_REACH_INCREMENTAL_IMPRESSION_REACH METRIC_UNIQUE_REACH_INCREMENTAL_TOTAL_REACH METRIC_UNIQUE_REACH_INCREMENTAL_VIEWABLE_IMPRESSION_REACH METRIC_UNIQUE_REACH_VIEWABLE_IMPRESSION_REACH
Masalah umum
Tidak ada.
Versi 1.1
Filter one-to-one untuk pemetaan kolom laporan
Filter yang dipetakan ke beberapa kolom laporan kini dipetakan ke satu kolom.
Misalnya, di v1, menyertakan filter FILTER_ADVERTISER
akan menghasilkan laporan
dengan kolom "Advertiser" selain "Advertiser ID". Pada v1.1, semua kolom laporan memiliki filternya sendiri. Misalnya, filter baru
FILTER_ADVERTISER_NAME
dipetakan ke "Pengiklan". Untuk mendapatkan kolom "ID Pengiklan" dan "Pengiklan" di laporan, filter FILTER_ADVERTISER
dan
FILTER_ADVERTISER_NAME
harus disertakan dalam
permintaan
Queries.createquery
.
Lebih jelasnya, permintaan createquery
:
{
...
"params": {
...
"groupBys": ["FILTER_ADVERTISER"],
"metrics": ["METRIC_IMPRESSIONS"],
...
}
...
}
membuat file laporan dengan header berikut di v1:
Advertiser,Advertiser ID,Advertiser Status,Advertiser Integration Code,Impressions
dan header berikut di v1.1:
Advertiser,Impressions
Kode v1 berikut digunakan untuk mendapatkan kolom laporan pada contoh di atas:
List<String> groupBys = new ArrayList<>();
groupBys.add("FILTER_ADVERTISER");
List<String> metrics = new ArrayList<>();
metrics.add("METRIC_IMPRESSIONS");
com.google.api.services.doubleclickbidmanager.model.Parameters createQueryParameters =
new com.google.api.services.doubleclickbidmanager.model.Parameters()
.setGroupBys(groupBys)
.setMetrics(metrics);
harus dimodifikasi seperti berikut di v1.1 (pengurutan filter catatan):
List<String> groupBys = new ArrayList<>();
groupBys.add("FILTER_ADVERTISER_NAME");
groupBys.add("FILTER_ADVERTISER");
groupBys.add("FILTER_ADVERTISER_INTEGRATION_STATUS");
groupBys.add("FILTER_ADVERTISER_INTEGRATION_CODE");
List<String> metrics = new ArrayList<>();
metrics.add("METRIC_IMPRESSIONS");
com.google.api.services.doubleclickbidmanager.model.Parameters createQueryParameters =
new com.google.api.services.doubleclickbidmanager.model.Parameters()
.setGroupBys(groupBys)
.setMetrics(metrics);
Filter asli | Filter ditambahkan |
---|---|
FILTER_ADVERTISER |
FILTER_ADVERTISER_NAME FILTER_ADVERTISER_INTEGRATION_CODE FILTER_ADVERTISER_INTEGRATION_STATUS |
FILTER_AD_POSITION |
FILTER_AD_POSITION_NAME |
FILTER_CARRIER |
FILTER_CARRIER_NAME |
FILTER_CHANNEL_ID |
FILTER_CHANNEL_NAME |
FILTER_CITY |
FILTER_CITY_NAME |
FILTER_COMPANION_CREATIVE_ID |
FILTER_COMPANION_CREATIVE_NAME |
FILTER_DMA |
FILTER_DMA_NAME |
FILTER_INSERTION_ORDER |
FILTER_INSERTION_ORDER_NAME |
FILTER_PARTNER |
FILTER_PARTNER_NAME FILTER_PARTNER_STATUS |
FILTER_REGION |
FILTER_REGION_NAME |
FILTER_TRUEVIEW_DMA |
FILTER_TRUEVIEW_DMA_NAME |
FILTER_TRUEVIEW_IAR_REGION |
FILTER_TRUEVIEW_IAR_REGION_NAME |
FILTER_USER_LIST_FIRST_PARTY |
FILTER_USER_LIST_FIRST_PARTY_NAME |
FILTER_USER_LIST_THIRD_PARTY |
FILTER_USER_LIST_THIRD_PARTY_NAME |
Penomoran halaman
v1.1 menambahkan penomoran halaman ke metode
Queries.listqueries
dan
Reports.listreports
.
Pada v1.1, jumlah hasil yang ditampilkan oleh metode ini sama dengan parameter pageSize
yang baru ditambahkan (defaultnya adalah 100
jika tidak ditentukan). Respons berisi kolom nextPageToken
yang baru ditambahkan, yang dapat digunakan untuk mengambil kumpulan hasil berikutnya. Kolom ini kosong jika hasil telah habis.
Kode v1 berikut untuk mengambil semua laporan yang termasuk dalam kueri tertentu:
public class GetReports {
public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();
return reportListResponse.getReports();
}
}
harus dimodifikasi seperti berikut di v1.1 agar dapat terus mengambil semua laporan:
public class GetReports {
public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();
List<Report> reports = new ArrayList<>(reportListResponse.getReports());
while (reportListResponse.getNextPageToken() != null
&& reportListResponse.getNextPageToken().length() > 0) {
// Get next set of results, aka page.
reportListResponse =
service
.reports()
.listreports(queryId)
.setPageToken(reportListResponse.getNextPageToken())
.execute();
reports.addAll(reportListResponse.getReports());
}
return reports;
}
}
Lihat dokumentasi metode Queries.listqueries
dan
Reports.listreports
untuk detail selengkapnya.
Masalah umum
Tidak ada.
Versi 1
Ini adalah versi awal API.
Masalah umum
Tidak ada.