Package spectrum.sas.portal.v1alpha1

ดัชนี

• Customers (อินเทอร์เฟซ)
• DeviceManager (อินเทอร์เฟซ)
• PolicyService (อินเทอร์เฟซ)
• Assignment (ข้อความ)
• BillingMode (enum)
• ChannelType (enum)
• CreateDeploymentRequest (ข้อความ)
• CreateDeviceRequest (ข้อความ)
• CreateNodeRequest (ข้อความ)
• CreateSignedDeviceRequest (ข้อความ)
• Customer (ข้อความ)
• DeleteDeploymentRequest (ข้อความ)
• DeleteDeviceRequest (ข้อความ)
• DeleteNodeRequest (ข้อความ)
• Deployment (ข้อความ)
• Device (ข้อความ)
• Device.State (enum)
• DeviceAirInterface (ข้อความ)
• DeviceAirInterface.RadioTechnology (enum)
• DeviceCategory (enum)
• DeviceConfig (ข้อความ)
• DeviceConfig.State (enum)
• DeviceGrant (ข้อความ)
• DeviceMetadata (ข้อความ)
• DeviceModel (ข้อความ)
• DpaMoveList (ข้อความ)
• FrequencyRange (ข้อความ)
• GenerateSecretRequest (ข้อความ)
• GenerateSecretResponse (ข้อความ)
• GetCustomerRequest (ข้อความ)
• GetDeploymentRequest (ข้อความ)
• GetDeviceRequest (ข้อความ)
• GetNodeRequest (ข้อความ)
• GetPolicyRequest (ข้อความ)
• GrantState (enum)
• HeightType (enum)
• InstallationParams (ข้อความ)
• ListCustomersRequest (ข้อความ)
• ListCustomersResponse (ข้อความ)
• ListDeploymentsRequest (ข้อความ)
• ListDeploymentsResponse (ข้อความ)
• ListDevicesRequest (ข้อความ)
• ListDevicesResponse (ข้อความ)
• ListNodesRequest (ข้อความ)
• ListNodesResponse (ข้อความ)
• MeasurementCapability (enum)
• MoveDeploymentRequest (ข้อความ)
• MoveDeviceRequest (ข้อความ)
• MoveNodeRequest (ข้อความ)
• Node (ข้อความ)
• Policy (ข้อความ)
• SetPolicyRequest (ข้อความ)
• SignDeviceRequest (ข้อความ)
• TestPermissionsRequest (ข้อความ)
• TestPermissionsResponse (ข้อความ)
• UpdateCustomerRequest (ข้อความ)
• UpdateDeploymentRequest (ข้อความ)
• UpdateDeviceRequest (ข้อความ)
• UpdateNodeRequest (ข้อความ)
• UpdateSignedDeviceRequest (ข้อความ)
• ValidateInstallerRequest (ข้อความ)
• ValidateInstallerResponse (ข้อความ)

ลูกค้า

บริการจัดการลูกค้า 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

บริการจัดการอุปกรณ์ Citizens Broadband Radio Service

CreateDeployment
rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment) สร้าง deployment ใหม่ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

CreateDevice
rpc CreateDevice(CreateDeviceRequest) returns (Device) สร้าง device ภายใต้ node หรือ customer ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

CreateNode
rpc CreateNode(CreateNodeRequest) returns (Node) สร้าง node ใหม่ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

CreateSignedDevice
rpc CreateSignedDevice(CreateSignedDeviceRequest) returns (Device) สร้าง device ที่ลงนามแล้วภายใต้ node หรือ customer ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

DeleteDeployment
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

DeleteNode
rpc DeleteNode(DeleteNodeRequest) returns (Empty) ลบ node ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

GenerateSecret
rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse) สร้างข้อมูลลับที่จะใช้กับ ValidateInstaller ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต 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

GetNode
rpc GetNode(GetNodeRequest) returns (Node) แสดงผล node ที่ขอ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

ListDeployments
rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse) รายการ deployments ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

ListDevices
rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse) รายการ devices ภายใต้ node หรือ customer ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต 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

MoveDevice
rpc MoveDevice(MoveDeviceRequest) returns (Operation) ย้าย device ไปไว้ใต้ node หรือ customer อื่น ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

MoveNode
rpc MoveNode(MoveNodeRequest) returns (Operation) ย้าย node ไปไว้ใต้ node หรือ customer อื่น ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

SignDevice
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

UpdateDevice
rpc UpdateDevice(UpdateDeviceRequest) returns (Device) อัปเดต device ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

UpdateNode
rpc UpdateNode(UpdateNodeRequest) returns (Node) อัปเดต node ที่มีอยู่ ขอบเขตการให้สิทธิ์ ต้องใช้ขอบเขต OAuth ต่อไปนี้ https://www.googleapis.com/auth/userinfo.email

UpdateSignedDevice
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

บริการควบคุมการเข้าถึงไปยังเครื่องมือจัดการทรัพยากรสเปกตรัม

GetPolicy
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

การมอบหมาย

เชื่อมโยง members กับ role

ช่อง
role	string ต้องระบุ บทบาทที่มอบหมายให้ members
members[]	string ข้อมูลประจำตัวที่กำหนดบทบาทให้ โดยอาจมีค่าดังต่อไปนี้ {user_email}: อีเมลที่แสดงถึงบัญชี Google ที่เฉพาะเจาะจง ตัวอย่างเช่น [e-mail] {group_email}: อีเมลที่แสดงถึงกลุ่ม Google เช่น [e-mail]

BillingMode

โหมดการเรียกเก็บเงินของ CBSD

Enum
BILLING_MODE_UNSPECIFIED	ไม่ได้ระบุโหมดการเรียกเก็บเงิน
MOBILE	ราคาจะขึ้นอยู่กับหมวดหมู่ของ CBSD ได้แก่ หมวดหมู่ A และหมวดหมู่ B ที่ลงทะเบียนกับ SAS
FIXED_WIRELESS	ราคาจะขึ้นอยู่กับประเภท CBSD ได้แก่ สถานีฐานหรือ CPE

ChannelType

Enum
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_id และ serial_number ต้องตั้งค่าฟิลด์ user_id

CreateNodeRequest

คำขอสำหรับ CreateNode

ช่อง
parent	string ต้องระบุ ชื่อทรัพยากรหลักที่จะสร้างโหนด
node	Node รายละเอียดโหนด name ต้องว่างเปล่า โดยเซิร์ฟเวอร์จะสร้างข้อมูลดังกล่าวให้ ต้องตั้งค่าโหนด display_name

CreateSignedDeviceRequest

คำขอสำหรับ CreateSignedDevice

ช่อง
parent	string ต้องระบุ ชื่อของทรัพยากรหลัก
encoded_device	bytes ต้องระบุ โทเค็นเว็บ JSON ที่ลงชื่อโดยใช้คีย์ส่วนตัวของ CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ device ต้องตั้งค่าฟิลด์ user_id
installer_id	string ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ำกัน (รหัส CPI) จากฐานข้อมูลผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง

ลูกค้า

เอนทิตีที่แสดงลูกค้า SAS

ช่อง
name	string เอาต์พุตเท่านั้น ชื่อทรัพยากรของลูกค้า
display_name	string ต้องระบุ ชื่อองค์กรที่เอนทิตีลูกค้าเป็นตัวแทน
sas_user_ids[]	string รหัสผู้ใช้ที่อุปกรณ์ของลูกค้ารายนี้ใช้

DeleteDeploymentRequest

คำขอสำหรับ DeleteDeployment

ช่อง
name	string ต้องระบุ ชื่อของdeployment

DeleteDeviceRequest

คำขอสำหรับ DeleteDevice

ช่อง
name	string ต้องระบุ ชื่อของอุปกรณ์

DeleteNodeRequest

คำขอสำหรับ DeleteNode

ช่อง
name	string ต้องระบุ ชื่อของnode

การทำให้ใช้งานได้

การติดตั้งใช้งาน

ช่อง
name	string เอาต์พุตเท่านั้น ชื่อทรัพยากร
display_name	string ชื่อที่แสดงของการติดตั้งใช้งาน
sas_user_ids[]	string รหัสผู้ใช้ที่อุปกรณ์ในการติดตั้งใช้งานนี้ใช้ การติดตั้งใช้งานแต่ละครั้งควรเชื่อมโยงกับรหัสผู้ใช้ที่ไม่ซ้ำกัน 1 รายการ
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 สามารถลบล้างได้

รัฐ

สถานะของอุปกรณ์

Enum
DEVICE_STATE_UNSPECIFIED	สถานะที่ไม่ได้ระบุ
RESERVED	อุปกรณ์ที่สร้างใน SAS Portal แต่ยังไม่ได้ลงทะเบียนกับ SAS
REGISTERED	อุปกรณ์ลงทะเบียนกับ SAS แล้ว
DEREGISTERED	ยกเลิกการลงทะเบียนอุปกรณ์กับ SAS แล้ว

DeviceAirInterface

ข้อมูลเกี่ยวกับอินเทอร์เฟซทางอากาศของอุปกรณ์

ช่อง
radio_technology	RadioTechnology มีเงื่อนไข ฟิลด์นี้ระบุเทคโนโลยีการเข้าถึงวิทยุที่ใช้สำหรับ CBSD
supported_spec	string ไม่บังคับ ฟิลด์นี้เกี่ยวข้องกับ radioTechnology และระบุข้อกำหนดของอินเทอร์เฟซทางอากาศที่ CBSD ปฏิบัติตามในขณะที่ลงทะเบียน

RadioTechnology

เทคโนโลยีการเข้าถึงวิทยุประเภทที่ได้รับอนุมัติ

Enum
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

หมวดหมู่ FCC ของอุปกรณ์ตามที่กำหนดไว้ในส่วนที่ 96

Enum
DEVICE_CATEGORY_UNSPECIFIED	หมวดหมู่อุปกรณ์ที่ไม่ได้ระบุ
DEVICE_CATEGORY_A	หมวดหมู่ ก.
DEVICE_CATEGORY_B	หมวดหมู่ B

DeviceConfig

ข้อมูลเกี่ยวกับการกำหนดค่าอุปกรณ์

ช่อง
category	DeviceCategory หมวดหมู่ FCC ของอุปกรณ์
model	DeviceModel ข้อมูลเกี่ยวกับรุ่นอุปกรณ์นี้
air_interface	DeviceAirInterface ข้อมูลเกี่ยวกับอินเทอร์เฟซทางอากาศของอุปกรณ์นี้
installation_params	InstallationParams พารามิเตอร์การติดตั้งสำหรับอุปกรณ์
measurement_capabilities[]	MeasurementCapability ความสามารถในการรายงานการวัดผลของอุปกรณ์
user_id	StringValue ตัวระบุผู้ใช้อุปกรณ์
call_sign	string สัญญาณเรียกขานของผู้ปฏิบัติงานอุปกรณ์
state	State สถานะของการกำหนดค่า
is_signed	BoolValue เอาต์พุตเท่านั้น การกำหนดค่าได้รับการลงนามโดย CPI หรือไม่
update_time	Timestamp เอาต์พุตเท่านั้น เวลาล่าสุดที่มีการแก้ไขการกำหนดค่าอุปกรณ์

รัฐ

สถานะของการกำหนดค่าอุปกรณ์ ใช้ได้เฉพาะการกำหนดค่าในสถานะ DEVICE_CONFIG_STATE_FINAL ในระหว่างการลงทะเบียน CBSD

Enum
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

การให้สิทธิ์เข้าถึงอุปกรณ์ โดยเป็นสิทธิ์ที่ระบบการเข้าถึงคลื่นความถี่ (Spectrum Access System) มอบให้แก่อุปกรณ์เพื่อส่งสัญญาณโดยใช้พารามิเตอร์การทำงานที่ระบุหลังจากที่อุปกรณ์ส่งสัญญาณ Heartbeat สำเร็จ

ช่อง
max_eirp	DoubleValue กำลังส่งออกอากาศสมมูลแบบไอโซทรอปิก (EIRP) สูงสุดที่ได้รับอนุญาตจากใบอนุญาต EIRP สูงสุดอยู่ในหน่วย dBm/MHz ค่าของ maxEirp แสดงถึง EIRP เฉลี่ย (RMS) ที่จะวัดได้ตามขั้นตอนที่กำหนดไว้ในส่วน 96.41(e)(3) ของ FCC
frequency_range	FrequencyRange ช่วงความถี่ในการส่ง
state	GrantState สถานะของการให้สิทธิ์
channel_type	ChannelType ประเภทของช่องที่ใช้
move_list[]	DpaMoveList รายการ DPA ที่มีการย้ายซึ่งมีการให้สิทธิ์นี้
expire_time	Timestamp เวลาหมดอายุของการให้สิทธิ์
suspension_reason[]	string หากมีการระงับเงินช่วยเหลือ เหตุผลของการระงับ
grant_id	string รหัสการให้สิทธิ์

DeviceMetadata

ข้อมูลอุปกรณ์ที่ทั้ง SAS Portal และคำขอลงทะเบียนสามารถลบล้างได้

DeviceModel

ข้อมูลเกี่ยวกับรุ่นของอุปกรณ์

ช่อง
vendor	string ชื่อของผู้จำหน่ายอุปกรณ์
name	string ชื่อรุ่นของอุปกรณ์
software_version	string เวอร์ชันซอฟต์แวร์ของอุปกรณ์
hardware_version	string เวอร์ชันฮาร์ดแวร์ของอุปกรณ์
firmware_version	string เวอร์ชันเฟิร์มแวร์ของอุปกรณ์

DpaMoveList

รายการในรายการย้ายของ DPA

ช่อง
dpa_id	StringValue รหัสของ DPA
frequency_range	FrequencyRange ช่วงความถี่ที่รายการย้ายมีผล

FrequencyRange

ช่วงความถี่ตั้งแต่ low_frequency ถึง high_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 ต้องระบุ แหล่งข้อมูลที่ขอใช้นโยบาย

GrantState

สถานะของการให้สิทธิ์

Enum
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED	ได้รับสิทธิ์แล้ว แต่อุปกรณ์ไม่ได้ส่งสัญญาณชีพจรในสิทธิ์นั้น
GRANT_STATE_TERMINATED	SAS ได้สิ้นสุดการให้สิทธิ์แล้ว
GRANT_STATE_SUSPENDED	SAS ได้ระงับการให้เงินช่วยเหลือ
GRANT_STATE_AUTHORIZED	ขณะนี้อุปกรณ์กำลังส่งข้อมูล
GRANT_STATE_EXPIRED	สิทธิ์หมดอายุแล้ว

HeightType

ระบุวิธีวัดความสูง

Enum
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 เมตร
vertical_accuracy	DoubleValue ตัวเลขบวกในหน่วยเมตรเพื่อระบุความแม่นยำของตำแหน่งแนวตั้งของเสาอากาศของอุปกรณ์ พารามิเตอร์ที่ไม่บังคับนี้ควรมีอยู่เฉพาะในกรณีที่ค่าของพารามิเตอร์น้อยกว่าข้อกำหนดของ FCC ที่ 3 เมตร
indoor_deployment	BoolValue เสาอากาศของอุปกรณ์อยู่ภายในอาคารหรือไม่ true: ในร่ม false: กลางแจ้ง
antenna_azimuth	Int32Value ทิศทาง Boresight ของระนาบแนวนอนของเสาอากาศเป็นองศาเมื่อเทียบกับทิศเหนือจริง ค่าของพารามิเตอร์นี้เป็นจำนวนเต็มที่มีค่าระหว่าง 0 ถึง 359 ค่า 0 องศาหมายถึงทิศเหนือจริง ส่วนค่า 90 องศาหมายถึงทิศตะวันออก พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้สำหรับอุปกรณ์หมวดหมู่ ก. และต้องใส่สำหรับอุปกรณ์หมวดหมู่ ข.
antenna_downtilt	Int32Value การก้มเสาอากาศเป็นองศาและเป็นจำนวนเต็มที่มีค่าระหว่าง -90 ถึง +90 รวมอยู่ด้วย ค่าลบหมายความว่าเสาอากาศเอียงขึ้น (เหนือแนวนอน) พารามิเตอร์นี้จะใส่หรือไม่ใส่ก็ได้สำหรับอุปกรณ์หมวดหมู่ ก. และต้องใส่สำหรับอุปกรณ์หมวดหมู่ ข.
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 (องศา) รวมอยู่ด้วย โดยเป็นพารามิเตอร์ที่ไม่บังคับสำหรับอุปกรณ์หมวดหมู่ ก. และเป็นพารามิเตอร์แบบมีเงื่อนไขสำหรับอุปกรณ์หมวดหมู่ ข.
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 ต้องระบุ ชื่อทรัพยากรหลัก เช่น "nodes/1", 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 ระบบจะแสดงอุปกรณ์ทั้งหมด ต้องอยู่ในช่วง [0, 1000]
page_token	string โทเค็นการแบ่งหน้าซึ่งได้จากการเรียกใช้ ListDevices ครั้งก่อนหน้าซึ่งระบุตำแหน่งที่ควรแสดงข้อมูลนี้ต่อ
filter	string นิพจน์ตัวกรอง ฟิลเตอร์ควรมีรูปแบบใดรูปแบบหนึ่งต่อไปนี้ "sn=123454" หรือ "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

Enum
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 รหัสผู้ใช้ที่อุปกรณ์ในโหนดนี้ใช้

นโยบาย

กำหนดนโยบายควบคุมการเข้าถึงทรัพยากร

ช่อง
assignments[]	Assignment รายการ assignments
etag	bytes ระบบใช้ ETag สำหรับการควบคุมการทำงานพร้อมกันแบบมองโลกในแง่ดีเพื่อช่วยป้องกันไม่ให้การอัปเดตนโยบายพร้อมกันเขียนทับกัน เราขอแนะนำอย่างยิ่งให้ระบบใช้ etag ในวงจรการอ่าน-แก้ไข-เขียนเพื่ออัปเดตนโยบายเพื่อหลีกเลี่ยงการแข่งขัน: ระบบจะส่งคืน etag ในการตอบกลับไปยัง GetPolicy และคาดว่าระบบจะใส่ etag นั้นในคำขอไปยัง SetPolicy เพื่อให้แน่ใจว่าการเปลี่ยนแปลงจะนำไปใช้กับนโยบายเวอร์ชันเดียวกัน หากไม่ได้ระบุ ETag ในการเรียกใช้ GetPolicy ระบบจะเขียนทับนโยบายที่มีอยู่โดยไม่ตรวจสอบ

SetPolicyRequest

ข้อความคำขอสำหรับเมธอด SetPolicy

ช่อง
resource	string ต้องระบุ ทรัพยากรที่กำลังระบุนโยบาย นโยบายนี้จะแทนที่นโยบายที่มีอยู่
policy	Policy ต้องระบุ นโยบายที่จะนำไปใช้กับ resource

SignDeviceRequest

คำขอสำหรับ SignDevice

ช่อง
device	Device ต้องระบุ device เพื่อลงนาม ต้องตั้งค่าฟิลด์ device name, fcc_id และ serial_number ต้องตั้งค่าฟิลด์ user_id

TestPermissionsRequest

ข้อความคำขอสำหรับเมธอด TestPermissions

ช่อง
resource	string ต้องระบุ ทรัพยากรที่ขอสิทธิ์
permissions[]	string ชุดสิทธิ์ที่จะตรวจสอบสำหรับ resource

TestPermissionsResponse

ข้อความตอบกลับสำหรับเมธอด TestPermissions

ช่อง
permissions[]	string ชุดสิทธิ์ที่ผู้โทรได้รับอนุญาต

UpdateCustomerRequest

คำขอสำหรับ UpdateCustomer

ช่อง
customer	Customer ต้องระบุ ค่าใหม่สำหรับ customer ลูกค้าต้องตั้งค่า name และ display_name
update_mask	FieldMask ฟิลด์ที่จะอัปเดต

UpdateDeploymentRequest

คำขอสำหรับ UpdateDeployment

ช่อง
deployment	Deployment ต้องระบุ ค่าใหม่สำหรับ deployment ต้องตั้งค่า name และ display_name
update_mask	FieldMask ฟิลด์ที่จะอัปเดต

UpdateDeviceRequest

คำขอสำหรับ UpdateDevice

ช่อง
device	Device ต้องระบุ device ที่จะอัปเดต ต้องตั้งค่าฟิลด์ device name, fcc_id และ serial_number ต้องตั้งค่าฟิลด์ user_id
update_mask	FieldMask ฟิลด์ที่จะอัปเดต

UpdateNodeRequest

คำขอสำหรับ UpdateNode

ช่อง
node	Node ต้องระบุ ค่าใหม่สำหรับ node ต้องตั้งค่า name และ display_name
update_mask	FieldMask ฟิลด์ที่จะอัปเดต

UpdateSignedDeviceRequest

คำขอสำหรับ UpdateSignedDevice

ช่อง
name	string ต้องระบุ ชื่อของอุปกรณ์ที่จะอัปเดต
encoded_device	bytes ต้องระบุ โทเค็นเว็บ JSON ที่ลงนามโดยใช้คีย์ส่วนตัวของ CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ device ต้องตั้งค่าฟิลด์ user_id
installer_id	string ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ำกัน (รหัส CPI) จากฐานข้อมูลผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง

ValidateInstallerRequest

คำขอสำหรับ ValidateInstaller

ช่อง
installer_id	string ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ำกัน (รหัส CPI) จากฐานข้อมูลผู้ติดตั้งมืออาชีพที่ได้รับการรับรอง
secret	string ต้องระบุ ข้อมูลลับที่ GenerateSecret ส่งคืน
encoded_secret	string ต้องระบุ โทเค็นเว็บ JSON ที่ลงชื่อโดยใช้คีย์ส่วนตัวของ CPI เพย์โหลดต้องมีอ้างสิทธิ์ "secret" ที่มีค่าเป็นข้อมูลลับ

ValidateInstallerResponse

คำตอบสำหรับ ValidateInstaller