Bid Manager API v1.1 から v2 に移行する

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 メソッド名	同等の v2 メソッド
  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

新しいエンドポイントへの更新

同等のメソッドを特定したら、リクエストを更新する必要があります。対象 たとえば、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 リソースの次のフィールドは、 ネストされたオブジェクトは、次のオブジェクト タイプを使用するように変更されました。

  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 リソースの次のフィールドは、 list オブジェクトが、次の新しいオブジェクト タイプのリストに変更されました。

  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 リソースの次のフィールド。元々は 文字列。v2 では列挙型で表現され、次の内容が含まれます。 変更点: <ph type="x-smartling-placeholder">
  </ph>
  • metadata.dataRange の v2 に相当する関数が Range を使用するようになりました。 enum。この列挙型に変換した結果、値 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 列挙型を使用するようになりました。イン この列挙型に変換するために、次の変更が行われています。
  • 次の値は非推奨となりました。 <ph type="x-smartling-placeholder">
    </ph>
    • 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 を使用します。 ミリ秒単位の経過時間をカウントしています。これらの置換フィールド このオブジェクトは、割り当てられている DataRange オブジェクトに移動されています。 dataRange フィールド QueryMetadata オブジェクト。
• フィールド schedule.startTimeMs と schedule.endTimeMs がフィールドに置き換えられました startDate と endDate QuerySchedule オブジェクト。新しい日付フィールドでは Date を使用します。 ミリ秒単位の経過時間をカウントしています。
• フィールド metadata.running、 metadata.reportCount, metadata.googleCloudStoragePathForLatestReport, metadata.googleDrivePathForLatestReport metadata.latestReportRunTimeMs が削除されました。 クエリに対して最近生成されたレポートに関する情報は、 代わりに、queries.reports.list メソッドを 「key.reportId desc」の orderBy クエリ パラメータを 最新のレポートが最初に表示されるようにする。
• フィールド kind、timezoneCode、 metadata.locale, params.includeInviteData schedule.nextRunMinuteOfDay が削除されました。
• queries.create は、作成後にクエリを自動的に実行しなくなりました また、asynchronous クエリ パラメータは削除されました。発信 queries.create以降は queries.run でレポートを生成します。 作成します
• queries.run メソッドが次のように更新されました。 <ph type="x-smartling-placeholder">
  </ph>
  • asynchronous クエリ パラメータは、次の内容に置き換えられました。 synchronous クエリ パラメータ。新しいクエリ パラメータ 逆論理で動作し、指定しない場合は false と見なされます。与えられた queries.run は、デフォルトで非同期でレポートを生成します。 同期同期は v1.1 のデフォルトです。
  • リクエストの本文は、 timezoneCode フィールドを使用して次のように置き換えます。 dataRange、reportDataStartTimeMs、 reportDataEndTimeMs フィールドに DataRange オブジェクトを dataRange フィールド。
  • このメソッドは、結果の Report オブジェクトを返します。 空のレスポンス本文です。
• queries.list レスポンス本文の kind フィールド は削除されました。

reports サービスの呼び出しを更新する

• 元の Report リソースの次のフィールド: 一般的なネスト オブジェクトは、次のオブジェクト タイプを使用するように変更されました。

  v1.1 フィールド	同等の v2 オブジェクト タイプ
  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

• 元の Report リソースの次のフィールド: 一般リスト オブジェクトが、次の新しいオブジェクトのリストに変更されました。 種類:

  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

• 元の Report リソースの次のフィールド: 変更されたため、v2 では対応するフィールドが new 許容される値に対する変更を含めることもできます。 <ph type="x-smartling-placeholder">
  </ph>
  • 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 が以下に置き換えられました フィールド reportDataStartDate と reportDataEndDate ReportMetadata オブジェクト。新しいフィールドでは Date オブジェクト（Unix エポックからのミリ秒数ではなく）
• metadata.status.finishTimeMs の後継モデル: finishTime フィールド ReportStatus オブジェクト。この新しい時間フィールドは RFC3339 UTC「Zulu」のタイムスタンプとしての日時を ミリ秒単位の経過時間。
• metadata.status.failure、 params.includeInviteData 個のフィールドが削除されました。
• reports.list レスポンス本文の kind フィールドには、 削除されました。

エラー処理ロジックを更新する

API 全体のエラー メッセージは v2 で更新されました。これらの新しいエラーメッセージは より具体的です。場合によっては、 エラーの原因となった API リクエストの数。既存のエラーが 特定のエラー メッセージ テキストに依存する処理ロジックの場合は、エラーを一般化し、 いくつか確認しましょう