Publicidade: referência da API, endpoints e exemplos

OpenAPI YAML OpenAPI JSON problemas YAML Visão geral da API

Este grupo tem 46 operações, geradas a partir de api/openapi.yaml. Filtre por caminho, ação ou autenticação. Cada endpoint lista suas entradas; expanda-o para ver um modelo de solicitação e os códigos de resposta. Os modelos precisam de seus próprios valores e de um corpo válido conforme o esquema.

Substitua os espaços reservados em maiúsculas pelos seus valores. Para uma solicitação JSON, salve um corpo que corresponda ao esquema em request.json. Exemplos de cookies usam um jar local de cookies de uma sessão autenticada.

Redes e campanhas de publicidade privadas

GET/api/advertising/network¶

Obter rede publicitária

A rede do vendedor que está ligando, incluindo a taxa de serviço resolvida do ScreenRig. Vendedores não podem alterar essa taxa.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingNetwork

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/network'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Rede.	AdvertisingNetwork (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/network¶

Criar rede de anúncios

Cria a única rede do vendedor que chama, se ausente. Requer telas=true. Idempotente; repetir retorna a mesma rede.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingNetworkCreate
ID da operação: createAdvertisingNetwork

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	maxLength: 120

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/network'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Rede.	AdvertisingNetwork (application/json)
403	proibido - o projeto não tem capacidade de tela ou possui um plano desconhecido.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/network/rate¶

Definir taxa padrão de publicidade

Define a taxa padrão do projeto do vendedor por 15 segundos de reprodução concluída. Uma alteração que altera a taxa efetiva de uma campanha aceita pausa toda a campanha com price_change_pending; uma alteração mascarada ou sem efeito não. If-Match carrega a revisão da rede.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingRate
ID da operação: setAdvertisingDefaultRate

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Campos do corpo da solicitação

Campo	Descrição
rate_mcr_per_15s (obrigatório, McrString)	Quantidade exata de millicréditos como string decimal canônica. 1 crédito é 1000 mcr. pattern: "^-?[0-9]+$"

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/network/rate'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Rede atualizada.	AdvertisingNetwork (application/json)
412	revision_conflict - If-Match está desatualizado.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/inventory¶

Listar inventário publicitário

O inventário optado pelo vendedor que está ligando.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingInventory

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/inventory'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Inventário.	AdvertisingInventoryList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

PUT/api/advertising/inventory/{screen_id}¶

Colocar inventário de publicidade

Atualiza ou insere o inventário de uma tela própria. Verifica a propriedade da tela. Uma substituição de taxa null restaura a herança, não zero. Uma alteração que muda a taxa efetiva de uma campanha aceita pausa essa campanha. Uma tela em uma pasta de telas protegida é protected_target (409).

Autenticação: projectBearer
Corpo da solicitação: AdvertisingInventoryWrite
ID da operação: putAdvertisingInventory

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
screen_id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
impressions_per_hour (opcional, inline)	A estimativa do vendedor das impressões que esta tela entrega em uma hora. Cada exibição concluída conta este valor vezes os seus segundos sobre 3600 como impressões estimadas nos relatórios. Null ou ausente significa sem estimativa.
ads_enabled (obrigatório, booleano)
site_name (opcional, string)	maxLength: 120
cidade (opcional, string)	maxLength: 120
região (opcional, string)	maxLength: 120
venue_type (opcional, string)	maxLength: 64
audience_tags (opcional, array)
posicionamento (opcional, string)	maxLength: 120
public_description (opcional, string)	maxLength: 500
rate_override_mcr_per_15s (opcional, inline)	Nulo restaura a herança do padrão do projeto; nunca significa zero.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request PUT --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/inventory/SCREEN_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Inventário armazenado.	AdvertisingInventory (application/json)
403	forbidden - a tela não pertence a este projeto; outside_screen_scope ou approver_required para um chamador limitado a telas.	Problema (application/problem+json)
409	protected_target - a tela está em uma pasta de telas protegida e a alteração não tem forma de revisão (docs/screen-scope.md); remova a proteção da pasta por meio de uma revisão, faça a alteração e proteja a pasta de novo.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/slots¶

Listar espaços publicitários

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingSlots

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/slots'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Slots.	AdvertisingSlotList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/slots¶

Criar espaço publicitário

Cria um slot de vendedor reutilizável. Imagens têm de 5 a 30 segundos e vídeos no máximo o teto da plataforma de 120 segundos. Anúncios estão sempre sem som.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingSlotWrite
ID da operação: createAdvertisingSlot

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 120
habilitado (opcional, boolean)
accepted_media (obrigatório, array)
max_image_duration_ms (obrigatório, inteiro)	mínimo: 5000 máximo: 30000
max_video_duration_ms (obrigatório, inteiro)	mínimo: 1000 máximo: 120000
rate_override_mcr_per_15s (opcional, inline)
vast_tag_url (opcional, embutido)	A própria tag de anúncio VAST 2-4 do vendedor, tentada quando nenhuma campanha convidada preenche essa vaga nas telas do vendedor. HTTPS na porta 443 ou 8443 para um host público apenas. O backend busca, segue até cinco Wrappers, ingere o MediaFile progressivo MP4 ou WebM escolhido na mídia do projeto e dispara Impression, creativeView e start em início aceito, complete em conclusão aceita e Error em falha. Quartile trackers não são disparados. Macros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] e [SCREENRIG_PAGE_ID] são expandidos. O slot deve aceitar vídeo. Nulo, ausente ou vazio limpa a tag. Compradores nunca veem isso.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/slots'

Respostas

Status	Significado	Corpo e cabeçalhos
201	Slotslot.	AdvertisingSlot (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/slots/{id}¶

Atualizar slot publicitário

Atualiza um espaço do vendedor. If-Match contém sua revisão. Uma alteração de tarifa verifica novamente o limite de preços. Um Idempotency-Key opcional reproduz o resultado original confirmado por 24 horas com o mesmo espaço, corpo e If-Match, mesmo após edições posteriores. A reutilização alterada retorna idempotency_mismatch. Uma nova gravação desatualizada retorna revision_conflict.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingSlotWrite
ID da operação: updateAdvertisingSlot

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 120
habilitado (opcional, boolean)
accepted_media (obrigatório, array)
max_image_duration_ms (obrigatório, inteiro)	mínimo: 5000 máximo: 30000
max_video_duration_ms (obrigatório, inteiro)	mínimo: 1000 máximo: 120000
rate_override_mcr_per_15s (opcional, inline)
vast_tag_url (opcional, embutido)	A própria tag de anúncio VAST 2-4 do vendedor, tentada quando nenhuma campanha convidada preenche essa vaga nas telas do vendedor. HTTPS na porta 443 ou 8443 para um host público apenas. O backend busca, segue até cinco Wrappers, ingere o MediaFile progressivo MP4 ou WebM escolhido na mídia do projeto e dispara Impression, creativeView e start em início aceito, complete em conclusão aceita e Error em falha. Quartile trackers não são disparados. Macros [CACHEBUSTING], [TIMESTAMP], [SCREENRIG_SCREEN_ID], [SCREENRIG_SLOT_ID] e [SCREENRIG_PAGE_ID] são expandidos. O slot deve aceitar vídeo. Nulo, ausente ou vazio limpa a tag. Compradores nunca veem isso.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/slots/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Slot atualizado.	AdvertisingSlot (application/json)
409	idempotency_mismatch.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/memberships¶

Listar associações publicitárias

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingMemberships

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Associações.	AdvertisingMembershipList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/memberships/{id}¶

Atualizar associação publicitária

Edição explícita da política/escopo do vendedor. Uma associação ativa é alterada aqui, nunca enviando um segundo convite. Mudanças de escopo impedem nova seleção; histórico financeiro é preservado.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingMembershipScope
ID da operação: updateAdvertisingMembership

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Campos do corpo da solicitação

Campo	Descrição
política (obrigatório, string)	Permitido: "trusted", "review_required"
screen_ids (obrigatório, array)
slot_ids (obrigatório, array)

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Associação atualizada.	AdvertisingMembership (application/json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/memberships/{id}/revoke¶

Revogar associação de publicidade

Revoga uma associação. Interrompe a nova seleção para essa rede; não limpa a flag de anunciante, outras associações ou histórico consolidado.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: revokeAdvertisingMembership

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/memberships/RESOURCE_ID/revoke'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Associação revogada.	AdvertisingMembership (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/networks¶

Listar redes publicitárias associadas

Redes às quais o anunciante chamador pertence atualmente, com o escopo e política de revisão concedidos. Contagem de telas não é contagem garantida de impressões.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingJoinedNetworks

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/networks'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Redes associadas.	AdvertisingJoinedNetworkList (application/json)
403	proibido - o projeto não tem a flag de anunciante.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/networks/{seller_project_id}/inventory¶

Listar inventário publicitário associado

Inventário optado e slots reutilizáveis dentro da associação do chamador. Nunca expõe capturas de tela, playlists ou dados de projeto do vendedor.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingJoinedInventory

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
seller_project_id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/networks/SELLER_PROJECT_ID/inventory'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Inventário e slots permitidos.	AdvertisingJoinedInventory (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/creatives¶

Listar criativos publicitários

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingCreatives

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/creatives'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Criativos.	AdvertisingCreativeList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/creatives¶

Criar criativo publicitário

Vincula uma revisão de mídia pronta e própria a um criativo imutável. Não copia bytes, não reenvia nem recarrega geração. Mídia desconhecida ou não pronta é rejeitada.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingCreativeCreate
ID da operação: createAdvertisingCreative

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
media_id (obrigatório, string)
copy (opcional, string)	maxLength: 500

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/creatives'

Respostas

Status	Significado	Corpo e cabeçalhos
201	Criativo.	AdvertisingCreative (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/creatives/{id}¶

Obter criativo publicitário

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingCreative

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/creatives/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Criativo.	AdvertisingCreative (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/seller-campaigns¶

Listar campanhas publicitárias do vendedor

As campanhas de comprador enviadas ao vendedor que chama, incluindo campanhas sem reproduções e o histórico após a revogação do acesso do comprador. Retorna no máximo 100 campanhas em ordem de identificador. Rascunhos, outras redes e orçamentos gerais do comprador são privados. Siga next_after com after até que ele esteja ausente.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingSellerCampaigns

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
depois	consulta	opcional	O next_after da página anterior.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/seller-campaigns'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanhas de comprador enviadas na rede deste vendedor.	AdvertisingSellerCampaignList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/seller-campaigns/{id}¶

Obter campanha publicitária do vendedor

A visão somente leitura do vendedor sobre uma campanha de comprador enviada. O inventário e a entrega consolidada de todo o período cobrem apenas o vendedor que chama. As finanças gerais do comprador e as outras redes são privadas. Um vendedor sem relação com a campanha recebe not_found.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingSellerCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/seller-campaigns/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Os detalhes de campanha e entrega do vendedor.	AdvertisingSellerCampaignDetail (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/campaigns¶

Listar campanhas publicitárias

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingCampaigns

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanhas.	AdvertisingCampaignList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns¶

Criar campanha publicitária

Cria uma campanha rascunho. Rascunhos não possuem dinheiro, não reservam nada e não autorizam entrega. A ativação requer uma cotação explicitamente aceita.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingCampaignDraft
ID da operação: createAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 120
category (opcional, AdvertisingCategory)	A categoria do anunciante. Dois anúncios da mesma categoria nunca são reproduzidos no mesmo intervalo de anúncios em uma tela; um anúncio sem categoria nunca é separado. Permitidos: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
daily_cap_mcr (obrigatório, McrString)	Quantidade exata de millicréditos como string decimal canônica. 1 crédito é 1000 mcr. pattern: "^-?[0-9]+$"
lifetime_cap_mcr (obrigatório, McrString)	Quantidade exata de millicréditos como string decimal canônica. 1 crédito é 1000 mcr. pattern: "^-?[0-9]+$"
image_duration_ms (opcional, inteiro)	Tempo de exibição da imagem em toda a campanha. Vídeos mantêm sua duração verificada pelo servidor. padrão: 10000 mínimo: 5000 máximo: 30000
max_play_price_mcr (opcional, inline)	Preço máximo positivo para reprodução concluída. Omitir para não ter teto adicional.
flight_start (obrigatório, string)	formato: "date-time"
flight_end (obrigatório, string)	formato: "date-time"
redes (obrigatório, array)

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns'

Respostas

Status	Significado	Corpo e cabeçalhos
201	Campanha rascunho.	AdvertisingCampaign (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/campaigns/{id}¶

Obter campanha publicitária

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha.	AdvertisingCampaign (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}¶

Atualizar campanha publicitária

Atualiza uma campanha rascunho. If-Match carrega a revisão da campanha. Redução de orçamento abaixo do já gasto mais reservas comprometidas é rejeitada com o valor mínimo permitido.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingCampaignDraft
ID da operação: updateAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 120
category (opcional, AdvertisingCategory)	A categoria do anunciante. Dois anúncios da mesma categoria nunca são reproduzidos no mesmo intervalo de anúncios em uma tela; um anúncio sem categoria nunca é separado. Permitidos: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
daily_cap_mcr (obrigatório, McrString)	Quantidade exata de millicréditos como string decimal canônica. 1 crédito é 1000 mcr. pattern: "^-?[0-9]+$"
lifetime_cap_mcr (obrigatório, McrString)	Quantidade exata de millicréditos como string decimal canônica. 1 crédito é 1000 mcr. pattern: "^-?[0-9]+$"
image_duration_ms (opcional, inteiro)	Tempo de exibição da imagem em toda a campanha. Vídeos mantêm sua duração verificada pelo servidor. padrão: 10000 mínimo: 5000 máximo: 30000
max_play_price_mcr (opcional, inline)	Preço máximo positivo para reprodução concluída. Omitir para não ter teto adicional.
flight_start (obrigatório, string)	formato: "date-time"
flight_end (obrigatório, string)	formato: "date-time"
redes (obrigatório, array)

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha atualizada.	AdvertisingCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/quote¶

Cotação de campanha publicitária

Precifica as taxas efetivas atuais da campanha, formatos, durações, período e limites antes da ativação. A cotação tem limite de tempo e fica obsoleta quando qualquer geração de preço ou taxa efetiva muda.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: quoteAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/quote'

Respostas

Status	Significado	Corpo e cabeçalhos
201	Cotação.	AdvertisingQuote (application/json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/activate¶

Ativar campanha publicitária

Aceita explicitamente a cotação atual nomeada e ativa a campanha. Verifica atomica e unicamente propriedade, associação, expiração da cotação, revisões de taxa, escopo aceito e negação de mesmo projeto, então registra os termos da compra. Não ocorre débito de carteira nem receita do vendedor ao aceitar os termos. A mesma chave com o mesmo corpo repete; um corpo alterado é conflito.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingQuoteAccept
ID da operação: activateAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.
Idempotency-Key	cabeçalho	opcional	Omitir para uma operação nova. Forneça e reutilize uma chave para deduplicar tentativas; o CLI gerencia as chaves automaticamente.

Campos do corpo da solicitação

Campo	Descrição
quote_id (obrigatório, string)

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/activate'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha ativa ou pendente de revisão.	AdvertisingCampaign (application/json)
409	quote_stale ou self_deal ou resource_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/pause¶

Pausar campanha publicitária

Pausa novas reservas para esta campanha. Anúncios válidos já iniciados normalmente terminam e são cobrados na conclusão.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: pauseAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/pause'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha pausada.	AdvertisingCampaign (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/resume¶

Retomar campanha publicitária

Retoma uma campanha pausada manualmente. Não pode liberar um bloqueio price_change_pending; uma recarga, tick de programação ou ação do vendedor não pode fornecer esse consentimento.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: resumeAdvertisingCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/resume'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha retomada.	AdvertisingCampaign (application/json)
409	price_change_pending - aceite as tarifas atuais primeiro.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/campaigns/{id}/accept-rates¶

Aceitar tarifas de publicidade

A aceitação explícita do comprador das taxas efetivas alteradas, vinculada ao ID da cotação, revisão da campanha e gerações atuais de preços. Substitui atomaticamente os termos futuros de entrega, registra o ator e o tempo, e limpa o bloqueio persistente de alteração de preço. Outra alteração concorrente de taxa deixa a campanha pausada.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingQuoteAccept
ID da operação: acceptAdvertisingRates

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Campos do corpo da solicitação

Campo	Descrição
quote_id (obrigatório, string)

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/campaigns/RESOURCE_ID/accept-rates'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha reativada.	AdvertisingCampaign (application/json)
409	price_change_pending ou quote_stale.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/reviews¶

Listar avaliações publicitárias

Versões criativas enviadas ao vendedor que chama para revisão. Um vendedor vê apenas a criativa enviada exata, nunca a biblioteca do comprador.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingReviews

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Revisões.	AdvertisingReviewList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/reviews/{id}/approve¶

Aprovar revisão de publicidade

Aprova uma revisão exata de criativo submetido. Aprovação não escolhe orçamento do comprador nem concede acesso à sua biblioteca de mídia. A pessoa deve poder aprovar revisões (approver_required). A mesma revisão também é acessível como tipo ad_creative em /api/reviews.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: approveAdvertisingReview

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/approve'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Revisão aprovada.	AdvertisingReview (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/reviews/{id}/reject¶

Rejeitar revisão de publicidade

Rejeita uma revisão exata de criação enviada com uma razão que o comprador lê na criação. Uma pessoa deve poder aprovar revisões (approver_required).

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingReviewRejection
ID da operação: rejectAdvertisingReview

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Campos do corpo da solicitação

Campo	Descrição
motivo (obrigatório, string)	minLength: 1 maxLength: 500

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/reject'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Revisão rejeitada.	AdvertisingReview (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/reports/spend¶

Obter gastos publicitários

Contagem de gastos e entregas do comprador para uma campanha. Os valores são strings decimais de mcr. Nunca expõe a renda do vendedor, status bancário ou uso do projeto inteiro.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingSpend

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
formato	consulta	opcional	json (padrão) retorna o relatório como JSON. csv, xlsx e pdf retornam as mesmas linhas como anexo (cada página de um relatório paginado, até 50000 linhas).
campaign_id	consulta	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/spend?campaign_id=CAMPAIGN_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Relatório de gastos.	AdvertisingSpendReport (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/reports/delivery¶

Obter entrega publicitária

Bruto, taxa de serviço e líquido no escopo do vendedor para uma janela, com sua própria evidência de entrega. Nunca expõe a carteira do comprador ou outras redes. Apenas evidência autorizada de reprodução completa estabelece entrega faturável. A janela tem no máximo 92 dias; janela maior é invalid_request.

Quando contém mais de 5000 liquidações, a resposta define truncado, totais e contagens ainda cobrem todos eles e linhas lista apenas os primeiros 5000.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingDelivery

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
formato	consulta	opcional	json (padrão) retorna o relatório como JSON. csv, xlsx e pdf retornam as mesmas linhas como anexo (cada página de um relatório paginado, até 50000 linhas).
de	consulta	obrigatório
até	consulta	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/delivery?from=FROM&to=TO'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Relatório de entrega.	AdvertisingDeliveryReport (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns¶

Listar campanhas diretas de publicidade

As campanhas diretas do vendedor que chama, da mais recente para a mais antiga, com seu ritmo.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: listAdvertisingDirectCampaigns

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanhas diretas.	AdvertisingDirectCampaignList (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns¶

Criar campanha direta de publicidade

Registra uma campanha direta, um acordo que o vendedor fez com um anunciante externo, sobre o inventário de anúncios do próprio vendedor. Ela não movimenta dinheiro; o vendedor cobra o anunciante e o preço é registrado para o valor do relatório. Fica ativa imediatamente e preenche antes das campanhas do marketplace.

Uma campanha com meta tem o ritmo distribuído uniformemente ao longo do período de veiculação e é reproduzida primeiro enquanto está atrás do ritmo; uma campanha sem meta ocupa todos os slots elegíveis durante o período de veiculação. Dois anúncios da mesma categoria nunca são reproduzidos no mesmo intervalo de anúncios em uma tela. Uma meta acima da estimativa de disponibilidade é recusada com goal_overbooked, a menos que overbook seja true.

A mesma chave com o mesmo corpo repete a resposta; um corpo alterado é um conflito.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingDirectCampaignDraft
ID da operação: createAdvertisingDirectCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
Idempotency-Key	cabeçalho	obrigatório

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 200
advertiser (obrigatório, string)	minLength: 1 maxLength: 200
category (opcional, AdvertisingCategory)	A categoria do anunciante. Dois anúncios da mesma categoria nunca são reproduzidos no mesmo intervalo de anúncios em uma tela; um anúncio sem categoria nunca é separado. Permitidos: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
flight_start (obrigatório, string)	formato: "date-time"
flight_end (obrigatório, string)	formato: "date-time"
goal_plays (opcional, integer)	As reproduções a entregar, com ritmo uniforme ao longo do período de veiculação. Zero ou omitido ocupa todos os slots elegíveis durante o período de veiculação. mínimo: 0 máximo: 1000000000000
price (opcional, AdvertisingDirectPrice)	O preço do acordo registrado pelo vendedor. O screenRIG nunca o cobra; ele dá valor ao relatório.
media_ids (obrigatório, array)	As imagens e os vídeos prontos do vendedor, cada um nomeado uma vez.
image_duration_ms (opcional, inteiro)	Tempo de exibição da imagem em toda a campanha. Vídeos mantêm sua duração verificada pelo servidor. padrão: 10000 mínimo: 5000 máximo: 30000
screen_ids (opcional, array)	Vazio significa todas as telas que optaram por participar.
slot_ids (opcional, array)	Vazio significa todos os slots ativados.
venue_types (opcional, array)
cities (opcional, array)
tags (opcional, array)
dayparts (opcional, array)
overbook (opcional, boolean)	Registra uma meta acima da estimativa de disponibilidade. Sem isso, a requisição é recusada com goal_overbooked. padrão: false

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Idempotency-Key: REQUEST_ID' --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns'

Respostas

Status	Significado	Corpo e cabeçalhos
201	Campanha direta.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — o plano do projeto não inclui campanhas diretas; required_plan nomeia o plano que as inclui.	Problema (application/problem+json)
409	goal_overbooked ou resource_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns/{id}¶

Obter campanha direta de publicidade

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingDirectCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha direta.	AdvertisingDirectCampaign (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}¶

Atualizar campanha direta de publicidade

Substitui os campos de rascunho da campanha. If-Match leva a revisão da campanha. As reproduções entregues são mantidas. As reproduções ainda a entregar são verificadas em relação à estimativa de disponibilidade, sem contar a reserva da própria campanha, e overbook as reserva mesmo assim.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingDirectCampaignDraft
ID da operação: updateAdvertisingDirectCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Campos do corpo da solicitação

Campo	Descrição
nome (obrigatório, string)	minLength: 1 maxLength: 200
advertiser (obrigatório, string)	minLength: 1 maxLength: 200
category (opcional, AdvertisingCategory)	A categoria do anunciante. Dois anúncios da mesma categoria nunca são reproduzidos no mesmo intervalo de anúncios em uma tela; um anúncio sem categoria nunca é separado. Permitidos: "alcohol", "apparel", "automotive", "beauty", "cannabis", "consumer_electronics", "education", "entertainment", "financial_services", "food_and_beverage", "gambling", "government", "grocery", "health_and_pharma", "home_and_garden", "insurance", "jobs", "legal", "media", "political", "quick_service_restaurants", "real_estate", "restaurants", "retail", "sports_and_fitness", "technology", "telecom", "tobacco_and_vaping", "travel", "utilities"
flight_start (obrigatório, string)	formato: "date-time"
flight_end (obrigatório, string)	formato: "date-time"
goal_plays (opcional, integer)	As reproduções a entregar, com ritmo uniforme ao longo do período de veiculação. Zero ou omitido ocupa todos os slots elegíveis durante o período de veiculação. mínimo: 0 máximo: 1000000000000
price (opcional, AdvertisingDirectPrice)	O preço do acordo registrado pelo vendedor. O screenRIG nunca o cobra; ele dá valor ao relatório.
media_ids (obrigatório, array)	As imagens e os vídeos prontos do vendedor, cada um nomeado uma vez.
image_duration_ms (opcional, inteiro)	Tempo de exibição da imagem em toda a campanha. Vídeos mantêm sua duração verificada pelo servidor. padrão: 10000 mínimo: 5000 máximo: 30000
screen_ids (opcional, array)	Vazio significa todas as telas que optaram por participar.
slot_ids (opcional, array)	Vazio significa todos os slots ativados.
venue_types (opcional, array)
cities (opcional, array)
tags (opcional, array)
dayparts (opcional, array)
overbook (opcional, boolean)	Registra uma meta acima da estimativa de disponibilidade. Sem isso, a requisição é recusada com goal_overbooked. padrão: false

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha direta atualizada.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — o plano do projeto não inclui campanhas diretas; required_plan nomeia o plano que as inclui.	Problema (application/problem+json)
409	goal_overbooked ou resource_conflict.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}/pause¶

Pausar campanha direta de publicidade

Interrompe novas reproduções de uma campanha ativa. As reproduções entregues e o período de veiculação são mantidos. Uma campanha pausada ou encerrada é um resource_conflict.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: pauseAdvertisingDirectCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/pause'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha direta pausada.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}/resume¶

Retomar campanha direta de publicidade

Retoma uma campanha direta pausada. Uma campanha com meta que ficou atrás do ritmo enquanto estava pausada é reproduzida primeiro até voltar ao ritmo. Uma campanha ativa ou encerrada é um resource_conflict.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: resumeAdvertisingDirectCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/resume'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha direta retomada.	AdvertisingDirectCampaign (application/json)
402	feature_not_in_plan — o plano do projeto não inclui campanhas diretas; required_plan nomeia o plano que as inclui.	Problema (application/problem+json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/direct-campaigns/{id}/end¶

Encerrar campanha direta de publicidade

Encerra uma campanha ativa ou pausada antes do fim do período de veiculação. Uma campanha encerrada não é mais reproduzida e mantém seu relatório.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: endAdvertisingDirectCampaign

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
If-Match	cabeçalho	opcional	Revisão positiva opcional do recurso. Omitir para escrever o recurso atual; uma revisão obsoleta fornecida é revision_conflict.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/end'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Campanha direta encerrada.	AdvertisingDirectCampaign (application/json)
412	revision_conflict.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/direct-campaigns/{id}/report¶

Obter relatório da campanha direta de publicidade

A entrega de uma campanha direta em uma janela, com seu ritmo, o valor registrado das reproduções entregues e linhas por dia UTC, tela, slot e mídia. Sem from e to, a janela é todo o período de veiculação. Quando a janela contém mais linhas do que o relatório lista, a resposta define truncated e os totais ainda cobrem todas as reproduções.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingDirectCampaignReport

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
formato	consulta	opcional	json (padrão) retorna o relatório como JSON. csv, xlsx e pdf retornam as mesmas linhas como anexo (cada página de um relatório paginado, até 50000 linhas).
id	caminho	obrigatório
de	consulta	opcional
até	consulta	opcional

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/direct-campaigns/RESOURCE_ID/report'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Relatório da campanha direta.	AdvertisingDirectReport (application/json)
402	feature_not_in_plan — o plano do projeto não inclui campanhas diretas; required_plan nomeia o plano que as inclui.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/availability¶

Estimar disponibilidade de publicidade

Estima as reproduções que uma meta direta pode reservar no inventário e no período de veiculação informados. É uma leitura e não altera nada. A estimativa são as ocorrências recentes de slot de anúncio das telas segmentadas projetadas sobre o período de veiculação, menos as metas que outras campanhas diretas ainda precisam nas mesmas telas.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: AdvertisingAvailabilityQuery
ID da operação: estimateAdvertisingAvailability

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.

Campos do corpo da solicitação

Campo	Descrição
screen_ids (opcional, array)	Vazio significa todas as telas que optaram por participar.
slot_ids (opcional, array)	Vazio significa todos os slots ativados.
venue_types (opcional, array)
cities (opcional, array)
tags (opcional, array)
dayparts (opcional, array)
flight_start (obrigatório, string)	formato: "date-time"
flight_end (obrigatório, string)	formato: "date-time"
exclude_campaign_id (opcional, string)	Exclui de booked_plays a reserva desta própria campanha direta, para uma edição.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/availability'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Estimativa de disponibilidade.	AdvertisingAvailability (application/json)
402	feature_not_in_plan — o plano do projeto não inclui campanhas diretas; required_plan nomeia o plano que as inclui.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/reports/fill¶

Obter estatísticas de preenchimento de publicidade

Oferta de espaços de anúncio do vendedor solicitante para uma janela, por dia UTC e no total. Cada ocorrência é preenchida por campanha direta, do mercado ou pela tag VAST, ou fica sem preenchimento com seu motivo. A janela solicitada é de no máximo 35 dias, por padrão os últimos 7. A oferta tem precisão horária.

Todas as horas UTC que sobrepõem a janela semiaberta solicitada são incluídas integralmente; from é arredondado para baixo e to para cima nos limites horários UTC. Um to já alinhado continua exclusivo. A resposta retorna esses limites efetivos, que podem abranger até 35 dias mais uma hora.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingFillStats

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
formato	consulta	opcional	json (padrão) retorna o relatório como JSON. csv, xlsx e pdf retornam as mesmas linhas como anexo (cada página de um relatório paginado, até 50000 linhas).
de	consulta	opcional
até	consulta	opcional

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reports/fill'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Estatísticas de preenchimento.	AdvertisingFillStats (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/reviews/{id}¶

Obter revisão publicitária

Detalhe do vendedor para uma revisão da sua rede. Retorna a revisão e a versão exata do criativo submetido. Nunca expõe outras mídias do comprador.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingReview

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Revisão e seu criativo.	AdvertisingReviewDetail (application/json)
404	not_found - a avaliação é desconhecida para este vendedor.	Problema (application/problem+json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

GET/api/advertising/reviews/{id}/content¶

Obter conteúdo de revisão publicitária

Transmite apenas a revisão exata do criativo que a revisão deste vendedor refere. Propriedade permanece com o projeto comprador; nenhuma chave de objeto ou local assinado é divulgado, e nenhuma outra mídia do comprador é acessível. O ETag é o SHA-256 forte do criativo e nunca muda para uma revisão.

A resposta de uma sessão do painel é privada, no-cache, então o navegador mantém uma cópia e a revalida; a resposta de um portador de projeto permanece privada, no-store.

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: nenhum
ID da operação: getAdvertisingReviewContent

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
Intervalo	cabeçalho	opcional	V1 aceita apenas um intervalo de byte.
If-None-Match	cabeçalho	opcional	ETag SHA-256 forte do criativo retornado por esta rota.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request GET --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Os bytes exatos do criativo da revisão.	sem corpo; cabeçalhos: Accept-Ranges, Content-Length, ETag, Cache-Control
206	Um intervalo de bytes correto segundo o padrão.	sem corpo; cabeçalhos: Content-Range, ETag, Cache-Control
304	O ETag do criativo corresponde ao If-None-Match, verificado após a revisão ser resolvida no projeto do vendedor. Nenhum corpo ou incremento de saída é produzido.	sem corpo; cabeçalhos: ETag, Cache-Control
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

HEAD/api/advertising/reviews/{id}/content¶

Revisão de conteúdo de publicidade principal

Autenticação: projectBearer
Corpo da solicitação: nenhum
ID da operação: headAdvertisingReviewContent

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório
Intervalo	cabeçalho	opcional	V1 aceita apenas um intervalo de byte.

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request HEAD --header 'Authorization: Bearer [SCREENRIG_TOKEN]' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/content'

Respostas

Status	Significado	Corpo e cabeçalhos
200	Apenas metadados.	sem corpo; cabeçalhos: Content-Length, ETag
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)

POST/api/advertising/reviews/{id}/request-changes¶

Solicitar alterações na revisão de publicidade

O vendedor pede ao comprador mudanças em uma revisão criativa enviada. A revisão torna-se changes_requested com a nota em reason; o comprador a lê na criativa, e a próxima revisão que a campanha abre para esse vendedor vincula previous_review_id. Uma pessoa deve poder aprovar revisões (approver_required).

Autenticação: projectBearer OU dashboardSession
Corpo da solicitação: ReviewChangesRequest
ID da operação: requestAdvertisingReviewChanges

Parâmetros

Nome	Enviar	Obrigatório?	Descrição
ScreenRig-Project	cabeçalho	opcional	Obsoleto por uma versão. Deve ser consistente com as concessões de projetos JWT; adiciona cabeçalhos Deprecation e Warning. Sem troca de token.
id	caminho	obrigatório

Campos do corpo da solicitação

Campo	Descrição
nota (obrigatório, string)	minLength: 1 maxLength: 500

Modelo e respostas da solicitação

shell · modelo de requisição

curl --request POST --header 'Authorization: Bearer [SCREENRIG_TOKEN]' --cookie cookies.txt --cookie-jar cookies.txt --header 'Content-Type: application/json' --data '@request.json' 'https://screenrig.ai/api/advertising/reviews/RESOURCE_ID/request-changes'

Respostas

Status	Significado	Corpo e cabeçalhos
200	A revisão, estado changes_requested.	AdvertisingReview (application/json)
padrão	Resposta de problema estável RFC 9457. Um 421 server_draining tem Retry-After de 1 segundo, um 500 not_ready ou dependency_unavailable tem 5, e um 500 manifest_degraded tem 60, a menos que o handler defina valor mais específico.	Problema (application/problem+json)