Ce cas d'utilisation décrit les exigences pour le téléchargement de contenu (une copie publicitaire) à partir d'une URL avec le API du service d'importation de contenu de Broadsign Control.
POST en utilisant la méthode suivante : /import.
Lors de la publication sur le point de terminaison /import, Broadsign Server exécute la requête de manière asynchrone. En d’autres termes, si la demande est valide, Broadsign renvoie un identifiant de contenu dans la réponse JSON et commence à importer le contenu en arrière-plan. Selon la taille du fichier et la bande passante disponible, l'importation complète du contenu et sa disponibilité dans Broadsign Control Administrator euvent prendre plusieurs minutes, voire plus.
Le tableau suivant répertorie les attributs possibles pour les copies publicitaires et le contenu. Incluez ces informations dans le paramètre attributs.
Note : Vous devez utiliser des séparateurs de nouvelle ligne dans la chaîne.
| Type Mime | Attributs possibles |
|---|---|
| avi |
duration audio_codec video_codec height width keep_aspect_ratio |
| bmp |
duration keep_aspect_ratio |
| divx |
duration audio_codec video_codec height width keep_aspect_ratio |
| exe | duration |
| f4v |
duration keep_aspect_ratio |
| fla | duration |
| flv |
duration audio_codec video_codec height width volume_modifier keep_aspect_ratio |
| gif |
duration height width |
| htm | duration |
| html |
direct_url show_scrollbars |
| jpeg |
height width |
| jpg |
height width |
| m2t |
duration height width audio_codec video_codec |
| m2v |
duration height width video_codec |
| m4a |
duration audio_codec volume_modifier |
| m4v |
duration keep_aspect_ratio |
| mht | duration |
| mkv |
duration keep_aspect_ratio video_codec |
| mov |
duration height width audio_codec video_codec keep_aspect_ratio |
| mp3 |
duration audio_codec |
| mp4 |
duration height width audio_codec video_codec keep_aspect_ratio |
| mpeg |
duration height width audio_codec video_codec |
| mpg |
duration height width audio_codec video_codec keep_aspect_ratio |
| pls |
duration volume_modifier |
| png |
duration height width keep_aspect_ratio |
| tif |
duration keep_aspect_ratio |
| vob |
duration height width audio_codec video_codec keep_aspect_ratio |
| webm |
duration height width audio_codec video_codec keep_aspect_ratio |
| wma |
duration audio_codec |
| wmv |
duration width height audio_codec video_codec |
| xap |
duration volume_modifier |
| x-creator |
duration volume_modifier |
| x-digital-tv | duration |
| x-html-package |
duration main_html_file_path |
| xml | duration |
| x-ticker | duration |
| zip |
duration command_line_parameters environment_variables executable_path run_as_admin run_only_once |
Ces exemples de requêtes illustrent comment importer du contenu externe dans Broadsign Server.
Note : Les numéros d'identification que nous utilisons dans ces échantillons sont fournis à titre d'illustration. Ils ne sont pas valides. Assurez-vous d’utiliser vos propres numéros d’identification pour vos intégrations. De plus, dans nos exemples, nous utilisons le point de terminaison content.control-prod et le jeton HTTP. À des fins de test, vous pouvez utiliser le point de terminaison content.control-beta.
curl -X POST \
https://content.control-prod.broadsign.com/import \
Header: Authorization: Bearer YourAPIKeyHere
{
"name": "My Content",
"container_id": "123",
"attributes": { "height": "720", "width": "1280" },
"url": "https://bucket.s3.ca-central-1.amazonaws.com/key.png"
}Paramètres de la requête
|
Nom |
Type |
Description |
|---|---|---|
|
name |
string |
Le nom du contenu qui sera créé. |
|
domain_id |
string (int64) |
Facultatif. L'identifiant du domaine où créer le contenu. Par défaut, il s'agit de l'identifiant de domaine de l'utilisateur effectuant la demande. |
|
customer_id |
string (int64) |
Facultatif. L'identifiant du client où créer le contenu. Par défaut, le Contenu n'appartiendra pas à un Client. |
|
container_id |
string (int64) |
Facultatif. L'identifiant du conteneur où créer le contenu. Par défaut, le contenu ne sera pas dans un conteneur. |
|
attributes |
Carte de chaînes JSON |
Informations sur le fichier, qui varient selon le type MIME. Voir Types et attributs MIME. Il s'agit d'une simple carte clé-valeur où les valeurs doivent toujours être des chaînes. |
|
url |
string |
L'URL à récupérer par Broadsign Control qui sera mis à disposition sous forme de contenu. Le mime du contenu sera déduit en fonction de l'extension de l'URL (par exemple : mp4, png, x-html-package, zip). |
202 - Accepted
{
"contentId": "123456789"
}
Paramètres de réponse
|
Nom |
Type |
Description |
|---|---|---|
|
contentId |
int64 (string) |
L'identifiant de contenu réservé pour cette importation. Cela servira de jeton pour surveiller la progression de cette importation et constituera l'identifiant du contenu une fois l'importation terminée. |
Étant donné que l'importation se déroule de manière asynchrone, il n'y a pas de retour direct sur la progression du téléchargement qui a lieu côté serveur. Certaines applications clientes peuvent avoir besoin de vérifier périodiquement l’importation pour voir si elle est terminée. Cela peut être réalisé en utilisant la méthode GET /import, en utilisant l'identifiant de contenu renvoyé par la méthode /import.
GET https://content.control-prod.broadsign.com/import/123456789
Header: Authorization: Bearer YourAPIKeyHereParamètres de la requête
| Nom | Type | Description |
|---|---|---|
| contentId | int64 (string) | L'identifiant du contenu pour lequel la progression est demandée. |
200 - OK
{
"status": "FAILED",
"error": "Failed to download the content at 'https://bucket.s3.ca-central-1.amazonaws.com/key.png'. The request failed with a 403 Forbidden error."
}Paramètres de réponse
| Nom | Type | Description |
|---|---|---|
| status | enum (string) |
L'une des valeurs d'état suivantes :
|
| error | string (optional) | Inclus si la demande de téléchargement de contenu a échoué. Chaîne descriptive et lisible par un humain décrivant pourquoi le contenu a échoué. |