2022 年 3 月に、Bid Manager API のバージョン 2 をリリースしました。この新しいバージョンのリリースに伴い、v1.1 のサポート終了日を発表する予定です。できるだけ早く v1.1 から v2 への移行を開始することをおすすめします。
アプリケーションの移行
v1.1 から v2 に移行するには、v2 を呼び出すようにエンドポイント URL を更新し、互換性を破る変更に対応するためにアプリケーションを更新する必要があります。
API 呼び出しを v1.1 から v2 に更新します。
v1.1 の代わりに v2 を使用するには、新しい v2 エンドポイントを使用するようにリクエストを更新する必要があります。
同等のメソッドを識別する
API 呼び出しを v1.1 から v2 に更新するには、まず v2 の同等の v1.1 メソッドを特定する必要があります。
すべてのサービスとメソッドの次の名称が、v1.1 と v2 の間で若干変更されました。
- v1.1 のサービス
QueriesとReportsは、v2 ではqueriesとqueries.reportsと呼ばれます。 - v2 では、メソッドの名前が次のように変更されました。
新しいエンドポイントに更新
同等のメソッドを特定したら、リクエストを更新する必要があります。たとえば、v1.1 で queries.getquery メソッドを呼び出すには、次の 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リソースの次のフィールドは、元々は文字列によって表されていましたが、v2 では列挙型によって表されます。これには、次の変更が含まれます。metadata.dataRangeに相当する v2 でRange列挙型が使用されるようになりました。この列挙型への変換で、値PREVIOUS_HALF_MONTHが削除され、値TYPE_NOT_SUPPORTEDがRANGE_UNSPECIFIEDに変更されました。metadata.formatはFormat列挙型を使用するようになりました。この列挙型への変換では、値EXCEL_CSVが削除され、値FORMAT_UNSPECIFIEDが追加されています。params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchとparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.matchは、Match列挙型を使用するようになりました。params.options.pathQueryOptions.pathFilters[].pathMatchPositionはPathMatchPosition列挙型を使用するようになりました。この列挙型への変換では、値PATH_MATCH_POSITION_UNSPECIFIEDが追加されています。schedule.frequencyはFrequency列挙型を使用するようになりました。この列挙型への変換で、値FREQUENCY_UNSPECIFIEDが追加されています。params.typeはReportType列挙型を使用するようになりました。この列挙型への変換において、次の変更が行われています。- 次の値は非推奨になりました。
TYPE_ACTIVE_GRPTYPE_AUDIENCE_PERFORMANCETYPE_CLIENT_SAFETYPE_COMSCORE_VCETYPE_CROSS_FEETYPE_CROSS_PARTNERTYPE_CROSS_PARTNER_THIRD_PARTY_DATA_PROVIDERTYPE_ESTIMATED_CONVERSIONTYPE_FEETYPE_KEYWORDTYPE_LINEAR_TV_SEARCH_LIFTTYPE_NIELSEN_AUDIENCE_PROFILETYPE_NIELSEN_DAILY_REACH_BUILDTYPE_NIELSEN_ONLINE_GLOBAL_MARKETTYPE_PAGE_CATEGORYTYPE_PETRA_NIELSEN_DAILY_REACH_BUILDTYPE_PETRA_NIELSEN_ONLINE_GLOBAL_MARKETTYPE_PIXEL_LOADTYPE_THIRD_PARTY_DATA_PROVIDERTYPE_TRUEVIEW_IARTYPE_VERIFICATIONTYPE_YOUTUBE_VERTICAL
- 残りの値はすべて更新され、同等の値が UI に反映されるようになっています。
v1.1 の値 同等の ReportType値TYPE_NOT_SUPPORTEDREPORT_TYPE_UNSPECIFIEDTYPE_GENERALSTANDARDTYPE_INVENTORY_AVAILABILITYINVENTORY_AVAILABILITYTYPE_AUDIENCE_COMPOSITIONAUDIENCE_COMPOSITIONTYPE_ORDER_IDFLOODLIGHTTYPE_TRUEVIEWYOUTUBETYPE_NIELSEN_SITEGRPTYPE_PETRA_NIELSEN_AUDIENCE_PROFILEYOUTUBE_PROGRAMMATIC_GUARANTEEDTYPE_REACH_AND_FREQUENCYREACHTYPE_REACH_AUDIENCEUNIQUE_REACH_AUDIENCETYPE_PATHFULL_PATHTYPE_PATH_ATTRIBUTIONPATH_ATTRIBUTION
- フィールド
metadata.dataRange、reportDataStartTimeMs、reportDataEndTimeMsが、フィールドrange、customStartDate、customEndDateに置き換えられました。新しい日付フィールドでは、Unix エポックからのミリ秒数ではなく、Dateオブジェクトを使用します。これらの置換フィールドは、QueryMetadataオブジェクトのdataRangeフィールドに割り当てられたDataRangeオブジェクトに移動されました。 - フィールド
schedule.startTimeMsとschedule.endTimeMsが、QueryScheduleオブジェクトのフィールドstartDateとendDateに置き換えられました。新しい日付フィールドでは、Unix エポックからのミリ秒数ではなく、Dateオブジェクトを使用します。 - フィールド
metadata.running、metadata.reportCount、metadata.googleCloudStoragePathForLatestReport、metadata.googleDrivePathForLatestReport、metadata.latestReportRunTimeMsが削除されました。代わりに、クエリで生成された最新のレポートに関する情報は、orderByクエリ パラメータを「key.reportId desc」に指定したqueries.reports.listメソッドを使用して取得する必要があります。これにより、リクエストで最新のレポートを最初にリストすることが保証されます。 - フィールド
kind、timezoneCode、metadata.locale、params.includeInviteData、schedule.nextRunMinuteOfDayが削除されました。 queries.createは、作成後にクエリを自動的に実行しなくなりました。また、asynchronousクエリ パラメータは削除されました。新しいクエリに関するレポートを生成するには、queries.createの後にqueries.runを呼び出します。queries.runメソッドが次のように更新されました。asynchronousクエリ パラメータはsynchronousクエリ パラメータに置き換えられました。新しいクエリ パラメータは逆論理で動作し、指定されていない場合は false と見なされます。そのため、queries.runは v1.1 のデフォルトである同期ではなく、v2 のデフォルトで非同期でレポートを生成します。- リクエスト本文が更新され、
timezoneCodeフィールドが削除され、dataRange、reportDataStartTimeMs、reportDataEndTimeMsのフィールドがdataRangeフィールドに割り当てられたDataRangeオブジェクトに置き換えられました。 - このメソッドは、空のレスポンス本文ではなく、結果の
Reportオブジェクトを返します。
queries.listレスポンス本文のkindフィールドが削除されました。
reports サービスへの呼び出しを更新する
- 元々一般的なネストされたオブジェクトによって表されていた
Reportリソースの次のフィールドが、次のオブジェクト タイプを使用するように変更されました。 - 元々一般リスト オブジェクトによって表されていた
Reportリソースの次のフィールドが、次の新しいオブジェクト タイプのリストに変更されました。 - もともと文字列で表されていた
Reportリソースの次のフィールドは、変更されたため、v2 の同等のフィールドは新しい列挙型で表されます。使用可能な値に対する変更が含まれています。metadata.status.formatはFormat列挙型を使用するようになりました。この列挙型への変換で、値EXCEL_CSVは削除され、FORMAT_UNSPECIFIEDが追加されています。metadata.status.stateはState列挙型を使用するようになりました。この列挙型への変換では、値QUEUEDとSTATE_UNSPECIFIEDが追加されています。params.options.pathQueryOptions.channelGrouping.rules[].disjunctiveMatchStatements[].eventFilters[].dimensionFilter.matchとparams.options.pathQueryOptions.pathFilters[].eventFilters[].dimensionFilter.matchは、Match列挙型を使用するようになりました。params.options.pathQueryOptions.pathFilters[].pathMatchPositionはPathMatchPosition列挙型を使用するようになりました。この列挙型への変換では、値PATH_MATCH_POSITION_UNSPECIFIEDが追加されています。params.typeはReportType列挙型を使用するようになりました。この列挙型への変換では、多くの変更が行われています。詳細については、クエリ サービス呼び出しの更新に関する前のセクションで説明します。
- フィールド
metadata.reportDataStartTimeMsとmetadata.reportDataEndTimeMsが、ReportMetadataオブジェクトのフィールドreportDataStartDateとreportDataEndDateに置き換えられました。新しいフィールドでは、Unix エポックからのミリ秒数ではなく、Dateオブジェクトを使用します。 metadata.status.finishTimeMsは、ReportStatusオブジェクトのfinishTimeフィールドに置き換えられました。この新しい時間フィールドは、Unix エポックからのミリ秒単位ではなく、RFC3339 UTC「Zulu」形式のタイムスタンプとして日時を表します。metadata.status.failureフィールドとparams.includeInviteDataフィールドが削除されました。reports.listレスポンス本文のkindフィールドが削除されました。
エラー処理ロジックを更新する
API 全体のエラー メッセージが v2 で更新されました。これらの新しいエラー メッセージはより具体的であり、場合によっては、エラーが返される API リクエストの値に関する情報を提供します。既存のエラー処理ロジックが特定のエラー メッセージ テキストに依存している場合は、v2 に移行する前にエラー処理を一般化してください。