キーワードリファレンス

Version 25.3.9411


キーワードリファレンス


APIScript の構文は、api: を接頭辞に取るXML エレメントであるキーワードを使って定義されます。キーワードは、プログラミングもしくはスクリプト言語の一般的な機能である条件分岐、ループ、およびフロー制御を含みます。ただし、APIScript は、フィード操作や生成に特化した専用のキーワードも含みます。例えば、api:callapi:enum、およびapi:set があります。

キーワードの多くは、その動作を定義もしくは影響を与えるパラメータを取ります。パラメータは、キーワードエレメントのXML アトリビュートとして定義されます。このセクションでは、それぞれのキーワードについて、必須およびオプションのパラメータ、コードサンプルが記載されています。

キーワードスコープ

APIScript では、一部のキーワードでスコープを持つものがあります。これは、一部のキーワードを他のキーワードのボディ内にネストできることを意味し、どのようにネストされるかがAPIScript 言語において重要な意味を持ちます。

  • キーワードのスコープ内で反復の指示を定義することが可能です。例えば、api:call キーワードのボディは、api:call により起動したオペレーションによって生成されたフィード内のそれぞれのアイテムに対して実行されます。このため、api:call の内部にネストされたキーワードは、それぞれの反復において実行され、フィード内にそれぞれのアイテムを作成します。
  • スコープは、キーワードの一致するペアを関連付けます。例えば、api:else キーワードは、api:equalsapi:check などの条件分岐キーワードの代替実行パスを定義します。APIScript では、api:else キーワードは、条件ステートメントの直接の子としてネストされている場合には、条件ステートメントに関連付けられます。これは、api:else キーワードを条件分岐キーワードによるスコープの外部で定義してはならないことを意味します。
  • キーワードは、スコープ内で新しいアイテム(変数)を導入できます。例えば、api:call キーワードは、生成されるフィード内で反復されるアイテムを表すデフォルトのアウトプットアイテムを導入します。
  • キーワードは、スコープ内でより多くの情報を提供する追加アトリビュートをデフォルトアイテムに挿入できます。これらのアトリビュートは、本ドキュメントでは コントロールアトリビュート と呼ばれます。コントロールアトリビュートは、アンダースコア_ で始まります.例えば、_attr_index、および_value はコントロールアトリビュートです。