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

خدمة إدارة أجهزة خدمة الراديو ذات النطاق العريض للمواطنين

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)

تُستخدَم للتحقّق من هوية فني تركيب معتمد.

نطاقات التفويض

يجب توفير نطاق 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

Assignment

يربط هذا الحقل members بـ role.

الحقول
role

string

مطلوب. الدور الذي تم تعيينه إلى members

members[]

string

الهويات التي تم تعيين الدور لها يمكن أن تتضمّن القيم التالية:

  • {user_email}: هو عنوان بريد إلكتروني يمثّل حسابًا معيّنًا على Google. على سبيل المثال: alice@gmail.com.

  • {group_email}: عنوان بريد إلكتروني يمثّل مجموعة Google. مثلاً: viewers@gmail.com

BillingMode

وضع الفوترة لجهاز CBSD

عمليات التعداد
BILLING_MODE_UNSPECIFIED لم يتم تحديد وضع الفوترة.
MOBILE يستند السعر إلى فئة جهاز CBSD: الفئة A أو الفئة B المسجّلة في نظام SAS.
FIXED_WIRELESS يستند السعر إلى نوع جهاز CBSD: محطة أساسية أو معدّات CPE.

ChannelType

عمليات التعداد
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 فارغة. ويتم إنشاؤه من خلال الخادم. يجب ضبط الحقلَين fcc_id وserial_number في device. يجب ضبط الحقل 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

مطلوب. معرّف المثبّت الفريد (معرّف تكلفة التركيب لكل عملية تثبيت) من قاعدة بيانات المثبّتين المحترفين المعتمَدين

العميل

كيان يمثّل أحد عملاء 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

رقم تعريف المستخدم الذي تستخدمه الأجهزة التابعة لعملية النشر هذه يجب أن يكون كل عملية نشر مرتبطة برقم تعريف مستخدم فريد.

default_billing_mode

BillingMode

وضع الفوترة التلقائي لعملية النشر والأجهزة التي تندرج تحتها

allowed_billing_modes[]

BillingMode

أوضاع الفوترة المسموح بها في عملية النشر هذه

الجهاز

الحقول
name

string

النتائج فقط. اسم مسار المورد

fcc_id

string

يشير إلى معرّف الجهاز الصادر عن لجنة الاتصالات الفيدرالية.

serial_number

string

رقم تسلسلي خصّصته جهة تصنيع الجهاز له.

preloaded_config

DeviceConfig

إعداد الجهاز، كما هو محدّد من خلال SAS Portal API

active_config

DeviceConfig

النتائج فقط. الإعدادات الحالية للجهاز كما تم تسجيلها في نظام SAS

state

State

النتائج فقط. حالة الجهاز

grants[]

DeviceGrant

النتائج فقط. الأذونات التي يملكها الجهاز

display_name

string

الاسم المعروض للجهاز

device_metadata

DeviceMetadata

معلَمات الجهاز التي يمكن تجاوزها من خلال كلّ من "بوابة نظام مشاركة الطيف الترددي" وطلبات تسجيل نظام مشاركة الطيف الترددي

الحالة

حالة الجهاز

عمليات التعداد
DEVICE_STATE_UNSPECIFIED حالة غير محدَّدة
RESERVED تم إنشاء الجهاز في SAS Portal، ولكن لم يتم تسجيله بعد في SAS.
REGISTERED تم تسجيل الجهاز في SAS.
DEREGISTERED تم إلغاء تسجيل الجهاز في SAS.

DeviceAirInterface

تعرض هذه السمة معلومات عن واجهة البث المباشر للجهاز.

الحقول
radio_technology

RadioTechnology

Conditional. يحدّد هذا الحقل تكنولوجيا الوصول اللاسلكي المستخدَمة في جهاز CBSD.

supported_spec

string

اختيارية: يرتبط هذا الحقل بالنوع radioTechnology ويوفّر مواصفات واجهة البث التي يتوافق معها جهاز CBSD عند التسجيل.

RadioTechnology

أنواع تكنولوجيا الوصول اللاسلكي المعتمدة

عمليات التعداد
RADIO_TECHNOLOGY_UNSPECIFIED
E_UTRA
CAMBIUM_NETWORKS
FOUR_G_BBW_SAA_1
NR
DOODLE_CBRS
CW
REDLINE
TARANA_WIRELESS

DeviceCategory

فئة الجهاز وفقًا للجنة الاتصالات الفيدرالية (FCC)، كما هو محدّد في الجزء 96

عمليات التعداد
DEVICE_CATEGORY_UNSPECIFIED فئة جهاز غير محدّدة
DEVICE_CATEGORY_A الفئة (أ)
DEVICE_CATEGORY_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.

عمليات التعداد
DEVICE_CONFIG_STATE_UNSPECIFIED
DRAFT
FINAL

DeviceGrant

منح إذن الوصول إلى الجهاز وهي عبارة عن تفويض يقدّمه نظام الوصول إلى الطيف الترددي لجهاز ما من أجل الإرسال باستخدام مَعلمات تشغيل محدّدة بعد أن يرسل الجهاز إشارة نبضية ناجحة.

الحقول
max_eirp

DoubleValue

الحد الأقصى للطاقة المشعّة المكافئة المتناحية (EIRP) المسموح بها بموجب المنحة الحد الأقصى لقوة الإشعاع الفعّالة المتناحية (EIRP) بوحدة ديسيبل ميلي واط لكل ميغاهرتز، وتمثّل قيمة maxEirp متوسط قوة الإشعاع الفعّالة المتناحية (RMS) التي يمكن قياسها باستخدام الإجراء المحدّد في الجزء 96.41(e)(3) من لوائح هيئة الاتصالات الفيدرالية.

frequency_range

FrequencyRange

نطاق تردد الإرسال

state

GrantState

حالة المنحة

channel_type

ChannelType

نوع القناة المستخدَمة

move_list[]

DpaMoveList

تعرِض هذه السمة قوائم نقل البيانات التي يظهر فيها هذا الإذن.

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_id

StringValue

معرّف اتفاقية معالجة البيانات.

frequency_range

FrequencyRange

نطاق التردد الذي تؤثر فيه قائمة النقل

FrequencyRange

نطاق معدّل التكرار من low_frequency إلى high_frequency

الحقول
low_frequency_mhz

DoubleValue

الحد الأدنى لمعدّل التكرار في نطاق معدّل التكرار بالميغاهرتز

high_frequency_mhz

DoubleValue

أعلى معدّل تكرار لنطاق التردد بالميغاهرتز

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

تمثّل هذه السمة حالة الإذن.

عمليات التعداد
GRANT_STATE_UNSPECIFIED
GRANT_STATE_GRANTED تم منح الإذن ولكن الجهاز لا يرسل إشارات نبضات القلب.
GRANT_STATE_TERMINATED تم إنهاء المنحة من قِبل SAS.
GRANT_STATE_SUSPENDED تم تعليق المنحة من قِبل SAS.
GRANT_STATE_AUTHORIZED الجهاز يرسل البيانات حاليًا.
GRANT_STATE_EXPIRED انتهت صلاحية الإذن.

HeightType

تحدّد هذه السمة كيفية قياس الارتفاع.

عمليات التعداد
HEIGHT_TYPE_UNSPECIFIED نوع الارتفاع غير محدَّد.
HEIGHT_TYPE_AGL يتم قياس الارتفاع عن سطح الأرض بالنسبة إلى مستوى سطح الأرض.
HEIGHT_TYPE_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

اتجاه محور الهوائي في المستوى الأفقي بالدرجات بالنسبة إلى الشمال الحقيقي قيمة هذه المَعلمة هي عدد صحيح يتراوح بين 0 و359 (بما في ذلك هذان الرقمان). تعني القيمة 0 درجة الشمال الحقيقي، وتعني القيمة 90 درجة الشرق. هذه المَعلمة اختيارية لأجهزة الفئة (أ) وشرطية لأجهزة الفئة (ب).

antenna_downtilt

Int32Value

ميل الهوائي إلى الأسفل بالدرجات وهو عدد صحيح تتراوح قيمته بين -90 و+90، وتشير القيمة السالبة إلى أنّ الهوائي مائل إلى الأعلى (فوق المستوى الأفقي). هذه المَعلمة اختيارية لأجهزة الفئة (أ) وشرطية لأجهزة الفئة (ب).

antenna_gain

Int32Value

الحد الأقصى لكسب الهوائي بوحدة dBi هذه المَعلمة هي عدد صحيح تتراوح قيمته بين -127 و+128 (ديسيبل بالنسبة إلى مصدر قدرة متساوي الاتجاهات) ضِمنًا.

eirp_capability

Int32Value

هذه المَعلمة هي الحد الأقصى لقوة الإشعاع الفعّالة المتناحية (EIRP) للجهاز بوحدات dBm/10MHz، وهي عدد صحيح تتراوح قيمته بين -127 و+47 (dBm/10 MHz) ضِمنًا. في حال عدم تضمينها، تفسّرها SAS على أنّها الحد الأقصى المسموح به للطاقة المشعّة المكافئة المتناحية (EIRP) بوحدات ديسيبل/10 ميغاهرتز لفئة الجهاز.

antenna_beamwidth

Int32Value

عرض حزمة الهوائي عند مستوى 3 ديسيبل في المستوى الأفقي بالدرجات هذه المَعلمة هي عدد صحيح غير موقّع تتراوح قيمته بين 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, 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.

عمليات التعداد
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

مطلوب. معرّف المثبِّت الفريد (معرّف تكلفة التركيب لكلّ تطبيق) من قاعدة بيانات المثبِّتين المحترفين المعتمَدين

ValidateInstallerRequest

طلب بشأن ValidateInstaller

الحقول
installer_id

string

مطلوب. معرّف المثبّت الفريد (معرّف تكلفة التركيب لكل عملية تثبيت) من قاعدة بيانات المثبّتين المحترفين المعتمَدين

secret

string

مطلوب. المفتاح السري الذي يعرضه GenerateSecret

encoded_secret

string

مطلوب. رمز JSON المميّز للويب موقَّع باستخدام مفتاح خاص لواجهة برمجة التطبيقات CPI. يجب أن تتضمّن الحمولة مطالبة "secret" تكون قيمتها هي المفتاح السرّي.

ValidateInstallerResponse

ردّ على السؤال ValidateInstaller