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_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
に置き換えられました。新しい日付フィールドでは、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 に移行する前にエラー処理を一般化してください。