Package spectrum.sas.portal.v1alpha1

索引

導入事例

SAS のお客様を管理するサービス。

GetCustomer

rpc GetCustomer(GetCustomerRequest) returns (Customer)

リクエストされた customer を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ListCustomers

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

リクエストされた customers のリストを返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
UpdateCustomer

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

既存の customer を更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email

DeviceManager

市民ブロードバンドの無線サービス デバイスを管理するサービス。

デプロイの作成

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

新しい deployment を作成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
CreateDevice

rpc CreateDevice(CreateDeviceRequest) returns (Device)

node または customer の下に device を作成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ノードの作成

rpc CreateNode(CreateNodeRequest) returns (Node)

新しい node を作成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
署名付きデバイスを作成

rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device)

node または customer の下に署名付き device を作成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
Deployment を削除する

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

deployment を削除します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
DeleteDevice

rpc DeleteDevice(DeleteDeviceRequest) returns (Empty)

device を削除します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ノードを削除

rpc DeleteNode(DeleteNodeRequest) returns (Empty)

node を削除します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
GenerateSecret

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

ValidateInstaller で使用する Secret を生成します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
GetDeployment

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

リクエストされた deployment を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
GetDevice

rpc GetDevice(GetDeviceRequest) returns (Device)

device に関する詳細を取得します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ノードの取得

rpc GetNode(GetNodeRequest) returns (Node)

リクエストされた node を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ListDeployment

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

deployments を一覧表示します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ListDevices

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

node または customerdevices を一覧表示します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ListNodes

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

nodes を一覧表示します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
MoveDeployment

rpc MoveDeployment(MoveDeploymentRequest) returns (Operation)

deployment を別の node または customer の下に移動します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
デバイスを移動

rpc MoveDevice(MoveDeviceRequest) returns (Operation)

device を別の node または customer の下に移動します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ノードを移動

rpc MoveNode(MoveNodeRequest) returns (Operation)

node を別の node または customer の下に移動します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
サインデバイス

rpc SignDevice(SignDeviceRequest) returns (Empty)

device に署名します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
UpdateDeployment

rpc UpdateDeployment(UpdateDeploymentRequest) returns (Deployment)

既存の deployment を更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
デバイスの更新

rpc UpdateDevice(UpdateDeviceRequest) returns (Device)

device を更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
更新ノード

rpc UpdateNode(UpdateNodeRequest) returns (Node)

既存の node を更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
署名付きデバイスの更新

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

署名付きの device を更新します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
ValidateInstaller

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

認定プロフェッショナル インストーラ(CPI)の識別情報を検証します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email

PolicyService

Spectrum Resource Manager へのアクセス制御サービス。

ポリシーの取得

rpc GetPolicy(GetPolicyRequest) returns (Policy)

リソースのアクセス制御ポリシーを取得します。リソースが存在し、ポリシーが設定されていない場合は、空のポリシーを返します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
SetPolicy

rpc SetPolicy(SetPolicyRequest) returns (Policy)

指定したリソースにアクセス制御ポリシーを設定します。既存のポリシーをすべて置き換えます。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email
TestPermissions

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

指定したリソースに対して呼び出し元が持っている権限を返します。

認証スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/userinfo.email

割り当て

membersrole に関連付けます。

フィールド
role

string

必須。members に割り当てるロール。

members[]

string

ロールが割り当てられている ID。以下のいずれかの値が設定されます。

  • {user_email}: 特定の Google アカウントを表すメールアドレス。例: alice@gmail.com

  • {group_email}: Google グループを表すメールアドレス。例: viewers@gmail.com

お支払いモード

CBSD の課金モード

列挙型
BILLING_MODE_UNSPECIFIED 請求モードが指定されていません。
MOBILE 価格は CBSD のカテゴリに基づきます。SAS に登録されているカテゴリ A、カテゴリ B。
FIXED_WIRELESS 価格は CBSD のタイプ(ベース ステーションまたは CPE)に基づきます。

チャンネル タイプ

列挙型
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

CreateDeploymentRequest(デプロイリクエストの作成)

CreateDeployment のリクエスト。

フィールド
parent

string

必須。デプロイを作成する親リソース名。

deployment

Deployment

必須。デプロイの詳細。name は空にする必要があります。これはサーバーによって生成されます。デプロイ display_name を設定する必要があります。

CreateDeviceRequest

CreateDevice のリクエスト。

フィールド
parent

string

必須。親リソースの名前。

device

Device

device の登録の詳細。name は空にする必要があります。これはサーバーによって生成されます。device フィールドの fcc_idserial_number を設定する必要があります。user_id フィールドを設定する必要があります。

CreateNodeRequest

CreateNode のリクエスト。

フィールド
parent

string

必須。ノードを作成する親リソース名。

node

Node

ノードの詳細。name は空にする必要があります。これはサーバーによって生成されます。ノード display_name を設定する必要があります。

CreateSignedDeviceRequest

CreateSignedDevice のリクエスト。

フィールド
parent

string

必須。親リソースの名前。

encoded_device

bytes

必須。CPI 秘密鍵を使用して署名された JSON Web Token。ペイロードは、device の JSON エンコードにする必要があります。user_id フィールドを設定する必要があります。

installer_id

string

必須。認定プロフェッショナル インストーラ データベースに登録されている一意のインストーラ ID(CPI ID)。

お客様

SAS の顧客を表すエンティティ。

フィールド
name

string

出力のみ。顧客のリソース名。

display_name

string

必須。顧客エンティティが表す組織の名前。

sas_user_ids[]

string

このお客様が所有するデバイスで使用されるユーザー ID。

DeleteDeploymentRequest

DeleteDeployment のリクエスト。

フィールド
name

string

必須。deployment の名前。

DeleteDeviceRequest

DeleteDevice のリクエスト。

フィールド
name

string

必須。デバイスの名前。

DeleteNodeRequest

DeleteNode のリクエスト。

フィールド
name

string

必須。node の名前。

デプロイ

Deployment。

フィールド
name

string

出力のみ。リソース名。

display_name

string

デプロイメントの表示名。

sas_user_ids[]

string

このデプロイに属するデバイスで使用されるユーザー ID。各デプロイメントは 1 つの一意のユーザー ID に関連付ける必要があります。

default_billing_mode

BillingMode

デプロイとそれ下にあるデバイスのデフォルトの請求モード。

allowed_billing_modes[]

BillingMode

このデプロイで許可される課金モード。

デバイス

フィールド
name

string

出力のみ。リソースパス名。

fcc_id

string

デバイスの FCC 識別子。

serial_number

string

デバイスのメーカーがデバイスに割り当てるシリアル番号。

preloaded_config

DeviceConfig

デバイスの構成。SAS Portal API で指定します。

active_config

DeviceConfig

出力のみ。SAS に登録されているデバイスの現在の構成。

state

State

出力のみ。デバイスの状態。

grants[]

DeviceGrant

出力のみ。デバイスに保持されている権限。

display_name

string

デバイスの表示名。

device_metadata

DeviceMetadata

SAS Portal と SAS 登録リクエストの両方でオーバーライドできるデバイス パラメータ。

状態

デバイスの状態。

列挙型
DEVICE_STATE_UNSPECIFIED 未指定の状態
RESERVED SAS Portal で作成されたデバイスがまだ SAS に登録されていない。
REGISTERED SAS に登録されているデバイス。
DEREGISTERED SAS から登録解除されたデバイス。

DeviceAirInterface

デバイスのエア インターフェースに関する情報

フィールド
radio_technology

RadioTechnology

条件付き。このフィールドでは、CBSD に使用される無線アクセス技術を指定します。

supported_spec

string

(省略可)このフィールドは radioTechnology に関連しており、登録時に CBSD が遵守しているエア インターフェース仕様を指定します。

放射線技術

承認されている無線アクセス技術のタイプ。

列挙型
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

パート 96 で定義されているデバイスの FCC カテゴリ。

列挙型
DEVICE_CATEGORY_UNSPECIFIED デバイス カテゴリが指定されていません。
DEVICE_CATEGORY_A カテゴリ A.
DEVICE_CATEGORY_B カテゴリ B.

DeviceConfig

デバイス設定に関する情報。

フィールド
category

DeviceCategory

デバイスの FCC カテゴリ

model

DeviceModel

このデバイスモデルに関する情報です。

air_interface

DeviceAirInterface

このデバイスのエア インターフェースに関する情報。

installation_params

InstallationParams

デバイスのインストール パラメータ。

measurement_capabilities[]

MeasurementCapability

デバイスの測定レポート機能。

user_id

StringValue

デバイス ユーザーの ID。

call_sign

string

デバイス事業者のコールサイン。

state

State

構成の状態。

is_signed

BoolValue

出力のみ。構成が CPI で署名されているかどうか。

update_time

Timestamp

出力のみ。デバイス設定の最終更新日時。

状態

デバイス構成の状態。CBSD の登録時に使用できるのは、状態 DEVICE_CONFIG_STATE_FINAL の構成ファイルのみです。

列挙型
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

デバイス付与

デバイスの許可これは、デバイスがハートビートに成功した後に、指定動作パラメータを使用して送信するために Spectrum Access システムによってデバイスに付与される認可です。

フィールド
max_eirp

DoubleValue

アクセス許可によって許容される最大等価放射電力(EIRP)最大 EIRP は dBm/MHz の単位です。maxEirp の値は FCC パート 96.41(e)(3)で定義される手順によって測定される平均(RMS)EIRP を表します。

frequency_range

FrequencyRange

送信周波数範囲。

state

GrantState

付与の状態。

channel_type

ChannelType

使用されたチャンネルの種類。

move_list[]

DpaMoveList

この付与が表示されている DPA Move リスト。

expire_time

Timestamp

付与の有効期限。

suspension_reason[]

string

助成金が停止された場合は、停止の理由。

grant_id

string

付与 ID。

デバイス メタデータ

SAS ポータル リクエストと登録リクエストの両方でデバイスデータをオーバーライド可能。

DeviceModel

デバイスのモデルに関する情報

フィールド
vendor

string

デバイスのベンダーの名前。

name

string

デバイスモデルの名前。

software_version

string

デバイスのソフトウェア バージョン

hardware_version

string

デバイスのハードウェア バージョン。

firmware_version

string

デバイスのファームウェア バージョン。

DpaMoveList

DPA の移動リストのエントリ。

フィールド
dpa_id

StringValue

DPA の ID。

frequency_range

FrequencyRange

移動リストが影響を与える頻度の範囲。

周波数範囲

頻度: low_frequencyhigh_frequency

フィールド
low_frequency_mhz

DoubleValue

周波数帯の最低周波数(MHz)。

high_frequency_mhz

DoubleValue

周波数帯での最大周波数(MHz)。

GenerateSecretRequest

GenerateSecret のリクエスト。

GenerateSecretResponse

GenerateSecret へのレスポンス。

フィールド
secret

string

文字列によって生成され、ValidateInstaller によって使用されるシークレット。

GetCustomerRequest

GetCustomer のリクエスト。

フィールド
name

string

必須。customer の名前。

GetDeploymentRequest

GetDeployment のリクエスト。

フィールド
name

string

必須。deployment の名前。

GetDeviceRequest

GetDevice のリクエスト。

フィールド
name

string

必須。デバイスの名前。

GetNodeRequest

GetNode のリクエスト。

フィールド
name

string

必須。node の名前。

GetPolicyRequest

GetPolicy メソッドに対するリクエスト メッセージ。

フィールド
resource

string

必須。ポリシーがリクエストされているリソース。

付与状態

付与の状態。

列挙型
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED 権限が付与されましたが、デバイスがハートビートで応答していません。
GRANT_STATE_TERMINATED 付与は SAS によって終了されました。
GRANT_STATE_SUSPENDED SAS によって資金提供が停止されています。
GRANT_STATE_AUTHORIZED デバイスは現在送信中です。
GRANT_STATE_EXPIRED 付与の有効期限が切れています。

高さのタイプ

高さの測定方法を指定します。

列挙型
HEIGHT_TYPE_UNSPECIFIED 高さのタイプが指定されていません。
HEIGHT_TYPE_AGL AGL の高さは、地面の高さに対して測定されます。
HEIGHT_TYPE_AMSL AMSL の高さは、平均海面を基準にして測定されます。

InstallationParams

デバイス インストール パラメータに関する情報です。

フィールド
latitude

DoubleValue

デバイスのアンテナ位置の緯度を、WGS 84 データに対する相対角度で表します。指定できる範囲は -90.000000 ~+90.000000 です。正の値は、赤道より北に位置する緯度、赤道より南にある緯度を表します。

longitude

DoubleValue

WGS 84 データに対するデバイス アンテナ位置の距離(度単位)。指定できる範囲は -180.000000 ~+180.000000 です。正の値は、本初子午線より東の経度を表し、負の値は本初子午線より西にあります。

height

DoubleValue

デバイスのアンテナの高さ(メートル単位)。heightType パラメータ値が「AGL」の場合、アンテナの高さは地面の高さに対して指定する必要があります。heightType パラメータ値が「AMSL」の場合、WGS84 データに対して指定されます。

height_type

HeightType

高さの測定方法を指定します。

horizontal_accuracy

DoubleValue

デバイス アンテナの水平方向の精度を示す、メートル単位の正の数値です。このオプションのパラメータは、その値が FCC 要件の 50 m を下回った場合にのみ指定します。

vertical_accuracy

DoubleValue

デバイス アンテナの垂直位置の精度を示す正数(メートル単位)。このオプションのパラメータは、その値が FCC 要件の 3 m より小さい場合にのみ指定する必要があります。

indoor_deployment

BoolValue

デバイスのアンテナが屋内かどうかを示します。true: 屋内。false: アウトドア

antenna_azimuth

Int32Value

アンテナの水平面のボアサイト方向(真北に対する角度)。このパラメータの値は 0 ~ 359 の整数です。値 0 度は真北を意味します。90 度は東を意味します。このパラメータはカテゴリ A デバイスでは省略可能で、カテゴリ B デバイスでは条件付きです。

antenna_downtilt

Int32Value

アンテナの角度は -90 ~+90 の範囲の整数です。負の値は、アンテナが上に傾斜(水平より上)していることを意味します。このパラメータはカテゴリ A デバイスでは省略可能で、カテゴリ B デバイスでは条件付きです。

antenna_gain

Int32Value

アンテナのピークゲイン(dBi)。このパラメータは、値が -127 ~+128(dBi)の整数です。

eirp_capability

Int32Value

このパラメータは、デバイスの最大 EIRP(dBm/10MHz 単位)で、-127 ~+47(dBm/10 MHz)の範囲の整数です。指定しない場合、SAS はデバイス カテゴリで最大許容 EIRP(dBm/10MHz 単位)と解釈します。

antenna_beamwidth

Int32Value

水平面におけるアンテナの 3 dB アンテナ ビーム幅(度単位)。このパラメータは、0 ~ 360(度)の値を持つ符号なし整数です。カテゴリ A のデバイスの場合、省略可能で、カテゴリ B のデバイスの場合は条件付きになります。

antenna_model

string

外部アンテナを使用する場合は、必要に応じてアンテナモデルを指定します。文字列の最大長は 128 オクテットです。

cpe_cbsd_indication

BoolValue

このパラメータがある場合、CBSD が CPE-CBSD かどうかを指定します。

ListCustomersRequest

ListCustomers のリクエスト。

フィールド
page_size

int32

レスポンスで返される customers の最大数。

page_token

string

前回の ListCustomers への呼び出しからページ設定トークンが返されます。これは、一覧表示がどこから継続するのかを指定します。

ListCustomersResponse

ListCustomers へのレスポンス。

フィールド
customers[]

Customer

リクエストに一致する customers のリスト。

next_page_token

string

前回の ListCustomers 呼び出しから返されたページ設定トークン。一覧表示を続行する場所を示します。この欄がないか、何も入力されていない場合は、顧客がいないことを意味します。

ListDeploymentsRequest に対するリクエスト メッセージです。

ListDeployments のリクエスト。

フィールド
parent

string

必須。親リソース名(例: customer/1/nodes/2)。

page_size

int32

レスポンスで返されるデプロイの最大数。

page_token

string

前回の ListDeployments への呼び出しからページ設定トークンが返されます。これは、一覧表示がどこから継続するのかを指定します。

filter

string

フィルタ式。フィルタの形式は "DIRECT_CHILDREN" または "direct_children" です。フィルタでは大文字と小文字が区別されません。空の場合、デプロイはフィルタリングされません。

ListDeploymentsResponse

ListDeployments へのレスポンス。

フィールド
deployments[]

Deployment

リクエストに一致する deployments

next_page_token

string

前回の ListDeployments 呼び出しから返されたページ設定トークン。一覧表示を続行する場所を示します。このフィールドがないか空の場合、デプロイがなくなったことを意味します。

ListDevicesRequest

ListDevices のリクエスト。

フィールド
parent

string

必須。親リソースの名前。

page_size

int32

レスポンスで返されるデバイスの最大数。空白またはゼロの場合、すべてのデバイスが表示されます。0 ~ 1, 000 の範囲内で指定します。

page_token

string

前回の ListDevices への呼び出しからページ設定トークンが返されます。これは、一覧表示がどこから継続するのかを指定します。

filter

string

フィルタ式。フィルタの形式は「sn=123454" or "display_name=MyDevice"」のいずれかです。sn はデバイスのシリアル番号に対応します。フィルタでは大文字と小文字が区別されません。

ListDevicesResponse

ListDevices へのレスポンス。

フィールド
devices[]

Device

リクエストに一致する devices

next_page_token

string

前回の ListDevices 呼び出しから返されたページ設定トークン。一覧表示を続行する場所を示します。このフィールドがないか空白の場合は、該当するデバイスがないことを意味します。

ListNodesRequest

ListNodes のリクエスト。

フィールド
parent

string

必須。親リソース名(例: &nodes/1")。

page_size

int32

レスポンスで返されるノードの最大数。

page_token

string

前回の ListNodes への呼び出しからページ設定トークンが返されます。これは、一覧表示がどこから継続するのかを指定します。

filter

string

フィルタ式。フィルタの形式は "DIRECT_CHILDREN" または "direct_children" です。フィルタでは大文字と小文字が区別されません。空の場合、ノードはフィルタリングされません。

ListNodesResponse

ListNodes へのレスポンス。

フィールド
nodes[]

Node

リクエストに一致する nodes

next_page_token

string

前回の ListNodes 呼び出しから返されたページ設定トークン。一覧表示を続行する場所を示します。このフィールドがないか空白の場合、ノードがないことを意味します。

MeasurementCapability

デバイス測定機能。値は WINNF-SSC-0002 によって定義されます。

列挙型
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

MoveDeploymentRequest(移動デプロイ リクエスト)

MoveDeployment のリクエスト。

フィールド
name

string

必須。移動する deployment の名前。

destination

string

必須。デプロイの親を調整するための新しい親リソース node または customer の名前。

MoveDeviceRequest(デバイスの移動リクエスト)

MoveDevice のリクエスト。

フィールド
name

string

必須。移動するデバイスの名前。

destination

string

必須。デバイスを親に再設定する新しい親リソース node または customer の名前。

MoveNodeRequest

MoveNode のリクエスト。

フィールド
name

string

必須。移動する node の名前。

destination

string

必須。ノードを親にする新しい親リソース node または customer の名前。

ノード

ノード。

フィールド
name

string

出力のみ。リソース名。

display_name

string

ノードの表示名。

sas_user_ids[]

string

このノードに属するデバイスで使用されるユーザー ID。

ポリシー

リソースへのアクセス制御ポリシーを定義します。

フィールド
assignments[]

Assignment

assignments のリスト

etag

bytes

etag は、オプティミスティック同時実行制御でポリシーの同時更新による相互上書きを防ぐために使用されます。競合状態を避けるために、読み取り - 変更 - 書き込みサイクルで ETag を使用することを強くおすすめします。これにより、競合状態を回避できるようになります。GetPolicy へのレスポンスには ETag が返されます。その ETag を SetPolicy へのリクエストに含めて、ポリシーの同じバージョンに変更が適用されるようにすることが期待されます。

GetPolicy の呼び出しで etag を指定しないと、既存のポリシーが無条件に上書きされます。

SetPolicyRequest

SetPolicy メソッドに対するリクエスト メッセージ。

フィールド
resource

string

必須。ポリシーが指定されているリソース。このポリシーは、既存のポリシーに代わるものです。

policy

Policy

必須。resource に適用するポリシー。

SignDeviceRequest

SignDevice のリクエスト。

フィールド
device

Device

必須。署名する devicedevice フィールドの namefcc_idserial_number を設定する必要があります。user_id フィールドを設定する必要があります。

TestPermissionsRequest

TestPermissions メソッドに対するリクエスト メッセージ。

フィールド
resource

string

必須。権限がリクエストされているリソース。

permissions[]

string

resource を確認する一連の権限。

TestPermissionsResponse

TestPermissions メソッドに対するレスポンス メッセージ。

フィールド
permissions[]

string

呼び出し元に許可されている権限のセット。

UpdateCustomerRequest

UpdateCustomer のリクエスト。

フィールド
customer

Customer

必須。customer の新しい値。お客様に namedisplay_name が設定されている必要があります。

update_mask

FieldMask

更新するフィールド。

UpdateDeploymentRequest

UpdateDeployment のリクエスト。

フィールド
deployment

Deployment

必須。deployment の新しい値。namedisplay_name を設定する必要があります。

update_mask

FieldMask

更新するフィールド。

UpdateDeviceRequest

UpdateDevice のリクエスト。

フィールド
device

Device

必須。更新する devicedevice フィールドの namefcc_idserial_number を設定する必要があります。user_id フィールドを設定する必要があります。

update_mask

FieldMask

更新するフィールド。

UpdateNodeRequest

UpdateNode のリクエスト。

フィールド
node

Node

必須。node の新しい値。namedisplay_name を設定する必要があります。

update_mask

FieldMask

更新するフィールド。

UpdateSignedDeviceRequest

UpdateSignedDevice のリクエスト。

フィールド
name

string

必須。更新するデバイスの名前。

encoded_device

bytes

必須。CPI 秘密鍵を使用して署名された JSON Web Token。ペイロードは、device の JSON エンコードにする必要があります。user_id フィールドを設定する必要があります。

installer_id

string

必須。認定プロフェッショナル インストーラ データベースから取得した、一意のインストーラ ID(CPI ID)。

ValidateInstallerRequest

ValidateInstaller のリクエスト。

フィールド
installer_id

string

必須。認定プロフェッショナル インストーラ データベースに登録されている一意のインストーラ ID(CPI ID)。

secret

string

必須。GenerateSecret から返されるシークレット。

encoded_secret

string

必須。CPI 秘密鍵を使用して署名された JSON Web Token。ペイロードには、シークレットである値である「secret」を含める必要があります。

ValidateInstallerResponse

ValidateInstaller へのレスポンス。