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

เราได้เปิดตัว Bid Manager API เวอร์ชัน 2 ในเดือนมีนาคม 2022 ในการเปิดตัวเวอร์ชันใหม่นี้ เรามีแผนที่จะประกาศวันหยุดให้บริการ 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 เป็นดังนี้

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

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

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

เรากำลังเปิดตัวการเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบในเวอร์ชัน 2 อ่านวิธีการต่อไปนี้และทำการเปลี่ยนแปลงที่จำเป็นซึ่งเกี่ยวข้องกับการใช้ Bid Manager API ที่มีอยู่

อัปเดตการโทรไปยังบริการ queries

  • ช่องต่อไปนี้ในทรัพยากร Query ซึ่งเดิมทีเป็นออบเจ็กต์ที่ซ้อนกันอยู่ได้เปลี่ยนไปใช้ประเภทออบเจ็กต์ต่อไปนี้
    ฟิลด์ v1.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 ซึ่งเดิมทีออบเจ็กต์รายการทั่วไปได้เปลี่ยนเป็นรายการประเภทออบเจ็กต์ใหม่ต่อไปนี้
    ฟิลด์รายการ v1.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 ใน v2 และมีการเปลี่ยนแปลงต่อไปนี้
    • ตอนนี้ค่าที่เทียบเท่า v2 ของ metadata.dataRange ใช้ enum ของ Range ในการแปลงเป็น 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 ไม่ใช่แบบซิงโครนัส ซึ่งเป็นค่าเริ่มต้นในเวอร์ชัน 1.1
    • เนื้อหาของคำขอได้รับการอัปเดตเพื่อนำช่อง timezoneCode ออกและแทนที่ช่อง dataRange reportDataStartTimeMs reportDataEndTimeMs ด้วยออบเจ็กต์ DataRange ที่กำหนดให้กับช่อง dataRange
    • เมธอดจะแสดงออบเจ็กต์ Report ที่ได้มาแทนเนื้อหาการตอบสนองที่ว่างเปล่า
  • ช่อง kind ในเนื้อหาการตอบกลับ queries.list ถูกนำออกแล้ว

อัปเดตการโทรไปยังบริการ reports

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

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