REST リソース: services

リソース: Service

コンシューマが利用可能なサービス。

JSON 表現

{
  "name": string,
  "parent": string,
  "config": {
    object(ServiceConfig)
  },
  "state": enum(State)
}
フィールド
name

string

コンシューマとサービスのリソース名。

有効な名前: - projects/123/services/serviceusage.googleapis.com

parent

string

コンシューマのリソース名。

有効な名前: - projects/123

config

object(ServiceConfig)

利用可能なサービスのサービス設定。一部のフィールドは、services.list メソッドへの応答で設定から除外される場合があります。これらのフィールドは、services.get メソッドへの応答内にのみ存在します。

state

enum(State)

コンシューマがサービスを利用可能になっているかどうか。

ServiceConfig

サービスの設定。

JSON 表現

{
  "name": string,
  "title": string,
  "apis": [
    {
      object(Api)
    }
  ],
  "documentation": {
    object(Documentation)
  },
  "quota": {
    object(Quota)
  },
  "authentication": {
    object(Authentication)
  },
  "usage": {
    object(Usage)
  },
  "endpoints": [
    {
      object(Endpoint)
    }
  ]
}
フィールド
name

string

このサービスが利用可能な DNS アドレス。

DNS アドレスの例: calendar.googleapis.com

title

string

このサービスのプロダクト タイトル。

apis[]

object(Api)

このサービスによって書き出される API インターフェースのリスト。インターフェースの名前、バージョン、メソッド名のみが含まれます。

documentation

object(Documentation)

追加の API ドキュメント。要約とドキュメントの URL のみが含まれます。

quota

object(Quota)

割り当て設定。

authentication

object(Authentication)

認証設定。OAuth ルールのみが含まれます。

usage

object(Usage)

このサービスの使用を制御する設定。

endpoints[]

object(Endpoint)

ネットワーク エンドポイントの設定。エンドポイントの名前とエイリアスのみが含まれます。

State

コンシューマがサービスを利用可能になっているかどうか。

列挙型
STATE_UNSPECIFIED デフォルト値。サービスの有効な状態が指定されていないか、意味がないことを示します。現在は、プロジェクト以外のすべてのコンシューマ(フォルダや組織など)が常にこの状態になります。
DISABLED このコンシューマはサービスを使用できません。明示的に無効になっているか、有効にされたことがありません。
ENABLED サービスは、明示的に、このコンシューマによって使用可能になっています。

メソッド

batchEnable

プロジェクトで複数のサービスを有効にします。

disable

プロジェクトで使用できなくなるようにサービスを無効にします。

enable

プロジェクトで使用できるようにサービスを有効にします。

get

指定されたサービスに関する、サービス設定と有効状態を返します。

list

指定されたプロジェクトで使用可能なすべてのサービスと、そのプロジェクトに関するサービスの現在の状態を一覧表示します。