Estamos atualizando a API Data para corresponder à forma como o YouTube conta as visualizações dos Shorts.
Saiba mais
Captions: update
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Atualiza uma faixa de legenda. Ao atualizar uma faixa de legenda, é possível mudar o status do rascunho, fazer upload de um novo arquivo de legenda ou ambos.
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: 100 MB
- Tipos MIME de mídia aceitos:
text/xml, application/octet-stream, */*
Impacto da cota:uma chamada para esse método tem um custo de cota de 450 unidades.
Casos de uso comuns
Solicitação
Solicitação HTTP
PUT https://www.googleapis.com/upload/youtube/v3/captions
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/youtube.force-ssl |
https://www.googleapis.com/auth/youtubepartner |
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 nesta operação. identifica as propriedades que serão definidas pela operação de gravação e as propriedades que serão incluídas pela resposta da API. Defina o valor da propriedade como snippet se você estiver atualizando o status de rascunho da faixa. Caso contrário, defina o valor da propriedade como id.
A lista a seguir contém os nomes de part que você pode incluir no valor do parâmetro:
|
| Parâmetros opcionais |
onBehalfOfContentOwner |
string
Esse parâmetro só pode ser usado em uma solicitação autorizada corretamente. 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. |
sync |
boolean
Esse parâmetro foi descontinuado.
Observação:o servidor da API só vai processar o valor do parâmetro se a solicitação tiver um arquivo de legenda atualizado.
O parâmetro sync indica se o YouTube deve sincronizar automaticamente o arquivo de legenda com a faixa de áudio do vídeo. Se você definir o valor como true, o YouTube sincronizará automaticamente a faixa de legenda com a faixa de áudio. |
Corpo da solicitação
Forneça um recurso de legenda no corpo da solicitação.
Para esse recurso:
-
É necessário especificar um valor para essas propriedades:
-
Você pode definir valores para estas propriedades:
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 retorna um recurso de legenda no corpo da resposta.
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) |
contentRequired |
A solicitação não enviou um arquivo de legenda atualizado. O conteúdo real da faixa será necessário se o parâmetro sync estiver definido como true. |
forbidden (403) |
forbidden |
As permissões associadas à solicitação não são suficientes para atualizar a faixa de legenda. A solicitação pode não es devidamente autorizada. |
notFound (404) |
captionNotFound |
Não foi possível encontrar a faixa de legenda especificada. Verifique o valor da propriedade id da solicitação para garantir que ele está correto. |
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,["# Captions: update\n\nUpdates a caption track. When updating a caption track, you can change the track's [draft status](/youtube/v3/docs/captions#snippet.isDraft), upload a new caption file for the track, or both.\n\nThis method supports media upload. Uploaded files must conform to these constraints:\n\n- **Maximum file size:** 100MB\n- **Accepted Media MIME types:** `text/xml`, `application/octet-stream`, `*/*`\n\n**Quota impact:** A call to this method has a [quota cost](/youtube/v3/getting-started#quota) of 450 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```\nPUT https://www.googleapis.com/upload/youtube/v3/captions\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/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtubepartner` |\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| `part` | `string` The **part** parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to `snippet` if you are updating the track's [draft status](/youtube/v3/docs/captions#snippet.isDraft). Otherwise, set the property value to `id`. The following list contains the `part` names that you can include in the parameter value: - `id` - `snippet` |\n| **Optional parameters** |||\n| `onBehalfOfContentOwner` | `string` This parameter can only be used in a properly [authorized request](/youtube/v3/guides/authentication). **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| `sync` | `boolean` This parameter has been deprecated. **Note:** The API server only processes the parameter value if the request contains an updated caption file. The **sync** parameter indicates whether YouTube should automatically synchronize the caption file with the audio track of the video. If you set the value to `true`, YouTube will automatically synchronize the caption track with the audio track. |\n\n### Request body\n\nProvide a [caption resource](/youtube/v3/docs/captions#resource) in the request body.\nFor that resource:\n\n- You must specify a value for these properties:\n\n \u003cbr /\u003e\n\n - `id`\n\n \u003cbr /\u003e\n\n- You can set values for these properties:\n\n \u003cbr /\u003e\n\n - `snippet.isDraft`\n\n \u003cbr /\u003e\n\n If you are submitting an update request, and your request does not specify a value for a property that already has a value, the property's existing value will be deleted.\n\nResponse\n--------\n\nIf successful, this method returns a [caption resource](/youtube/v3/docs/captions#resource) in the response body.\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)` | `contentRequired` | The request did not upload an updated caption file. The actual track contents are required if the `sync` parameter is set to `true`. |\n| `forbidden (403)` | `forbidden` | The permissions associated with the request are not sufficient to update the caption track. The request might not be properly authorized. |\n| `notFound (404)` | `captionNotFound` | The specified caption track could not be found. Check the value of the request's `id` property to ensure that it is correct. |\n\nTry it!\n-------\n\nUse the APIs Explorer to call this API and see the API request and response."]]
