דף זה תורגם על ידי Cloud Translation API.

מעבר מ-Bid Manager API גרסה 1.1 לגרסה 2

במרץ 2022 השקנו את גרסה 2 של Bid Manager API. בהינתן של הגרסה החדשה הזו, אנחנו מתכננים להכריז על תאריך הסגירה של v1.1 בקרוב. רביעי מומלץ להתחיל את ההעברה מ-v1.1 לגרסה 2 בהקדם האפשרי.

העברת האפליקציה

מעבר מ-v1.1 לגרסה 2 מחייב לעדכן את כתובות ה-URL של נקודות הקצה לגרסה 2. צריך לעדכן את האפליקציה כדי להביא בחשבון שינויים שעלולים לגרום לכשל.

עדכון הקריאות ל-API מגרסה 1.1 לגרסה 2

כדי להשתמש ב-v2 במקום ב-v1.1, צריך לעדכן את הבקשות כך שישתמשו בגרסה החדשה. נקודות קצה (endpoints).

פרטו שיטות מקבילות

כדי לעדכן את הקריאות ל-API מהשימוש בגרסה 1.1 לגרסה 2, תחילה צריך לזהות את ה-methods המקבילות ב-v1.1 בגרסה 2.

השמות הבאים של כל השירותים והשיטות השתנו מעט בין v1.1 ו-v2:

השירותים Queries ו-Reports בגרסה 1.1 ידועים בתור queries ו-queries.reports בגרסה 2.

שמות השיטות השתנו באופן הבא בגרסה 2:

שם ה-method v1.1	השיטה המקבילה בגרסה 2
`Queries.createquery`	`queries.create`
`Queries.deletequery`	`queries.delete`
`Queries.getquery`	`queries.get`
`Queries.listqueries`	`queries.list`
`Queries.runquery`	`queries.run`
`Reports.listreports`	`queries.reports.list`

עדכון לנקודות קצה חדשות

אחרי שתזהו שיטות מקבילות, תצטרכו לעדכן את הבקשות. עבור לדוגמה, כדי להפעיל את ה-method queries.getquery עם גרסה 1.1, צריך להשתמש בפונקציה כתובת ה-URL הבאה:

https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId

כדי להפעיל את ה-method המקביל בגרסה 2, שנקראת queries.get, מעדכנים את כתובת ה-URL הבאה:

GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId

אם משתמשים בספריית לקוח כדי לשלוח בקשות ל-API, צריך להשתמש את הגרסה האחרונה של ספריית הלקוח ולעדכן את ההגדרות לשימוש בגרסה 2.

ביצוע השינויים הנדרשים

אנחנו משיקים מספר שינויי תוכנה שעלולים לגרום לכשלים בגרסה 2. אפשר לעיין בפרטים הבאים ולבצע את השינויים הנדרשים שרלוונטיים לשימוש הקיים שלכם ממשק ה-API של 'מנהל הצעות המחיר'.

עדכון השיחות לשירות `queries`

השדות הבאים במשאב Query מיוצגים במקור על ידי הכלל הכללי האובייקטים שהוצבו השתנו כדי להשתמש בסוגי האובייקטים הבאים:

שדה גרסה 1.1	סוג אובייקט v2 שווה ערך
`metadata`	`QueryMetadata`
`params`	`Parameters`
`params.options`	`Options`
`params.options.pathQueryOptions`	`PathQueryOptions`
`params.options.pathQueryOptions.channelGrouping`	`ChannelGrouping`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`
`schedule`	`QuerySchedule`

השדות הבאים במשאב Query מיוצגים במקור על ידי הכלל הכללי האובייקטים של הרשימה השתנו ל'רשימות של סוגי האובייקטים החדשים הבאים:

שדה ברשימה גרסה 1.1	סוג אובייקט v2
`params.filters[]`	`FilterPair`
`params.options.pathQueryOptions.channelGrouping.rules[]`	`Rule`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]`	`DisjunctiveMatchStatement`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]`	`EventFilter`
`params.options.pathQueryOptions.pathFilters[]`	`PathFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[]`	`EventFilter`

השדות הבאים במשאב Query, מיוצגים במקור על ידי מחרוזות מיוצגות על ידי סוגי enum בגרסה 2, וכוללות את שינויים:

הגרסה המקבילה בגרסה 2 של metadata.dataRange משתמשת עכשיו בפונקציה Range טיפוסים בני מנייה (enum) בהמרה ל-enum הזה, הערך PREVIOUS_HALF_MONTH היה הוסר והערך TYPE_NOT_SUPPORTED שונה ל- RANGE_UNSPECIFIED.
metadata.format משתמש עכשיו בספירה של Format. בתהליך המרה ל-enum הזה, הערך EXCEL_CSV הוסר והערך מילת המפתח FORMAT_UNSPECIFIED נוספה.
params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match וגם params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match משתמשים עכשיו ב-enum Match.
עכשיו משתמש params.options.pathQueryOptions.pathFilters[].pathMatchPosition טיפוסים בני מנייה (enum) PathMatchPosition. בהמרה ל: הנתון 'טיפוסים בני מנייה (enum)' הזה, נוסף הערך PATH_MATCH_POSITION_UNSPECIFIED.
schedule.frequency משתמש עכשיו בספירה של Frequency. לחשבון לאחר המרה ל-enum הזה, נוסף הערך FREQUENCY_UNSPECIFIED.
params.type משתמש עכשיו בספירה של ReportType. לחשבון מומר ל-enum הזה, בוצעו השינויים הבאים:
הערכים הבאים הוצאו משימוש:
- TYPE_ACTIVE_GRP
- TYPE_AUDIENCE_PERFORMANCE
- TYPE_CLIENT_SAFE
- TYPE_COMSCORE_VCE
- TYPE_CROSS_FEE
- TYPE_CROSS_PARTNER
- TYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDER
- TYPE_ESTIMATED_CONVERSION
- TYPE_FEE
- TYPE_KEYWORD
- TYPE_LINEAR_TV_SEARCH_LIFT
- TYPE_NIELSEN_AUDIENCE_PROFILE
- TYPE_NIELSEN_DAILY_REACH_BUILD
- TYPE_NIELSEN_ONLINE_GLOBAL_MARKET
- TYPE_PAGE_CATEGORY
- TYPE_PETRA_NIELSEN_DAILY_REACH_BUILD
- TYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKET
- TYPE_PIXEL_LOAD
- TYPE_THIRD_PARTY_DATA_PROVIDER
- TYPE_TRUEVIEW_IAR
- TYPE_VERIFICATION
- TYPE_YOUTUBE_VERTICAL

כל הערכים הנותרים עודכנו כדי לשקף טוב יותר את הערכים שלהם ערכים מקבילים בממשק המשתמש:

ערכים של גרסה 1.1	שווה ערך ל-`ReportType`
`TYPE_NOT_SUPPORTED`	`REPORT_TYPE_UNSPECIFIED`
`TYPE_GENERAL`	`STANDARD`
`TYPE_INVENTORY_AVAILABILITY`	`INVENTORY_AVAILABILITY`
`TYPE_AUDIENCE_COMPOSITION`	`AUDIENCE_COMPOSITION`
`TYPE_ORDER_ID`	`FLOODLIGHT`
`TYPE_TRUEVIEW`	`YOUTUBE`
`TYPE_NIELSEN_SITE`	`GRP`
`TYPE_PETRA_NIELSEN_AUDIENCE_PROFILE`	`YOUTUBE_PROGRAMMATIC_GUARANTEED`
`TYPE_REACH_AND_FREQUENCY`	`REACH`
`TYPE_REACH_AUDIENCE`	`UNIQUE_REACH_AUDIENCE`
`TYPE_PATH`	`FULL_PATH`
`TYPE_PATH_ATTRIBUTION`	`PATH_ATTRIBUTION`

השדות metadata.dataRange, reportDataStartTimeMs, וגם reportDataEndTimeMs הוחלפו בשדות range, customStartDate, וגם customEndDate. בשדות התאריך החדשים נעשה שימוש ב-Date ולא באלפיות שנייה מאז תאריך יוניקס (Unix Epoch). השדות החלופיים האלה הועברו לאובייקט DataRange שהוקצה השדה dataRange בשדה אובייקט QueryMetadata.
השדות schedule.startTimeMs ו schedule.endTimeMs הוחלפו בשדות startDate ו-endDate אינץ' את האובייקט QuerySchedule. בשדות התאריך החדשים נעשה שימוש ב-Date ולא באלפיות שנייה מאז תאריך יוניקס (Unix Epoch).
השדות metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport, וגם metadata.latestReportRunTimeMs הוסרו. מידע בנוגע לדוחות האחרונים שנוצרו עבור שאילתה במקום זאת, מאוחזרים באמצעות השיטה queries.reports.list עם orderBy פרמטר השאילתה של 'key.reportId desc' ל- להבטיח שבבקשה רשומים הדוחות העדכניים ביותר קודם.
שדות kind, timezoneCode, metadata.locale, params.includeInviteData, וגם schedule.nextRunMinuteOfDay הוסרו.
queries.create לא מריץ יותר שאילתות באופן אוטומטי אחרי היצירה ופרמטר השאילתה asynchronous הוסר. שיחת טלפון queries.run אחרי queries.create כדי ליצור דוחות עבור שאילתות חדשות.
השיטה queries.run עודכנה בדרכים הבאות:
- פרמטר השאילתה asynchronous הוחלף ב- פרמטר של שאילתה synchronous. פרמטר השאילתה החדש פועלת עם לוגיקה הפוכה ונחשבת כ-False אם לא צוין אחרת. נתון כך, queries.run יוצר דוחות באופן אסינכרוני כברירת מחדל v2 בניגוד לגרסה סינכרונית, שהיא ברירת המחדל בגרסה 1.1.
- גוף הבקשה עודכן כדי להסיר את השדה timezoneCode והחלפה שלו dataRange, reportDataStartTimeMs, reportDataEndTimeMs שדות עם אובייקט DataRange הוקצה אל שדה dataRange.
- ה-method מחזירה את האובייקט Report שמתקבל במקום גוף תגובה ריק.
השדה kind בגוף התשובה queries.list הוסר.

עדכון השיחות לשירות `reports`

השדות הבאים במשאב Report מיוצגים במקור על ידי אובייקטים מקוננים כלליים השתנו כך שישתמשו בסוגי האובייקטים הבאים:

שדה גרסה 1.1	סוג אובייקט v2 שווה ערך
`key`	`ReportKey`
`metadata`	`ReportMetadata`
`metadata.status`	`ReportStatus`
`params`	`Parameters`
`params.options`	`Options`
`params.options.pathQueryOptions`	`PathQueryOptions`
`params.options.pathQueryOptions.channelGrouping`	`ChannelGrouping`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter`	`PathQueryOptionsFilter`

השדות הבאים במשאב Report מיוצגים במקור על ידי אובייקטים מסוג רשימה כללית השתנו לרשימות של האובייקט החדש הבא סוגי:

שדה ברשימה גרסה 1.1	סוג אובייקט v2
`params.filters[]`	`FilterPair`
`params.options.pathQueryOptions.channelGrouping.rules[]`	`Rule`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[]`	`DisjunctiveMatchStatement`
`params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[]`	`EventFilter`
`params.options.pathQueryOptions.pathFilters[]`	`PathFilter`
`params.options.pathQueryOptions.pathFilters[].eventFilters[]`	`EventFilter`

השדות הבאים במשאב Report מיוצגים במקור על ידי מחרוזות השתנו כך שהשדות המקבילים שלהן בגרסה 2 מיוצגים על ידי טיפוסים בני מנייה (enum) ושינויים בערכים הקבילים:
- metadata.status.format משתמש עכשיו בספירה של Format. לחשבון מומר ל-enum הזה, הערך EXCEL_CSV הוסר ו מילת המפתח FORMAT_UNSPECIFIED נוספה.
- metadata.status.state משתמש עכשיו בספירה של State. לחשבון לאחר ההמרה ל-enum הזה, הערכים QUEUED ו-STATE_UNSPECIFIED יש נוסף.
- params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match וגם params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match משתמשים עכשיו ב-enum Match.
- עכשיו משתמש params.options.pathQueryOptions.pathFilters[].pathMatchPosition טיפוסים בני מנייה (enum) PathMatchPosition. בהמרה ל: הנתון 'טיפוסים בני מנייה (enum)' הזה, נוסף הערך PATH_MATCH_POSITION_UNSPECIFIED.
- params.type משתמש עכשיו בספירה של ReportType. לחשבון להמרה ל-enum הזה, בוצעו שינויים רבים ומפורטים בסעיף הקודם לגבי עדכון קריאות שירות לשאילתות.
השדות metadata.reportDataStartTimeMs ו metadata.reportDataEndTimeMs הוחלף ב שדות reportDataStartDate ו reportDataEndDate ב ReportMetadata. בשדות החדשים נעשה שימוש Date אובייקטים במקום אלפיות שנייה מאז פרק הזמן של יוניקס (Unix Epoch).
החלק metadata.status.finishTimeMs הוחלף ב- השדה finishTime בשדה אובייקט ReportStatus. שדה הזמן החדש מייצג את תאריך ושעה כחותמת זמן בפורמט RFC3339 UTC "Zulu" פורמט במקום ב- אלפיות השנייה מאז תאריך יוניקס (Unix epoch).
metadata.status.failure ו- הוסרו params.includeInviteData שדות.
בשדה kind בגוף התשובה reports.list הוסר.

עדכון לוגיקת הטיפול בשגיאות

הודעות השגיאה ב-API עודכנו בגרסה 2. הודעות השגיאה החדשות האלה הם ספציפיים יותר, ובמקרים מסוימים הם מספקים מידע על הערכים בקשת ה-API שגורמת לחזרה לשגיאה. אם לוגיקת הטיפול מסתמכת על טקסט ספציפי של הודעת שגיאה, לפני המעבר ל-v2.

מעבר מ-Bid Manager API גרסה 1.1 לגרסה 2 קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.