בדף הזה מוצגות נתוני גרסה של Google Bid Manager API.
גרסה 2
שינינו את המבנה של ה-API, כולל עדכון של נקודת הקצה (endpoint) של השירות ושינוי השם של השירותים והשיטות.
עדכנו בצורה משמעותית את המשאבים של שאילתות ודיווח על ידי הסרת שדות לא נחוצים, ארגון מחדש של שדות קיימים ושינוי סוגי שדות. למשל, שינוי של סוגי השדות לשימוש באובייקטים בעלי שם במקום בהגדרה הכללית של 'אובייקט בתוך רכיב'.
נדרשת הרצה של שאילתות אד-הוק באמצעות השיטה queries.run
, במקום שהן יפעלו באופן אוטומטי לאחר יצירתן.
החלפנו את פרמטר השאילתה queries.run
asynchronous
בערך synchronous
.
אחזור פשוט יותר של דוחות באמצעות השינויים הבאים:
- הוספה של שיטת
queries.reports.get
. - הוספה של פרמטר שאילתה מסוג
orderBy
אלqueries.reports.list
. - גוף התגובה
queries.run
עודכן מאובייקט ריק למופע של משאבReport
שנוצר.
הודעות השגיאה שהוחזרו על ידי ה-API עודכנו ועכשיו הן ספציפיות יותר ומכילות פתרונות תיאוריים יותר.
פועלים לפי ההוראות במדריך להעברת נתונים לגרסה 2 כדי לעבור מגרסה 1.1 לגרסה 2.
תכונות חדשות
נקודת הקצה של השירות השתנתה:
נקודת סיום של שירות v1 נקודת קצה של שירות v2 https://www.googleapis.com/doubleclickbidmanager
https://doubleclickbidmanager.googleapis.com
שם השירותים השתנה באופן הבא:
שירות v1 שירות v2 שאילתות שאילתות דוחות queries.reports שמות השיטות השתנו באופן הבא:
השיטות הבאות נוספו:
שירות שיטות queries.reports מקבלים לשיטות הבאות יש גוף תגובה חדש:
שיטה אובייקט חדש של גוף התגובה queries.run דיווח השדות הבאים הוסרו:
משאב שדות queries.list
גוף התגובהסיווג
queries.reports.list
גוף התגובהסיווג
שאילתה סיווג
reportDataEndTimeMs
reportDataStartTimeMs
timezoneCode
RunQueryRequest reportDataEndTimeMs
reportDataStartTimeMs
timezoneCode
סוג האובייקט של השדות הבאים השתנה ל:
משאב שדות סוג אובייקט שאילתה דיווח RunQueryRequest נוספו הפרמטרים הבאים של שאילתות ל-methods:
שיטה פרמטרים של שאילתות queries.list orderBy queries.reports.list orderBy queries.run סינכרוני הפרמטרים הבאים של שאילתה של method הוסרו:
שיטה פרמטרים של שאילתות queries.create אסינכרוני queries.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
, נוצר דוח עם העמודות Advertiser (מפרסם) בנוסף ל-Advertiser ID (מזהה המפרסם). בגרסה 1.1 לכל עמודות הדוח יש מסננים משלהן. לדוגמה, מסנן חדש FILTER_ADVERTISER_NAME
ממופה לערך 'מפרסם'. כדי שיוצגו בדוחות גם העמודה Advertiser ID (מזהה המפרסם) וגם העמודה Advertiser (מפרסם), המסננים FILTER_ADVERTISER
ו-FILTER_ADVERTISER_NAME
בהתאמה צריכים להיכלל בבקשות Queries.createquery
.
ליתר דיוק, הבקשה createquery
:
{
...
"params": {
...
"groupBys": ["FILTER_ADVERTISER"],
"metrics": ["METRIC_IMPRESSIONS"],
...
}
...
}
יוצר קובץ דוח עם הכותרות הבאות בגרסה 1:
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.
בעיות ידועות
ללא.