[comment]: # translation:outdated

[comment]: # aside:1

[comment]: # ({ee4a2645-28092341})
# Lietotāja makro objekts

Tālāk norādītie objekti ir tieši saistīti ar `usermacro` API.

[comment]: # ({/ee4a2645-28092341})

[comment]: # ({0a76e75e-e654cd12})
### Globālais makross

Globālā makrosa objektam ir šādas īpašības.

|Īpašība|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|globalmacroid|ID|Globālā makrosa ID.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *tikai lasāms*<br>- *obligāts* atjaunināšanas operācijām|
|description|string|Makrosa apraksts.|
|macro|string|Makrosa virkne.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *obligāts* izveides operācijām|
|type|integer|Makrosa tips.<br><br>Iespējamās vērtības:<br>0 - *(noklusējums)* Teksta makross;<br>1 - Slepenais makross;<br>2 - Vault noslēpums.|
|value|string|Makrosa vērtība.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *tikai rakstāms*, ja `type` ir iestatīts uz "Secret macro"<br>- *obligāts* izveides operācijām|

[comment]: # ({/0a76e75e-e654cd12})

[comment]: # ({52a5aa5d-5a3a9f9f})
### Hosta makross

Hosta makrosa objekts definē makrosu, kas ir pieejams hostā, hosta
prototipā vai veidnē. Tam ir šādas īpašības.

|Īpašība|[Type](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|hostmacroid|ID|Makrosa ID.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *tikai lasāms*<br>- *obligāts* atjaunināšanas operācijām|
|automatic|integer|Nosaka, vai makrosu kontrolē atklāšanas kārtula.<br><br>Iespējamās vērtības:<br>0 - *(noklusējums)* Makrosu pārvalda lietotājs;<br>1 - Makrosu pārvalda atklāšanas kārtula.<br><br>Lietotājam nav atļauts izveidot automātisku makrosu.<br>Lai atjauninātu automātisku makrosu, tas ir [jāpārveido par manuālu](/manual/api/reference/usermacro/update#change-macro-value-that-was-created-by-discovery-rule).|
|config|object/array|[Makrosa konfigurācija](#macro-configuration), kas nosaka, kā makross tiek attēlots [Host Wizard](/manual/config/hosts/host_wizard#configure-host).|
|description|string|Makrosa apraksts.|
|hostid|ID|Hosta, hosta prototipa vai veidnes ID, kuram pieder makross.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *konstants*<br>- *obligāts* izveides operācijām|
|macro|string|Makrosa virkne.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *obligāts* izveides operācijām|
|type|integer|Makrosa tips.<br><br>Iespējamās vērtības:<br>0 - *(noklusējums)* Teksta makross;<br>1 - Slepens makross;<br>2 - Vault noslēpums.|
|value|string|Makrosa vērtība.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *tikai rakstāms*, ja `type` ir iestatīts uz "Secret macro"<br>- *obligāts* izveides operācijām|

[comment]: # ({/52a5aa5d-5a3a9f9f})

[comment]: # ({17133911-2d3baa1d})
#### Makro konfigurācija

Makro konfigurācijas objekts nosaka, kā makro tiek attēlots [Host Wizard](/manual/config/hosts/host_wizard#configure-host).

|Īpašība|[Tips](/manual/api/reference_commentary#data-types)|Apraksts|
|--|--|------|
|type|integer|Makro ievades lauka tips.<br><br>Iespējamās vērtības:<br>0 - Makro netiek izmantots Host Wizard;<br>1 - Teksta lauks;<br>2 - Saraksts;<br>3 - Izvēles rūtiņa.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *obligāts*|
|label|string|Makro ievades lauka etiķete.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *obligāts*, ja `type` ir iestatīts uz "Textbox", "List" vai "Checkbox"|
|description|text|Palīdzības teksts, kas tiek parādīts blakus makro ievades laukam. Atbalsta Markdown formatējumu.|
|priority|integer|Makro ievades lauka pozīcija makro sarakstā.<br><br>Ja `priority` nav iestatīts, makro tiek pievienots negrupēto makro saraksta beigās.|
|required|integer|Norāda, ka makro ir obligāts.<br><br>Iespējamās vērtības:<br>0 - Nav obligāts;<br>1 - Obligāts.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *atbalstīts*, ja `type` ir iestatīts uz "Textbox" vai "List"|
|regex|string|Regulārā izteiksme lietotāja ievades pārbaudei teksta laukā.<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *atbalstīts*, ja `type` ir iestatīts uz "Textbox"|
|section\_name|string|Sakļaujamās sadaļas etiķete, kurā makro tiek grupēts.<br><br>Ja `section_name` nav iestatīts, makro netiek grupēts. Negrupētie makro tiek parādīti vispirms; grupētie makro tiek parādīti zemāk, sakārtoti pēc to `priority` katrā sakļaujamajā sadaļā.|
|options|text|JSON virkne, kas definē saraksta vienumus vai izvēles rūtiņas vērtības.<br><br>Sarakstiem: objektu masīvs ar `value` un `text` īpašībām.<br>Piemērs: `[{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]`<br><br>Izvēles rūtiņām: objekts ar `checked` un `unchecked` īpašībām.<br>Piemērs: `{"checked": true, "unchecked": false}`<br><br>[Īpašības darbība](/manual/api/reference_commentary#property-behavior):<br>- *obligāts*, ja `type` ir iestatīts uz "List" vai "Checkbox"|

[comment]: # ({/17133911-2d3baa1d})