Shotgun の API

注: Shotgun API の詳細については、API ドキュメントを参照してください。

Shotgun のアプリケーション プログラミング インタフェース(API)を使用すると、ユーザは独自のツールを Shotgun に簡単に統合することができます。 これにより、自動プロセスの作成、数多くのサード パーティ ソフトウェア パッケージとの統合、スタジオ内の既存のツールとの通信が可能になります。 スタジオごとにニーズが大きく異なるため、Shotgun API は強力で低レベルの機能を提供し、ビジネス ロジックのほとんどはお客様が決定できます。

API は、メディアおよびエンターテインメント業界で広く使用される一般的なプログラミング言語である Python を使用して作成されています。 Shotgun Python API の使用は、Shotgun サイトに無料で含まれます。

API は CRUD パターンに従うため、単一のエンティティ タイプに対して作成、読み取り、更新、および削除の操作をスクリプトで実行することができます。 多くの操作には、フィルタ、返される列、およびソート結果を定義する機能が含まれています。

API を介して Shotgun サーバと通信する場合、ユーザの資格情報を提供するか、スクリプト キーを使用することによって、スクリプトをサーバに対して認証できます。 新しいスクリプト キーは、Admin メニューに表示される Scripts ページから生成することができます。

スクリプト

上級者向けのヒント: スクリプトは個別に登録し、それぞれに個別の API キーを設定します。 これにより、各スクリプトと実行される操作をイベント ログでより正確にモニタできます。

一般的な最初のプロジェクト

API は https://github.com/shotgunsoftware/python-api でダウンロードすることができます。 一般的な最初のプロジェクトのいくつかには、以下のものが含まれます。

  1. バージョンを作成し、ショットにリンクする。 レビュー用に新しいレンダラの送信を自動化できます。
  2. サムネイルをアップロードする。 サイト上のすべての要素に、手動で追加することなく最新のサムネイルを反映できます。
  3. Shotgun を SVN などのコード リポジトリと統合する。 Shotgun を利用してソフトウェア開発のプロジェクトを管理します。

API で実行できない操作

  • 権限ルールへのアクセスまたは変更(セキュリティ上の理由による)
  • ページ設定の読み取りまたは変更
  • 個々のページまたはウィジェットのフィルタまたはクエリー設定へのアクセス
  • UI の操作
  • 条件付き書式設定ルールの追加、編集または削除
  • クエリー フィールドの作成または編集

アクション メニュー項目(AMI)

Shotgun のインタフェース内から簡単に起動するスクリプトを作成するには、AMI を使用します。 これらは、データの行を右クリックして表示するコンテキスト メニューに表示される、カスタマイズ可能なオプションです。 クリックするとコンテキスト データ ダンプが Web サーバまたはカスタム ブラウザ プロトコル ハンドラに送信されます。ここでカスタム ビジネス ロジックを実行できます。

エンティティごとに異なる AMI を設定することができ、プロジェクトまたは権限グループ別にそれらの項目へのアクセスを制限することができます。

イベント トリガ デーモン

Shotgun で(ユーザまたは API スクリプトにより)実行されるすべての操作でイベントが生成されます。 イベント デーモンでは、イベント ストリームをモニタし、定義された条件に基づいて特定の API スクリプトを実行することができます。 次に、いくつかの例を示します。

  • 上流工程のタスクのステータスに基づいて、下流工程のタスクのステータスを自動的に変更する
  • 値が変更された場合に関連する cut duration フィールドを再計算する
  • ショットが特定のステータスに設定されている場合、ファイルのパッケージ化と転送操作を実行する

追加情報

Shotgun API に関する詳細については、次の記事を参照してください。

投稿とコラボレーション

世界中の人と共有したいと思うような優れたツールを Shotgun で作成したことはありませんか。 それはすばらしいことです。 当社には、情報を共有したり、協力しあうことが大好きな開発者向けの、活発な開発者コミュニティがあります。 参加するには:

  • Shotgun-dev リストに参加します。
  • GitHub にコードを投稿します(コードはパイプライン固有のものではなく、十分に文書化されたもので、txt または mdk 形式の README が必要です)。
  • リンクと説明を dev リストに投稿します。 開発者コミュニティと Shotgun の開発者はその投稿をチェックアウトし、フィードバックを提供したり、良い点は高く評価します。

当社は、絶えずお客様が提供するさまざまなツールや統合に感動し、刺激を受けています。 ぜひお客様の実力をお見せください。

フォローする

0 コメント

ログインしてコメントを残してください。