URL: https://orbitvu.co/api/v1/presentations [.json|.xml]
返されるデータ
このエンドポイントによって返されるデータは、プレゼンテーションとそのコンテンツのページ付けされたリストです。 例えば：
{
"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"
}
],
"custom_attributes": [
{
"label": "Category 1",
"value": "summer",
}
],
"presentationcontent_set": [
{
"id": 117,
"sorting_order": 1,
"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,
"sorting_order": 2,
"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,
"sorting_order": 3,
"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": ""
}
]
}
]
}
Click to copy
ページネーションに関連するデータ：
- count - 結果の数
- next - 結果の次のページへのURL（次のページがない場合はnull）
- previous - 結果の前のページへのURL（前のページがない場合はnull）
- per_page - 1ページあたりの結果の数（page_size URLパラメータで設定可能）
- results - 結果のリスト（プレゼンテーションオブジェクト）
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 - crop (特定のサイズで画像をクロップ)、 supplement（白背景を付け足して目的のサイズを得る）
- statistics_url - プレゼンテーション統計のURL
- orbittour_set - プレゼンテーション用に定義された ORBITTOURのリスト (現在のところ 一つのORBITTOURまで)
- custom_attributes - プレゼンテーション用に定義されたカスタム属性のリスト
- presentationcontent_set - プレゼンテーションコンテンツのリスト：
- id - プレゼンテーションコンテンツの一意のID
- sorting_order - コンテンツの順序を表す番号
- name - コンテンツの名前。360 コンテンツの場合はov3601、2D画像コンテンツの場合はファイル名
- type - コンテンツのタイプ： 1 - 360° コンテンツ、 3 - 2D画像, 4 - ビデオ
- type_display - コンテンツのタイプの分かり易い説明
- ovus_folder - 360°プレゼンテーションの ovus_folder URL。2Dコンテンツの場合は空
- thumbnail_url - 画像のURL（2Dコンテンツの場合）あるいはサムネイルのURL（360°コンテンツの場合）。画像はクエリ文字列パラメータで操作できます（前述の説明を参照）
- script_url - 360°コンテンツのスクリプトのエンドポイントURL
- view_url - 360°コンテンツの閲覧用エンドポイントURL
- max_width - 360°コンテンツの最大幅
- max_height - 360°コンテンツの最大高
- content2_xml - 360°コンテンツがcontent2.xmlファイルを使用しているかどうかを示すブール値
検索
- 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
Click to copy
- by create_date
日付の範囲をcreate_date_from または 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
Click to copy
- 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
# match all presentations with tags like 'tag1' or 'tag2'
https://orbitvu.co/api/v1/presentations?search_tags=tag1,tag2
Click to copy
- ilike - 一度に複数のフィールド内を検索
sku, name, uidのいずれかで特定のパターンを含むプレゼンテーションを検索します。
例：
# match all presentations with sku, name or uid containing 'A123' or 'a123'
https://orbitvu.co/api/v1/presentations?search=A123
Click to copy
並び替え
sku, uid, name による並び替え
例：
# ascending
https://orbitvu.co/api/v1/presentations?ordering=sku
# descending
https://orbitvu.co/api/v1/presentations?ordering=-sku
Click to copy
ページネーション
1ページあたりのプレゼンテーション数
例：
https://orbitvu.co/api/v1/presentations/?page_size=5
Click to copy