Канфігурацыя і брэндынг
На гэтай старонцы
Захоўвайце прыватныя ўліковыя даныя ў канфігурацыі бэкенда, а ў канфігурацыі фронтэнда — толькі публічныя значэнні.
Як карыстацца гэтымі інструментамі
- Спачатку выклічце адпаведны інструмент чытання або праверкі стану.
- Праверце мэтавы аб’ект і абавязковыя аргументы.
- Выканайце адно запланаванае дзеянне. Калі патрабуецца яўнае пацвярджэнне чалавека, атрымайце яго перад выкананнем.
- Пасля гэтага праверце стан або паўторна прачытайце рэсурс, які закранула дзеянне.
Параметры ніжэй апісваюць публічны кантракт. Вызначальным застаецца актуальны спіс інструментаў падключанага сервера. Некаторыя інструменты патрабуюць пэўнага хоста, мэтавага аб’екта, рэжыму інферэнсу або плана. Ідэнтыфікатары — гэта значэнні, якія вярнулі ранейшыя інструменты; не прыдумляйце іх.
project_settings
Налады праекта.
Прачытайце вернуты рэсурс і ўлічвайце яго бягучыя значэнні, калі плануеце наступнае дзеянне.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| projectId | Не | радок |
| scope | Не | ephemeral, production |
Аперацыя: толькі чытанне.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
update_project_settings
Змяніце налады праекта.
Прачытайце вернуты рэсурс і ўлічвайце яго бягучыя значэнні, калі плануеце наступнае дзеянне.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| projectId | Не | радок |
| copyright | Не | радок |
| organizationName | Не | радок |
| termsUrl | Не | радок |
| privacyUrl | Не | радок |
| googleTag | Не | радок |
| useOrganizationDefaults | Не | булева значэнне |
| scope | Не | ephemeral, production |
Аперацыя: можа змяніць стан або запусціць працу.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
set_platform_credit
Схавайце або пакажыце згадку платформы.
Магчымасць прыбраць брэнд платформы залежыць ад таго, ці прадугледжана яна вашым планам. Захоўвайце абавязковыя юрыдычныя паведамленні і паведамленні трэціх асоб.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| projectId | Не | радок |
| hidden | Так | булева значэнне |
| scope | Не | ephemeral, production |
Аперацыя: можа змяніць стан або запусціць працу.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
project_configuration
Зменныя канфігурацыі праекта.
Прачытайце вернуты рэсурс і ўлічвайце яго бягучыя значэнні, калі плануеце наступнае дзеянне.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| projectId | Не | радок |
| scope | Не | ephemeral, production |
Аперацыя: толькі чытанне.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
update_project_configuration
Задайце зменныя канфігурацыі.
Прыватныя ўліковыя даныя трэба захоўваць у значэннях бэкенда. Значэнні фронтэнда могуць стаць даступнымі наведвальнікам; ніколі не захоўвайце ў іх прыватныя ключы.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| projectId | Не | радок |
| backend | Не | аб’ект |
| frontend | Не | аб’ект |
| scope | Не | ephemeral, production |
Аперацыя: можа змяніць стан або запусціць працу.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
recollect_configuration
Знайдзіце зменныя, абвешчаныя ў зыходным кодзе.
Абнаўляе спіс вядомых абвешчаных зменных пасля змен у зыходным кодзе. Праверце значэнні, перш чым прымяняць канфігурацыю.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| projectId | Не | радок |
Аперацыя: можа змяніць стан або запусціць працу.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
organization_branding
Стандартныя налады брэндынгу арганізацыі.
Прачытайце вернуты рэсурс і ўлічвайце яго бягучыя значэнні, калі плануеце наступнае дзеянне.
Аргументы: няма ({}).
Аперацыя: толькі чытанне.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
update_organization_branding
Змяніце стандартныя налады брэндынгу арганізацыі.
Прачытайце вернуты рэсурс і ўлічвайце яго бягучыя значэнні, калі плануеце наступнае дзеянне.
| Аргумент | Абавязковы | Тып або дапушчальныя значэнні |
|---|
| organizationName | Не | радок |
| copyright | Не | радок |
Аперацыя: можа змяніць стан або запусціць працу.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.
backfill_project_branding
Запоўніце пустыя налады праекта стандартнымі значэннямі.
Запаўняе пустыя налады брэндынгу праекта стандартнымі значэннямі арганізацыі. Пасля гэтага праверце значэнні, зададзеныя ў праекце.
Аргументы: няма ({}).
Аперацыя: можа змяніць стан або запусціць працу.
Даступныя канфігурацыі: stdio, воблачны праект, воблачны інферэнс; stdio, воблачны праект, дэлегаваны інферэнс; stdio, лакальны праект, воблачны інферэнс; stdio, лакальны праект, дэлегаваны інферэнс; HTTP на хостынгу.
Машыначытальныя кантракты інструментаў змяшчаюць укладзеныя схемы аргументаў.