Estamos atualizando a API Data para corresponder à forma como o YouTube conta as visualizações dos Shorts.
Saiba mais
Thumbnails: set
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Carrega uma miniatura de vídeo personalizada para o YouTube e a define para um vídeo.
Este método oferece suporte ao envio de mídia. Os arquivos enviados devem estar de acordo com estas restrições:
- Tamanho máximo do arquivo: 2 MB
- Tipos MIME de mídia aceitos:
image/jpeg
, image/png
, application/octet-stream
Impacto da cota:uma chamada para esse método tem um custo de cota de aproximadamente 50 unidades.
Casos de uso comuns
Solicitação
Solicitação HTTP
POST https://www.googleapis.com/upload/youtube/v3/thumbnails/set
Autorização
Esta solicitação requer autorização com pelo menos um dos seguintes escopos (leia mais sobre autenticação e autorização).
Escopo |
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube.upload |
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 |
videoId |
string
O parâmetro videoId especifica um ID de vídeo do YouTube para o qual a miniatura de vídeo personalizada está sendo fornecida. |
Parâmetros opcionais |
onBehalfOfContentOwner |
string
Observação:esse parâmetro é destinado exclusivamente a parceiros de conteúdo do YouTube.
O parâmetro onBehalfOfContentOwner indica que as credenciais de autorização da solicitação identificam um usuário do CMS do YouTube que está agindo em nome do proprietário do conteúdo especificado no valor do 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 real com a qual o usuário autentica deve estar vinculada ao proprietário do conteúdo do YouTube especificado. |
Corpo da solicitação
O corpo da solicitação contém a imagem em miniatura que você está enviando. O corpo da solicitação não contém um recurso thumbnail
.
Resposta
Se for bem-sucedido, esse método retornará um corpo de resposta com esta estrutura:
{
"kind": "youtube#thumbnailSetResponse",
"etag": etag,
"items": [
thumbnail resource
]
}
Propriedades
A tabela a seguir define as propriedades que aparecem neste recurso:
Propriedades |
kind |
string
Identifica o tipo de recurso da API. O valor será youtube#thumbnailSetResponse . |
etag |
etag
A Etag desse recurso. |
items[] |
list
Uma lista de miniaturas. |
Erros
A tabela a seguir identifica mensagens de erro que a API pode retornar em resposta a uma chamada para esse método. Consulte a documentação mensagem de erro para mais detalhes.
Tipo de erro |
Detalhe do erro |
Descrição |
badRequest (400) |
invalidImage |
O conteúdo da imagem fornecido é inválido. |
badRequest (400) |
mediaBodyRequired |
A solicitação não inclui o conteúdo da imagem. |
forbidden (403) |
forbidden |
A miniatura não pode ser configurada para o vídeo especificado. A solicitação pode não es devidamente autorizada. |
forbidden (403) |
forbidden |
O usuário autenticado não tem permissões para carregar e configurar miniaturas de vídeo personalizadas. |
notFound (404) |
videoNotFound |
O vídeo no qual você está tentando inserir uma imagem em miniatura não pode ser encontrado. Verifique o valor do parâmetro videoId da solicitação para garantir que ele está correto. |
tooManyRequests (429) |
uploadRateLimitExceeded |
O canal enviou muitas miniaturas recentemente. Tente fazer a solicitação novamente mais tarde. |
Confira!
Use o APIs Explorer para chamar essa API e conferir a solicitação e a resposta da API.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-04-26 UTC.
[null,null,["Última atualização 2024-04-26 UTC."],[],[],null,["# Thumbnails: set\n\nUploads a custom video thumbnail to YouTube and sets it for a video.\n\nThis method supports media upload. Uploaded files must conform to these constraints:\n\n- **Maximum file size:** 2MB\n- **Accepted Media MIME types:** `image/jpeg`, `image/png`, `application/octet-stream`\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of approximately 50 units.\n\nCommon use cases\n----------------\n\nThe list below shows common use cases for this method. Hover over a use case to see its description, or click on a use case to load sample parameter values in the APIs Explorer. You can open the [fullscreen APIs Explorer](#) to see code samples that dynamically update to reflect the parameter values entered in the Explorer.\n\nThe table below shows common use cases for this method. You can click on a use case name to load sample parameter values in the APIs Explorer. Or you can see code samples for a use case in the fullscreen APIs Explorer by clicking on the code icon below a use case name. In the fullscreen UI, you can update parameter and property values and the code samples will dynamically update to reflect the values you enter. \nThis method has one common use case, which is described below. The buttons below the description populate the APIs Explorer with sample values or open the fullscreen APIs Explorer to show code samples that use those values. The code samples also dynamically update if you change the values.\n\n\u003cbr /\u003e\n\nRequest\n-------\n\n### HTTP request\n\n```\nPOST https://www.googleapis.com/upload/youtube/v3/thumbnails/set\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/guides/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtubepartner` |\n| `https://www.googleapis.com/auth/youtube.upload` |\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `videoId` | `string` The **videoId** parameter specifies a YouTube video ID for which the custom video thumbnail is being provided. |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` **Note:** This parameter is intended exclusively for YouTube content partners. The **onBehalfOfContentOwner** parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner. |\n\n### Request body\n\nThe body of the request contains the thumbnail image that you are uploading. The request body does not contain a [thumbnail](/youtube/v3/docs/thumbnails#resource-representation) resource.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#thumbnailSetResponse\",\n \"etag\": etag,\n \"items\": [\n thumbnail resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|-----------|------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#thumbnailSetResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `items[]` | `list` A list of thumbnails. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|-------------------------|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `badRequest (400)` | `invalidImage` | The provided image content is invalid. |\n| `badRequest (400)` | `mediaBodyRequired` | The request does not include the image content. |\n| `forbidden (403)` | `forbidden` | The thumbnail can't be set for the specified video. The request might not be properly authorized. |\n| `forbidden (403)` | `forbidden` | The authenticated user doesn't have permissions to upload and set custom video thumbnails. |\n| `notFound (404)` | `videoNotFound` | The video that you are trying to insert a thumbnail image for cannot be found. Check the value of the request's `videoId` parameter to ensure that it is correct. |\n| `tooManyRequests (429)` | `uploadRateLimitExceeded` | The channel has uploaded too many thumbnails recently. Please try the request again later. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]