Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Este guia de início rápido explica como configurar um aplicativo simples de linha de comando em PHP
que faz solicitações à API YouTube Data. Este
início rápido explica como fazer duas solicitações de API:
Você vai usar uma chave de API, que identifica seu aplicativo, para
recuperar informações sobre o canal do YouTube GoogleDevelopers.
Você vai usar um ID do cliente OAuth 2.0 para enviar uma solicitação autorizada
que recupera informações sobre seu próprio canal do YouTube.
Pré-requisitos
Para executar este guia de início rápido, você vai precisar do seguinte:
PHP 5.4 ou mais recente com a interface de linha de comando (CLI) e a extensão JSON instaladas.
A ferramenta de gestão de dependências do Composer instalada globalmente {: target="_blank"}
A biblioteca de cliente das APIs do Google para PHP:
Se você ainda não instalou a biblioteca de cliente:
composer require google/apiclient:^2.0
Se você já instalou a biblioteca de cliente, recomendamos atualizá-la
para garantir que você tenha as classes mais atualizadas da biblioteca
que está testando:
Criar uma chave de API
Você vai usar a chave de API para fazer solicitações de API que não exigem autorização do usuário. Por exemplo, não é necessário ter autorização do usuário para recuperar informações sobre um canal público do YouTube.
Crie um ID do cliente OAuth 2.0
Defina o tipo de aplicativo como Outro. Você precisa usar credenciais do OAuth 2.0 para solicitações que exigem autorização do usuário. Por exemplo, você precisa de autorização do usuário para recuperar informações sobre o canal do YouTube do usuário autenticado no momento.
Faça o download do arquivo JSON que contém suas credenciais do OAuth 2.0. O
arquivo tem um nome como client_secret_CLIENTID.json, em que CLIENTID é
o ID do cliente do seu projeto.
Etapa 2: configurar e executar o exemplo
Use o widget do APIs Explorer no painel lateral para receber um exemplo de código para
recuperar informações sobre o canal do YouTube GoogleDevelopers. Essa solicitação
usa uma chave de API para identificar seu aplicativo e não requer autorização
do usuário nem permissões especiais dele para executar a amostra.
Nessa página, a seção "Casos de uso comuns" contém uma tabela que explica
várias maneiras comuns de usar o método. A primeira listagem na tabela é para resultados por ID do canal.
Clique no símbolo de código da primeira listagem para abrir e preencher o
APIs Explorer em tela cheia.
O lado esquerdo do API Explorer em tela cheia mostra o seguinte:
Abaixo do cabeçalho Parâmetros da solicitação, há uma lista de parâmetros
aceitos pelo método. Os valores de parâmetro part e id precisam ser definidos. O valor do parâmetro id, UC_x5XG1OV2P6uZZ5FSM9Ttw, é o ID do canal do YouTube GoogleDevelopers.
Abaixo dos parâmetros, há uma seção chamada Credenciais. O menu
suspenso nessa seção vai mostrar o valor Chave de API. O
APIs Explorer usa credenciais de demonstração por padrão para facilitar o
início. Mas você vai usar sua própria chave de API para executar a amostra localmente.
O lado direito do APIs Explorer em tela cheia mostra guias com exemplos de código
em diferentes linguagens. Selecione a guia PHP.
Copie o exemplo de código e salve-o em um arquivo chamado
example.php.
No exemplo que você baixou, encontre a string YOUR_API_KEY e substitua pela chave de API criada na etapa 1 deste guia de início rápido.
Execute a amostra na linha de comando. No diretório de trabalho, execute:
php example.php
O exemplo precisa executar a solicitação e imprimir a resposta em STDOUT.
Etapa 3: executar uma solicitação autorizada
Nesta etapa, você vai modificar o exemplo de código para que, em vez de recuperar informações sobre o canal do YouTube GoogleDevelopers, ele recupere informações sobre seu canal do YouTube. Essa solicitação requer autorização do usuário.
Volte à documentação do método
channels.list da API.
Na seção "Casos de uso comuns", clique no símbolo de código da terceira
entrada na tabela. O caso de uso é chamar o método list para "my
channel".
Novamente, no lado esquerdo do APIs Explorer em tela cheia, você verá uma lista de parâmetros seguida da seção Credenciais. No entanto, há duas mudanças em relação ao exemplo em que você recuperou informações sobre o canal GoogleDevelopers:
Na seção de parâmetros, em vez de definir o valor do parâmetro id, defina o valor do parâmetro mine como true. Isso instrui o servidor de API a recuperar informações sobre o canal do usuário autenticado no momento.
Na seção Credenciais, o menu suspenso deve selecionar a opção Google OAuth 2.0.
Além disso, se você clicar no link Mostrar escopos, o escopo https://www.googleapis.com/auth/youtube.readonly vai estar marcado.
Como no exemplo anterior, selecione a guia PHP, copie o exemplo de código e salve-o em example.php.
No código, encontre a string YOUR_CLIENT_SECRET_FILE.json e substitua
pelo local do arquivo de chave secreta do cliente que você baixou na etapa 1
deste guia de início rápido.
Execute a amostra na linha de comando. No diretório de trabalho, execute:
php example.php
Copie o URL do console e abra no navegador.
Se você ainda não tiver feito login na sua Conta do Google, será
solicitado que faça isso. Se você tiver feito login em várias Contas do Google, será necessário selecionar uma delas para usar na autorização.
Clique no botão para conceder ao aplicativo acesso aos escopos especificados no
exemplo de código.
Copie o código de autenticação do navegador e cole-o no terminal. Em seguida, feche a guia do navegador usada para o fluxo de autenticação.
A resposta da API precisa ser impressa novamente em STDOUT.
[null,null,["Última atualização 2025-08-21 UTC."],[[["\u003cp\u003eThis guide demonstrates setting up a PHP command-line application to interact with the YouTube Data API.\u003c/p\u003e\n"],["\u003cp\u003eThe guide covers making two distinct API requests: one using an API key to get information about the GoogleDevelopers YouTube channel, and another using OAuth 2.0 to access data about your own YouTube channel.\u003c/p\u003e\n"],["\u003cp\u003eTo run this quickstart, you'll need PHP 5.4 or greater, the Composer dependency management tool, and the Google APIs Client Library for PHP.\u003c/p\u003e\n"],["\u003cp\u003eThe setup involves creating an API key for public data requests and an OAuth 2.0 client ID for requests needing user authorization, both within the Google API Console.\u003c/p\u003e\n"],["\u003cp\u003eThe guide will also help with running an authorized request by using the \u003cem\u003emine\u003c/em\u003e parameter set to true, which fetches information for the authenticated user's channel.\u003c/p\u003e\n"]]],["This guide demonstrates using the YouTube Data API with PHP. It outlines two types of API requests: one using an API key to retrieve public channel data, and another using OAuth 2.0 for authorized access to a user's own channel data. The process involves setting up a project in the API Console, enabling the YouTube Data API, and generating both an API key and an OAuth 2.0 client ID. Sample code is provided and instructions are given for updating parameters, integrating credentials and running the scripts to retrieve information from the API.\n"],null,["# PHP Quickstart\n\nThis quickstart guide explains how to set up a simple, PHP\ncommand-line application that makes requests to the YouTube Data API. This\nquickstart actually explains how to make two API requests:\n\n1. You will use an API key, which identifies your application, to retrieve information about the GoogleDevelopers YouTube channel.\n2. You will use an OAuth 2.0 client ID to submit an *authorized* request that retrieves information about your own YouTube channel.\n\n| **Note:** More generally, you can follow the instructions for the first example for any use case that uses an API key or the instructions for the second example for any use case that requires authorization using OAuth 2.0. See the [use cases and code samples tool](/youtube/v3/code_samples/code_snippets) for more examples.\n\nPrerequisites\n-------------\n\nTo run this quickstart, you'll need:\n\n- PHP 5.4 or greater with the command-line interface (CLI) and JSON extension installed.\n- The Composer dependency management tool [installed globally](https://getcomposer.org/doc/00-intro.md#globally) {: target=\"_blank\"}\n- The Google APIs Client Library for PHP:\n - If you have not previously installed the client library: \n\n ```\n composer require google/apiclient:^2.0\n ```\n - If you previously installed the client library, we recommend updating it to ensure that you have the most up-to-date classes for the library you are testing: \n\n ```\n composer update google/apiclient --with-dependencies\n ```\n\nStep 1: Set up your project and credentials\n-------------------------------------------\n\nCreate or select a project in the [API Console](https://console.cloud.google.com/). Complete the following tasks in the API Console for your project:\n\n1. In the [library panel](https://console.developers.google.com/apis/library),\n search for the YouTube Data API v3. Click into the listing for that API and\n make sure the API is enabled for your project.\n\n2. In the [credentials\n panel](https://console.developers.google.com/apis/credentials),\n create two credentials:\n\n 1. **Create an API key**\n You will use the API key to make API requests that do\n not require user authorization. For example, you do not need user\n authorization to retrieve information about a public YouTube channel.\n\n 2. **Create an OAuth 2.0 client ID**\n\n Set the application type to **Other**. You need to use OAuth 2.0\n credentials for requests that require user authorization. For example,\n you need user authorization to retrieve information about the currently\n authenticated user's YouTube channel.\n\n Download the JSON file that contains your OAuth 2.0 credentials. The\n file has a name like `client_secret_CLIENTID.json`, where `CLIENTID` is\n the client ID for your project.\n\nStep 2: Set up and run the sample\n---------------------------------\n\nUse the APIs Explorer widget in the side panel to obtain sample code for\nretrieving information about the GoogleDevelopers YouTube channel. This request\nuses an API key to identify your application, and it does not require user\nauthorization or any special permissions from the user running the sample.\n\n1. Open the documentation for the API's [channels.list](/youtube/v3/docs/channels/list) method.\n2. On that page, the \"Common use cases\" section contains a table that explains\n several common ways that the method is used. The first listing in the table\n is for listing results by channel ID.\n\n Click the code symbol for the first listing to open and populate the\n fullscreen APIs Explorer.\n\n3. The left side of the fullscreen APIs Explorer shows the following:\n\n 1. Below the **Request parameters** header, there is a list of parameters\n that the method supports. The `part` and `id` parameter values should\n be set. The `id` parameter value, `UC_x5XG1OV2P6uZZ5FSM9Ttw`, is the\n ID for the GoogleDevelopers YouTube channel.\n\n 2. Below the parameters, there is a section named **Credentials** . The\n pulldown menu in that section should display the value **API key**. The\n APIs Explorer uses demo credentials by default to make it easier to get\n started. But you'll use your own API key to run the sample locally.\n\n4. The right side of the fullscreen APIs Explorer shows tabs with code samples\n in different languages. Select the **PHP** tab.\n\n5. Copy the code sample and save it in a file named\n `example.php`.\n\n6. In the sample that you downloaded, find the `YOUR_API_KEY` string and\n replace that with the API key that you created in step 1 of this quickstart.\n\n7. Run the sample from the command line. In your working directory, run:\n\n\n `php example.php`\n\n8. The sample should execute the request and print the response to `STDOUT`.\n\nStep 3: Run an authorized request\n---------------------------------\n\nIn this step, you'll modify your code sample so that instead of retrieving\ninformation about the GoogleDevelopers YouTube channel, it retrieves information\nabout *your* YouTube channel. This request does require user authorization.\n\n1. Go back to the documentation for the API's\n [channels.list](/youtube/v3/docs/channels/list) method.\n\n2. In the \"Common use cases\" section, click the code symbol for the third\n listing in the table. That use case is to call the `list` method for \"my\n channel.\"\n\n3. Again, in the left side of the fullscreen APIs Explorer, you will see a\n list of parameters followed by the **Credentials** section. However, there\n are two changes from the example where you retrieved information about the\n GoogleDevelopers channel:\n\n 1. In the parameters section, instead of the `id` parameter value being\n set, the `mine` parameter value should be set to `true`. This instructs\n the API server to retrieve information about the currently authenticated\n user's channel.\n\n 2. In the **Credentials** section, the pulldown menu should select the\n option for **Google OAuth 2.0**.\n\n In addition, if you click the **Show scopes** link, the\n **https://www.googleapis.com/auth/youtube.readonly** scope should be\n checked.\n\n4. As with the previous example, select the **PHP** tab,\n copy the code sample, and save it to `example.php`.\n\n\n In the code, find the `YOUR_CLIENT_SECRET_FILE.json` string and replace\n it with the location of the client secret file you downloaded in step 1\n of this quickstart.\n5. Run the sample from the command line. In your working directory, run:\n\n\n `php example.php`\n\n6. \u003cbr /\u003e\n\n\n Copy the URL from the console and open it in your browser.\n\n If you are not already logged into your Google account, you will be\n prompted to log in. If you are logged into multiple Google accounts, you\n will be asked to select one account to use for the authorization.\n7. Click the button to grant your application access to the scopes specified in\n your code sample.\n\n8. \u003cbr /\u003e\n\n\n Copy the auth code from the browser and paste it into your terminal. You can\n then close the browser tab used for the auth flow.\n\n The API response should again be printed to `STDOUT`.\n\nFurther reading\n---------------\n\n- [Google Developers Console help documentation](/console/help/new)\n- [Google APIs Client Library for PHP documentation](/api-client-library/php)\n- [Google APIs Client Library for PHP on GitHub](https://github.com/googleapis/google-api-php-client) and [autogenerated classes](https://github.com/googleapis/google-api-php-client-services/tree/master/src/Google/Service) for the YouTube API. (On the page, find the `YouTube` folder and the `YouTube.php` file.\n- [YouTube Data API reference documentation](/youtube/v3/docs)"]]