ย้ายข้อมูลจาก Bid Manager API v1.1 ไปยัง v2

ในเดือนมีนาคม 2022 เราได้เปิดตัว Bid Manager API เวอร์ชัน 2 และวางแผนที่จะประกาศวันที่เลิกใช้งาน v1.1 ในเร็วๆ นี้ เราขอแนะนำให้คุณเริ่มย้ายข้อมูลจาก v1.1 ไปยัง v2 โดยเร็วที่สุด

ย้ายข้อมูลแอปพลิเคชัน

การย้ายข้อมูลจาก v1.1 ไปยัง v2 ต้องอัปเดต URL ปลายทางเพื่อเรียกใช้ v2 และอัปเดตแอปพลิเคชันเพื่อรองรับการเปลี่ยนแปลงที่ทำให้เกิดข้อผิดพลาด

อัปเดตการเรียก API จาก v1.1 เป็น v2

หากต้องการใช้ v2 แทน v1.1 คุณต้องอัปเดตคำขอเพื่อใช้ปลายทาง v2 ใหม่

ระบุเมธอดที่เทียบเท่า

หากต้องการอัปเดตการเรียก API จากการใช้ v1.1 เป็น v2 ก่อนอื่นคุณต้องระบุเมธอด v1.1 ที่เทียบเท่าใน v2

ชื่อบริการและเมธอดทั้งหมดต่อไปนี้มีการเปลี่ยนแปลงเล็กน้อยระหว่าง v1.1 กับ v2

อัปเดตเป็นปลายทางใหม่

เมื่อระบุเมธอดที่เทียบเท่าแล้ว คุณต้องอัปเดตคำขอ ตัวอย่างเช่น หากต้องการเรียกเมธอด queries.getquery ด้วย v1.1 คุณจะต้องใช้ URL ต่อไปนี้

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

หากต้องการเรียกเมธอดที่เทียบเท่าใน v2 ซึ่งเรียกว่า queries.get ให้อัปเดต URL เป็น URL ต่อไปนี้

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

หากคุณใช้ไลบรารีของไคลเอ็นต์เพื่อส่งคำขอไปยัง API ให้ใช้ไลบรารีของไคลเอ็นต์เวอร์ชันล่าสุดและอัปเดตการกำหนดค่าเพื่อใช้ v2

ทำการเปลี่ยนแปลงที่จำเป็น

เรากำลังเปิดตัวการเปลี่ยนแปลงที่ทำให้เกิดข้อผิดพลาดจำนวนมากใน v2 โปรดอ่านคำแนะนำต่อไปนี้และทำการเปลี่ยนแปลงที่จำเป็นซึ่งเกี่ยวข้องกับการใช้ Bid Manager API ที่มีอยู่

อัปเดตการเรียกใช้บริการ queries

  • ช่องต่อไปนี้ในทรัพยากร Query ซึ่งเดิมแสดงโดยออบเจ็กต์ทั่วไปที่ซ้อนกันได้เปลี่ยนไปใช้ประเภทออบเจ็กต์ต่อไปนี้
    ช่อง v1.1ประเภทออบเจ็กต์ v2 ที่เทียบเท่า
    metadata QueryMetadata
    params Parameters
    params.options Options
    params.options.pathQueryOptions นำออกแล้ว
    params.options.pathQueryOptions.channelGrouping นำออกแล้ว
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter นำออกแล้ว
    params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter นำออกแล้ว
    schedule QuerySchedule
  • ช่องต่อไปนี้ในทรัพยากร Query ซึ่งเดิมแสดงโดยออบเจ็กต์รายการทั่วไปได้เปลี่ยนเป็นรายการประเภทออบเจ็กต์ใหม่ต่อไปนี้
    ช่องรายการ v1.1ประเภทออบเจ็กต์ v2
    params.filters[] FilterPair
    params.options.pathQueryOptions.channelGrouping.rules[] นำออกแล้ว
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[] นำออกแล้ว
    params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[] นำออกแล้ว
    params.options.pathQueryOptions.pathFilters[] นำออกแล้ว
    params.options.pathQueryOptions.pathFilters[].eventFilters[] นำออกแล้ว
  • ช่องต่อไปนี้ในทรัพยากร Query ซึ่งเดิมแสดงโดยสตริงจะแสดงโดยประเภท Enum ใน v2 และมีการเปลี่ยนแปลงต่อไปนี้
    • สิ่งที่เทียบเท่าใน v2 ของ metadata.dataRange ใช้ Range Enum แล้ว เมื่อแปลงเป็น Enum นี้ ระบบได้นำค่า 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 ใช้ Enum Match แล้ว
    • params.options.pathQueryOptions.pathFilters[].pathMatchPosition ใช้ Enum PathMatchPosition แล้ว เมื่อแปลงเป็น 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
  • ช่อง 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

อัปเดตตรรกะการจัดการข้อผิดพลาด

ข้อความแสดงข้อผิดพลาดใน API ได้รับการอัปเดตใน v2 ข้อความแสดงข้อผิดพลาดใหม่เหล่านี้มีความเฉพาะเจาะจงมากขึ้น และในบางกรณีจะให้ข้อมูลเกี่ยวกับค่าในคำขอ API ที่ทำให้ระบบแสดงข้อผิดพลาด หากตรรกะการจัดการข้อผิดพลาดที่มีอยู่ของคุณอาศัยข้อความแสดงข้อผิดพลาดที่เฉพาะเจาะจง ให้จัดการข้อผิดพลาดแบบทั่วไปก่อนที่จะย้ายข้อมูลไปยัง v2