最新バージョンにアップグレードする

Google Ads API の古いメジャー バージョンから新しいメジャー バージョンへのアップグレードは、定期的に行うことをおすすめします。バージョンが廃止されること、新しい機能を使用したい場合などが考えられます。常に最新バージョンにアップグレードすることをおすすめします。

アップグレードを計画するには、サポート終了スケジュールをご確認ください。バージョニングの仕組みについては、バージョニング ガイドをご覧ください。

次のチェックリストを利用して、アップグレードを開始してください。

  1. メジャー バージョンを変更すると、エンドポイントも変更されます。最新のエンドポイントを使用するようにクライアント ライブラリを更新します。
  2. 各リリースで導入された変更については、リリースノートをご覧ください。
  3. アップグレードするバージョンで重点を置くべき点については、以下の表をご覧ください。

2 つのバージョンの proto の差分に基づく変更の概要については、差分テーブルをご覧ください。

v16 ~ v17

サービスとそのコンポーネントの変更
GoogleAdsService Search リクエストと SearchStream リクエスト

コストが高すぎるためにリクエストが抑制されている場合のエラーは、QuotaError.RESOURCE_EXHAUSTED ではなく、QuotaError.EXCESSIVE_SHORT_TERM_QUERY_RESOURCE_CONSUMPTION または QuotaError.EXCESSIVE_LONG_TERM_QUERY_RESOURCE_CONSUMPTION になります。詳しくは、こちらのブログ投稿をご覧ください。

GoogleAdsService Search リクエスト。

page_sizeGoogleAdsService.Search に渡すと、RequestError.PAGE_SIZE_NOT_SUPPORTED エラーが発生します。

CampaignAd

AdvertisingChannelTypeDISCOVERY のキャンペーンでは、AdvertisingChannelTypeDEMAND_GEN になります。

また、一部の広告では、レポート用にタイプとフィールド名が変更されます。

  • DISCOVERY_MULTI_ASSET_ADDDEMAND_GEN_MULTI_ASSET_ADD に、対応するレポート フィールド ad_group_ad.ad.discovery_multi_asset_adad_group_ad.ad.demand_gen_multi_asset_ad になります。
  • DISCOVERY_CAROUSEL_ADDEMAND_GEN_CAROUSEL_AD に、対応するレポート フィールド ad_group_ad.ad.discovery_carousel_adad_group_ad.ad.demand_gen_carousel_ad になります。
  • DISCOVERY_VIDEO_RESPONSIVE_ADDEMAND_GEN_VIDEO_RESPONSIVE_AD に、対応するレポート フィールド ad_group_ad.ad.discovery_video_responsive_adad_group_ad.ad.demand_gen_video_responsive_ad になります。

AdService GetAd エンドポイントは削除されます。これにより、AdService は Google Ads API の他のサービスと連動するようになります。広告やその他のリソースタイプを取得するおすすめの方法については、オブジェクトの取得に関するガイドをご覧ください。
CustomerLifecycleGoalCampaignLifecycleGoal ライフサイクル目標に基づくセグメントの管理方法が再構築されました。概要については、ライフサイクル目標に関するドキュメントのオーディエンスのセグメントセクションをご覧ください。
ProductLink product_link に対して GoogleAdsService 検索または検索ストリーム リクエストを実行するときに、1 つのリンクされた商品に関連するフィールドのみを選択できるようになりました。リンクされた異なるサービスから複数のフィールドを選択すると、QuotaError.PROHIBITED_FIELD_COMBINATION_IN_SELECT_CLAUSE エラーが発生します。
報告 metrics.sk_ad_network_conversion_value フィールドの名前を metrics.sk_ad_network_fine_conversion_value に変更しました。

v15 ~ v16

サービスとそのコンポーネントの変更
AccountLink linked_accountdata_partner リンクと google_ads リンクが削除されました。代わりに ProductLinkServiceProductLinkInvitationService を使用してください。
CampaignLifecycleGoal 以前に既存の CampaignLifecycleGoal を更新する場合は、特定の要件を指定して create オペレーションを発行します。これで、他のリソースタイプと同様に update オペレーションを発行できるようになりました。
Error Reporting 汎用の ContextError.OPERATION_NOT_PERMITTED_FOR_CONTEXT エラーが返された 2 つのケースで、より具体的なエラー メッセージが表示されるようになりました。
  • CampaignError.CANNOT_LINK_TO_COMPARISON_SHOPPING_SERVICE_ACCOUNT
  • CampaignError.CANNOT_TARGET_NETWORK_FOR_COMPARISON_SHOPPING_SERVICE_LINKED_ACCOUNTS
AudienceInsightsAttributeMetadata score フィールドが削除されました。
KeywordMatchTypeRecommendation キーワードのマッチタイプが設定されていない場合、API は recommended_match_type フィールドで UNKNOWN ではなく UNSPECIFIED を返すようになりました。

v14 ~ v15

サービスとそのコンポーネントの変更
AssetGroupListingGroupFilter vertical 列挙型フィールドの名前が feed_type に変更されました。
MediaFileService このサービスは不要になったため削除されました。下記の ImageAdInfo の変更をご覧ください。
ImageAdInfo media_file フィールドが image_asset に置き換えられました。
MerchantCenterLinkService このサービスは、 ProductLinkInvitationService ProductLinkService に置き換えられました。
Campaign.ShoppingSetting sales_country フィールドが削除されました。これで、情報が feed_label フィールドに返されます。
ProductBiddingCategoryConstant ProductCategoryConstant に置き換えられました。これに合わせて複数のフィールドの名前が変更されました。以下の 3 つの変更をご覧ください。
ListingDimensionInfo product_bidding_category フィールドを product_category に置き換えました。
ListingGroupFilterDimension product_bidding_category フィールドを product_category に置き換えました。
shopping_performance_view レポート 次のセグメント フィールド:
  • product_bidding_category_level1
  • product_bidding_category_level2
  • product_bidding_category_level3
  • product_bidding_category_level4
  • product_bidding_category_level5
が次の内容に置き換えられました。
  • product_category_level1
  • product_category_level2
  • product_category_level3
  • product_category_level4
  • product_category_level5
Campaign.shopping_setting このフィールドを使った検索キャンペーンの作成のサポートは終了しました。
CampaignCriterion.listing_scope このフィールドを使った検索キャンペーンの作成のサポートは終了しました。
sk_ad_network_conversions レポート metrics.sk_ad_network_conversionsmetrics.sk_ad_network_installs に置き換えられました。
OfflineConversionClientSummary offline_conversion_client_summaries フィールドを Customer から、個別にクエリできる最上位リソースに移動しました。

クエリを次から変更:

SELECT customer.offline_conversion_client_summaries
FROM customer
から
SELECT
  offline_conversion_upload_client_summary.client,
  offline_conversion_upload_client_summary.status,
  offline_conversion_upload_client_summary.total_event_count,
  offline_conversion_upload_client_summary.successful_event_count,
  offline_conversion_upload_client_summary.last_upload_date_time,
  ...
FROM offline_conversion_upload_client_summary
に変更

選択とフィルタリングに使用可能なフィールドのリストを確認するには、クエリビルダーを使用します。

OfflineConversionUploadAlert OfflineConversionAlert に名前が変更されました。
OfflineConversionUploadError OfflineConversionError に名前が変更されました。
AdNetworkType 列挙型 YOUTUBE_SEARCH YOUTUBE_WATCH が単一の列挙型 YOUTUBE に統合されました。