เมื่อเดือนมีนาคม 2022 เราได้เปิดตัว Bid Manager API เวอร์ชัน 2 เนื่องจาก สำหรับเวอร์ชันใหม่นี้ เรามีแผนที่จะประกาศวันที่หยุดให้บริการสำหรับ v1.1 เร็วๆ นี้ พ ขอแนะนำให้คุณเริ่มต้นย้ายข้อมูลจากเวอร์ชัน 1.1 ไปยัง v2 โดยเร็วที่สุด
ย้ายข้อมูลแอปพลิเคชันของคุณ
การย้ายข้อมูลจาก v1.1 ไป v2 ต้องอัปเดต URL ปลายทางของคุณให้เรียกใช้ v2 และ อัปเดตแอปพลิเคชันให้ครอบคลุมการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบ
อัปเดตการเรียก API จากเวอร์ชัน 1.1 เป็น v2
หากต้องการใช้เวอร์ชัน 2 แทนเวอร์ชัน 1.1 คุณต้องอัปเดตคำขอเพื่อใช้เวอร์ชัน 2 เวอร์ชันใหม่ ปลายทาง
ระบุวิธีการที่เทียบเท่า
ในการอัปเดตการเรียก API จากการใช้ v1.1 ไปเป็น v2 คุณต้องระบุก่อน เมธอด v1.1 ที่เทียบเท่าใน v2
ชื่อบริการและเมธอดต่อไปนี้มีการเปลี่ยนแปลงเล็กน้อยระหว่าง v1.1 และ v2:
- รู้จักบริการ
Queries
และReports
ในเวอร์ชัน 1.1 เป็นqueries
และqueries.reports
ในเวอร์ชัน 2 - โดยมีการเปลี่ยนชื่อเมธอดดังนี้ใน 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
ทำการเปลี่ยนแปลงที่จำเป็น
เราขอแนะนำการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบใน v2 โปรดตรวจสอบสิ่งต่อไปนี้ ดำเนินการเปลี่ยนแปลงที่จำเป็นที่เกี่ยวข้องกับการใช้งาน Bid Manager API
อัปเดตการโทรไปยังบริการ queries
- ช่องต่อไปนี้ในแหล่งข้อมูล
Query
ที่แสดงเป็นช่องทั่วไป ออบเจ็กต์ที่ซ้อนกันได้เปลี่ยนไปใช้ประเภทออบเจ็กต์ต่อไปนี้ - ช่องต่อไปนี้ในแหล่งข้อมูล
Query
ที่แสดงเป็นช่องทั่วไป เปลี่ยนรายการเป็นรายการของประเภทออบเจ็กต์ใหม่ต่อไปนี้ - ช่องต่อไปนี้ในทรัพยากร
Query
ซึ่งเดิมแสดงด้วย สตริงจะแสดงด้วยประเภท enum ใน v2 และประกอบด้วยรายการต่อไปนี้ การเปลี่ยนแปลง:- ตอนนี้ค่าเทียบเท่าใน v2 ของ
metadata.dataRange
ใช้Range
แล้ว enum ในการแปลงเป็น enum นี้ ค่าPREVIOUS_HALF_MONTH
ได้มีการ นำออกและค่าTYPE_NOT_SUPPORTED
เปลี่ยนเป็นRANGE_UNSPECIFIED
- ตอนนี้
metadata.format
ใช้ EnumFormat
แล้ว กำลังทำ Conversion ใน 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
ใช้ EnumFrequency
แล้ว ใน แปลงเป็น enum นี้ ระบบจะเพิ่มค่าFREQUENCY_UNSPECIFIED
เข้าไป - ตอนนี้
params.type
ใช้ EnumReportType
แล้ว ใน แปลงเป็น 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
ใช้ EnumFormat
แล้ว ใน ที่แปลงเป็น enum นี้ ระบบได้นำค่าEXCEL_CSV
ออกแล้วและ เพิ่มFORMAT_UNSPECIFIED
แล้ว - ตอนนี้
metadata.status.state
ใช้ EnumState
แล้ว ใน จะแปลงเป็น 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
ใช้ EnumReportType
แล้ว ใน ที่แปลงเป็น enum นี้ เราได้ทำการเปลี่ยนแปลงหลายอย่างและแสดงไว้ใน รายละเอียดในส่วนก่อนหน้านี้เกี่ยวกับการอัปเดตการเรียกใช้บริการสอบถามข้อมูล
- ตอนนี้
- ช่อง
metadata.reportDataStartTimeMs
และmetadata.reportDataEndTimeMs
ถูกแทนที่ด้วย ฟิลด์reportDataStartDate
และreportDataEndDate
ในReportMetadata
ฟิลด์ใหม่จะใช้Date
แทนที่จะเป็นมิลลิวินาทีตั้งแต่ Unix Epoch metadata.status.finishTimeMs
มีการแทนที่ด้วย ในช่องfinishTime
ในฟิลด์ ออบเจ็กต์ReportStatus
ฟิลด์เวลาใหม่นี้แสดง วันที่และเวลาเป็นการประทับเวลาใน RFC3339 UTC "ซูลู" แทนที่จะเป็นรูปแบบ มิลลิวินาทีที่เริ่มนับมาตั้งแต่วันที่ Unix Epochmetadata.status.failure
และ นำช่องparams.includeInviteData
ออกแล้ว- ช่อง
kind
ในส่วนเนื้อหาการตอบกลับreports.list
มี ถูกนำออกแล้ว
อัปเดตตรรกะการจัดการข้อผิดพลาด
ข้อความแสดงข้อผิดพลาดใน API ได้รับการอัปเดตในเวอร์ชัน 2 ข้อความแสดงข้อผิดพลาดใหม่เหล่านี้ มีความเฉพาะเจาะจงมากขึ้น และในบางกรณีอาจให้ข้อมูลเกี่ยวกับค่าในส่วน คำขอ API ที่ทำให้เกิดข้อผิดพลาด หากข้อผิดพลาดที่มีอยู่ ตรรกะการจัดการอาศัยข้อความแสดงข้อผิดพลาดที่เจาะจง ทำให้ข้อผิดพลาดของคุณเป็นแบบทั่วไป ก่อนย้ายข้อมูลไปยังเวอร์ชัน 2