For the complete documentation index, see llms.txt. This page is also available as Markdown.

Publicação

Permite verificar a ocupação das playlists e adicionar novas publicações.

Endpoints

  • Ocupação de playlist

URL: <seuprojeto>.edgecontents.com/ds/api/playlistmedia/occupation

Método: GET

Autenticação: Basic Auth

Parâmetros de Consulta:

Parâmetro
Tipo
Obrigatório
Descrição

playlist

int

Sim

ID da playlist

start

date

Sim

Data de início

end

date

Sim

Data de fim

screens

int

Sim

Player (aceita múltiplos valores separados por vírgula)

sites

int

Sim

Locais (aceita múltiplos valores separados por vírgula)

groups

int

Sim

Grupos (aceita múltiplos valores separados por vírgula)

all

int

Sim

Todos os players (aceita 0 e 1)

Observação: entre os parâmetros "screens", "sites", "groups" e "all", é obrigatório o uso de apenas um deles.

Exemplo de retorno:

  • Adicionar publicação com nova mídia

URL: <seuprojeto>.edgecontents.com/ds/api/playlistmedia/add

Método: POST

Autenticação: Basic Auth

Corpo da Requisição (form-data):

Parâmetro
Tipo
Obrigatório
Descrição

playlist

Text

Sim

ID da playlist

start

Text

Sim

Data de início

end

Text

Sim

Data de fim

screens

Text

Não

Player (aceita múltiplos valores separados por vírgula)

sites

Text

Não

Locais (aceita múltiplos valores separados por vírgula)

groups

Text

Não

Grupos (aceita múltiplos valores separados por vírgula)

all

Text

Não

Todos os players (aceita 0 e 1)

customer

Text

Sim

ID do cliente

campaign

Text

Sim

ID da campanha

playlistitems

Text

Sim

ID de Playlistitems (aceita múltiplos valores separados por vírgula)

file[]

File

-

Caminho do arquivo

file_url

Text

-

URL da mídia

Exemplo de requisição com file:

Exemplo de requisição com file_url:

Exemplo de retorno:

  • Adicionar publicação com mídia já existente

URL: <seuprojeto>.edgecontents.com/ds/api/playlistmedia/add

Método: POST

Autenticação: Basic Auth

Corpo da Requisição (json):

Parâmetro
Tipo
Obrigatório
Descrição

playlist

int

Sim

ID da playlist

start

date

Sim

Data de início

end

date

Sim

Data de fim

screens

int

Não

ID de Player (aceita múltiplos valores como array)

sites

int

Não

ID de Locais (aceita múltiplos valores como array)

groups

int

Não

ID de Grupos (aceita múltiplos valores como array)

all

int

Não

Todos os players (aceita 0 e 1)

media

int

Sim

ID de Mídias (aceita múltiplos valores como array)

playlistitems

int

Sim

ID de Playlistitems (aceita múltiplos valores como array)

Exemplo de requisição:

Exemplo de retorno:

🟡 Publicação – Reserva de Espaço (Sem Mídia)

📌 Descrição

Cria uma publicação (playmedia) sem mídia vinculada, reservando espaço para uma campanha.

Essa reserva pode ser preenchida posteriormente com mídias.


📥 Requisição

URL: <seuprojeto>.edgecontents.com/ds/api/playlistmedia/add

Método: POST

Autenticação: Basic Auth

Corpo da Requisição (json):


Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

playlist

int

✅ Sim

ID da playlist

playlistitems

int[]

✅ Sim

IDs dos playlist items

start

datetime

✅ Sim

Data de início

end

datetime

✅ Sim

Data de fim

campaign

int

✅ Sim

ID da campanha

screens

int[]

❌ Não

IDs de players

sites

int[]

❌ Não

IDs de locais

groups

int[]

❌ Não

IDs de grupos

all

int (0/1)

❌ Não

Aplicar para todos os players


⚠️ Regras

  • Não enviar media

  • campaign é obrigatória

  • Será criado um playmedia sem mídia associada

  • O campo name no retorno poderá ser null


📥 Exemplo


📤 Resposta


🔁 Publicação – Adicionar Mídia em Reserva

📌 Descrição

Preenche uma ou mais reservas existentes (sem mídia), associando mídias a elas.

As reservas antigas são marcadas como deletadas e novas publicações são criadas com as mídias.


📥 Requisição

URL: <seuprojeto>.edgecontents.com/ds/api/playlistmedia/add

Método: POST

Autenticação: Basic Auth

Corpo da Requisição (json):


Parâmetros

Parâmetro
Tipo
Obrigatório
Descrição

playlist

int

✅ Sim

ID da playlist

playlistitems

int[]

✅ Sim

IDs dos playlist items

start

datetime

✅ Sim

Data de início

end

datetime

✅ Sim

Data de fim

media

int[]

✅ Sim

IDs das mídias

campaign

int

✅ Sim

ID da campanha

reserves_id

int[]

✅ Sim

IDs das reservas a serem substituídas

screens

int[]

❌ Não

IDs de players

sites

int[]

❌ Não

IDs de locais

groups

int[]

❌ Não

IDs de grupos

all

int (0/1)

❌ Não

Aplicar para todos os players


⚠️ Regras

  • media é obrigatória

  • campaign é obrigatória

  • reserves_id é obrigatório

  • As reservas informadas devem:

    • Pertencer à mesma campanha

    • Estar sem mídia (cd_media_med = null)

  • O sistema irá:

    1. Criar novos playmedias com as mídias informadas

    2. Marcar as reservas antigas como deletadas (fl_deleted_plm = 1)


📥 Exemplo


📤 Resposta


🧠 Observação importante

Atualizado