プレゼンテーションのリスト

返されるデータ

このエンドポイントによって返されるデータは、改ページされたプレゼンテーションのリストとその内容です。例:

{
    "count": 1,
    "next": null,
    "previous": null,
    "per_page": 50,
    "results": [
        {
            "id": 46,
            "uid": "5Etsw445fEtdGYpKLnTp5b",
            "name": "Some presentation",
            "sku": "1234",
            "category_1": "",
            "category_2": "",
            "create_date": "2013-02-15T09:45:00",
            "ovus_number": "025",
            "presentation_size": 11066632,
            "has_orbittour": true,
            "tags": [],
            "url": "https://orbitvu.co/api/presentations/46",
            "edit_url": "https://orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/",
            "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/img01.png",
            "statistics_url": "https://orbitvu.co/api/v1/presentations/46/statistics",
            "orbittour_set": [
                {
                    "id": 1,
                    "script_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/2/orbittour/1/script",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/2/orbittour/1/view"
                }
            ],
            "presentationcontent_set": [
                {
                    "id": 117,
                    "name": "ov3601",
                    "type": 1,
                    "type_display": "ORBITVU 360",
                    "ovus_folder": "https://orbitvu.co/025/5Etsw445fEtdGYpKLnTp5b/ov3601/",
                    "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/img01.png",
                    "script_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/ov3601/3/script",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/ov3601/3/view",
                    "max_width": 4272,
                    "max_height": 2848,
                    "content2_xml": true
                },
                {
                    "id": 119,
                    "name": "img_1.jpg",
                    "type": 3,
                    "type_display": "image2d",
                    "ovus_folder": "",
                    "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/119/img01.png",
                    "script_url": "",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/119/img01.png",
                    "max_width": 0,
                    "max_height": 0,
                    "content2_xml": ""
                },
                {
                    "id": 120,
                    "name": "img_2.jpg",
                    "type": 3,
                    "type_display": "image2d",
                    "ovus_folder": "",
                    "thumbnail_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/120/img01.png",
                    "script_url": "",
                    "view_url": "//orbitvu.co/001/5Etsw445fEtdGYpKLnTp5b/iproc/2d/120/img01.png",
                    "max_width": 0,
                    "max_height": 0,
                    "content2_xml": ""
                }
            ]
        }
    ]
}

データに関連するページネーション:

  • count - 結果の数
  • next - 結果の次のページへのURL(次のページがない場合はnull)
  • previous - 結果の前のページへのURL(前のページがない場合はnull)
  • per_page - ページあたりの結果の数(page_size URLパラメータで設定可能)
  • results - 結果のリスト(プレゼンテーションオブジェクト)

結果データの詳細:

  • id - 一意のプレゼンテーションID (数字)
  • uid - 一意のプレゼンテーションID (URLで使用される)
  • name, SKU, category_1, category_2 - プレゼンテーションの詳細
  • create_date - プレゼンテーションの作成日付
  • ovus_number - 360コンテンツのovus_folderパラメータ内で使用される番号。ovus_folderの自動生成に役立ちます。
  • presentation_size - プレゼンテーションのバイトサイズ
  • has_orbittour - 当プレゼンテーションにORBITTOURが存在するかどうかを決定するブーリアン値
  • tags - プレゼンテーションに付加されたタグのリスト
  • url - 当プレゼンテーションオブジェクトの直接URL
  • edit_url - ORBITVU SUN プレゼンテーション編集ページのURL
  • thumbnail_url - 当プレゼンテーションのサムネイル画像のURL。画像は以下のクエリ文字列パラメータで操作できます:
    • width - 要求された幅
    • height - 要求された高さ
    • max_width - 最大幅(高さとの割合を維持)
    • max_height - 最大高(幅との割合を維持)
    • action - クロップ (特定のサイズで画像をクロップ)、 補正(白背景を補正して任意のサイズを得る)
  • statistics_url - プレゼンテーション統計のURL
  • orbittour_set - プレゼンテーション用に定義された ORBITTOURs  (現在は 一つのORBITTOURのみ)のリスト
  • presentationcontent_set - プレゼンテーションコンテンツのリスト:
    • id - プレゼンテーションコンテンツの一意のID
    • name - コンテンツの名前,  360 コンテンツではov3601、2D 画像コンテンツの場合はファイル名
    • type - type of content: 1 - 360° コンテンツ、 2 -  2D 画像
    • type_display - コンテンツタイプの分かり易い説明
    • ovus_folder - 360°プレゼンテーションの ovus_folder URL。2D コンテンツの場合は空
    • thumbnail_url - 2D コンテンツの画像、または、360°コンテンツのサムネイルへのURL。画像はクエリ文字列パラメータに変更できます(上記の説明を参照)
    • script_url - 360° コンテンツのクリプトエンドポイントへのURL
    • view_url - 360° コンテンツのビューエンドポイントへのURL
    • max_width - 360° コンテンツの最大幅
    • max_height - 360° コンテンツの最大高さ
    • content2_xml - 360° コンテンツが content2.xml ファイルを使用するかどうかを決定するブーリアン値 

検索(Searching)

  • exact

    特定のフィールドと完全一致によるプレゼンテーションの検索: id, sku, name, uid, tags,  例:

    # match presentation with sku == 1234
    https://orbitvu.co/api/v1/presentations.json?sku=1234
    
    # match presentation with tag shoes
    https://orbitvu.co/api/v1/presentations.json?tags=shoes
  • by create_date
    日付範囲 create_date_from and/or create_date_to と日付フォーマット YYYY-MM-DD を使用してプレゼンテーションを検索 例:

# Search for presentations created after 2018-01-05: https://orbitvu.co/api/v1/presentations.json?create_date_from=2018-01-05

# Search for presentations created between 2018-01-01 and 2018-01-05: 
https://orbitvu.co/api/v1/presentations.json?create_date_from=2018-01-01&create_date_to=2018-01-05
  • ilike

    特定のフィールド内の特定のパターンを含むプレゼンテーションを検索する: search_sku, search_name, search_uid, search_tags:

    # match all presentations with sku containing '123'
    https://orbitvu.co/api/v1/presentations?search_sku=123
  • ilike - 一度に複数のフィールド内を検索

    sku, name, uidの一つの中の特定のパターンを含むプレゼンテーションを検索する:

    # match all presentations with sku, name or uid containing 'A123' or 'a123'
    https://orbitvu.co/api/v1/presentations?search=A123

並び替え(Ordering)

skuuidname による並び替え:

# ascending
https://orbitvu.co/api/v1/presentations?ordering=sku

# descending
https://orbitvu.co/api/v1/presentations?ordering=-sku

改ページ(Pagination)

1ページあたりのプレゼンテーション数:

https://orbitvu.co/api/v1/presentations/?page_size=5