App Engine Admin API を最新リリースにアップグレードする

このページでは、v1 バージョンの Admin API を使用するようにアプリをアップグレードする方法を説明します。Admin API の v1beta4 バージョンと v1beta5 バージョンのサポートは終了し、2019 年 1 月 14 日に停止されます。

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

Admin API を最新バージョンにアップグレードするには、アプリのコードにいくつかの変更を加える必要があります。

Admin API のバージョン v1 には、非推奨となるリソースや名前が変更されるリソースがあるため、いくつかの互換性を損なう変更が行われます。バージョン v1 におけるこれらの変更は、次の API のすべてのリソースのフィールドとメソッドに影響を与えます。

下記の一覧を参照し、v1 バージョンの API で非推奨または名称変更となるフィールドとメソッドを確認してください。

下記の一覧では、クライアントライブラリの変更に関する概要が明記されていませんが、この一覧から、アプリに変更を加える必要がある箇所を判断する必要があります。

Applications

Applications リソースに関しては、次の変更を行う必要があります。

REST API の場合:
- apps.patch メソッドで updateMask パラメータを使用する必要があります。次に例を示します。
  
  mask → updateMask
- ensureResourcesExist パラメータが apps.get メソッドから削除されました。v1 では、代わりに apps.repair メソッドを使用できます。
RPC API の場合:
- google.appengine.v1.Application リソースで location_id フィールドを使用する必要があります。次に例を示します。
  
  location → location_id
- google.appengine.v1.UpdateApplicationRequest リソースで update_mask フィールドを使用する必要があります。次に例を示します。
  
  mask → update_mask
- ensure_resources_exist フィールドは google.appengine.v1.GetApplicationRequest リソースから削除されました。代わりに RepairApplication メソッドを使用できます。

Instances

Instances リソースに関しては、次の変更を行う必要があります。

REST API の場合:
- apps.services.versions.instances リソースで startTime フィールドと vmDebugEnabled フィールドを使用する必要があります。次に例を示します。
  
  startTimestamp → startTime
  
  vmUnlocked → vmDebugEnabled
- apps.services.versions.instances リソースで parent フィールドを使用する必要があります。次に例を示します。
  
  name → parent
- v1beta4 の場合のみ: modules へのすべての参照が services になりました。v1 では、services リソース（例: apps.services.versions.instances）を使用する必要があります。
  
  apps.modules.versions.instances → apps.services.versions.instances
  
  詳細については、以下のサービスセクションをご覧ください。
RPC API の場合:
- google.appengine.v1.Instance リソースで start_time フィールドと vm_debug_enabled フィールドを使用する必要があります。次に例を示します。
  
  start_timestamp → start_time
  
  vm_unlocked → vm_debug_enabled
- google.appengine.v1.ListInstancesRequest リソースで parent フィールドを使用する必要があります。次に例を示します。
  
  name → parent
- v1beta4 の場合のみ: module のすべての参照が service リソースに置き換えられました。
  
  詳細については、以下のサービスセクションをご覧ください。

Services

Services リソースに関しては、次の変更を行う必要があります。

REST API の場合:
- apps.services リソースで parent フィールドを使用する必要があります。次に例を示します。
  
  name → parent
- apps.services.patch メソッドで updateMask パラメータを使用する必要があります。次に例を示します。
  
  mask → updateMask
- v1beta4 の場合のみ: modules へのすべての参照が services になりました。v1 では、services リソースを使用する必要があります。次に例を示します。
  
  apps.modules.delete → apps.services.delete
  
  apps.modules.get → apps.services.get
  
  apps.modules.list → apps.services.list
  
  apps.modules.patch → apps.services.patch
RPC API の場合:
- google.appengine.v1.ListServicesRequest リソースで parent フィールドを使用する必要があります。次に例を示します。
  
  name → parent
- google.appengine.v1.UpdateServicesRequest リソースで updateMask フィールドを使用する必要があります。次に例を示します。
  
  mask → update_mask
- v1beta4 の場合のみ: modules へのすべての参照が services になりました。v1 では、Services インターフェースを使用する必要があります。次に例を示します。
  
  DeleteModule → DeleteService
  
  GetModule → GetService
  
  ListModules → ListServices
  
  UpdateModule → UpdateServices

Versions

Versions リソースに関しては、次の変更を行う必要があります。

REST API の場合:
- apps.services.versions リソースで parent フィールドを使用する必要があります。次に例を示します。
  
  name → parent
- apps.services.versions.patch メソッドで updateMask パラメータを使用する必要があります。次に例を示します。
  
  mask → updateMask
- v1beta4 の場合のみ: modules へのすべての参照が services になりました。v1 では、services リソースを使用する必要があります。次に例を示します。
  
  apps.modules.versions → apps.services.versions
RPC API の場合:
- google.appengine.v1.Version インターフェースで created_by フィールドと created_time フィールドを使用する必要があります。次に例を示します。
  
  deployer → created_by
  
  created_by → create_time
- parent フィールドを、google.appengine.v1.CreateVersionRequest リソースと google.appengine.v1.ListVersionsRequest リソースで使用する必要があります。次に例を示します。
  
  name → parent
- google.appengine.v1.UpdateVersionRequest リソースで updateMask フィールドを使用する必要があります。次に例を示します。
  
  mask → update_mask

Deployment

次のフィールドが削除されました。

REST API の場合:

sourceReferences フィールドはサポートが終了し、apps.services.versions リソースから削除されました。
RPC API の場合:

source_references フィールドはサポートが終了し、google.appengine.v1.Deployment リソースから削除されました。

DiskUtilization

次のフィールドが変更されました。

REST API の場合:

apps.services.versions リソースで targetWriteBytesPerSecond、targetWriteOpsPerSecond、targetReadBytesPerSecond、targetReadOpsPerSecond の各フィールドを使用する必要があります。次に例を示します。

targetWriteBytesPerSec → targetWriteBytesPerSecond

targetWriteOpsPerSec → targetWriteOpsPerSecond

targetReadBytesPerSec → targetReadBytesPerSecond

targetReadOpsPerSec → targetReadOpsPerSecond
RPC API の場合:

google.appengine.v1.DiskUtilization リソースで target_write_bytes_per_second、target_write_ops_per_second、target_read_bytes_per_second、target_read_ops_per_second の各フィールドを使用する必要があります。次に例を示します。

target_write_bytes_per_sec → target_write_bytes_per_second

target_write_ops_per_sec → target_write_ops_per_second

target_read_bytes_per_sec → target_read_bytes_per_second

target_read_ops_per_sec → target_read_ops_per_second

NetworkUtilization

次のフィールドが変更されました。

REST API の場合:

apps.services.versions リソースで targetSentBytesPerSecond、targetSentPacketsPerSecond、targetReceivedBytesPerSecond、targetReceivedPacketsPerSecond の各フィールドを使用する必要があります。次に例を示します。

targetSentBytesPerSec → targetSentBytesPerSecond

targetSentPacketsPerSec → targetSentPacketsPerSecond

targetReceivedBytesPerSec → targetReceivedBytesPerSecond

targetReceivedPacketsPerSec → targetReceivedPacketsPerSecond
RPC API の場合:

google.appengine.v1.NetworkUtilization リソースで target_sent_bytes_per_second、target_sent_packets_per_second、target_received_bytes_per_second、target_received_packets_per_second の各フィールドを使用する必要があります。次に例を示します。

target_sent_bytes_per_sec → target_sent_bytes_per_second

target_sent_packets_per_sec → target_sent_packets_per_second

target_received_bytes_per_sec → target_received_bytes_per_second

target_received_packets_per_sec → target_received_packets_per_second

OperationMetadataV1

次のフィールドが変更されました。

google.appengine.v1.OperationMetadataV1 リソースで method フィールドを使用する必要があります。次に例を示します。

operation_type → method
google.appengine.v1.OperationMetadataV1 リソースで OperationMetadataV1 フィールドを使用する必要があります。
- v1beta4 は OperationMetadata に置き換えます。次に例を示します。
  
  OperationMetadata → OperationMetadataV1
- v1beta5 は OperationMetadataV1Beta5 に置き換えます。次に例を示します。
  
  OperationMetadataV1Beta5 → OperationMetadataV1

RequestUtilization

次のフィールドが変更されました。

REST API の場合:

apps.services.versions リソースで targetRequestCountPerSecond フィールドを使用する必要があります。次に例を示します。

targetRequestCountPerSec → targetRequestCountPerSecond
RPC API の場合:

google.appengine.v1.RequestUtilization リソースで target_request_count_per_second フィールドを使用する必要があります。次に例を示します。

target_request_count_per_sec → target_request_count_per_second

UrlDispatchRule

apps REST API リソースと google.appengine.v1.UrlDispatchRule RPC リソースで service フィールドを使用する必要があります。次に例を示します。

UrlDispatchRule.module → UrlDispatchRule.service