Bermigrasi dari Bid Manager API v1.1 ke v2

Pada Maret 2022, kami merilis Bid Manager API versi 2. Mengingat rilis versi baru ini, kami berencana untuk segera mengumumkan tanggal penghentian untuk v1.1. Rab Sebaiknya mulai migrasi dari v1.1 ke v2 sesegera mungkin.

Memigrasikan aplikasi Anda

Migrasi dari v1.1 ke v2 memerlukan update URL endpoint untuk memanggil v2, dan memperbarui aplikasi untuk memperhitungkan perubahan yang dapat menyebabkan gangguan.

Mengupdate panggilan API dari v1.1 ke v2

Untuk menggunakan v2, bukan v1.1, Anda harus memperbarui permintaan agar menggunakan v2 baru endpoint.

Mengidentifikasi metode ekuivalen

Untuk memperbarui panggilan API agar tidak menggunakan v1.1 ke v2, pertama-tama Anda harus mengidentifikasi metode v1.1 yang setara dalam v2.

Nama semua layanan dan metode berikut telah sedikit berubah antara v1.1 dan v2:

• Layanan Queries dan Reports di v1.1 diketahui sebagai queries dan queries.reports di v2.
• Metode telah diganti namanya sebagai berikut di v2:

  Nama metode v1.1	Metode v2 yang setara
  Queries.createquery	queries.create
  Queries.deletequery	queries.delete
  Queries.getquery	queries.get
  Queries.listqueries	queries.list
  Queries.runquery	queries.run
  Reports.listreports	queries.reports.list

Perubahan ke endpoint baru

Setelah mengidentifikasi metode yang setara, Anda perlu memperbarui permintaan Anda. Sebagai misalnya, untuk memanggil metode queries.getquery dengan v1.1, Anda akan menggunakan URL berikut:

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

Untuk memanggil metode yang setara di v2, yang dikenal sebagai queries.get, update URL ke:

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

Jika Anda menggunakan library klien untuk membuat permintaan ke API, gunakan versi terbaru pustaka klien dan perbarui konfigurasi Anda untuk menggunakan v2.

Membuat perubahan yang diperlukan

Kami memperkenalkan sejumlah perubahan yang dapat menyebabkan gangguan di v2. Tinjau hal berikut dan membuat perubahan yang diperlukan relevan dengan penggunaan Anda atas API Bid Manager.

Update panggilan ke layanan queries

• Kolom berikut dalam resource Query yang awalnya diwakili oleh atribut objek bertingkat telah berubah untuk menggunakan jenis objek berikut:

  Kolom v1.1	Jenis objek v2 yang setara
  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

• Kolom berikut dalam resource Query yang awalnya diwakili oleh atribut daftar objek telah berubah menjadi daftar jenis objek baru berikut:

  Kolom daftar v1.1	Jenis objek 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

• Kolom berikut dalam resource Query, yang awalnya diwakili oleh {i>string<i}, diwakili oleh jenis enum di v2, dan menyertakan yang berikut perubahan:
  • Versi v2 yang setara dengan metadata.dataRange kini menggunakan Range enum. Untuk mengonversi ke enum ini, nilai PREVIOUS_HALF_MONTH telah dihapus dan nilai TYPE_NOT_SUPPORTED diubah menjadi RANGE_UNSPECIFIED.
  • metadata.format sekarang menggunakan enum Format. Sedang mengonversi ke enum ini, nilai EXCEL_CSV telah dihapus dan nilainya FORMAT_UNSPECIFIED telah ditambahkan.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match dan params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match sekarang gunakan enum Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition sekarang menggunakan enum PathMatchPosition. Dalam mengonversi ke enum ini, nilai PATH_MATCH_POSITION_UNSPECIFIED telah ditambahkan.
  • schedule.frequency sekarang menggunakan enum Frequency. Di beberapa mengonversi ke enum ini, nilai FREQUENCY_UNSPECIFIED telah ditambahkan.
  • params.type sekarang menggunakan enum ReportType. Di beberapa mengonversi ke enum ini, perubahan berikut telah dilakukan:
  • Nilai berikut tidak digunakan lagi:
    • 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
  • Semua nilai yang tersisa telah diperbarui untuk lebih mencerminkan nilai setara di UI:

    Nilai v1.1	Nilai ReportType yang setara
    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

• Kolom metadata.dataRange, reportDataStartTimeMs, dan reportDataEndTimeMs telah diganti dengan kolom range, customStartDate, dan customEndDate. Kolom tanggal baru menggunakan Date objek alih-alih milidetik sejak Unix Epoch. Kolom pengganti ini telah dipindahkan ke objek DataRange yang ditetapkan ke Kolom dataRange di kolom QueryMetadata.
• Kolom schedule.startTimeMs dan schedule.endTimeMs telah diganti dengan kolom startDate dan endDate inci objek QuerySchedule. Kolom tanggal baru menggunakan Date objek alih-alih milidetik sejak Unix Epoch.
• Kolom metadata.running, metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport, dan metadata.latestReportRunTimeMs telah dihapus. Informasi mengenai laporan kueri yang dibuat baru-baru ini harus mengambil data menggunakan metode queries.reports.list dengan ID Parameter kueri orderBy “key.reportId desc” menjadi menjamin bahwa permintaan tersebut akan mencantumkan laporan terbaru terlebih dahulu.
• Kolom kind, timezoneCode, metadata.locale, params.includeInviteData, dan schedule.nextRunMinuteOfDay telah dihapus.
• queries.create tidak lagi menjalankan kueri secara otomatis setelah pembuatan dan parameter kueri asynchronous telah dihapus. Telepon queries.run setelah queries.create guna membuat laporan untuk kueri baru.
• Metode queries.run telah diperbarui dengan cara berikut:
  • Parameter kueri asynchronous telah diganti dengan Parameter kueri synchronous. Parameter kueri baru beroperasi dengan logika terbalik dan dianggap salah jika tidak ditentukan. Diberikan ini, queries.run menghasilkan laporan secara asinkron secara default di v2 sebagai lawan dari sinkron, yang merupakan default di v1.1.
  • Isi permintaan telah diperbarui untuk menghapus Kolom timezoneCode dan ganti dataRange, reportDataStartTimeMs, reportDataEndTimeMs kolom dengan objek DataRange yang ditetapkan ke Kolom dataRange.
  • Metode ini menampilkan objek Report yang dihasilkan, bukan objek isi respons kosong.
• Kolom kind dalam isi respons queries.list telah dihapus.

Update panggilan ke layanan reports

• Kolom berikut dalam resource Report yang awalnya diwakili oleh objek bertingkat umum telah berubah untuk menggunakan jenis objek berikut:

  Kolom v1.1	Jenis objek v2 yang setara
  key	ReportKey
  metadata	ReportMetadata
  metadata.status	ReportStatus
  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

• Kolom berikut dalam resource Report yang awalnya diwakili oleh objek daftar umum telah berubah menjadi daftar objek baru berikut jenis:

  Kolom daftar v1.1	Jenis objek 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

• Kolom berikut dalam resource Report yang awalnya diwakili oleh {i>string<i} telah berubah sehingga bidang setaranya di v2 diwakili oleh jenis enum dan termasuk perubahan pada nilai yang dapat diterima:
  • metadata.status.format sekarang menggunakan enum Format. Di beberapa mengonversi ke enum ini, nilai EXCEL_CSV telah dihapus dan FORMAT_UNSPECIFIED telah ditambahkan.
  • metadata.status.state sekarang menggunakan enum State. Di beberapa mengonversi ke enum ini, nilai QUEUED dan STATE_UNSPECIFIED memiliki telah ditambahkan.
  • params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.match dan params.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.match sekarang gunakan enum Match.
  • params.options.pathQueryOptions.pathFilters[].pathMatchPosition sekarang menggunakan enum PathMatchPosition. Dalam mengonversi ke enum ini, nilai PATH_MATCH_POSITION_UNSPECIFIED telah ditambahkan.
  • params.type sekarang menggunakan enum ReportType. Di beberapa mengonversi ke enum ini, banyak perubahan telah dilakukan dan tercantum di di bagian sebelumnya tentang memperbarui panggilan layanan kueri.
• Kolom metadata.reportDataStartTimeMs dan metadata.reportDataEndTimeMs telah diganti dengan kolom reportDataStartDate dan reportDataEndDate di objek ReportMetadata. {i>Field<i} baru menggunakan Objek Date, bukan milidetik sejak Unix Epoch.
• metadata.status.finishTimeMs telah diganti dengan kolom finishTime di kolom ReportStatus. Bidang waktu baru ini mewakili tanggal & waktu sebagai stempel waktu dalam RFC3339 UTC "Zulu" alih-alih dalam format milidetik sejak Unix Epoch.
• metadata.status.failure dan Kolom params.includeInviteData telah dihapus.
• Kolom kind dalam isi respons reports.list memiliki telah dihapus.

Memperbarui logika penanganan error

Pesan error di seluruh API telah diperbarui di v2. Pesan {i>error<i} baru ini lebih spesifik dan, dalam beberapa kasus, memberikan informasi tentang nilai dalam Permintaan API yang menyebabkan error ditampilkan. Jika pesan error yang ada logika penanganan mengandalkan teks pesan error tertentu, menggeneralisasi error Anda ditangani sebelum bermigrasi ke v2.