REST Resource: operators.planStatuses

Ресурс: PlanStatus

PlanStatus содержит подробную информацию обо всех пакетах мобильных услуг верхнего уровня, приобретенных пользователем.

Представление JSON
{
  "name": string,
  "plans": [
    {
      object (Plan)
    }
  ],
  "languageCode": string,
  "expireTime": string,
  "updateTime": string,
  "title": string,
  "subscriberId": string,
  "accountInfo": {
    object (AccountInfo)
  },
  "uiCompatibility": enum (UiCompatibility),
  "notifications": [
    enum (NotificationType)
  ],
  "planInfoPerClient": {
    object (PlanInfoPerClient)
  }
}
Поля
name

string

Имя ресурса PlanStatus в следующем формате: operators/{asn_id}/planStatuses/{userKey} . Имя игнорируется при создании записи PlanStatus.

plans[]

object ( Plan )

Список планов, принадлежащих этому пользователю.

languageCode

string

Необходимый. Код языка BCP-47, например «en-US» или «sr-Latn». Для получения дополнительной информации см. http://www.unicode.org/reports/tr35/#Unicode_locale_identifier .

expireTime

string ( Timestamp format)

Необходимый. Время, когда информация о группе общего плана устаревает. По истечении этого времени PlanStatus не будет передаваться приложениям.

Отметка времени в формате RFC3339 UTC "Zulu" с точностью до наносекунд. Пример: "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Необходимый. Время, когда агент плана данных (DPA) получил информацию о состоянии плана из серверных систем. Может использоваться для определения того, насколько актуальна информация о состоянии плана.

Отметка времени в формате RFC3339 UTC "Zulu" с точностью до наносекунд. Пример: "2014-10-02T15:01:23.045123456Z" .

title

string

Название договора, заключенного пользователем с оператором. Это будет показано в заголовке пользовательского интерфейса.

subscriberId

string

Уникальный стабильный идентификатор в системе оператора для идентификации пользователя.

accountInfo

object ( AccountInfo )

Требуется для пользователей с предоплатой. Информация о балансе учетной записи пользователя.

uiCompatibility

enum ( UiCompatibility )

Определяет, можно ли отображать PlanStatus пользователю в пользовательском интерфейсе. Если установлено значение UI_INCOMPATIBLE, PlanStatus может использоваться для отправки уведомлений пользователю, но не будет использоваться для отображения информации о плане пользователю.

notifications[]

enum ( NotificationType )

Типы уведомлений, отправленных пользователю.

planInfoPerClient

object ( PlanInfoPerClient )

Методы

create

 Позволяет оператору мобильной связи (определяемому своим уникальным номером автономной системы (ASN)) добавлять новую запись PlanStatus.