Channels: update

Agora, a API permite marcar seu canal ou vídeos como "conteúdo para crianças". Além disso, os recursos channel e video agora também contêm uma propriedade que identifica o status "conteúdo para crianças" do canal ou vídeo. Os Termos de Serviço e as Políticas para Desenvolvedores dos serviços de APIs do YouTube também foram atualizados em 10 de janeiro de 2020. Para mais informações, consulte os históricos de revisão do serviço da API YouTube Data e dos Termos de Serviço dos serviços de APIs do YouTube.

Atualiza os metadados de um canal. Esse método só aceita atualizações nos objetos brandingSettings, invideoPromotion e localizations do recurso channel e nas propriedades secundárias deles.

Impacto na cota:uma chamada para esse método tem um custo de cota de 50 unidades.

Casos de uso comuns

Solicitação

Solicitação HTTP

PUT https://www.googleapis.com/youtube/v3/channels

Autorização

Esta solicitação requer autorização com pelo menos um dos seguintes escopos. Para saber mais sobre autenticação e autorização, consulte Implementar a autorização do OAuth 2.0.

Escopo
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

Parâmetros

A tabela a seguir lista os parâmetros compatíveis com essa consulta. Todos os parâmetros listados são os parâmetros de consulta.

Parâmetros
Parâmetros obrigatórios
part string
O parâmetro part tem duas finalidades nessa operação. Ele identifica as propriedades que a operação de gravação vai definir, bem como as propriedades que a resposta da API vai incluir.

A API só permite que o valor de parâmetro seja definido como brandingSettings, invideoPromotion ou localizations. Só é possível atualizar uma dessas partes com uma única solicitação.

Observação: esse método substitui os valores atuais de todas as propriedades mutáveis contidas na parte especificada pelo valor de parâmetro.
Parâmetros opcionais
onBehalfOfContentOwner string
Esse parâmetro só pode ser usado em uma solicitação devidamente autorizada.

O parâmetro onBehalfOfContentOwner indica que o usuário autenticado está agindo em nome do proprietário do conteúdo especificado no valor de parâmetro. Este parâmetro destina-se a parceiros de conteúdo do YouTube que possuem e gerenciam vários canais do YouTube diferentes. Ele permite que os proprietários de conteúdo autentiquem uma vez e tenham acesso a todos os dados de seu canal e de seus vídeos sem ter que fornecer credenciais de autenticação para cada canal. A conta do CMS com que o usuário se autentica precisa estar vinculada ao proprietário do conteúdo especificado do YouTube.

Esse parâmetro precisa ser fornecido se a solicitação for autenticada com credenciais de um usuário proprietário de conteúdo do CMS que atua em um canal gerenciado. Se omitido, a solicitação será executada no contexto direto do usuário autenticado e retornará um erro HTTP 403 Forbidden.

Corpo da solicitação

Forneça um recurso channel no corpo da solicitação. Para esse recurso:

  • É necessário especificar um valor para essas propriedades:

    • id

  • Você pode definir valores para estas propriedades:

    • brandingSettings.channel.country
    • brandingSettings.channel.description
    • brandingSettings.channel.defaultLanguage
    • brandingSettings.channel.keywords
    • brandingSettings.channel.trackingAnalyticsAccountId
    • brandingSettings.channel.unsubscribedTrailer
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description
    • status.selfDeclaredMadeForKids

    Se você estiver enviando uma solicitação de atualização e ela não especificar um valor para uma propriedade que já tenha um, o valor existente da propriedade será excluído.

Resposta

Se for bem-sucedido, esse método vai retornar um recurso channel no corpo da resposta.

Erros

A tabela a seguir identifica as mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Para mais detalhes, consulte API YouTube Data - Erros.

Tipo de erro Detalhe do erro Descrição
badRequest (400) brandingValidationError Um dos valores no objeto brandingSettings falhou na validação. Use o método channels.list para recuperar as configurações atuais do canal e atualize os valores das propriedades seguindo as diretrizes na documentação do recurso channels.
badRequest (400) channelTitleUpdateForbidden Ao atualizar o brandingSettings part de um canal, defina o valor da propriedade brandingSettings.channel.title como o título atual do canal ou omita a propriedade. A API vai retornar um erro se você mudar o valor da propriedade.
badRequest (400) defaultLanguageNotSetError O defaultLanguage precisa ser definido para atualizar localizations.
badRequest (400) invalidBrandingOption Uma das configurações de marca que você especificou não existe. Use o método channels.list para recuperar valores válidos e atualize-os seguindo as diretrizes na documentação do recurso channels.
badRequest (400) invalidCustomMessage Os metadados da solicitação especificam uma mensagem personalizada inválida. Verifique o valor da propriedade invideoPromotion.items[].customMessage no recurso enviado pela solicitação.
badRequest (400) invalidDuration Os metadados da solicitação especificam uma duração inválida na parte "invideoPromotion".
badRequest (400) invalidDuration Os metadados da solicitação especificam um tipo de posição inválido para determinar como o item promovido está posicionado no player de vídeo. Verifique o valor da propriedade invideoPromotion.position.type no recurso enviado pela solicitação.
badRequest (400) invalidRecentlyUploadedBy Os metadados da solicitação especificam um ID de canal inválido. Verifique o valor da propriedade invideoPromotion.items[].id.recentlyUploadedBy no recurso enviado pela solicitação.
badRequest (400) invalidTimingOffset Os metadados da solicitação especificam um ajuste de tempo inválido na parte "invideoPromotion".
badRequest (400) invalidTimingOffset Os metadados da solicitação especificam um ajuste de tempo inválido para determinar quando o item promovido deve ser exibido no player de vídeo. Verifique o valor da propriedade invideoPromotion.timing.offsetMs no recurso enviado pela solicitação.
badRequest (400) invalidTimingType Os metadados da solicitação especificam um método de tempo inválido para determinar quando o item promovido deve ser exibido no player de vídeo. Verifique o valor da propriedade invideoPromotion.timing.type no recurso enviado pela solicitação.
badRequest (400) localizationValidationError Um dos valores no objeto de localizações não passou na validação. Use o método channels.list para recuperar valores válidos e atualize-os de acordo com as diretrizes na documentação do recurso de canais.
badRequest (400) tooManyPromotedItems O número de itens promovidos permitidos foi excedido na parte invideoPromotion.
forbidden (403) channelForbidden O canal especificado no parâmetro id não é compatível com a solicitação ou ela não está autorizada corretamente.
forbidden (403) promotedVideoNotAllowed O canal que a solicitação da API está tentando atualizar não pode ser encontrado. Verifique o valor da propriedade id no recurso channel que a solicitação enviou para garantir que o ID do canal esteja correto.
forbidden (403) websiteLinkNotAllowed O URL do site especificado não é permitido.
notFound (404) channelNotFound Não foi possível encontrar o canal especificado no parâmetro id.
notFound (404) channelNotFound O canal especificado pelo parâmetro id não foi encontrado ou não tem opções de branding.
notFound (404) unknownChannelId O ID do canal especificado não foi encontrado.
notFound (404) unknownChannelId O ID do canal recentlyUploadedBy especificado não foi encontrado.
notFound (404) unknownVideoId O ID do vídeo especificado como um item promovido não pode ser encontrado.
required (400) requiredItemIdType Os metadados da solicitação precisam especificar um tipo de item na parte invideoPromotion.
required (400) requiredItemId Os metadados da solicitação precisam especificar um ID do item na parte invideoPromotion.
required (400) requiredTimingOffset Os metadados da solicitação precisam especificar um ajuste de tempo padrão para que o YouTube possa determinar quando mostrar o item promovido. Defina o valor da propriedade invideoPromotion.defaultTiming.offsetMs no recurso enviado pela solicitação.
required (400) requiredTimingOffset Os metadados da solicitação precisam especificar um ajuste de tempo para que o YouTube possa determinar quando mostrar o item promovido. Defina o valor da propriedade invideoPromotion.timing.offsetMs no recurso enviado pela solicitação.
required (400) requiredTimingType Os metadados da solicitação devem especificar um método de horário para que o YouTube possa determinar quando exibir o item promovido. Defina o valor da propriedade invideoPromotion.defaultTiming.type no recurso enviado pela solicitação.
required (400) requiredTimingType Os metadados da solicitação devem especificar um método de horário para que o YouTube possa determinar quando exibir o item promovido. Defina o valor da propriedade invideoPromotion.timing.type no recurso enviado pela solicitação.
required (400) requiredTiming Os metadados da solicitação precisam especificar um tempo para cada item na parte invideoPromotion.
required (400) requiredVideoId Os metadados da solicitação devem especificar um ID de vídeo para identificar o item promovido.
required (400) requiredWebsiteUrl Os metadados da solicitação precisam especificar um URL do site na parte "invideoPromotion". Defina o valor da propriedade invideoPromotion.items[].id.websiteUrl no recurso enviado pela solicitação.

Confira!

Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.