Serviços de Mídia HHS (Editor Independente) (versão prévia)
O Departamento de Saúde e Serviço Humano criou uma maneira fácil para os parceiros de saúde pública acessarem recursos digitais produzidos pelo governo federal - incluindo conteúdo da Web, imagens, vídeo, dados, infográficos e muito mais - para uso em sites, aplicativos e mídias sociais. A sindicalização permite que os recursos baseados em ciência sejam combinados com informações em níveis estaduais e locais, compartilhando mensagens de integridade para o máximo impacto.
Esse conector está disponível nos seguintes produtos e regiões:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Aplicativos Lógicos | Standard | Todas as regiões dos Aplicativos Lógicos , exceto as seguintes: – Regiões do Azure Governamental - Regiões do Azure China - Departamento de Defesa dos EUA (DoD) |
| Power Apps | Premium | Todas as regiões do Power Apps , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Power Automate | Premium | Todas as regiões do Power Automate , exceto as seguintes: – Governo dos EUA (GCC) – Governo dos EUA (GCC High) - China Cloud operado pela 21Vianet - Departamento de Defesa dos EUA (DoD) |
| Contato | |
|---|---|
| Nome | Troy Taylor |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| Metadados do conector | |
|---|---|
| Publicador | Troy Taylor |
| Site da Web | https://digitalmedia.hhs.gov/ |
| Política de privacidade | https://www.hhs.gov/privacy.html |
| Categorias | Dados |
Limitações
| Nome | Chamadas | Período de renovação |
|---|---|---|
| Chamadas à API por conexão | 100 | 60 segundos |
Ações
| Obter a lista de mídia do usuário |
Recupere uma lista de mídia para um usuário específico. |
| Obter campanha |
Recupere informações sobre uma campanha específica. |
| Obter campanhas |
Recupere as listagens de mídia para uma campanha específica. |
| Obter conteúdo do item de mídia |
Recupere o conteúdo de um item de mídia. |
| Obter conteúdo em destaque |
Recupere uma lista de conteúdo em destaque no sistema de sindicalização. |
| Obter conteúdo sindicalizado do item de mídia |
Recupere uma lista de conteúdo sindicalizado para um item de mídia. |
| Obter código de inserção de item de mídia |
Recupere o código de inserção JavaScript ou iFrame para este item de mídia (para inserir em uma página da Web). |
| Obter fontes |
Recupere uma lista de fontes disponíveis. |
| Obter idioma |
Recupere informações sobre um idioma específico. |
| Obter idiomas de marca |
Recupere uma lista de idiomas de marca. |
| Obter item de mídia |
Recupere informações sobre um item de mídia específico. |
| Obter itens de mídia |
Recupere uma lista de itens de mídia. |
| Obter itens de mídia de marca |
Recupere uma lista de itens de mídia para uma marca específica. |
| Obter itens de mídia de origem |
Recupere os itens de mídia de uma origem. |
| Obter itens de mídia para a campanha |
Recupere os itens de mídia para uma campanha específica. |
| Obter itens de mídia populares |
Recupere uma lista da mídia com as classificações mais altas. |
| Obter itens de mídia relacionados |
Recupere as outras mídias relacionadas ao item de mídia. |
| Obter itens do sindicato de marcas |
Recupere uma lista de itens do sindicato para uma marca específica. |
| Obter itens do sindicato para a campanha |
Recupere os itens do sindicato para uma campanha específica. |
| Obter linguagens |
Recupere uma lista de idiomas disponíveis. |
| Obter marca |
Recupere informações sobre uma marca específica. |
| Obter marcas |
Recupere uma lista de marcas disponíveis. |
| Obter marcas relacionadas |
Recupera informações sobre marcas relacionadas a uma marca específica. |
|
Obter metadados do You |
Recupere os metadados do YouTube para um item de mídia. |
| Obter miniatura JPG do item de mídia |
Recupere a miniatura JPG do item de conteúdo (quando aplicável). |
| Obter origem |
Recupere informações sobre uma fonte específica. |
| Obter tipos de mídia |
Recupere uma lista de tipos de mídia. |
| Obter tipos de mídia de marca |
Recupere uma lista de tipos de mídia para uma marca específica. |
| Obter visualização de marca |
Recupere a visualização JPG do item de conteúdo (quando aplicável). |
| Pesquisar itens de mídia |
Recupere uma lista de itens de mídia que correspondam à consulta de pesquisa. |
Obter a lista de mídia do usuário
Recupere uma lista de mídia para um usuário específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
|
Método de exibição
|
displayMethod | string |
Método usado para renderizar uma solicitação HTML. Aceita um: mv, lista, feed. |
Retornos
- Corpo
- MediaItemWrapped
Obter campanha
Recupere informações sobre uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
Retornos
- Corpo
- CampaignWrapped
Obter campanhas
Recupere as listagens de mídia para uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
O deslocamento dos registros definidos para retornar para paginação. |
|
|
Classificar
|
sort | string |
Conjunto de campos para classificar os registros. |
Retornos
- Corpo
- CampaignWrapped
Obter conteúdo do item de mídia
Recupere o conteúdo de um item de mídia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da mídia para a qual mostrar o conteúdo. |
|
Chamado por build
|
calledByBuild | boolean |
O método que chamou esse método. |
Retornos
- response
- string
Obter conteúdo em destaque
Recupere uma lista de conteúdo em destaque no sistema de sindicalização.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
Retornos
- Corpo
- MediaItem
Obter conteúdo sindicalizado do item de mídia
Recupere uma lista de conteúdo sindicalizado para um item de mídia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da mídia para a qual mostrar o código de inserção. |
|
Classe CSS
|
cssClass | string |
A classe CSS a ser direcionada para extração. |
|
|
Estilos de faixa
|
stripStyles | boolean |
Remova estilos em linha do conteúdo. |
|
|
Remover scripts
|
stripScripts | boolean |
Remova marcas de script do conteúdo. |
|
|
Remover imagens
|
stripImages | boolean |
Remova marcas de imagem do conteúdo. |
|
|
Intervalos de tiras
|
stripBreaks | boolean |
Remova marcas de interrupção do conteúdo. |
|
|
Strip Classes
|
stripClasses | boolean |
Remover atributos de classe do conteúdo (exceto 'union'). |
|
|
Tamanho da fonte
|
font-size | integer |
Defina o tamanho da fonte (em pontos) de marcas p, div e span. |
|
|
Float de imagem
|
imageFloat | string |
Aceita opções de float CSS válidas, como "esquerda" ou "direita". Injetará um estilo no conteúdo antes da renderização. |
|
|
Margem de Imagem
|
imageMargin | string |
Aceita 4 valores CSV que representam tamanhos de pixel de margem semelhantes ao CSS. O formato padrão é "norte, leste, sul, oeste" - por exemplo, "0,10,10,0" colocaria uma margem de 10 pixels nos lados direito e inferior de uma imagem. Injetará um estilo no conteúdo antes da renderização. |
|
|
Reprodução automática
|
autoplay | boolean |
Se o conteúdo for um vídeo, o vídeo inserido será reproduzido automaticamente quando carregado. |
|
|
Related
|
rel | boolean |
Se o conteúdo for um vídeo, os itens relacionados serão mostrados no final da reprodução. |
Retornos
Obter código de inserção de item de mídia
Recupere o código de inserção JavaScript ou iFrame para este item de mídia (para inserir em uma página da Web).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da mídia para a qual obter o código de inserção. |
|
Sabor
|
flavor | string |
Atualmente, dá suporte a 'iframe', o padrão é 'javascript'. |
|
|
Largura
|
width | integer |
A largura do iFrame gerado. |
|
|
Altura
|
height | integer |
A altura do iFrame gerado. |
|
|
Nome do iFrame
|
iframeName | string |
O nome do elemento iFrame. |
|
|
Excluir jQuery
|
excludeJquery | boolean |
Uma referência à Biblioteca JQuery deve ser omitida?. |
|
|
Excluir Div
|
excludeDiv | boolean |
O div no qual inserir o conteúdo deve ser omitido?. |
|
|
Div ID
|
divId | string |
O div no qual inserir o conteúdo deve ter um nome específico?. |
|
|
Método de exibição
|
displayMethod | string |
Método usado para renderizar uma solicitação HTML. Aceita um: mv, lista, feed. |
Retornos
- response
- string
Obter fontes
Recupere uma lista de fontes disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
|
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
Retornos
- Corpo
- SourceWrapped
Obter idioma
Recupere informações sobre um idioma específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do idioma a ser pesquisado. |
Retornos
- Corpo
- LanguageWrapped
Obter idiomas de marca
Obter item de mídia
Recupere informações sobre um item de mídia específico.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens de mídia
Recupere uma lista de itens de mídia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
O deslocamento dos registros definidos para retornar para paginação. |
|
|
Classificar
|
sort | string |
Conjunto de campos para classificar os registros. |
|
|
Pedido
|
order | string |
A ordem crescente ou decrescente. |
|
|
Tipos de mídia
|
mediaTypes | string |
Localize todos os itens de mídia pertencentes aos tipos de mídia especificados. |
|
|
Nome
|
name | string |
Localize todos os itens de mídia que contêm o nome fornecido, não diferenciando maiúsculas de minúsculas. |
|
|
ID da coleção
|
collectionId | integer |
Restrinja a filtragem a itens de mídia em uma coleção específica. |
|
|
O nome contém
|
nameContains | string |
Localize todos os itens de mídia que contêm o nome parcial, não diferenciando maiúsculas de minúsculas. |
|
|
A descrição contém
|
descriptionContains | string |
Localize todos os itens de mídia que contêm a descrição parcial fornecida, não diferenciando maiúsculas de minúsculas. |
|
|
URL de origem
|
sourceUrl | string |
Localize todos os itens de mídia que tenham o sourceUrl fornecido, que não diferencia maiúsculas de minúsculas. |
|
|
A URL de origem contém
|
sourceUrlContains | string |
Localize todos os itens de mídia que contêm o sourceUrl parcial fornecido, não diferencia maiúsculas de minúsculas. |
|
|
URL de Miniatura Personalizada
|
customThumbnailUrl | string |
Localize todos os itens de mídia que tenham o customThumbnailUrl fornecido, sem diferenciar maiúsculas de minúsculas. |
|
|
A URL de Miniatura Personalizada contém
|
customThumbnailUrlContains | string |
Localize todos os itens de mídia que contêm o customThumbnailUrl parcial fornecido, não diferencia maiúsculas de minúsculas. |
|
|
Conteúdo de data criado
|
dateContentAuthored | date |
Encontre todos os itens de mídia criados no dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo de data atualizado
|
dateContentUpdated | date |
Encontre todos os itens de mídia atualizados no dia fornecido (RFC 3339, hora ignorada). |
|
|
Conteúdo de data publicado
|
dateContentPublished | date |
Encontre todos os itens de mídia publicados no dia fornecido (RFC 3339, hora ignorada). |
|
|
Conteúdo de data revisado
|
dateContentReviewed | date |
Encontre todos os itens de mídia revisados no dia fornecido (RFC 3339, tempo ignorado). |
|
|
Sindicalização de data capturada
|
dateSyndicationCaptured | date |
Encontre todos os itens de mídia sindicalizados no dia fornecido (RFC 3339, hora ignorada). |
|
|
Sindicalização de data atualizada
|
dateSyndicationUpdated | date |
Encontre todos os itens de mídia atualizados por meio do sistema de sindicalização no dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo criado desde a data
|
contentAuthoredSinceDate | date |
Encontre todos os itens de mídia criados desde o dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo criado antes da data
|
contentAuthoredBeforeDate | date |
Encontre todos os itens de mídia criados antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo criado no intervalo
|
contentAuthoredInRange | string |
Encontre todos os itens de mídia criados entre os dias de início e término fornecidos (RFC 3339, separados por vírgula, tempo ignorado). |
|
|
Conteúdo atualizado desde a data
|
contentUpdatedSinceDate | date |
Encontre todos os itens de mídia atualizados desde o dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo atualizado antes da data
|
contentUpdatedBeforeDate | date |
Encontre todos os itens de mídia atualizados antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo atualizado no intervalo
|
contentUpdatedInRange | string |
Encontre todos os itens de mídia atualizados entre os dias de início e término fornecidos (RFC 3339, separado por vírgula, tempo ignorado). |
|
|
Conteúdo publicado desde a data
|
contentPublishedSinceDate | date |
Encontre todos os itens de mídia atualizados desde o dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo publicado antes da data
|
contentPublishedBeforeDate | date |
Encontre todos os itens de mídia publicados antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo publicado no intervalo
|
contentPublishedInRange | string |
Encontre todos os itens de mídia publicados entre os dias de início e término fornecidos (RFC 3339, separado por vírgula, tempo ignorado). |
|
|
Conteúdo revisado desde a data
|
contentReviewedSinceDate | date |
Encontre todos os itens de mídia revisados desde o dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo revisado antes da data
|
contentReviewedBeforeDate | date |
Encontre todos os itens de mídia revisados antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Conteúdo revisado no intervalo
|
contentReviewedInRange | string |
Encontre todos os itens de mídia revisados entre os dias de início e término fornecidos (RFC 3339, separado por vírgula, tempo ignorado). |
|
|
Sindicalização capturada desde a data
|
syndicationCapturedSinceDate | date |
Encontre todos os itens de mídia criados desde o dia fornecido (RFC 3339, tempo ignorado). |
|
|
Sindicalização capturada antes da data
|
syndicationCapturedBeforeDate | date |
Encontre todos os itens de mídia criados antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Sindicalização capturada no intervalo
|
syndicationCapturedInRange | string |
Encontre todos os itens de mídia criados entre os dias de início e término fornecidos (RFC 3339, separados por vírgula, tempo ignorado). |
|
|
Sindicalização atualizada desde a data
|
syndicationUpdatedSinceDate | date |
Encontre todos os itens de mídia atualizados desde o dia fornecido(RFC 3339, tempo ignorado). |
|
|
Sindicalização atualizada antes da data
|
syndicationUpdatedBeforeDate | date |
Encontre todos os itens de mídia atualizados antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Sindicalização atualizada no intervalo
|
syndicationUpdatedInRange | string |
Encontre todos os itens de mídia atualizados entre os dias de início e término fornecidos (RFC 3339, separado por vírgula, tempo ignorado). |
|
|
Sindicalização visível desde a data
|
syndicationVisibleSinceDate | date |
Encontre todos os itens de mídia visíveis desde o dia fornecido(RFC 3339, tempo ignorado). |
|
|
Sindicalização Visível Antes da Data
|
syndicationVisibleBeforeDate | date |
Encontre todos os itens de mídia visíveis antes do dia fornecido (RFC 3339, tempo ignorado). |
|
|
Sindicalização Visível no Intervalo
|
syndicationVisibleInRange | date |
Localize todos os itens de mídia visíveis entre os dias de início e término fornecidos (RFC 3339, separado por vírgula, tempo ignorado). |
|
|
ID do idioma
|
languageId | integer |
Localize todos os itens de mídia escritos no idioma especificado pelo identificador. |
|
|
Nome da linguagem
|
languageName | string |
Localize todos os itens de mídia escritos no idioma especificado pelo nome, sem diferenciar maiúsculas de minúsculas. |
|
|
Código ISO de linguagem
|
languageIsoCode | string |
Localize todos os itens de mídia escritos na linguagem especificada pelo código ISO 639-2, não diferencia maiúsculas de minúsculas. |
|
|
Hash
|
hash | string |
Localize todos os itens de mídia que correspondam ao hash fornecido, não diferenciando maiúsculas de minúsculas. |
|
|
Contém hash
|
hashContains | string |
Localize todos os itens de mídia que correspondam ao hash parcial fornecido, não diferenciando maiúsculas de minúsculas. |
|
|
ID de origem
|
sourceId | integer |
Localize todos os itens de mídia que pertencem à origem especificada pelo identificador. |
|
|
Nome da origem
|
sourceName | string |
Localize todos os itens de mídia que pertencem à origem especificada pelo nome, sem diferenciar maiúsculas de minúsculas. |
|
|
O nome de origem contém
|
sourceNameContains | string |
Localize todos os itens de mídia que pertencem à origem especificada pelo nome parcial, não diferenciando maiúsculas de minúsculas. |
|
|
Acrônimo de origem
|
sourceAcronym | string |
Localize todos os itens de mídia que pertencem à origem especificada pelo acrônimo, que não diferencia maiúsculas de minúsculas. |
|
|
O acrônimo de origem contém
|
sourceAcronymContains | string |
Localize todos os itens de mídia que pertencem à origem especificada pelo acrônimo parcial, que não diferencia maiúsculas de minúsculas. |
|
|
IDs de marca
|
tagIds | string |
Localize apenas os itens de mídia marcados com as IDs de marca especificadas. |
|
|
Restringir para definir
|
restrictToSet | string |
Localize apenas a mídia de dentro da lista de IDs fornecida. |
|
|
Criado por
|
createdBy | string |
Localize todos os itens de mídia que contêm o valor createdBy. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens de mídia de marca
Recupere uma lista de itens de mídia para uma marca específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da marca a ser pesquisada. |
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens de mídia de origem
Recupere os itens de mídia de uma origem.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
|
Método de exibição
|
displayMethod | string |
Método usado para renderizar uma solicitação HTML. Aceita um: mv, lista, feed. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens de mídia para a campanha
Recupere os itens de mídia para uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da campanha para o qual localizar itens de mídia. |
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
O deslocamento dos registros definidos para retornar para paginação. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens de mídia populares
Recupere uma lista da mídia com as classificações mais altas.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
O deslocamento dos registros definidos para retornar para paginação. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens de mídia relacionados
Recupere as outras mídias relacionadas ao item de mídia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do item de mídia para o qual obter mídia relacionada. |
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
|
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
Retornos
- Corpo
- MediaItemWrapped
Obter itens do sindicato de marcas
Recupere uma lista de itens do sindicato para uma marca específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
|
Método de exibição
|
displayMethod | string |
Método usado para renderizar uma solicitação HTML. Aceita um: mv, lista, feed. |
Retornos
- response
- string
Obter itens do sindicato para a campanha
Recupere os itens do sindicato para uma campanha específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
|
Método de exibição
|
displayMethod | string |
Método usado para renderizar uma solicitação HTML. Aceita um: mv, lista, feed. |
Retornos
Obter linguagens
Recupere uma lista de idiomas disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
|
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
Retornos
- Corpo
- LanguageWrapped
Obter marca
Recupere informações sobre uma marca específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do registro a ser pesquisado. |
Retornos
- Corpo
- TagMarshallerWrapped
Obter marcas
Recupere uma lista de marcas disponíveis.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
|
|
Nome
|
name | string |
Retornar marcas que correspondam ao nome fornecido. |
|
|
O nome contém
|
nameContains | string |
Retornar marcas que contêm o nome parcial fornecido. |
|
|
ID de mídia
|
mediaId | integer |
Retornar marcas associadas ao identificador de mídia fornecido. |
|
|
ID do tipo
|
typeId | integer |
Retornar marcas pertencentes ao identificador de tipo de marca fornecido. |
|
|
Nome do Tipo
|
typeName | string |
Retornar marcas pertencentes ao nome de tipo de marca fornecido. |
Retornos
- Corpo
- TagMarshallerWrapped
Obter marcas relacionadas
Recupera informações sobre marcas relacionadas a uma marca específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da marca a ser pesquisada. |
|
Classificar
|
sort | string |
O nome da propriedade à qual a classificação será aplicada. |
|
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
Retornar registros começando no índice de deslocamento. |
Retornos
- Corpo
- TagMarshallerWrapped
Obter metadados do YouTube do item de mídia
Recupere os metadados do YouTube para um item de mídia.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador do vídeo para o qual mostrar metadados. |
Retornos
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
retorno de chamada
|
callback | string | |
|
results
|
results | array of YoutubeMetadata |
Obter miniatura JPG do item de mídia
Recupere a miniatura JPG do item de conteúdo (quando aplicável).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da mídia para a qual obter uma miniatura. |
Retornos
- response
- object
Obter origem
Recupere informações sobre uma fonte específica.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da origem a ser pesquisada. |
Retornos
- Corpo
- SourceWrapped
Obter tipos de mídia
Obter tipos de mídia de marca
Recupere uma lista de tipos de mídia para uma marca específica.
Retornos
- Corpo
- TagTypeMarshallerWrapped
Obter visualização de marca
Recupere a visualização JPG do item de conteúdo (quando aplicável).
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
ID
|
id | True | integer |
O identificador da mídia para a qual obter uma visualização. |
Retornos
- response
- object
Pesquisar itens de mídia
Recupere uma lista de itens de mídia que correspondam à consulta de pesquisa.
Parâmetros
| Nome | Chave | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
Consulta de pesquisa
|
q | True | string |
A consulta de pesquisa fornecida pelo usuário. |
|
Máximo
|
max | integer |
O número máximo de registros a serem retornados. |
|
|
Offset
|
offset | integer |
O deslocamento dos registros definidos para retornar para paginação. |
Retornos
- Corpo
- MediaItemWrapped
Definições
MediaItem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Tipo de mídia
|
mediaType | string |
O tipo de mídia. |
|
Description
|
description | string |
A descrição. |
|
URL de origem
|
sourceUrl | string |
O endereço de URL de origem. |
|
URL de Atribuição Personalizada
|
customAttributionUrl | string |
O endereço de URL de atribuição personalizado. |
|
Campanha
|
campaigns | array of Campaign |
A campanha. |
|
URL de Destino
|
targetUrl | string |
O endereço de URL de destino. |
|
URL de Miniatura Personalizada
|
customThumbnailUrl | string |
O endereço de URL de miniatura personalizado. |
|
URL de visualização personalizada
|
customPreviewUrl | string |
O endereço de URL de visualização personalizado. |
|
Conteúdo de data criado
|
dateContentAuthored | date |
A data em que o conteúdo foi criado. |
|
Conteúdo de data atualizado
|
dateContentUpdated | date |
O conteúdo da data foi atualizado. |
|
Conteúdo de data publicado
|
dateContentPublished | date |
O conteúdo da data foi publicado. |
|
Conteúdo de data revisado
|
dateContentReviewed | date |
O conteúdo da data revisado. |
|
Sindicalização de data capturada
|
dateSyndicationCaptured | date |
A sindicalização de data capturada. |
|
Sindicalização de data atualizada
|
dateSyndicationUpdated | date |
A sindicalização da data foi atualizada. |
|
Sindicalização de data visível
|
dateSyndicationVisible | date |
A sindicalização da data estava visível. |
|
linguagem
|
language | Language | |
|
GUID externo
|
externalGuid | string |
O GUID externo. |
|
Hash
|
hash | string |
O hash. |
|
fonte
|
source | Source | |
|
Criado por
|
createdBy | string |
O criado por. |
|
URL de Sindicalização Estrangeira
|
foreignSyndicationAPIUrl | string |
O endereço de URL da API de sindicalização estrangeira. |
|
extendedAttributes
|
extendedAttributes | ExtendedAttribute |
Source
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Acrônimo
|
acronym | string |
O acrônimo. |
|
URL do site
|
websiteUrl | string |
O endereço da URL do site. |
|
URL de logotipo grande
|
largeLogoUrl | string |
O endereço de URL do logotipo grande. |
|
URL do logotipo pequeno
|
smallLogoUrl | string |
O endereço de URL do logotipo pequeno. |
|
Email de contato
|
contactEmail | string |
O endereço de email de contato. |
Linguagem
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Código ISO
|
isoCode | string |
O código ISO. |
|
Está ativo
|
isActive | boolean |
Se está ativo. |
ExtendedAttribute
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Value
|
value | string |
O valor. |
Campanha
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Description
|
description | string |
A descrição. |
|
Data de Início
|
startDate | date |
A data de início. |
|
Data de Término
|
endDate | date |
A data de término. |
|
fonte
|
source | Source | |
|
Email de contato
|
contactEmail | string |
O endereço de email de contato. |
Paginação
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Máximo
|
max | integer |
O máximo. |
|
Offset
|
offset | integer |
O deslocamento. |
|
Contagem
|
count | integer |
A contagem. |
|
Total
|
total | integer |
O total. |
|
Número da Página
|
pageNum | integer |
O número da página. |
|
Total de Páginas
|
totalPages | integer |
O número total de páginas. |
|
Classificar
|
sort | string |
A classificação. |
|
URL atual
|
currentUrl | string |
O endereço de URL atual. |
|
Próxima URL
|
nextUrl | string |
O próximo endereço de URL. |
|
Endereço de URL anterior
|
previousUrl | string |
O endereço de URL anterior. |
Meta
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Situação
|
status | integer |
O status. |
|
Message
|
messages | array of Message |
A mensagem. |
|
paginação
|
pagination | Pagination |
Message
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Mensagem de erro
|
errorMessage | string |
A mensagem de erro. |
|
Detalhes do erro
|
errorDetail | string |
O detalhe do erro. |
|
Código de erro
|
errorCode | string |
O código de erro. |
|
Mensagem do usuário
|
userMessage | string |
A mensagem do usuário. |
YoutubeMetadata
MediaTypeHolder
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Nome
|
name | string |
O nome. |
|
Description
|
description | string |
A descrição. |
TagTypeMarshaller
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
TagLanguageMarshaller
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
Código ISO
|
isoCode | string |
O código ISO. |
|
Está ativo
|
isActive | boolean |
Se está ativo. |
SyndicateMarshaller
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
Content
|
content | string |
O conteúdo. |
|
Description
|
description | string |
A descrição. |
|
ID
|
id | integer |
O identificador. |
|
Tipo de mídia
|
mediaType | string |
O tipo de mídia. |
|
Nome
|
name | string |
O nome. |
|
URL de origem
|
sourceUrl | string |
O endereço de URL de origem. |
TagMarshaller
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
ID
|
id | integer |
O identificador. |
|
Nome
|
name | string |
O nome. |
|
linguagem
|
language | TagLanguageMarshaller | |
|
tipo
|
type | TagTypeMarshaller |
MediaItemWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Item de Mídia
|
results | array of MediaItem |
O item de mídia. |
SourceWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Source
|
results | array of Source |
A origem. |
LanguageWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Linguagem
|
results | array of Language |
O idioma. |
CampaignWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Campanha
|
results | array of Campaign |
A campanha. |
MediaTypeHolderWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Titular do tipo de mídia
|
results | array of MediaTypeHolder |
O titular do tipo de mídia. |
TagTypeMarshallerWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Marshaller de Tipo de Marca
|
results | array of TagTypeMarshaller |
O marshaller de tipo de marca. |
TagLanguageMarshallerWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Tag Language Marshaller
|
results | array of TagLanguageMarshaller |
O marshaller de linguagem de marca. |
SyndicateMarshallerWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Marshaller do Sindicato
|
results | array of SyndicateMarshaller |
O marshaller do sindicato. |
TagMarshallerWrapped
| Nome | Caminho | Tipo | Description |
|---|---|---|---|
|
meta
|
meta | Meta | |
|
Callback
|
callback | string |
O retorno de chamada. |
|
Marca Marshaller
|
results | array of TagMarshaller |
O marshaller de marca. |
cadeia
Esse é o tipo de dados básico 'string'.
objeto
Esse é o tipo 'object'.