限定公開プレビューのオンボーディング

Universal Ledger 限定公開プレビュー版 へようこそ。このガイドでは、API を有効にして、プロジェクトで使い始める方法について説明します。 Google Cloud

許可リスト登録リクエスト

これは限定公開プレビュー版のリリースであるため、API にアクセスするには、Google の担当者と初期オンボーディングの手順を完了する必要があります。 完了すると、API を有効にして IAM ロールを割り当て、リクエストの送信を開始できます。

  1. お客様 ID または組織 ID を確認する

    オンボーディングを行う前に、組織を API の内部許可リストに追加する必要があります。次のいずれかを提供する必要があります。

    • 組織のお客様 ID 。 お客様 ID を確認するの手順に沿って、 管理者が取得できます。 通常、この ID は「C」で始まり、その後に英数字が続きます。

    • プロジェクトとリソースを保持する組織 ID。 Google Cloud 詳しくは、 組織リソース ID の取得をご覧ください。 この ID は大きな 10 進数で表示されます。

  2. プロジェクト Google Cloud を選択する

    API で使用する プロジェクトを特定または作成します。 Google Cloud 詳しくは、プロジェクトの作成と管理 をご覧ください。これらのプロジェクトが、ステップ 1 と同じお客様組織内に存在することを確認してください。

  3. Google の担当者にメールを送信する

    gcul-help@google.com に次の内容を記載したメールを送信します。

    • ステップ 1 のお客様 ID または組織 ID
    • ステップ 2 のプロジェクト ID のリスト

    組織とプロジェクトが限定公開プレビュー版の許可リストに正常に追加されると、確認メールが届きます。このステップが完了したら、API を有効にできます。

API の有効化

プロジェクトが許可リストに追加されたら、gcloud を使用して Universal Ledger API を有効にし、特定の IAM ロールを使用してチームメンバーに詳細なアクセス権を割り当てることができます。

  1. gcloud を使用して API を有効にする

    API を有効にするには、gcloud services enable コマンドを使用します。

    gcloud services enable universalledger.googleapis.com \
    --project=PROJECT_ID

    PROJECT_ID は、API を有効にするプロジェクトの ID に置き換えます。

    プロジェクト オーナーの場合は、API にリクエストを送信できるようになります。

  2. IAM ロールを使用して詳細なアクセス権を設定する

    組織の他のメンバーに対する Universal Ledger API への詳細なアクセス権を管理するには、IAM ロールを割り当てます。API には 3 つの IAM ロールが構成されており、それぞれ異なるレイヤのアクセス権が付与されます。

    • roles/universalledger.viewer: 利用可能なエンドポイントとネットワークへの読み取り専用アクセス。エンドポイントを表示し、エンドポイントを使用してネットワークをクエリする権限を付与します。
    • roles/universalledger.editor: 利用可能なエンドポイントとネットワークへの完全アクセス。ネットワークのクエリとトランザクションの送信を行う権限を付与します。
    • roles/universalledger.admin: 利用可能なエンドポイントとネットワークへの完全アクセス。ネットワークのクエリとトランザクションの送信を行う権限を付与します。このロールには、Universal Ledger 編集者ロールと同じ権限が付与されますが、今後変更される可能性があります。

    ユーザーに新しい IAM ロールを追加するには、gcloud projects add-iam-policy-binding コマンドを使用します。

    gcloud projects add-iam-policy-binding PROJECT_ID \
    --member="PRINCIPAL" \
    --role="ROLE"

    次のように置き換えます。

    • PROJECT_ID: IAM ポリシー バインディングを追加するプロジェクト
    • PRINCIPAL: ロールが追加されるプリンシパル（user:test-user@gmail.com、serviceAccount:test123@example.domain.com など）。
    • ROLE: プリンシパルに割り当てる、前述のロールのいずれか

最初のリクエストを送信する

これで API の使用を開始できます。

前の構成が正しく機能していることを確認するには、まず を使用して認証しますgcloud auth login コマンド:

gcloud auth login

次に、endpoints.list リクエストを送信します。

curl -H "Authorization: Bearer $(gcloud auth print-access-token)" \
    -X GET "https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/us-central1/endpoints"

特定の Universal Ledger ネットワークへのリクエストは、API エンドポイントを使用して送信されます。形式は次のようになります。

https://universalledger.googleapis.com/v1/projects/PROJECT_ID/locations/REGION/endpoints/NETWORK_NAME

利用可能なメソッドの詳細については、REST または RPC API のリファレンスをご覧ください。

利用可能なネットワークとリージョン

限定公開プレビュー版では、次の 2 つのネットワークを使用できます。

  • gcul-pilot-testing: 試験運用版の機能を含む頻繁な更新 を受け取ります。このネットワークを使用して、迅速なイテレーション を行い、新しいアセットタイプとプロダクトをテストします。
  • gcul-user-testing: 更新頻度が低い ネットワーク。テスト トランザクションと本番環境トランザクションの両方を処理し、支払いワークフローと決済ワークフローに統合することを目的としています。

次の表に、これらのネットワークごとにバリデータを使用できるリージョンをまとめます。

リージョン gcul-pilot-testing gcul-user-testing
us-central1
us-east1
us-east4
us-east5
us-west1
europe-west2
europe-west3

次のステップ