エンドポイント

Endpoint は、API のセットを提供するネットワーク エンドポイントを記述します。1 つのサービスでいくつのエンドポイントでも公開できます。すべてのエンドポイントは同じサービス構成(割り当て、モニタリングなど)を共有します。

サービス設定の例:

name: library-example.googleapis.com
endpoints:
  # Below entry makes 'google.example.library.v1.Library'
  # API be served from endpoint address library-example.googleapis.com.
  # It also allows HTTP OPTIONS calls to be passed to the backend, for
  # it to decide whether the subsequent cross-origin request is
  # allowed to proceed.
- name: library-example.googleapis.com
  allowCors: true
JSON 表現

{
  "name": string,
  "aliases": [
    string
  ],
  "features": [
    string
  ],
  "target": string,
  "allowCors": boolean
}
フィールド
name

string

このエンドポイントの正規名。

aliases[]
(deprecated)

string

非推奨: このフィールドはサポートされなくなりました。エイリアスを使用する代わりに、想定されたエイリアスごとに複数の google.api.Endpoint を指定してください。

このエンドポイントがホストされる追加の名前。

features[]

string

このエンドポイントで有効になっている機能のリスト。

target

string

この API エンドポイントへのリクエストを処理する API フロントエンドのインターネット ルーティング可能アドレスの指定。有効な IPv4 アドレスと完全修飾ドメイン名のどちらかにする必要があります。たとえば、"8.8.8.8" または "myservice.appspot.com" にします。

allowCors

boolean

CORS(クロスドメイン トラフィック)を許可すると、このエンドポイントのバックエンドで HTTP OPTIONS リクエストを送受信できます。ブラウザは、レスポンスを使用して後続のクロスオリジン リクエストを処理可能かどうか判別します。