SG Developer
Our Developer documentation has relocated and this site will be discontinued soon. Visit our new Developer Help Center here.

API の概要

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

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

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

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

Python API を使用した環境設定の概要ビデオ

スクリプト キー

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

スクリプト

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

個人用アクセス トークン(PAT)

スクリプト キーに加えて、ShotGrid サイトと通信するために個人用アクセス トークン(PAT)も設定する必要があります。設定方法については、次のビデオ解説を参照してください。

最初に行う一般的な作業

https://github.com/shotgunsoftware/python-api で API をダウンロードします。最初に行う一般的な作業には、以下のようなものがあります。

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

API で実行できない操作

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

アクション メニュー アイテム(AMI)

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

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

イベント トリガ デーモン

ShotGrid で(ユーザまたは API スクリプトにより)実行されるあらゆるアクションでイベントが生成されます。イベント デーモンを使用して、イベント ストリームを監視し、定義した条件に基づいて特定の API スクリプトを実行することができます。次に、いくつかの例を示します。

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

追加情報

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

投稿とコラボレーション

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

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

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

Edit this document