เมื่อเดือนมีนาคม 2022 เราได้เปิดตัว Bid Manager API เวอร์ชัน 2 เนื่องจากมีการเปิดตัวเวอร์ชันใหม่นี้ เรามีแผนที่จะประกาศวันที่เลิกใช้งานสําหรับเวอร์ชัน 1.1 เร็วๆ นี้ เราขอแนะนําให้คุณเริ่มย้ายข้อมูลจาก v1.1 ไป v2 โดยเร็วที่สุด
ย้ายข้อมูลแอปพลิเคชัน
คุณต้องอัปเดต URL ปลายทางเพื่อเรียกใช้ v2 และอัปเดตการตั้งค่าแอปพลิเคชันเพื่อให้การเปลี่ยนแปลงมีการเปลี่ยนแปลง
อัปเดตการเรียก API จากเวอร์ชัน 1.1 เป็น v2
หากต้องการใช้ v2 แทน v1.1 คุณจะต้องอัปเดตคําขอเพื่อใช้ปลายทาง v2 ใหม่
ระบุวิธีการที่เทียบเท่า
หากต้องการอัปเดตการเรียก API จากการใช้ v1.1 เป็น v2 ก่อนอื่นคุณต้องระบุเมธอด v1.1 ที่เทียบเท่าใน v2
ชื่อของบริการและเมธอดทั้งหมดมีการเปลี่ยนแปลงเล็กน้อยระหว่าง v1.1 กับ v2
- บริการ
Queries
และReports
ใน v1.1 เรียกว่าqueries
และqueries.reports
ใน v2 - เราเปลี่ยนชื่อเมธอดเป็น v2 ดังนี้
การอัปเดตปลายทางใหม่
เมื่อระบุวิธีที่เทียบเท่าได้แล้ว คุณจะต้องอัปเดตคําขอ ตัวอย่างเช่น หากต้องการเรียกเมธอด queries.getquery
ที่มี v1.1 ให้ใช้ URL ต่อไปนี้
https://www.googleapis.com/doubleclickbidmanager/v1.1/query/queryId
หากต้องการเรียกเมธอดที่เทียบเท่าใน v2 (หรือที่เรียกว่า queries.get
) ให้อัปเดต URL เป็นดังนี้
GET https://doubleclickbidmanager.googleapis.com/v2/queries/queryId
ถ้าคุณใช้ไลบรารีของไคลเอ็นต์เพื่อส่งคําขอไปยัง API ให้ใช้ไลบรารีของไคลเอ็นต์เวอร์ชันล่าสุดและอัปเดตการกําหนดค่าให้ใช้ v2
ทำการเปลี่ยนแปลงที่จำเป็น
เราขอแนะนําการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นจํานวนหนึ่งในเวอร์ชัน 2 ตรวจสอบวิธีการต่อไปนี้ และทําการเปลี่ยนแปลงที่จําเป็นที่เกี่ยวข้องกับการใช้ Bid Manager API ที่มีอยู่
อัปเดตการโทรไปยังบริการ queries
- ช่องต่อไปนี้ในทรัพยากร
Query
ที่แสดงโดยออบเจ็กต์ที่ซ้อนกันอยู่แต่เดิมได้เปลี่ยนไปใช้ประเภทออบเจ็กต์ต่อไปนี้ - ช่องต่อไปนี้ในทรัพยากร
Query
ที่แสดงโดยออบเจ็กต์รายการทั่วไปในตอนแรกได้เปลี่ยนเป็นรายการประเภทออบเจ็กต์ใหม่ต่อไปนี้ - ช่องต่อไปนี้ในทรัพยากร
Query
ซึ่งเดิมแสดงด้วยสตริง จะแสดงด้วยประเภท enum ใน v2 และจะมีการเปลี่ยนแปลงต่อไปนี้- ตอนนี้ v2 ที่เทียบเท่า
metadata.dataRange
ใช้ EnumRange
ในการแปลงค่าแจกแจงนี้ ค่าPREVIOUS_HALF_MONTH
ได้ถูกนําออกแล้ว และค่าTYPE_NOT_SUPPORTED
ได้เปลี่ยนเป็นRANGE_UNSPECIFIED
แล้ว metadata.format
ใช้ Enum ของFormat
แล้ว ในการแปลงเป็น Enum นี้ เราได้นําค่าEXCEL_CSV
ออกและได้เพิ่มค่าFORMAT_UNSPECIFIED
แล้วparams.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
และparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
ใช้ EnumMatch
แล้วparams.options.pathQueryOptions.pathFilters[].pathMatchPosition
ใช้ EnumPathMatchPosition
แล้ว ในการแปลงเป็น Enum นี้ ระบบจะเพิ่มค่าPATH_MATCH_POSITION_UNSPECIFIED
schedule.frequency
ใช้ Enum ของFrequency
แล้ว ในการแปลงเป็น Enum นี้ ระบบจะเพิ่มค่าFREQUENCY_UNSPECIFIED
params.type
ใช้ Enum ของ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
- ค่าที่เหลือได้รับการอัปเดตทั้งหมดเพื่อแสดงค่าเทียบเท่าใน UI ได้ดีขึ้น
ค่า v1.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
- ตอนนี้ v2 ที่เทียบเท่า
- ช่อง
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
พารามิเตอร์การค้นหาใหม่จะทํางานกับตรรกะแบบผกผัน และจะถือว่าเป็น "เท็จ" หากไม่ได้ระบุไว้ ด้วยเหตุนี้queries.run
จึงสร้างรายงานแบบไม่พร้อมกันโดยค่าเริ่มต้นใน v2 แทนที่จะเป็นแบบซิงโครนัส ซึ่งเป็นค่าเริ่มต้นใน v1.1 - อัปเดตเนื้อหาของคําขอเพื่อนําช่อง
timezoneCode
ออกและแทนที่dataRange
,reportDataStartTimeMs
,reportDataEndTimeMs
ด้วยออบเจ็กต์DataRange
ที่กําหนดให้กับช่องdataRange
- เมธอดจะแสดงออบเจ็กต์
Report
ที่ได้มาแทนที่จะเป็นเนื้อหาการตอบกลับที่ว่างเปล่า
- เราแทนที่พารามิเตอร์การค้นหา
- นําช่อง
kind
ในส่วนเนื้อหาของการตอบกลับqueries.list
ออกแล้ว
อัปเดตการโทรไปยังบริการ reports
- ช่องต่อไปนี้ในทรัพยากร
Report
ซึ่งเดิมเป็นออบเจ็กต์ที่ซ้อนกันทั่วไปได้เปลี่ยนไปใช้ประเภทออบเจ็กต์ต่อไปนี้ - ช่องต่อไปนี้ในทรัพยากร
Report
ที่แสดงโดยออบเจ็กต์รายการทั่วไปในตอนแรกได้เปลี่ยนเป็นรายการประเภทออบเจ็กต์ใหม่ต่อไปนี้ - ช่องต่อไปนี้ในทรัพยากร
Report
ที่แสดงครั้งแรกด้วยสตริงมีการเปลี่ยนแปลง ดังนั้นช่องที่เทียบเท่าใน v2 จะแสดงโดยประเภท Enum ใหม่และรวมการเปลี่ยนแปลงเป็นค่าที่ยอมรับได้metadata.status.format
ใช้ Enum ของFormat
แล้ว ในการแปลงเป็นแจกแจงนี้ ค่าEXCEL_CSV
ได้ถูกนําออกและเพิ่มFORMAT_UNSPECIFIED
แล้วmetadata.status.state
ใช้ Enum ของState
แล้ว ในการแปลงเป็น Enum นี้ ระบบได้เพิ่มค่าQUEUED
และSTATE_UNSPECIFIED
แล้วparams.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match
และparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match
ใช้ EnumMatch
แล้วparams.options.pathQueryOptions.pathFilters[].pathMatchPosition
ใช้ EnumPathMatchPosition
แล้ว ในการแปลงเป็น Enum นี้ ระบบจะเพิ่มค่าPATH_MATCH_POSITION_UNSPECIFIED
params.type
ใช้ Enum ของ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 ที่ทําให้ข้อผิดพลาดแสดงผล หากตรรกะการจัดการข้อผิดพลาดที่มีอยู่อาศัยข้อความแสดงข้อผิดพลาดที่เจาะจง ให้ใช้วิธีการจัดการข้อผิดพลาดทั่วไปก่อนย้ายข้อมูลไปยังเวอร์ชัน 2