با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
این سند تمام اطلاعات اولیه مورد نیاز برای شروع استفاده از کتابخانه را ارائه می دهد. مفاهیم کتابخانه را پوشش می دهد، نمونه هایی را برای موارد استفاده مختلف نشان می دهد، و پیوندهایی به اطلاعات بیشتر ارائه می دهد.
راه اندازی
چند مرحله راه اندازی وجود دارد که باید قبل از استفاده از این کتابخانه انجام دهید:
بسته NuGet را که می خواهید با آن کار کنید نصب کنید .
احراز هویت و مجوز
درک اصول اولیه نحوه استفاده از احراز هویت و مجوز API بسیار مهم است. همه تماس‌های API باید از دسترسی ساده یا مجاز (تعریف شده در زیر) استفاده کنند. بسیاری از روش‌های API به دسترسی مجاز نیاز دارند، اما برخی می‌توانند از هر کدام استفاده کنند. برخی از روش‌های API که می‌توانند استفاده کنند، بسته به اینکه از دسترسی ساده یا مجاز استفاده می‌کنید، رفتار متفاوتی دارند. برای تعیین نوع دسترسی مناسب، به مستندات روش API مراجعه کنید.
1. دسترسی ساده API (کلیدهای API)
این تماس‌های API به هیچ داده خصوصی کاربر دسترسی ندارند. برنامه شما باید خود را به عنوان یک برنامه متعلق به پروژه Google API Console شما احراز هویت کند. این برای اندازه گیری استفاده از پروژه برای اهداف حسابداری مورد نیاز است.
کلید API : برای تأیید اعتبار برنامه خود، از یک کلید API برای پروژه کنسول API خود استفاده کنید. هر تماس دسترسی ساده ای که برنامه شما برقرار می کند باید شامل این کلید باشد.
2. دسترسی مجاز API (OAuth 2.0)
این فراخوان‌های API به داده‌های کاربر خصوصی دسترسی دارند. قبل از اینکه بتوانید با آنها تماس بگیرید، کاربری که به داده های خصوصی دسترسی دارد باید به برنامه شما اجازه دسترسی بدهد. بنابراین، برنامه شما باید احراز هویت شود، کاربر باید به برنامه شما دسترسی بدهد و کاربر باید احراز هویت شود تا به آن دسترسی اعطا شود. همه اینها با OAuth 2.0 و کتابخانه های نوشته شده برای آن انجام می شود.
محدوده : هر API یک یا چند محدوده تعریف می کند که مجموعه ای از عملیات را مجاز اعلام می کند. به عنوان مثال، یک API ممکن است دامنه‌های فقط خواندنی و خواندنی و نوشتنی داشته باشد. هنگامی که برنامه شما درخواست دسترسی به داده های کاربر می کند، درخواست باید شامل یک یا چند محدوده باشد. کاربر باید دامنه دسترسی درخواستی شما را تأیید کند.
نشانه‌های بازخوانی و دسترسی : وقتی کاربر به برنامه شما دسترسی می‌دهد، سرور مجوز OAuth 2.0 به برنامه شما نشانه‌های تازه‌سازی و دسترسی را ارائه می‌دهد. این توکن ها فقط برای محدوده درخواستی معتبر هستند. برنامه شما از نشانه های دسترسی برای مجاز کردن تماس های API استفاده می کند. توکن‌های دسترسی منقضی می‌شوند، اما توکن‌های تازه‌سازی منقضی نمی‌شوند. برنامه شما می تواند از یک نشانه رفرش برای به دست آوردن یک نشانه دسترسی جدید استفاده کند.
شناسه مشتری و راز مشتری : این رشته ها به طور منحصر به فرد برنامه شما را شناسایی می کنند و برای به دست آوردن توکن ها استفاده می شوند. آنها برای پروژه شما در کنسول API ایجاد شده اند. سه نوع شناسه مشتری وجود دارد، بنابراین مطمئن شوید که نوع صحیح برنامه خود را دریافت کنید:
این API از دو نوع اعتبارنامه پشتیبانی می کند. هر اعتباری را که برای پروژه شما مناسب است ایجاد کنید:
OAuth 2.0: هر زمان که برنامه شما اطلاعات کاربر خصوصی را درخواست می کند، باید یک توکن OAuth 2.0 را همراه با درخواست ارسال کند. برنامه شما ابتدا یک شناسه مشتری و احتمالاً یک رمز سرویس گیرنده را برای دریافت رمز ارسال می کند. می توانید اعتبارنامه OAuth 2.0 را برای برنامه های کاربردی وب، حساب های خدماتی یا برنامه های نصب شده ایجاد کنید.
کلیدهای API: درخواستی که توکن OAuth 2.0 ارائه نمی کند باید یک کلید API ارسال کند. کلید پروژه شما را شناسایی می کند و دسترسی، سهمیه و گزارش های API را فراهم می کند.
API از چندین نوع محدودیت در کلیدهای API پشتیبانی می کند. اگر کلید API مورد نیاز شما از قبل وجود ندارد، با کلیک روی ایجاد اعتبار > کلید API، یک کلید API در کنسول ایجاد کنید. می‌توانید کلید را قبل از استفاده از آن در تولید با کلیک کردن روی Restrict key و انتخاب یکی از محدودیت‌ها محدود کنید.
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);}}}}}
نکاتی برای استفاده از کلیدهای API:
برای استفاده از یک سرویس خاص، باید یک مرجع به آن اضافه کنید. برای مثال اگر می‌خواهید از Tasks API استفاده کنید، باید بسته NuGet آن Google.Apis.Tasks.v1 را نصب کنید.
برای ایجاد یک نمونه از یک سرویس، فقط سازنده آن را فراخوانی کنید. به عنوان مثال: new TasksService(new BaseClientService.Initializer {...});" .
تمام متدهای یک سرویس بر روی منابع فردی در خود شیء سرویس قرار دارند. سرویس Discovery یک منبع Apis دارد که حاوی یک متد List است. هنگامی که service.Apis.List(..) را فراخوانی می کنید، یک شی درخواست که این متد را هدف قرار می دهد، برگردانده می شود. برای اجرای یک درخواست، متد Execute() یا ExecuteAsyc() را روی یک درخواست فراخوانی کنید.
کلید API را با استفاده از ویژگی ApiKey در نمونه BaseClientService.Initializer تنظیم کنید.
یافتن اطلاعات در مورد API ها
صفحه پشتیبانی شده APIها لیستی از APIهایی را که می توان با استفاده از این کتابخانه به آنها دسترسی داشت و همچنین پیوندهایی به اسناد ارائه می کند.
همچنین می‌توانید از APIs Explorer برای مرور APIها، فهرست کردن روش‌های موجود و حتی امتحان تماس‌های API از مرورگر خود استفاده کنید.
تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی.
[null,null,["تاریخ آخرین بهروزرسانی 2025-08-29 بهوقت ساعت هماهنگ جهانی."],[[["\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."]]
