フォルダー子要素を一覧表示 | Frame.io API Documentation

from frameio import Frameio
client = Frameio(
    token="YOUR_TOKEN_HERE",
)
client.folders.index(
    account_id="5c77ab31-41ee-432a-8013-5ec57eb95e6b",
    folder_id="2cf94114-e51a-44d7-809f-3582226192a1",
    include="media_links.original",
)

{
  "data": [
    {
      "type": "file",
      "created_at": "2023-09-25T19:18:29.614189Z",
      "file_size": 1137444,
      "id": "b4c00e24-9beb-4c38-91ad-8f58a88f5a8a",
      "media_type": "image/png",
      "name": "asset.png",
      "parent_id": "6ecaf9c3-23ab-4031-8dc8-8acbfec1afbd",
      "project_id": "70e467b0-c8ab-4881-9c63-836664103a26",
      "status": "created",
      "updated_at": "2024-02-07T16:44:41.986478Z",
      "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/view/5a89a9fb-0900-4b23-826b-127b90e4db4c",
      "adobe_id": "urn:aaid:sc:US:a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "adobe_version_id": "2",
      "creator": {
        "active": true,
        "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
        "email": "user_email@example.com",
        "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
        "name": "Jon Doe"
      },
      "media_links": {
        "high_quality": {
          "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN"
        },
        "original": {
          "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
          "inline_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=inline%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragSDFXDFh&1Key-Pair-Id=KKI497NESTHMN"
        },
        "thumbnail": {
          "download_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
          "url": "https://picture2.frame.io/image/s3://frameio-assets-development/image/cd58cb8e-24b3-4498-8d0f-9532fcd04d11/image_full.png?alg=HS256&sig=0_u7w_wz2MwQHOXp000ibbQSMRijujyaUu8V3YYPxu4&exp=1729857600"
        }
      },
      "metadata": [
        {
          "field_type": "select",
          "field_definition_id": "36279dd3-a607-432e-ad85-2005522b3c4e",
          "field_definition_name": "Fields definition name",
          "mutable": true,
          "value": [
            {
              "display_name": "Display name",
              "id": "6711d43d-b717-4765-bde4-994bf39f88df"
            }
          ],
          "field_options": [
            {
              "display_name": "Display name",
              "id": "6711d43d-b717-4765-bde4-994bf39f88df"
            },
            {
              "display_name": "Display name 2",
              "id": "6f10a133-919f-43f0-8e67-13efc50ba439"
            }
          ]
        }
      ],
      "project": {
        "created_at": "2024-01-25T19:18:29.614189Z",
        "id": "90d3f72c-abed-463f-8d1b-1c3c084556e1",
        "name": "My Project",
        "root_folder_id": "a8426cb1-5056-4010-92d0-416e2c0d3a78",
        "status": "active",
        "storage": 15000,
        "updated_at": "2024-02-07T16:44:41.986478Z",
        "view_url": "https://next.frame.io/project/d5e6011c-2bc9-4596-be05-77d562627112/",
        "workspace_id": "f9cc69f8-c0f8-4176-9eb1-3049c4b6b647",
        "description": "Project Description",
        "adobe_id": "urn:aaid:sc:US:9f4e4d7a-4b6b-4c4f-9f00-b31a91cfc6f3",
        "restricted": false,
        "owner": {
          "active": true,
          "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN",
          "email": "user_email@example.com",
          "id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e",
          "name": "Jon Doe"
        }
      }
    }
  ],
  "links": {
    "next": "/v4/accounts/123/folders/123/folders"
  },
  "total_count": 10
}

指定フォルダー内の子を一覧表示します。

include クエリパラメーターを使用して、応答に追加のプロパティを選択的に含めます。

注 : media_links.original を含め、対応するプロジェクトでファイルをダウンロードする権限をユーザーが持っていない場合、このエンドポイントは 403 Forbidden エラーで応答します。このユーザーに透かしが必要で、要求された media_links でサポートされていないためにコンテンツにアクセスできない場合、リクエストは成功しますが、サポートされていないメディアリンクは null に設定されます。同様に、特定のファイルに対して要求されたトランスコードリンクが存在しない場合 (例 : 静的な画像ファイルに media_links.video_h264_180 を含める) や、トランスコーディングプロセスが完了していない場合 (つまり、ファイルの status が「アップロード済み」で「トランスコード済み」ではない場合)、メディアリンクも応答ペイロードで null に設定されます。つまり、クライアントは null のメディアリンクを適切に処理する必要があります。
レート制限 : account_user あたり 1.00 分ごとに 100 回の呼び出し

指定フォルダー内の子を一覧表示します。 <br/> `include` クエリパラメーターを使用して、応答に追加のプロパティを選択的に含めます。 <br/> 注 : `media_links.original` を含め、対応するプロジェクトでファイルをダウンロードする権限をユーザーが持っていない場合、このエンドポイントは `403 Forbidden` エラーで応答します。このユーザーに透かしが必要で、要求された media_links でサポートされていないためにコンテンツにアクセスできない場合、リクエストは成功しますが、サポートされていないメディアリンクは null に設定されます。同様に、特定のファイルに対して要求されたトランスコードリンクが存在しない場合 (例 : 静的な画像ファイルに `media_links.video_h264_180` を含める) や、トランスコーディングプロセスが完了していない場合 (つまり、ファイルの `status` が「アップロード済み」で「トランスコード済み」ではない場合)、メディアリンクも応答ペイロードで null に設定されます。つまり、クライアントは null のメディアリンクを適切に処理する必要があります。 <br/>レート制限 : account_user あたり 1.00 分ごとに 100 回の呼び出し

認証

AuthorizationBearer

Bearer <token>形式のBearer認証。tokenは認証トークンです。

パスパラメータ

account_idstring必須

Frame.io またはアドビエンティティの識別子。通常は Frame.io の UUID です。ただし、アドビクラウドストレージ内に存在するアカウント、プロジェクト、フォルダー、ファイル、バージョンスタックの場合 (アカウントとプロジェクトが Workfront に接続されている場合に該当)、アドビが割り当てた ID が代わりに使用される場合もあります。これらの ID には「adobe:」がプレフィックスとして付加されています (例 : アカウントの場合は「adobe:<adobe_org_id>」、プロジェクトまたはフォルダーの場合は「adobe:<adobe_asset_id>」、ファイルアセットの場合は「adobe:<adobe_asset_id>|<version>」)。

folder_idstring必須

クエリパラメータ

includeenumオプション

メディアリンクを含むファイルを返すエンドポイントでサポートされている include クエリパラメーター値

typestringオプション

フォルダー子要素のフィルターを入力

afterstringオプション

ページ分割された結果を返すリクエスト用の不透明なカーソルクエリパラメーター。

注 : この値は自動生成され、前の応答のリンクの一部として含まれます。人が読めることを意図していません。

page_sizeintegerオプション1-500デフォルト値 50

アセットリストリクエストのページサイズのクエリパラメーター

include_total_countbooleanオプションデフォルト値 false

すべてのエンティティ数を含めるためのページクエリパラメーター

レスポンスヘッダー

x-ratelimit-limitinteger

レート制限

x-ratelimit-remaininginteger

レート制限の残り

x-ratelimit-windowinteger

レート制限ウィンドウ (ミリ秒)

レスポンス

datalist of objects

アセット

linksobject

ページ分割されたデータへのリンク

total_countinteger or nullオプション

合計数

エラー

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

指定フォルダー内の子を一覧表示します。

include クエリパラメーターを使用して、応答に追加のプロパティを選択的に含めます。