इस पेज का अनुवाद Cloud Translation API से किया गया है.

कोड के नमूने चलाएं

Google API एक्सप्लोरर, डायनैमिक तौर पर कोड सैंपल जनरेट करता है. इन कोड सैंपल को स्थानीय रूप से कॉपी करने और चलाने के लिए डिज़ाइन किया गया है. सैंपल देखने के लिए, एपीआई एक्सप्लोरर साइड पैनल में फ़ुल-स्क्रीन पर क्लिक करें. नीचे दिया गया चित्र, विस्तृत फ़ुल-स्क्रीन API एक्सप्लोरर दिखाता है:

**दूसरी इमेज**: Google Books API के लिए API एक्सप्लोरर फ़ुल-स्क्रीन पैनल.

एपीआई एक्सप्लोरर डिफ़ॉल्ट रूप से, आपके अनुरोध को पूरा करने के लिए cURL इस्तेमाल करने का तरीका बताता है. कुछ एपीआई अन्य भाषाओं के भी नमूने दिखा सकते हैं, जैसे कि JavaScript, Java, और Python.

स्थानीय तौर पर कोड सैंपल चलाएं

नीचे दिए गए टैब, कोड सैंपल चलाने के लिए ज़रूरी शर्तों और चरणों के बारे में बताते हैं. कोड के नमूने चलाने के लिए, आपको अपने अनुमति वाले क्रेडेंशियल जनरेट और इस्तेमाल करने होंगे. प्रोजेक्ट बनाने और क्रेडेंशियल जनरेट करने के तरीके के बारे में ज़्यादा जानकारी पाने के लिए, अपने खास Google API के दस्तावेज़ देखें.

क्रेडेंशियल इस तरह के डेटा पर निर्भर करता है (सार्वजनिक या निजी) जिस तरीके से ऐक्सेस किया जा रहा है:

सार्वजनिक डेटा के लिए, क्रेडेंशियल एक एपीआई कुंजी है.
निजी डेटा के लिए, क्रेडेंशियल client_secret.json ऐसी फ़ाइल होती है जिसमें आपके OAuth 2.0 क्लाइंट आईडी और क्लाइंट सीक्रेट या OAuth 2.0 का ऐक्सेस टोकन होता है.

cURL

सेट अप करें

अपने ऐप्लिकेशन के लिए प्रोजेक्ट बनाने या चुनने के लिए, एपीआई दस्तावेज़ में दिए गए निर्देशों का पालन करें.
Cloud Console में, एपीआई कुंजी बनाएं.
Cloud Console में, किसी वेब ऐप्लिकेशन के लिए OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं और रीडायरेक्ट यूआरआई के तौर पर https://developers.google.com/oauthplayground का इस्तेमाल करें.
OAuth 2.0 Playground में, OAuth 2.0 कॉन्फ़िगरेशन पर क्लिक करें.
अपने क्रेडेंशियल का इस्तेमाल करें पर सही का निशान लगाएं.
तीसरे चरण में जनरेट किया गया क्लाइंट आईडी और क्लाइंट सीक्रेट डालें.
स्कोप फ़ील्ड में, अपने तरीके के साथ इस्तेमाल करने के लिए दायरा टाइप करें और एपीआई अनुमति दें पर क्लिक करें.
(ज़रूरी नहीं) अगर साइन इन स्क्रीन के साथ स्क्रीन शेयर की गई हो, तो जिस खाते का इस्तेमाल करना है उसे चुनें.
(ज़रूरी नहीं) अगर ऑथराइज़ेशन स्क्रीन दिखती है, तो स्वीकार करें पर क्लिक करें.
टोकन के लिए एक्सचेंज ऑथराइज़ेशन कोड पर क्लिक करें. टोकन दिखाया जाता है.
cURL कोड सैंपल में, [YOUR_API_KEY] को दूसरे चरण में जनरेट की गई एपीआई कुंजी से बदलें: 'https://www.googleapis.com/drive/v3/files?key=[YOUR_API_KEY]' \
cURL कोड सैंपल में, [YOUR_ACCESS_TOKEN] को चरण 10 में जनरेट किए गए ऐक्सेस टोकन से बदलें: --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \

कोड का एक्ज़ीक्यूट करें

कमांड लाइन से, cURL निर्देश चलाएं. कमांड इससे मिलता-जुलता होना चाहिए:

curl \
'https://www.googleapis.com/drive/v3/files?key=AIzaSyBiKcaoXmVApwnT24hitQG_dwjGvAj6Ddw' \
--header 'Authorization: Bearer ya29.a0ARrdaM_yQn9MWBpJgKPx880BSnRYIizRYIDz0JN9e66nSliIYpqNXmPsvv2ccfplCTG_U4b1' \
--header 'Accept: application/json' \
--compressed

JavaScript

सेट अप करें

अपने ऐप्लिकेशन के लिए प्रोजेक्ट बनाने या चुनने के लिए, एपीआई दस्तावेज़ में दिए गए निर्देशों का पालन करें.
Cloud Console में, एपीआई कुंजी बनाएं.
Cloud Console में, एक "वेब ऐप्लिकेशन&quot के लिए OAuth क्लाइंट आईडी क्रेडेंशियल बनाएं; और उस यूआरएल की पहचान करने के लिए अनुमति वाले JavaScript ऑरिजिन को सेट करें जिससे आप अनुरोध भेजेंगे, जैसे कि http://localhost.
पूरे कोड सैंपल को किसी ऐसी स्थानीय फ़ाइल में कॉपी करें जिसे आपके वेब सर्वर से ऐक्सेस किया जा सके, जैसे कि /var/www/html/example.html.
कोड सैंपल में, वह लाइन ढूंढें जो एपीआई कुंजी या क्लाइंट आईडी सेट करती है और वैल्यू को दूसरे और तीसरे चरण में जनरेट की गई वैल्यू से बदलें:
- एपीआई कुंजी: gapi.client.setApiKey(YOUR_API_KEY);
- OAuth 2.0 क्लाइंट आईडी: gapi.client.init({ 'clientId': 'YOUR_CLIENT_ID',

कोड का एक्ज़ीक्यूट करें

अपने ब्राउज़र में फ़ाइल खोलें, जैसे कि http://localhost/example.html. हम Google Chrome जैसे डीबग करने वाले कंसोल के साथ ब्राउज़र इस्तेमाल करने का सुझाव देते हैं.
(ज़रूरी नहीं) अगर साइन इन स्क्रीन के साथ स्क्रीन शेयर की गई हो, तो जिस खाते का इस्तेमाल करना है उसे चुनें.
(ज़रूरी नहीं) अगर ऑथराइज़ेशन स्क्रीन दिखती है, तो स्वीकार करें पर क्लिक करें. डीबग करने वाले कंसोल में, रिस्पॉन्स को JSON ऑब्जेक्ट के तौर पर दिखाया जाना चाहिए.

Java

ज़रूरी शर्तें

Java 1.7 या उसके बाद का वर्शन.
7 या उससे ज़्यादा Gradle.

सेट अप करें

अपने ऐप्लिकेशन के लिए प्रोजेक्ट बनाने या चुनने के लिए, एपीआई दस्तावेज़ में दिए गए निर्देशों का पालन करें.
तरीका, डेटा को ऐक्सेस करने के आधार पर एपीआई कुंजी (सार्वजनिक डेटा) बनाता है या OAuth 2.0 क्लाइंट आईडी (निजी डेटा) बनाता है.
ऐप्लिकेशन टाइप को डेस्कटॉप ऐप्लिकेशन पर सेट करें.
अगर आपने OAuth 2.0 क्लाइंट आईडी बनाया है, तो ऐसी JSON फ़ाइल डाउनलोड करें जिसमें आपके OAuth 2.0 क्रेडेंशियल शामिल हों. इस फ़ाइल का नाम client_secret_CLIENTID.json से मिलता-जुलता है, जहां CLIENTID आपके प्रोजेक्ट का क्लाइंट आईडी है.
अपनी काम करने वाली निर्देशिका में, नया प्रोजेक्ट स्ट्रक्चर बनाने के लिए नीचे दिए गए निर्देश चलाएं:
```
$ gradle init --type basic
$ mkdir -p src/main/java src/main/resources
```
अगर आपने दूसरे चरण में OAuth 2.0 क्लाइंट आईडी बनाया है, तो उस JSON फ़ाइल का नाम बदलें जिसे आपने client_secret.json पर डाउनलोड किया है.
बदली गई फ़ाइल को src/main/resources डायरेक्ट्री में सेव करें, जिसे आपने पांचवें चरण में बनाया था.

अपनी काम करने की निर्देशिका में, build.gradle फ़ाइल खोलें और इसकी सामग्री को नीचे बताए गए तरीके से बदलें:

apply plugin: 'java'
apply plugin: 'application'

mainClassName = 'ApiExample'
sourceCompatibility = 1.7
targetCompatibility = 1.7
version = '1.0'

repositories {
    mavenCentral()
}

dependencies {
    compile 'com.google.api-client:google-api-client:1.23.0'
    compile 'com.google.oauth-client:google-oauth-client-jetty:1.23.0'
    API_SPECIFIC_DEPENDENCY
}

build.gradle फ़ाइल में, API_SPECIFIC_DEPENDENCY वाली लाइन को बदलें. कोड की मदद से, उस कोड को कंपाइल करें जिसमें आप कॉल कर रहे हैं. यहां YouTube Analytics API का सैंपल दिया गया है:
```
compile 'com.google.apis:google-api-services-youtubeAnalytics:v2-rev16-1.23.0'
```
यह निर्देश इस टेंप्लेट के बाद आता है:
```
compile 'com.google.apis:google-api-services-API_NAME:API_VERSION-   revREVISION-CL_VERSION'
```

जगह:

एपीआई के लिए, GitHub पर API_NAME का नाम दिया गया है. नाम ढूंढने के लिए, एपीआई की सुविधा वाले Google API पेज पर, अपने एपीआई के आगे मौजूद वर्शन के लिंक पर क्लिक करें. वर्शन लिंक GitHub पर जाता है. एपीआई का नाम पेज के बीच में है, जिसके पहले googleapis/google-apis-services- है. उदाहरण के लिए, Drive API के v3 के लिए, API_NAME drive है.
एपीआई के लिए सूची में शामिल एपीआई का वर्शन API_VERSION है. यह एपीआई, काम करने वाले Google API पेज पर एपीआई के नाम के नीचे होता है.
REVISION, एपीआई के लिए JavaDoc रेफ़रंस में शामिल रिवीज़न नंबर है. JavaDoc रेफ़रंस https://googleapis.dev/java/google-api-services-API_NAME/latest/index.html पर दिया गया है
CL_VERSION, क्लाइंट लाइब्रेरी का वर्शन है. यह वैल्यू JavaDoc रेफ़रंस में भी दिखती है.
अपनी काम करने वाली निर्देशिका से, कोड एक्सप्लोरर को API एक्सप्लोरर से src/main/java/ApiExample.java में कॉपी करें. (हर नमूने में मौजूद क्लास का नाम, ApiExample होता है, ताकि आपको अलग-अलग सैंपल चलाने के लिए, build.gradle फ़ाइल में बदलाव करने की ज़रूरत न पड़े.

कोड का एक्ज़ीक्यूट करें

उदाहरण चलाने के लिए, इस निर्देश का इस्तेमाल करें:

  gradle -q run

सैंपल में आपके एपीआई का अनुरोध पूरा होना चाहिए और जवाब को STDOUT पर प्रिंट किया जाना चाहिए. आप वह सेवा भी देख सकते हैं जिसे आप कॉल कर रहे हैं, ताकि डेटा लिखने वाले अनुरोधों के असर देखे जा सकें.

Node.js के लिए

ज़रूरी शर्तें

Node.js के लिए
Node.js के लिए Google API क्लाइंट लाइब्रेरी:
- अगर आपने पहले क्लाइंट लाइब्रेरी इंस्टॉल नहीं की है, तो निर्देश खोलें:
```
npm install googleapis --save
```
- अगर आपने पहले क्लाइंट लाइब्रेरी इंस्टॉल की थी, तो हम आपको यह अपडेट करने का सुझाव देते हैं. इससे यह पक्का हो जाएगा कि आपके पास उस लाइब्रेरी की सबसे अप-टू-डेट क्लास है जिसकी आप जांच कर रहे हैं. क्लाइंट लाइब्रेरी को अपडेट करने के लिए, निर्देश चलाएं:
```
npm update googleapis --save
```

सेट अप करें

अपने ऐप्लिकेशन के लिए प्रोजेक्ट बनाने या चुनने के लिए, एपीआई दस्तावेज़ में दिए गए निर्देशों का पालन करें.
तरीका, डेटा को ऐक्सेस करने के आधार पर एपीआई कुंजी (सार्वजनिक डेटा) बनाता है या OAuth 2.0 क्लाइंट आईडी (निजी डेटा) बनाता है.
ऐप्लिकेशन टाइप को डेस्कटॉप ऐप्लिकेशन पर सेट करें.
अगर आपने OAuth 2.0 क्लाइंट आईडी बनाया है, तो ऐसी JSON फ़ाइल डाउनलोड करें जिसमें आपके OAuth 2.0 क्रेडेंशियल शामिल हों. इस फ़ाइल का नाम client_secret_CLIENTID.json से मिलता-जुलता है, जहां CLIENTID आपके प्रोजेक्ट का क्लाइंट आईडी है.
अपनी एपीआई कुंजी या क्लाइंट सीक्रेट फ़ाइल की सही से पहचान करने के लिए, कोड के सैंपल को किसी स्थानीय फ़ाइल में कॉपी करें और नमूने में बदलाव करें. नमूने में, एपीआई कुंजी की वैल्यू YOUR_API_KEY है और क्लाइंट सीक्रेट फ़ाइल की जगह YOUR_CLIENT_SECRET_FILE.json है.

कोड का एक्ज़ीक्यूट करें

उदाहरण चलाने के लिए, इस निर्देश का इस्तेमाल करें:

  node sample.js

ज़्यादातर सैंपल, एपीआई के नतीजे (या किसी और चीज़) को STDOUT पर प्रिंट करते हैं.

PHP

ज़रूरी शर्तें

कमांड-लाइन इंटरफ़ेस (CLI) और JSON एक्सटेंशन के साथ PHP 5.4 या उसके बाद का वर्शन.
Composer डिपेंडेंसी मैनेजमेंट टूल दुनिया भर में इंस्टॉल किया गया.
PHP के लिए Google API क्लाइंट लाइब्रेरी:
- अगर आपने पहले क्लाइंट लाइब्रेरी इंस्टॉल नहीं की है, तो निर्देश खोलें:
```
composer require google/apiclient:^2.0
```
- अगर आपने पहले क्लाइंट लाइब्रेरी इंस्टॉल की है, तो हम उसे अपडेट करने का सुझाव देते हैं. इससे यह पक्का हो जाएगा कि आपके पास लाइब्रेरी के लिए अप-टू-डेट क्लास है, जिसकी आप जांच कर रहे हैं. क्लाइंट लाइब्रेरी को अपडेट करने के लिए, निर्देश चलाएं:
```
composer update google/apiclient --with-dependencies
```

कोड का एक्ज़ीक्यूट करें

उदाहरण चलाने के लिए, इस निर्देश का इस्तेमाल करें:

  php sample.php

ज़्यादातर सैंपल, एपीआई के नतीजे (या किसी और चीज़) को STDOUT पर प्रिंट करते हैं.

Python

ज़रूरी शर्तें

Python 2.7 या Python 3.5+
पीआईपी पैकेज मैनेजमेंट टूल
Python के लिए Google API क्लाइंट लाइब्रेरी:
```
pip install --upgrade google-api-python-client
```
उपयोगकर्ता की अनुमति के लिए google-auth-oauthlib और google-auth-httplib2 लाइब्रेरी:
```
pip install --upgrade google-auth-oauthlib google-auth-httplib2
```

सेट अप करें

अपने ऐप्लिकेशन के लिए प्रोजेक्ट बनाने या चुनने के लिए, एपीआई दस्तावेज़ में दिए गए निर्देशों का पालन करें.
तरीका, डेटा को ऐक्सेस करने के आधार पर एपीआई कुंजी (सार्वजनिक डेटा) बनाता है या OAuth 2.0 क्लाइंट आईडी (निजी डेटा) बनाता है.
ऐप्लिकेशन टाइप को डेस्कटॉप ऐप्लिकेशन पर सेट करें.
अगर आपने OAuth 2.0 क्लाइंट आईडी बनाया है, तो ऐसी JSON फ़ाइल डाउनलोड करें जिसमें आपके OAuth 2.0 क्रेडेंशियल शामिल हों. इस फ़ाइल का नाम client_secret_CLIENTID.json से मिलता-जुलता है, जहां CLIENTID आपके प्रोजेक्ट का क्लाइंट आईडी है.
अपनी एपीआई कुंजी या क्लाइंट सीक्रेट फ़ाइल की सही से पहचान करने के लिए, कोड के सैंपल को किसी स्थानीय फ़ाइल में कॉपी करें और नमूने में बदलाव करें. नमूने में, एपीआई कुंजी की वैल्यू YOUR_API_KEY है और क्लाइंट सीक्रेट फ़ाइल की जगह YOUR_CLIENT_SECRET_FILE.json है.

कोड का एक्ज़ीक्यूट करें

उदाहरण चलाने के लिए, इस निर्देश का इस्तेमाल करें:

  python sample.py

ज़्यादातर सैंपल, एपीआई के नतीजे (या किसी और चीज़) को STDOUT पर प्रिंट करते हैं.

Ruby

ज़रूरी शर्तें

रूबी 2.0 या उसके बाद का वर्शन
Ruby के लिए Google API क्लाइंट लाइब्रेरी:
```
gem install google-api-client`
```

सेट अप करें

अपने ऐप्लिकेशन के लिए प्रोजेक्ट बनाने या चुनने के लिए, एपीआई दस्तावेज़ में दिए गए निर्देशों का पालन करें.
तरीका, डेटा को ऐक्सेस करने के आधार पर एपीआई कुंजी (सार्वजनिक डेटा) बनाता है या OAuth 2.0 क्लाइंट आईडी (निजी डेटा) बनाता है.
ऐप्लिकेशन टाइप को डेस्कटॉप ऐप्लिकेशन पर सेट करें.
अगर आपने OAuth 2.0 क्लाइंट आईडी बनाया है, तो ऐसी JSON फ़ाइल डाउनलोड करें जिसमें आपके OAuth 2.0 क्रेडेंशियल शामिल हों. इस फ़ाइल का नाम client_secret_CLIENTID.json से मिलता-जुलता है, जहां CLIENTID आपके प्रोजेक्ट का क्लाइंट आईडी है.
अपनी एपीआई कुंजी या क्लाइंट सीक्रेट फ़ाइल की सही से पहचान करने के लिए, कोड के सैंपल को किसी स्थानीय फ़ाइल में कॉपी करें और नमूने में बदलाव करें. नमूने में, एपीआई कुंजी की वैल्यू YOUR_API_KEY है और क्लाइंट सीक्रेट फ़ाइल की जगह YOUR_CLIENT_SECRET_FILE.json है.

कोड का एक्ज़ीक्यूट करें

उदाहरण चलाने के लिए, इस निर्देश का इस्तेमाल करें:

  ruby sample.rb

ज़्यादातर सैंपल, एपीआई के नतीजे (या किसी और चीज़) को STDOUT पर प्रिंट करते हैं.

सैंपल से जुड़ी समस्याएं हल करना

अनुमति देने वाला डायलॉग नहीं दिखता

API एक्सप्लोरर आपके निजी डेटा का ऐक्सेस देने के लिए पॉप-अप का इस्तेमाल करता है. अगर आपका ब्राउज़र पॉप-अप ब्लॉक करता है, तो यह पॉप-अप नहीं दिखेगा और आप ऐक्सेस नहीं दे पाएंगे.

अनुमति देने वाली स्क्रीन पर जाकर, "अनुमति दें" और क्लिक करने पर, कुछ नहीं होता है. पॉप-अप चालू करने के लिए, अपने ब्राउज़र की पॉप-अप सेटिंग बदलें.

401 या 403 गड़बड़ी मिली

अगर आपको सैंपल का टेस्ट करते समय 401 या 403 गड़बड़ी का मैसेज मिल रहा है, तो यह इनमें से किसी एक समस्या की वजह से हो सकता है:

आपके प्रोजेक्ट के लिए एपीआई चालू नहीं है. एपीआई बनाने और एपीआई को चालू करने के तरीके से जुड़े निर्देश देखें.
आप OAuth 2.0 के बजाय, एपीआई कुंजी के गलत टाइप का इस्तेमाल कर रहे हैं.
आप OAuth 2.0 का इस्तेमाल कर रहे हैं, लेकिन दायरा बहुत कम है.
API (एपीआई) कुंजी सेट अप करने पर, आप अपने क्रेडेंशियल का बिना अनुमति के इस्तेमाल करने से रोकने के लिए पाबंदियां सेट अप कर सकते हैं. हालांकि, अनुरोध उन पाबंदियों को पूरा नहीं करता. ज़्यादा जानकारी के लिए, एपीआई कुंजी से जुड़ी पाबंदियों का इस्तेमाल करना देखें.

मिले-जुले कॉन्टेंट के बारे में चेतावनी मिली

अगर आप Google Cloud एंडपॉइंट का इस्तेमाल करते हैं और अपने एंडपॉइंट को डेवलपमेंट सर्वर में चला रहे हैं, तो आपका ब्राउज़र मिली-जुली सामग्री के लिए चेतावनी दे सकता है. यह चेतावनी इसलिए होती है, क्योंकि एपीआई एक्सप्लोरर एचटीटीपीएस पर लोड होता है. हालांकि, जब आपका एपीआई स्थानीय तौर पर चलता है, तो उसे एचटीटीपी पर होस्ट किया जाता है.

Chrome का इस्तेमाल करके, इस चेतावनी को छिपाने के लिए, खास फ़्लैग के साथ Chrome सेशन शुरू करें:

path/to/chrome --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:port

उदाहरण के लिए:

/usr/bin/google-chrome-stable --user-data-dir=test --unsafely-treat-insecure-origin-as-secure=http://localhost:8080

आपको इस चेतावनी को सिर्फ़ स्थानीय जांच के लिए छिपाना चाहिए.

सिर्फ़ JavaScript पर: gapi तय नहीं की जाती

जब कोई JavaScript कोड, लाइब्रेरी के लोड होने से पहले JavaScript के लिए Google API क्लाइंट लाइब्रेरी को कॉल करने की कोशिश करता है, तो >gapi तय नहीं होती है. पक्का करें कि gapi वैरिएबल का रेफ़रंस देने वाला कोड तब तक कॉल न किया जाए, जब तक क्लाइंट लाइब्रेरी लोड न हो जाए.