用途

サービスの使用を制御する構成。

JSON 表現

{
  "requirements": [
    string
  ],
  "rules": [
    {
      object(UsageRule)
    }
  ],
  "producerNotificationChannel": string
}
フィールド
requirements[]

string

ユーザー プロジェクトでサービスを使用するために満たされる必要のある要件。各要件は <service.name>/ の形式を取ります。たとえば、'serviceusage.googleapis.com/billing-enabled'.です。

rules[]

object(UsageRule)

個々の API メソッドに適用される使用ルールのリスト。

注: すべてのサービス設定ルールは「最後の 1 つが最優先」の順序に従います。

producerNotificationChannel

string

サービス プロデューサに通知を送信するために使用されるチャネルの完全なリソース名。

Google Service Management は、現時点で、通知チャンネルとして Google Cloud Pub/Sub のみをサポートしています。Google Cloud Pub/Sub をチャンネルとして使用するには、https://cloud.google.com/pubsub/docs/overview に記載されている Cloud Pub/Sub トピック名の形式を使用した Cloud Pub/Sub トピックの名前にする必要があります。

UsageRule

サービスの使用に関する設定ルール。

注: 開発中です。

このルールを使用して、サービスの未登録の呼び出しを設定します。未登録の呼び出しとは、ユーザー プロジェクト ID が含まれていない呼び出しです(例: API キーが含まれてんでいない呼び出し)。デフォルトでは、API メソッドは未登録の呼び出しを許可しません。また、各メソッド呼び出しはユーザー プロジェクト ID によって識別される必要があります。このルールを使用して、未登録の呼び出しを許可または禁止します。

サービス全体で未登録の呼び出しを許可する API の例:

usage:
  rules:
  - selector: "*"
    allowUnregisteredCalls: true

未登録の呼び出しを許可するメソッドの例:

usage:
  rules:
  - selector: "google.example.library.v1.LibraryService.CreateBook"
    allowUnregisteredCalls: true
JSON 表現

{
  "selector": string,
  "allowUnregisteredCalls": boolean,
  "skipServiceControl": boolean
}
フィールド
selector

string

このルールが適用されるメソッドを選択します。すべての API のすべてのメソッドを指定するには、'*' を使用します。

構文について詳しくは、selector をご覧ください。

allowUnregisteredCalls

boolean

true の場合は、選択されたメソッドが登録されていない呼び出しを許可します。たとえば、ユーザーやアプリケーションを指定しない呼び出しが可能になります。

skipServiceControl

boolean

true の場合は、選択されたメソッドがサービス コントロールをスキップすることになり、割り当てや課金などのコントロール プレーン機能が使用できなくなります。このフラグは、Google Cloud Endpoints でサービス ヘルスチェック メソッドなどの内部メソッドのチェックをバイパスするために使用されます。