Shotgun API

概要

Shotgun API (アプリケーション プログラミング インタフェース)を利用すれば、ユーザは自分のツールを Shotgun と容易に統合することができます。シンプルな CRUD ベースの Python API を使用して、スクリプトを Shotgun にすばやく統合できます。スタジオごとにニーズはまったく異なるため、強力なローレベルの機能を提供し、ユーザがビジネス ロジックの大部分をコントロールできるようしています。

API は CRUD パターンに従い、Create (生成)、Read (読み取り)、Update (更新)、Delete (削除)を簡単に行えます。各リクエストは単一のエンティティ タイプに作用し、特定のアクションに応じて、フィルタ、返されるコラム、情報のソート、追加オプションなどを定義できます。API を介して Shotgun サーバと通信するには、Shotgun サイトにスクリプトが登録されていなければなりません。また、有効な API キーが必要です。スクリプト キーの生成は、[Admin] -> [Scripts]ページから行えます。

Screen_Shot_2013-06-08_at_11.37.58_AM.png

スクリプトは個別に登録して、それぞれに独自の API キーを設定することを強くお勧めします。こうすれば、個々のスクリプトおよびそれが実行しているアクションをイベント ログではるかに正確に監視できます。

Action Menu Items (アクション メニュー項目)

Shotgun インタフェースから簡単に起動したいスクリプトをセットアップする場合は、[Action Menu Items]から行います。これらはエンティティを右クリックしたときにメニュー内に表示されるカスタムのメニュー項目で、クリックするとスクリプトが呼び出されます。

アクション メニュー項目

 

エンティティによって異なるアクション メニュー項目をセットアップすることができ、プロジェクトごと、あるいは権限グループごとにアクセスを制限することも可能です。アクション メニュー項目のセットアップ方法に関する技術的な詳細についてはこちらをご覧ください

貢献と協力

自分が作成した Shotgun の便利なツールを世界中のユーザと共有したいと思いますか?素晴らしいことです! 互いに共有や協力を積極的に行う、活気に満ちた開発者コミュニティがありますので、ぜひご参加ください。

  • Shotgun-Dev List に参加します。
  • GitHub に自作のコードをポストします。(パイプライン固有のコードではないものにしましょう。適切な解説を添え、txt または mdk 形式の README ファイルも用意します。)
  • Shotgun-Dev List にリンクと説明をポストします。コミュニティのメンバーや Shotgun 開発者がそれをチェックし、フィードバックや称賛を寄せてくれます。

お客様の手によるさまざまな自作ツールや統合には、いつも驚きとインスピレーションをいただいています。ユーザの皆様のアイデアをお待ちしています!

イベント トリガ デーモン

Shotgun 内で(ユーザまたは API スクリプトによって)実行されるすべてのアクションはイベントを生成します。イベント デーモンはそのイベント ストリームを監視して、定義した条件に基づいて特定の API スクリプトを実行します。以下に例をいくつか紹介します。

  • 上流タスクのステータスに基づいて下流タスクのステータスを自動的に変更します。
  • 値が変更されたときに、関係のあるカットの長さのフィールドを再計算します。
  • ショットが特定のステータスになったら、ファイルのパッケージ化と転送操作を実行します。

これはほんの一部です。API およびトリガのフレームワークは非常に柔軟で、どのような作業工程にも対応できます。

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

  1. バージョンを作成し、それをショットに紐付ける - レビュー用の新しいレンダリングの提出を自動化できます。
  2. サムネイルのアップロード - サイト上のすべてのものに最新のサムネイルが適用され、手動で追加する必要はありません。
  3. Shotgun をコード リポジトリ(SVN など)に統合する - Shotgun をソフトウェア開発のプロジェクト管理に活用します。
  4. ディスク上のディレクトリ作成にリンクする - Shotgun でショットやアセットなどを作成する際のプロセスを自動化することによって、ディレクトリが常に一貫した構成で作成されます。

API で行えないこと

  • セキュリティ上の理由により、権限ルールへのアクセスまたは変更(ただし、読み取り専用のアクセスは検討中)
  • ページ設定の読み取りまたは変更
  • 個々のページまたはウィジェットのフィルタ設定やクエリ設定へのアクセス
  • UI の操作
  • ユーザ パスワードの設定
  • タグの追加、編集、削除
  • 条件付き書式ルールの追加、編集、削除
  • クエリ フィールドの作成、編集
  • 特定のプロジェクトへのスクリプト アクセスの制限

関連情報へのリンク

GitHub から Shotgun API をダウンロード

Shotgun API Wiki ドキュメント

Shotgun-Dev List (一般公開)

Shotgun イベント デーモン サンプル コード

イベント駆動のトリガの記述方法

API スクリプトの作成方法と管理方法

Shotgun スキーマについて

API のパフォーマンスの考慮事項およびベスト プラクティス


パイプラインの統合の項目

  1. パイプライン統合の概要
  2. Shotgun API
  3. Shotgun Pipeline Toolkit
  4. その他の統合

パイプライン統合のナレッジ ベース(英語)

<< Shotgun ユーザ ガイドに戻る

 

Follow

0 Comments

Please sign in to leave a comment.