این صفحه یادداشتهای انتشار را برای Google Bid Manager API ارائه میکند.
نسخه 2
تغییرات ساختاری در API ایجاد کرد، از جمله بهروزرسانی نقطه پایانی سرویس و تغییر نام سرویسها و روشها.
منابع Query و Report با حذف فیلدهای غیر ضروری، سازماندهی مجدد فیلدهای موجود و تغییر انواع فیلدها به طور قابل توجهی به روز شده است. این شامل تغییر انواع فیلدها برای استفاده از اشیاء نامگذاری شده به جای تعریف کلی "شیء تودرتو" است.
اجرای پرسوجوهای ad-hoc با استفاده از روش queries.run
به جای اجرای خودکار آنها پس از ایجاد الزامی است.
پارامتر query queries.run
asynchronous
با synchronous
جایگزین شد.
بازیابی گزارش ساده از طریق تغییرات زیر:
- اضافه شدن یک روش
queries.reports.get
. - افزودن یک پارامتر پرس و جو
orderBy
بهqueries.reports.list
. - به روز رسانی بدنه پاسخ
queries.run
از یک شی خالی به یک نمونه از منبعReport
تولید شده.
پیامهای خطای بهروزرسانیشده توسط API برای مشخصتر بودن و ارائه راهحلهای تجویزیتر برگردانده میشوند.
دستورالعمل های ارائه شده در راهنمای مهاجرت v2 را برای مهاجرت از نسخه 1.1 به نسخه 2 دنبال کنید.
ویژگی های جدید
نقطه پایانی سرویس تغییر کرده است:
نقطه پایانی سرویس v1 نقطه پایانی سرویس v2 https://www.googleapis.com/doubleclickbidmanager
https://doubleclickbidmanager.googleapis.com
خدمات به شرح زیر تغییر نام داده است:
سرویس v1 سرویس v2 پرس و جوها پرس و جوها گزارش ها پرس و جوها.گزارش ها متدها به صورت زیر تغییر نام داده اند:
روش های زیر اضافه شده است:
سرویس مواد و روش ها) پرس و جوها.گزارش ها گرفتن روش های زیر بدنه پاسخ جدیدی دارند:
روش جسم پاسخ جدید query.run گزارش فیلدهای زیر حذف شده اند:
منبع زمینه های) queries.list
بدنه پاسخنوع
queries.reports.list
بدنه پاسخنوع
پرس و جو نوع
ReportDataEndTimeMs
ReportDataStartTimeMs
کد منطقه زمانی
RunQueryRequest ReportDataEndTimeMs
ReportDataStartTimeMs
کد منطقه زمانی
نوع شی فیلدهای زیر به شکل زیر تغییر یافته است:
منبع زمینه های) نوع شی پرس و جو گزارش RunQueryRequest پارامترهای پرس و جو روش زیر اضافه شده است:
روش پارامتر(های) پرس و جو quries.list سفارش توسط quries.reports.list سفارش توسط query.run همزمان پارامترهای پرس و جو روش زیر حذف شده اند:
روش پارامتر(های) پرس و جو پرس و جو. ایجاد نامتقارن query.run نامتقارن مقادیر فیلتر زیر اضافه شده است:
مقدار فیلتر FILTER_INVENTORY_MEDIA_COST_TYPE FILTER_TARGETING_EXPANSION مقادیر فیلتر زیر حذف شده است:
مقدار فیلتر FILTER_TRUEVIEW_IAR_REGION مقادیر متریک زیر اضافه شده است:
مقدار متریک 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
مشکلات شناخته شده
هیچ یک.
نسخه 1.1
فیلتر یک به یک برای گزارش نگاشت ستون
فیلترهایی که به چندین ستون گزارش نگاشت شده اند، اکنون به ستون های تک نگاشت می شوند.
برای مثال، در نسخه 1، شامل فیلتر FILTER_ADVERTISER
، گزارشی با ستونهای «آگهیدهنده» علاوه بر «شناسه آگهیدهنده» ارائه میکند. در نسخه 1.1، تمام ستون های گزارش فیلترهای مخصوص به خود را دارند. به عنوان مثال، یک فیلتر جدید FILTER_ADVERTISER_NAME
به "تبلیغ کننده" نگاشت می شود. برای دریافت هر دو ستون "Advertiser ID" و "Advertiser" در گزارشها، هر دو فیلتر FILTER_ADVERTISER
و FILTER_ADVERTISER_NAME
به ترتیب باید در درخواستهای Queries.createquery
گنجانده شوند.
به طور دقیق تر، درخواست createquery
:
{
...
"params": {
...
"groupBys": ["FILTER_ADVERTISER"],
"metrics": ["METRIC_IMPRESSIONS"],
...
}
...
}
یک فایل گزارش با هدرهای زیر در v1 ایجاد می کند:
Advertiser,Advertiser ID,Advertiser Status,Advertiser Integration Code,Impressions
و هدرهای زیر در نسخه 1.1:
Advertiser,Impressions
کد v1 زیر برای دریافت ستون های گزارش در مثال بالا استفاده می شود:
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);
باید مشابه موارد زیر در نسخه 1.1 اصلاح شود (به ترتیب فیلتر توجه کنید):
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_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 |
صفحه بندی
نسخه 1.1 صفحه بندی را به روش های Queries.listqueries
و Reports.listreports
اضافه می کند.
در نسخه 1.1، تعداد نتایج برگردانده شده توسط این روش ها برابر با پارامتر pageSize
است که به تازگی اضافه شده است (اگر مشخص نشده باشد به طور پیش فرض 100
است). پاسخ ها حاوی یک فیلد nextPageToken
هستند که به تازگی اضافه شده است که می تواند برای بازیابی مجموعه بعدی از نتایج استفاده شود. اگر نتایج تمام شده باشد، این قسمت خالی است.
کد v1 زیر برای بازیابی تمام گزارش های متعلق به یک پرس و جو خاص:
public class GetReports {
public List<Report> getReports(DoubleClickBidManager service, long queryId) throws IOException {
ListReportsResponse reportListResponse = service.reports().listreports(queryId).execute();
return reportListResponse.getReports();
}
}
برای ادامه بازیابی همه گزارش ها، باید مشابه موارد زیر در نسخه 1.1 اصلاح شود:
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;
}
}
برای جزئیات بیشتر به مستندات روش Queries.listqueries
و Reports.listreports
مراجعه کنید.
مشکلات شناخته شده
هیچ یک.
نسخه 1
این نسخه اولیه API است.
مشکلات شناخته شده
هیچ یک.