เราเลิกใช้งาน Bid Manager API v1.1 ในเดือนสิงหาคม 2022 และจะหยุดให้บริการในวันที่ 28 กุมภาพันธ์ 2023

ย้ายข้อมูลไปยัง v2 เพื่อหลีกเลี่ยงไม่ให้บริการหยุดชะงัก โปรดดูขั้นตอนการย้ายข้อมูลเป็นเวอร์ชัน 2 ในคําแนะนําในการย้ายข้อมูล

ย้ายข้อมูลจาก Bid Manager API v1.1 เป็น v2

เมื่อเดือนมีนาคม 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.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 ที่แสดงโดยออบเจ็กต์ที่ซ้อนกันอยู่แต่เดิมได้เปลี่ยนไปใช้ประเภทออบเจ็กต์ต่อไปนี้
    ช่อง 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 ในการแปลงค่าแจกแจงนี้ ค่า 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 ได้รับการอัปเดตในเวอร์ชัน 2 แล้ว ข้อความแสดงข้อผิดพลาดใหม่เหล่านี้เป็นข้อมูลที่เจาะจงมากขึ้น และในบางกรณีก็ให้ข้อมูลเกี่ยวกับค่าในคําขอ API ที่ทําให้ข้อผิดพลาดแสดงผล หากตรรกะการจัดการข้อผิดพลาดที่มีอยู่อาศัยข้อความแสดงข้อผิดพลาดที่เจาะจง ให้ใช้วิธีการจัดการข้อผิดพลาดทั่วไปก่อนย้ายข้อมูลไปยังเวอร์ชัน 2