Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Dokumen ini memberikan semua informasi dasar yang Anda perlukan untuk mulai menggunakan library.
Materi ini mencakup konsep-konsep perpustakaan,
menunjukkan contoh untuk berbagai kasus penggunaan,
dan memberikan tautan
ke informasi lebih lanjut.
Penyiapan
Ada beberapa langkah penyiapan yang perlu Anda selesaikan sebelum dapat menggunakan library ini:
Penting untuk memahami dasar-dasar cara penanganan otentikasi dan otorisasi API.
Semua panggilan API harus menggunakan akses sederhana atau terotorisasi (ditentukan di bawah).
Banyak metode API memerlukan akses yang sah, tetapi beberapa metode juga dapat menggunakannya.
Beberapa metode API yang bisa menggunakan
perilaku yang berbeda,
tergantung apakah Anda menggunakan
akses sederhana atau terotorisasi.
Lihat dokumentasi metode API untuk menentukan jenis akses yang sesuai.
1. Akses API sederhana (kunci API)
Panggilan API ini tidak mengakses data pribadi pengguna.
Aplikasi Anda harus mengautentikasi dirinya sendiri sebagai aplikasi yang
ke project Konsol API Google Anda.
Hal ini diperlukan untuk mengukur penggunaan proyek untuk tujuan akuntansi.
Kunci API:
Untuk mengautentikasi aplikasi Anda, gunakan sebuah
Kunci API
untuk project Konsol API Anda.
Setiap panggilan akses sederhana yang dilakukan aplikasi Anda harus menyertakan kunci ini.
2. Akses API yang diizinkan (OAuth 2.0)
Panggilan API ini mengakses data pribadi pengguna.
Sebelum Anda dapat
melakukan panggilan kepada mereka,
pengguna yang memiliki akses ke data pribadi harus
memberikan akses aplikasi Anda.
Oleh karena itu, aplikasi Anda harus diautentikasi,
pengguna harus memberikan
akses untuk aplikasi Anda,
dan pengguna harus diotentikasi
untuk memberikan akses itu.
Semua ini dicapai dengan
OAuth 2.0 dan library yang ditulis untuknya.
Cakupan:
Setiap API mendefinisikan satu atau beberapa cakupan yang mendeklarasikan serangkaian operasi yang diizinkan.
Misalnya, API mungkin memiliki cakupan hanya baca dan baca tulis.
Saat aplikasi Anda meminta akses ke data pengguna,
permintaan harus menyertakan satu atau beberapa cakupan.
Pengguna harus menyetujui cakupan akses yang diminta aplikasi Anda.
Token akses dan refresh:
Ketika pengguna memberikan akses aplikasi Anda, server otorisasi OAuth 2.0
menyediakan token refresh dan akses ke aplikasi Anda.
Token ini hanya valid untuk cakupan yang diminta.
Aplikasi Anda menggunakan token akses untuk mengizinkan panggilan API.
Masa berlaku token akses habis, tetapi token refresh tidak.
Aplikasi Anda dapat menggunakan token refresh untuk memperoleh token akses baru.
Client ID dan rahasia klien:
String ini secara unik mengidentifikasi aplikasi Anda dan digunakan untuk memperoleh token.
API ini dibuat untuk project Anda di Konsol API.
Ada tiga jenis client ID,
jadi pastikan untuk mendapatkan jenis
yang tepat untuk aplikasi Anda:
Di bagian ini, ada contoh penggunaan API sederhana tanpa otorisasi.
Untuk informasi selengkapnya tentang panggilan otorisasi, lihat
Halaman OAuth 2.0 untuk .NET.
Contoh API sederhana
Contoh ini menggunakan akses API sederhana untuk aplikasi command line.
Fungsi ini memanggil
Google Discovery API untuk menampilkan daftar semua Google API.
Misalnya, penyiapan
Mendapatkan kunci API Sederhana. Untuk menemukan kunci API aplikasi Anda, lakukan hal berikut:
API ini mendukung dua jenis kredensial.
Buat kredensial apa pun yang sesuai untuk project Anda:
OAuth 2.0: Setiap kali aplikasi Anda meminta pengguna pribadi
data, klien harus mengirimkan
token OAuth 2.0 bersama dengan permintaan. Nama
mula-mula mengirim ID klien dan, mungkin, rahasia klien ke
mendapatkan token. Anda dapat membuat kredensial OAuth 2.0 untuk web
aplikasi, akun layanan, atau aplikasi terinstal.
Kunci API:
Permintaan yang tidak menyediakan token OAuth 2.0 harus mengirimkan API
tombol.
Kunci ini mengidentifikasi project Anda dan memberikan akses, kuota, dan
laporan.
API ini mendukung beberapa jenis pembatasan pada kunci API. Jika kunci API yang Anda
kebutuhan Anda belum ada, maka buat kunci API di Konsol
mengeklik Create credentials
> Kunci API. Anda dapat membatasi kunci sebelum menggunakannya
dalam produksi dengan mengklik Restrict key dan memilih salah satu
Pembatasan.
usingSystem;usingSystem.Threading.Tasks;usingGoogle.Apis.Discovery.v1;usingGoogle.Apis.Discovery.v1.Data;usingGoogle.Apis.Services;namespaceDiscovery.ListAPIs{///<summary>
///ThisexampleusesthediscoveryAPItolistallAPIsinthediscoveryrepository.///https://developers.google.com/discovery/v1/using.///<summary>
classProgram{[STAThread]staticvoidMain(string[]args){Console.WriteLine("Discovery API Sample");Console.WriteLine("====================");try{newProgram().Run().Wait();}catch(AggregateExceptionex){foreach(vareinex.InnerExceptions){Console.WriteLine("ERROR: "+e.Message);}}Console.WriteLine("Press any key to continue...");Console.ReadKey();}privateasyncTaskRun(){//Createtheservice.varservice=newDiscoveryService(newBaseClientService.Initializer{ApplicationName="Discovery Sample",ApiKey="[YOUR_API_KEY_HERE]",});//Runtherequest.Console.WriteLine("Executing a list request...");varresult=awaitservice.Apis.List().ExecuteAsync();//Displaytheresults.if(result.Items!=null){foreach(DirectoryList.ItemsDataapiinresult.Items){Console.WriteLine(api.Id+" - "+api.Title);}}}}}
Tips untuk menggunakan kunci API:
Untuk menggunakan layanan tertentu, Anda harus menambahkan referensi ke layanan tersebut.
Misalnya, jika Anda ingin menggunakan
Tasks API,
Anda perlu menginstal paket NuGet-nya
Google.Apis.Tasks.v1.
Untuk membuat instance layanan, cukup panggil konstruktornya. Contoh:
new TasksService(new BaseClientService.Initializer {...});".
Semua metode layanan berada di resource individual di objek layanan itu sendiri.
Layanan Discovery memiliki resource Apis, yang berisi metode List.
Saat Anda memanggil service.Apis.List(..), objek permintaan yang menargetkan metode ini akan ditampilkan.
Untuk menjalankan permintaan, panggil metode Execute() atau ExecuteAsyc() pada permintaan.
Tetapkan kunci API menggunakan properti ApiKey pada instance BaseClientService.Initializer.
Menemukan informasi tentang API
Tujuan
API yang didukung
mencantumkan semua API yang bisa diakses menggunakan library ini serta link ke dokumentasi.
Anda juga dapat menggunakan
Penjelajah API
menelusuri API, mencantumkan metode yang tersedia, dan bahkan mencoba panggilan API dari browser Anda.
[null,null,["Terakhir diperbarui pada 2025-08-31 UTC."],[[["\u003cp\u003eThis documentation provides an overview of using the Google API client library for .NET, including setup, authentication, and usage examples.\u003c/p\u003e\n"],["\u003cp\u003eBefore using the library, ensure you have a Google account, a Google API Console project, and install the necessary NuGet package.\u003c/p\u003e\n"],["\u003cp\u003eThe library supports both simple API access using API keys and authorized access with OAuth 2.0 for private user data.\u003c/p\u003e\n"],["\u003cp\u003eSimple API access requires an API key for project usage tracking, while authorized access necessitates OAuth 2.0 for user data access.\u003c/p\u003e\n"],["\u003cp\u003eExamples are provided for basic API usage and guidance on locating further information about supported APIs and the APIs Explorer is included.\u003c/p\u003e\n"]]],[],null,["This document provides all the basic information you need to start using the library.\nIt covers the library concepts,\nshows examples for various use cases,\nand gives links to more information.\n\nSetup\n\n\nThere are a few setup steps you need to complete before you can use this library:\n\n1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).\n2. If you have never created a Google API Console project, read the [Managing Projects page](/console/help/managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).\n3. [Install](http://www.nuget.org/packages?q=google.apis&prerelease=true&sortOrder=relevance) the NuGet package you want to work with.\n\nAuthentication and authorization\n\n\nIt is important to understand the basics of how API authentication and authorization are handled.\nAll API calls must use either simple or authorized access (defined below).\nMany API methods require authorized access, but some can use either.\nSome API methods that can use either behave differently,\ndepending on whether you use simple or authorized access.\nSee the API's method documentation to determine the appropriate access type.\n\n1. Simple API access (API keys)\n\n\nThese API calls do not access any private user data.\nYour application must authenticate itself as an application belonging\nto your Google API Console project.\nThis is needed to measure project usage for accounting purposes.\n\n\n**API key** :\nTo authenticate your application, use an\n[API key](/console/help/using-keys)\nfor your API Console project.\nEvery simple access call your application makes must include this key.\n| **Warning**: Keep your API key private. If someone obtains your key, they could use it to consume your quota or incur charges against your API Console project.\n\n\u003cbr /\u003e\n\n2. Authorized API access (OAuth 2.0)\n\n\nThese API calls access private user data.\nBefore you can call them,\nthe user that has access to the private data must grant your application access.\nTherefore, your application must be authenticated,\nthe user must grant access for your application,\nand the user must be authenticated in order to grant that access.\nAll of this is accomplished with\n[OAuth 2.0](/accounts/docs/OAuth2) and libraries written for it.\n\n\n**Scope**:\nEach API defines one or more scopes that declare a set of operations permitted.\nFor example, an API might have read-only and read-write scopes.\nWhen your application requests access to user data,\nthe request must include one or more scopes.\nThe user needs to approve the scope of access your application is requesting.\n\n\n**Refresh and access tokens**:\nWhen a user grants your application access, the OAuth 2.0 authorization server\nprovides your application with refresh and access tokens.\nThese tokens are only valid for the scope requested.\nYour application uses access tokens to authorize API calls.\nAccess tokens expire, but refresh tokens do not.\nYour application can use a refresh token to acquire a new access token.\n| **Warning**: Keep refresh and access tokens private. If someone obtains your tokens, they could use them to access private user data.\n\n\u003cbr /\u003e\n\n\n**Client ID and client secret** :\nThese strings uniquely identify your application and are used to acquire tokens.\nThey are created for your project on the [API Console](https://console.cloud.google.com/).\nThere are three types of client IDs,\nso be sure to get the correct type for your application:\n\n- [Web application](/accounts/docs/OAuth2WebServer) client IDs\n- [Installed application](/accounts/docs/OAuth2InstalledApp) client IDs\n- [Service Account](/accounts/docs/OAuth2ServiceAccount) client IDs\n\n| **Warning**: Keep your client secret private. If someone obtains your client secret, they could use it to consume your quota, incur charges against your Console project, and request access to user data.\n\n\u003cbr /\u003e\n\nExamples\n\n\nIn this section, there are examples of simple API usage without authorization.\nFor more information about authorization calls, see the\n[OAuth 2.0 page for .NET](/api-client-library/dotnet/guide/aaa_oauth).\n\nSimple API example\n\n\nThis example uses simple API access for a command-line application.\nIt calls the\n[Google Discovery API](/discovery) to list all Google APIs.\n\nSetup for example\n\n\n**Get your Simple API key**. To find your application's API key, do the following:\n\n\n1. Open the [Credentials page](https://console.cloud.google.com/apis/credentials) in the API Console.\n2. This API supports two types of credentials. Create whichever credentials are appropriate for your project:\n - **OAuth 2.0:** Whenever your application requests private user\n data, it must send an OAuth 2.0 token along with the request. Your\n application first sends a client ID and, possibly, a client secret to\n obtain a token. You can generate OAuth 2.0 credentials for web\n applications, service accounts, or installed applications.\n\n For more information, see the [OAuth 2.0 documentation](https://developers.google.com/identity/protocols/OAuth2).\n - **API keys:**\n\n A request that does not provide an OAuth 2.0 token must send an API\n key.\n\n The key identifies your project and provides API access, quota, and\n reports.\n\n The API supports several types of restrictions on API keys. If the API key that you\n need doesn't already exist, then create an API key in the Console by\n clicking **[Create credentials](https://console.cloud.google.com/apis/credentials) \\\u003e API key** . You can restrict the key before using it\n in production by clicking **Restrict key** and selecting one of the\n **Restrictions**.\n\nTo keep your API keys secure, follow the [best practices for\nsecurely using API keys](//cloud.google.com/docs/authentication/api-keys).\n\n\u003cbr /\u003e\n\nCode for example \n\n```transact-sql\nusing System;\nusing System.Threading.Tasks;\n\nusing Google.Apis.Discovery.v1;\nusing Google.Apis.Discovery.v1.Data;\nusing Google.Apis.Services;\n\nnamespace Discovery.ListAPIs\n{\n /// \u003csummary\u003e\n /// This example uses the discovery API to list all APIs in the discovery repository.\n /// https://developers.google.com/discovery/v1/using.\n /// \u003csummary\u003e\n class Program\n {\n [STAThread]\n static void Main(string[] args)\n {\n Console.WriteLine(\"Discovery API Sample\");\n Console.WriteLine(\"====================\");\n try\n {\n new Program().Run().Wait();\n }\n catch (AggregateException ex)\n {\n foreach (var e in ex.InnerExceptions)\n {\n Console.WriteLine(\"ERROR: \" + e.Message);\n }\n }\n Console.WriteLine(\"Press any key to continue...\");\n Console.ReadKey();\n }\n\n private async Task Run()\n {\n // Create the service.\n var service = new DiscoveryService(new BaseClientService.Initializer\n {\n ApplicationName = \"Discovery Sample\",\n ApiKey=\"[YOUR_API_KEY_HERE]\",\n });\n\n // Run the request.\n Console.WriteLine(\"Executing a list request...\");\n var result = await service.Apis.List().ExecuteAsync();\n\n // Display the results.\n if (result.Items != null)\n {\n foreach (DirectoryList.ItemsData api in result.Items)\n {\n Console.WriteLine(api.Id + \" - \" + api.Title);\n }\n }\n }\n }\n}\n```\n\n\nTips for using API keys:\n\n- In order to use a specific service, you have to add a reference to it. For example if you want to use the [Tasks API](https://developers.google.com/google-apps/tasks/), you should install its NuGet package [Google.Apis.Tasks.v1](http://www.nuget.org/packages/Google.Apis.Tasks.v1/).\n- To create an instance of a service, just call its constructor. For example: `new TasksService(new BaseClientService.Initializer {...});\"`.\n- All methods of a service are located on individual resources on the service object itself. The Discovery service has an `Apis` resource, which contains a `List` method. When you call `service.Apis.List(..)` a request object targeting this method is returned. \n To execute a request, call the `Execute()` or `ExecuteAsyc()` method on a request.\n- Set the API key using the `ApiKey` property on the `BaseClientService.Initializer` instance.\n\nFinding information about the APIs\n\n\nThe\n[Supported APIs](/api-client-library/dotnet/apis)\npage lists all APIs that can be accessed using this library as well as links to documentation.\n\n\nYou can also use the\n[APIs Explorer](/apis-explorer)\nto browse APIs, list available methods, and even try API calls from your browser."]]
