Package spectrum.sas.portal.v1alpha1

ดัชนี

ลูกค้า

บริการที่จัดการลูกค้า SAS

หาลูกค้า

rpc GetCustomer(GetCustomerRequest) returns (Customer)

แสดงผลcustomerที่ขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
รายชื่อลูกค้า

rpc ListCustomers(ListCustomersRequest) returns (ListCustomersResponse)

แสดงผลรายการ customers ที่ขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
อัปเดตลูกค้า

rpc UpdateCustomer(UpdateCustomerRequest) returns (Customer)

อัปเดต customer ที่มีอยู่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

โปรแกรมจัดการอุปกรณ์

บริการจัดการอุปกรณ์วิทยุกระจายเสียงของพลเมือง

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

rpc CreateDeployment(CreateDeploymentRequest) returns (Deployment)

สร้าง deployment ใหม่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
สร้างอุปกรณ์

rpc CreateDevice(CreateDeviceRequest) returns (Device)

สร้าง device ภายใต้ node หรือ customer

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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)

สร้าง device ที่ลงนามภายใต้ node หรือ customer

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
ลบการทําให้ใช้งานได้

rpc DeleteDeployment(DeleteDeploymentRequest) returns (Empty)

ลบ deployment

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
ลบอุปกรณ์

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
สร้างข้อมูลลับ

rpc GenerateSecret(GenerateSecretRequest) returns (GenerateSecretResponse)

สร้างข้อมูลลับเพื่อใช้กับ ValidateInstaller

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
รับการทําให้ใช้งานได้

rpc GetDeployment(GetDeploymentRequest) returns (Deployment)

แสดงผลdeploymentที่ขอ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
รับอุปกรณ์

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
แสดงรายการการทําให้ใช้งานได้

rpc ListDeployments(ListDeploymentsRequest) returns (ListDeploymentsResponse)

รายการ deployments

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
รายการอุปกรณ์

rpc ListDevices(ListDevicesRequest) returns (ListDevicesResponse)

แสดงรายการ devices ภายใต้ node หรือ customer

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
รายการโหนด

rpc ListNodes(ListNodesRequest) returns (ListNodesResponse)

รายการ nodes

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
ย้ายการทําให้ใช้งานได้

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
อัปเดตการทําให้ใช้งานได้

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
อัปเดต SignedDevice

rpc UpdateSignedDevice(UpdateSignedDeviceRequest) returns (Device)

อัปเดต device ที่ลงนามแล้ว

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
ผู้ตรวจสอบการติดตั้ง

rpc ValidateInstaller(ValidateInstallerRequest) returns (ValidateInstallerResponse)

ตรวจสอบข้อมูลระบุตัวตนของผู้ติดตั้งมืออาชีพที่ผ่านการรับรอง (CPI)

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

บริการนโยบาย

เข้าถึงบริการควบคุมการเข้าถึง Spectrum Resource Manager

รับนโยบาย

rpc GetPolicy(GetPolicyRequest) returns (Policy)

รับนโยบายควบคุมการเข้าถึงสําหรับทรัพยากร แสดงนโยบายที่ว่างเปล่าหากมีทรัพยากรอยู่และไม่ได้ตั้งค่านโยบายไว้

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
กําหนดนโยบาย

rpc SetPolicy(SetPolicyRequest) returns (Policy)

ตั้งค่านโยบายการควบคุมการเข้าถึงสําหรับทรัพยากรที่ระบุ แทนที่นโยบายที่มีอยู่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/userinfo.email
สิทธิ์ทดสอบ

rpc TestPermissions(TestPermissionsRequest) returns (TestPermissionsResponse)

แสดงผลสิทธิ์ที่ผู้โทรมีในทรัพยากรที่ระบุ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

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

งาน

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

ช่อง
role

string

ต้องระบุ บทบาทที่กําหนดให้กับ members
members[]

string

ข้อมูลประจําตัวที่มีการมอบหมายบทบาท ซึ่งมีค่าต่อไปนี้

  • {user_email}: อีเมลที่ระบุบัญชี Google ที่เจาะจง เช่น alice@gmail.com

  • {group_email}: อีเมลที่แสดงถึงกลุ่มใน Google Groups เช่น viewers@gmail.com

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

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

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

ประเภทช่อง

Enum
CHANNEL_TYPE_UNSPECIFIED
CHANNEL_TYPE_GAA
CHANNEL_TYPE_PAL

สร้างคําขอทําให้ใช้งานได้

คําขอสําหรับ CreateDeployment

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุดที่จะสร้างการทําให้ใช้งานได้
deployment

Deployment

ต้องระบุ รายละเอียดการทําให้ใช้งานได้ name ต้องว่างเปล่า ซึ่งสร้างขึ้นโดยเซิร์ฟเวอร์ ต้องตั้งค่าการติดตั้งใช้งาน display_name

สร้างคําขออุปกรณ์

คําขอสําหรับ CreateDevice

ช่อง
parent

string

ต้องระบุ ชื่อของทรัพยากรระดับบนสุด
device

Device

รายละเอียดการจดทะเบียน device name ต้องว่างเปล่า ซึ่งสร้างขึ้นโดยเซิร์ฟเวอร์ ต้องตั้งค่าช่อง device fcc_id และ serial_number ต้องตั้งค่าช่อง user_id

สร้าง NodeRequest

คําขอสําหรับ CreateNode

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุดที่จะสร้างโหนด
node

Node

รายละเอียดโหนด name ต้องว่างเปล่า ซึ่งสร้างขึ้นโดยเซิร์ฟเวอร์ ต้องตั้งค่าโหนด display_name

สร้าง SignedDeviceRequest

คําขอสําหรับ 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

รหัสผู้ใช้ที่ใช้โดยอุปกรณ์ของลูกค้ารายนี้

ลบคําขอทําให้ใช้งานได้

คําขอสําหรับ DeleteDeployment

ช่อง
name

string

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

ลบคําขออุปกรณ์

คําขอสําหรับ DeleteDevice

ช่อง
name

string

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

ลบคําขอโหนด

คําขอสําหรับ DeleteNode

ช่อง
name

string

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

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

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

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากร
display_name

string

ชื่อที่แสดงของการทําให้ใช้งานได้
sas_user_ids[]

string

รหัสผู้ใช้ที่ใช้โดยอุปกรณ์ของการทําให้ใช้งานได้นี้ การทําให้ใช้งานได้แต่ละรายการควรเชื่อมโยงกับ User-ID ที่ไม่ซ้ํากัน 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 และคําขอลงทะเบียน SAS

รัฐ

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

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

อินเทอร์เฟซ AirAir

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

ช่อง
radio_technology

RadioTechnology

มีเงื่อนไข ช่องนี้ระบุเทคโนโลยีการเข้าถึงวิทยุที่ใช้สําหรับ CBSD
supported_spec

string

ไม่บังคับ ช่องนี้เกี่ยวข้องกับ radioTechnology และได้ระบุข้อมูลจําเพาะของอินเทอร์เฟซระบบอากาศที่ CBSD ปฏิบัติตามเมื่อลงทะเบียน

เทคโนโลยีวิทยุ

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

Enum
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

หมวดหมู่อุปกรณ์

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

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

การกําหนดค่าอุปกรณ์

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

ช่อง
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

ให้สิทธิ์อุปกรณ์

การให้สิทธิ์อุปกรณ์ โดยเป็นการให้สิทธิ์จากระบบการเข้าถึงสเปกตรัมสําหรับอุปกรณ์เพื่อส่งโดยใช้พารามิเตอร์การทํางานที่ระบุหลังจากที่อุปกรณ์ฮาร์ตบีตสําเร็จ

ช่อง
max_eirp

DoubleValue

พลังงานรังสีไอโซโทรปิกเทียบเท่า (EIRP) สูงสุดที่ได้รับอนุญาต EIRP สูงสุดอยู่ในหน่วย dBm/MHz ค่า maxEirp แสดงถึง EIRP เฉลี่ย (RMS) ที่จะวัดโดยขั้นตอนที่กําหนดไว้ในส่วน FCC ส่วนที่ 96.41(e)(3)
frequency_range

FrequencyRange

ช่วงความถี่ของการส่งข้อมูล
state

GrantState

สถานะการให้สิทธิ์
channel_type

ChannelType

ประเภทช่องทางที่ใช้
move_list[]

DpaMoveList

การย้าย DPA จะแสดงการสมนาคุณนี้
expire_time

Timestamp

เวลาของการให้สิทธิ์
suspension_reason[]

string

หากการให้สิทธิ์ถูกระงับ สาเหตุของการระงับ
grant_id

string

รหัส Grant

ข้อมูลเมตาของอุปกรณ์

ข้อมูลอุปกรณ์ลบล้างได้โดยทั้งพอร์ทัล SAS และคําขอลงทะเบียน

รุ่นอุปกรณ์

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

ช่อง
vendor

string

ชื่อผู้ให้บริการอุปกรณ์
name

string

ชื่อรุ่นของอุปกรณ์
software_version

string

เวอร์ชันซอฟต์แวร์ของอุปกรณ์
hardware_version

string

เวอร์ชันฮาร์ดแวร์ของอุปกรณ์
firmware_version

string

เวอร์ชันเฟิร์มแวร์ของอุปกรณ์

รายการ DpaMove

ข้อมูลในรายการการย้ายของ DPA&#39

ช่อง
dpa_id

StringValue

รหัสของ DPA
frequency_range

FrequencyRange

ช่วงความถี่ที่รายการย้ายได้รับผลกระทบ

ช่วงความถี่

ช่วงความถี่จาก low_frequency ถึง high_frequency

ช่อง
low_frequency_mhz

DoubleValue

ความถี่ต่ําสุดของช่วงความถี่ในหน่วยมิลลิวินาที
high_frequency_mhz

DoubleValue

ความถี่สูงสุดของช่วงความถี่ในหน่วยเมกะเฮิร์ตซ์

สร้างคําขอลับ

คําขอสําหรับ GenerateSecret

สร้างการตอบกลับลับ

คําตอบสําหรับ GenerateSecret

ช่อง
secret

string

ข้อมูลลับที่สร้างโดยสตริงและใช้โดย ValidateInstaller

รับคําขอของลูกค้า

คําขอสําหรับ GetCustomer

ช่อง
name

string

ต้องระบุ ชื่อcustomer

รับ GetDeployment

คําขอสําหรับ GetDeployment

ช่อง
name

string

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

คําขอรับอุปกรณ์

คําขอสําหรับ GetDevice

ช่อง
name

string

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

รับ GetNode

คําขอสําหรับ GetNode

ช่อง
name

string

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

คําขอรับนโยบาย

ข้อความคําขอสําหรับเมธอด 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 การให้สิทธิ์หมดอายุแล้ว

ประเภทความสูง

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

Enum
HEIGHT_TYPE_UNSPECIFIED ประเภทความสูงที่ไม่ระบุ
HEIGHT_TYPE_AGL ความสูง AGL จะวัดโดยสัมพันธ์กับระดับพื้น
HEIGHT_TYPE_AMSL ความสูงของ AMSL จะวัดโดยสัมพันธ์กับระดับน้ําทะเลเฉลี่ย

พารามิเตอร์การติดตั้ง

ข้อมูลเกี่ยวกับพารามิเตอร์การติดตั้งอุปกรณ์

ช่อง
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

ทิศทางของระนาบแนวนอนของเสาอากาศในหน่วยองศาตามทิศเหนือจริง ค่าของพารามิเตอร์นี้เป็นจํานวนเต็มที่มีค่าระหว่าง 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

เสาอากาศ 3dd แบบกระจายแสงของเสาอากาศในระนาบแนวนอน หน่วยเป็นองศา พารามิเตอร์นี้เป็นจํานวนเต็มที่ไม่ได้รับการรับรองที่มีค่าระหว่าง 0 ถึง 360 (องศา) พารามิเตอร์นี้เป็นตัวเลือกสําหรับอุปกรณ์หมวดหมู่ A และมีเงื่อนไขสําหรับอุปกรณ์หมวดหมู่ B
antenna_model

string

หากใช้เสาอากาศภายนอก รูปแบบเสาอากาศจะระบุไว้ในช่องนี้หรือไม่ก็ได้ สตริงมีความยาวได้สูงสุด 128 อ็อกเท็ต
cpe_cbsd_indication

BoolValue

พารามิเตอร์นี้จะระบุว่า CBSD เป็น CPE-CBSD หรือไม่

คําขอรายชื่อลูกค้า

คําขอสําหรับ ListCustomers

ช่อง
page_size

int32

จํานวนสูงสุดของ customers ที่จะแสดงผลในการตอบกลับ
page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListCustomers ครั้งก่อน ซึ่งระบุว่าข้อมูลนี้ควรอยู่ต่อที่ใด

การตอบกลับรายชื่อลูกค้า

คําตอบสําหรับ ListCustomers

ช่อง
customers[]

Customer

รายการของ customers ที่ตรงกับคําขอ
next_page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListCustomers ครั้งก่อน ซึ่งบ่งชี้ตําแหน่งที่ข้อมูลควรดําเนินต่อไป หากช่องหายไปหรือว่างเปล่า หมายความว่าจะไม่มีลูกค้าเพิ่มเติม

แสดงรายการคําขอการทําให้ใช้งานได้

คําขอสําหรับ ListDeployments

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุด เช่น "nodes/1", customer/1/nodes/2
page_size

int32

จํานวนสูงสุดของการทําให้ใช้งานได้ที่จะส่งคืนในการตอบสนอง
page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListDeployments ครั้งก่อน ซึ่งระบุว่าข้อมูลนี้ควรอยู่ต่อที่ใด
filter

string

นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบต่อไปนี้: "DIRECT_CHILDREN" หรือรูปแบบ: "direct_children" ตัวกรองไม่คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากว่างเปล่า ระบบจะไม่กรองการทําให้ใช้งานได้

การตอบกลับรายการการทําให้ใช้งานได้

คําตอบสําหรับ ListDeployments

ช่อง
deployments[]

Deployment

deployments ที่ตรงกับคําขอ
next_page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListDeployments ครั้งก่อน ซึ่งบ่งชี้ตําแหน่งที่ข้อมูลควรดําเนินต่อไป หากช่องหายไปหรือว่างเปล่า แสดงว่าไม่มีการติดตั้งใช้งานอีกต่อไป

คําขอรายการอุปกรณ์

คําขอสําหรับ ListDevices

ช่อง
parent

string

ต้องระบุ ชื่อของทรัพยากรระดับบนสุด
page_size

int32

จํานวนสูงสุดของอุปกรณ์ที่จะแสดงผลในการตอบกลับ หากว่างเปล่าหรือมีค่าเป็น 0 อุปกรณ์ทั้งหมดจะแสดงในรายการ ต้องอยู่ในช่วง [0, 1000]
page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListDevices ครั้งก่อน ซึ่งระบุว่าข้อมูลนี้ควรอยู่ต่อที่ใด
filter

string

นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบใดรูปแบบหนึ่งต่อไปนี้ ได้แก่ "sn=123454" หรือ "display_name=MyDevice". sn จะสอดคล้องกับหมายเลขซีเรียลของอุปกรณ์ ตัวกรองไม่คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่

คําตอบรายการอุปกรณ์

คําตอบสําหรับ ListDevices

ช่อง
devices[]

Device

devices ที่ตรงกับคําขอ
next_page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListDevices ครั้งก่อน ซึ่งบ่งชี้ตําแหน่งที่ข้อมูลควรดําเนินต่อไป หากช่องหายไปหรือว่างเปล่า แสดงว่าไม่มีอุปกรณ์เพิ่มเติม

ขอรายการโหนด

คําขอสําหรับ ListNodes

ช่อง
parent

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุด เช่น "nodes/1"
page_size

int32

จํานวนโหนดสูงสุดที่จะแสดงในการตอบกลับ
page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListNodes ครั้งก่อน ซึ่งระบุว่าข้อมูลนี้ควรอยู่ต่อที่ใด
filter

string

นิพจน์ตัวกรอง ตัวกรองควรมีรูปแบบต่อไปนี้: "DIRECT_CHILDREN" หรือรูปแบบ: "direct_children" ตัวกรองไม่คํานึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ หากเว้นว่างไว้ ระบบจะไม่กรองโหนด

การตอบกลับรายการ

คําตอบสําหรับ ListNodes

ช่อง
nodes[]

Node

nodes ที่ตรงกับคําขอ
next_page_token

string

โทเค็นการใส่เลขหน้าที่แสดงผลจากการเรียกไปยัง ListNodes ครั้งก่อน ซึ่งบ่งชี้ตําแหน่งที่ข้อมูลควรดําเนินต่อไป หากช่องหายไปหรือว่างเปล่า หมายความว่าจะไม่มีโหนดอื่นอีก

ความสามารถในการวัด

ความสามารถในการวัดอุปกรณ์ ค่านี้กําหนดโดย WINNF-SSC-0002

Enum
MEASUREMENT_CAPABILITY_UNSPECIFIED
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITH_GRANT
MEASUREMENT_CAPABILITY_RECEIVED_POWER_WITHOUT_GRANT

ย้ายคําขอการติดตั้งใช้งาน

คําขอสําหรับ MoveDeployment

ช่อง
name

string

ต้องระบุ ชื่อของ deployment ที่จะย้าย
destination

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุดใหม่ node หรือ customer เพื่อทําให้การทําให้ใช้งานได้ใหม่ใช้งานได้อีกครั้ง

คําขอย้ายอุปกรณ์

คําขอสําหรับ MoveDevice

ช่อง
name

string

ต้องระบุ ชื่ออุปกรณ์ที่จะย้าย
destination

string

ต้องระบุ ชื่อทรัพยากรระดับบนสุดใหม่ node หรือ customer เพื่อระดับบนสุดของอุปกรณ์ใหม่

ย้ายคําขอโหนด

คําขอสําหรับ MoveNode

ช่อง
name

string

ต้องระบุ ชื่อของ node ที่จะย้าย
destination

string

ต้องระบุ ชื่อของทรัพยากรระดับบนสุดใหม่ node หรือ customer เพื่อปรับโหนดใหม่ภายใต้โหนดนี้

โหนด

โหนด

ช่อง
name

string

เอาต์พุตเท่านั้น ชื่อทรัพยากร
display_name

string

ชื่อที่แสดงของโหนด'
sas_user_ids[]

string

รหัสผู้ใช้ที่ใช้โดยอุปกรณ์ที่อยู่ในโหนดนี้

นโยบาย

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

ช่อง
assignments[]

Assignment

รายการ assignments
etag

bytes

โดยใช้เพื่อควบคุมการเกิดขึ้นพร้อมกันให้ได้มากที่สุด เพื่อป้องกันไม่ให้อัปเดตนโยบายพร้อมกันมากเกินไป เราขอแนะนําอย่างยิ่งให้ระบบใช้แท็กอิเล็กทรอนิกส์ในวงจร Read-modify-Write เพื่อทําการปรับปรุงนโยบายเพื่อหลีกเลี่ยงเงื่อนไขการแข่งขัน ได้แก่ แท็กจะส่งคืนเพื่อตอบสนองต่อ GetPolicy และระบบคาดว่าจะใส่แท็กดังกล่าวในคําขอถึง SetPolicy เพื่อให้แน่ใจว่าการเปลี่ยนแปลงจะมีผลกับนโยบายเวอร์ชันเดียวกัน

หากไม่ได้ใส่ Etag ไว้ในการเรียก GetPolicy นโยบายที่มีอยู่จะถูกเขียนทับด้วยตาบอด

คําขอตั้งค่านโยบาย

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

ช่อง
resource

string

ต้องระบุ ทรัพยากรที่มีการระบุนโยบาย นโยบายนี้จะแทนที่นโยบายที่มีอยู่
policy

Policy

ต้องระบุ นโยบายที่จะนําไปใช้กับ resource

คําขอ SignDevice

คําขอสําหรับ SignDevice

ช่อง
device

Device

ต้องระบุ เครื่องหมาย device เพื่อลงนาม ต้องตั้งค่าช่อง device, name, fcc_id และ serial_number ต้องตั้งค่าช่อง user_id

คําขอสิทธิ์ทดสอบ

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

ช่อง
resource

string

ต้องระบุ ทรัพยากรที่มีการขอสิทธิ์
permissions[]

string

ชุดของสิทธิ์ในการตรวจสอบ resource

การตอบกลับเกี่ยวกับสิทธิ์ทดสอบ

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

ช่อง
permissions[]

string

ชุดสิทธิ์ที่ผู้โทรอนุญาต

อัปเดตคําขอลูกค้า

คําขอสําหรับ UpdateCustomer

ช่อง
customer

Customer

ต้องระบุ ค่าใหม่สําหรับcustomer ลูกค้าต้องตั้งค่าnameและdisplay_name
update_mask

FieldMask

ช่องที่จะอัปเดต

อัปเดตคําขอทําให้ใช้งานได้

คําขอสําหรับ UpdateDeployment

ช่อง
deployment

Deployment

ต้องระบุ ค่าใหม่สําหรับdeployment ต้องตั้งค่า name และ display_name
update_mask

FieldMask

ช่องที่จะอัปเดต

อัปเดตคําขออุปกรณ์

คําขอสําหรับ UpdateDevice

ช่อง
device

Device

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

FieldMask

ช่องที่จะอัปเดต

อัปเดต NodeRequest

คําขอสําหรับ UpdateNode

ช่อง
node

Node

ต้องระบุ ค่าใหม่สําหรับnode ต้องตั้งค่า name และ display_name
update_mask

FieldMask

ช่องที่จะอัปเดต

อัปเดตคําขอ SignedDevice

คําขอสําหรับ UpdateSignedDevice

ช่อง
name

string

ต้องระบุ ชื่อของอุปกรณ์ที่จะอัปเดต
encoded_device

bytes

ต้องระบุ โทเค็นเว็บ JSON ที่รับรองโดยใช้คีย์ส่วนตัว CPI เพย์โหลดต้องเป็นการเข้ารหัส JSON ของ device ต้องตั้งค่าช่อง user_id
installer_id

string

ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ํา (รหัส CPI) จากฐานข้อมูลโปรแกรมติดตั้งที่ได้รับการรับรอง

ตรวจสอบคําขอติดตั้ง

คําขอสําหรับ ValidateInstaller

ช่อง
installer_id

string

ต้องระบุ รหัสโปรแกรมติดตั้งที่ไม่ซ้ํา (รหัส CPI) จากฐานข้อมูลโปรแกรมติดตั้งที่ได้รับการรับรอง
secret

string

ต้องระบุ ข้อมูลลับที่แสดงผลโดย GenerateSecret
encoded_secret

string

ต้องระบุ โทเค็นเว็บ JSON ที่รับรองโดยใช้คีย์ส่วนตัว CPI เปย์โหลดต้องมี "secret" การอ้างสิทธิ์ที่มีค่าเป็นความลับ

โปรแกรมตรวจสอบ InstallInstaller

คําตอบสําหรับ ValidateInstaller