इंडेक्सिंग एपीआई के लिए ज़रूरी शर्तें

इंडेक्सिंग एपीआई का इस्तेमाल करने से पहले, कुछ ऐसी चीज़ें हैं जिन्हें करना ज़रूरी है. खास तौर पर जब आपने उन्हें पहले से नहीं किया है:

अपने क्लाइंट के लिए प्रोजेक्ट बनाना

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

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

सेवा खाता बनाना

  1. सेवा खाते का पेज खोलें. पूछे जाने पर, प्रोजेक्ट चुनें.
  2. सेवा खाता बनाएं पर क्लिक करें, सेवा खाते का नाम और जानकारी डालें. आप डिफ़ॉल्ट सेवा खाता आईडी इस्तेमाल कर सकते हैं या फिर कोई दूसरा, अलग खाता आईडी चुन सकते हैं. काम पूरा हो जाने पर, बनाएं पर क्लिक करें.
  3. फ़ॉलो करने वाले सेवा खाते की अनुमतियां (ज़रूरी नहीं) सेक्शन की ज़रूरत नहीं है. जारी रखें पर क्लिक करें.
  4. उपयोगकर्ताओं को इस खाते का ऐक्सेस दें स्क्रीन पर, नीचे कुंजी बनाएं सेक्शन तक स्क्रोल करें. कुंजी बनाएं पर क्लिक करें.
  5. दिखने वाले साइड पैनल में, अपनी कुंजी का फ़ॉर्मैट चुनें: JSON का सुझाव दिया जाता है.
  6. बनाएं पर क्लिक करें. आपकी नई सार्वजनिक/निजी कुंजी की जोड़ी जनरेट करके आपकी मशीन पर डाउनलोड की जाती है; यह इस कुंजी की अकेली कॉपी की तरह काम करती है. इसे सुरक्षित तौर पर कैसे सेव किया जाए, इसकी जानकारी के लिए, सेवा खाता कुंजियां प्रबंधित करें देखें.
  7. आपके कंप्यूटर पर सेव की गई निजी कुंजी संवाद पर बंद करें पर क्लिक करें, फिर अपने सेवा खातों की टेबल पर वापस लौटने के लिए हो गया पर क्लिक करें.

आगे दिए गए तरीके तभी ज़रूरी हैं अगर आप सेवा खाते को पूरे G Suite डोमेन पर अनुमति देना चाहते हों.

  1. टेबल में नए बनाए गए सेवा खाते का पता लगाएं. कार्रवाइयां में, पर क्लिक करें, फिर बदलाव करें पर क्लिक करें.
  2. सेवा खाते की जानकारी में, पूरे डोमेन पर सौंपना दिखाएं पर क्लिक करें, फिर यह पक्का करें कि पूरे G Suite डोमेन पर सौंपना चालू करें चेकबॉक्स पर सही का निशान लगा है.
  3. अगर आपने अब तक अपने ऐप्लिकेशन की OAuth सहमति स्क्रीन कॉन्फ़िगर नहीं की है, तो आपको पूरे डोमेन पर सौंपना चालू करने से पहले ऐसा करना ज़रूरी होगा. OAuth सहमति कॉन्फ़िगर करने के लिए स्क्रीन पर दिखने वाले निर्देशों का पालन करें, फिर ऊपर दिए गए तरीकों को दोहराएं और चेकबॉक्स को दोबारा चुनें.
  4. सेवा खाते को अपडेट करने के लिए सेव करें पर क्लिक करें और सेवा खातों की टेबल पर वापस लौटें. एक नया कॉलम, पूरे डोमेन पर सौंपना देखा जा सकता है. क्लाइंट आईडी पाने के लिए क्लाइंट आईडी देखें पर क्लिक करें और उसे नोट करके रखें.

Search Console में साइट के मालिकाना हक की पुष्टि करना

यह तरीका अपनाकर आप पुष्टि करेंगे कि आप अपनी वेब प्रॉपर्टी को नियंत्रित करते हैं.

अपनी साइट के मालिकाना हक की पुष्टि करने के लिए:

  1. अपनी प्रॉपर्टी के मालिकाना हक की पुष्टि करने के लिए सुझाया गया तरीका अपनाएं.
  2. प्रॉपर्टी के मालिकाना हक की पुष्टि हो जाने के बाद, Search Console खोलें.
  3. ऐसी प्रॉपर्टी चुनें जिसकी पुष्टि हो चुकी है.
  4. बाईंं ओर दिए गए नेविगेशन पैनल में जाएं और प्रॉपर्टी की सेटिंग खोलें.
  5. उपयोगकर्ता और अनुमतियां चुनें. मालिक का नाम जोड़ें पर क्लिक करें.
  6. अपने सेवा खाते का ईमेल पता डालें. अनुमति से जुड़ी ड्रॉप-डाउन सूची में, सभी चुनें. आप सेवा खाते का ईमेल पता इन दो जगहों पर देख सकते हैं:
    • JSON निजी कुंजी के client_email फ़ील्ड में, जिसे आपने प्रोजेक्ट बनाते समय डाउनलोड किया था.
    • Developers Console में दिखने वाले सेवा खाते केसेवा खाता आईडी कॉलम में.

    ईमेल पते का फ़ॉर्मैट नीचे दिए गए फ़ॉर्मैट जैसा होता है:

    my-service-account@project-name.google.com.iam.gserviceaccount.com

    उदाहरण के लिए, "my-service-account@test-project-42.google.com.iam.gserviceaccount.com".

एक्सेस टोकन पाना

इंडेक्स करने वाले एपीआई को कॉल करने के लिए, कॉल की पुष्टि OAuth टोकन से की जानी चाहिए. यह टोकन आपको अपनी निजी कुंजी डालने पर मिलता है. Google कई मशीनी भाषाओं के लिए एपीआई क्लाइंट लाइब्रेरी की सुविधा देता है जिससे आपको OAuth टोकन मिल सकते हैं.

ज़रूरी बातें

इंडेक्सिंग एपीआई को अनुरोध सबमिट करते समय, अनुरोध में ये चीज़ें होनी चाहिए:

  1. अनुमति देने वाले लिंक के तौर पर, https://www.googleapis.com/auth/indexing का इस्तेमाल करें.
  2. एपीआई इस्तेमाल करना, इस लिंक में बताए गए किसी एक एंडपॉइंट का इस्तेमाल करें.
  3. अनुरोध में सेवा खाते को एक्सेस के लिए टोकन शामिल करें.
  4. एपीआई इस्तेमाल करना में दिए गए कोड के हिसाब से अनुरोध का कोड डालें.

उदाहरण

नीचे दिए गए उदाहरणों में OAuth ऐक्सेस के लिए टोकन पाने का तरीका बताया गया है:

Python

Python के लिए Google API Client library इस्तेमाल करके OAuth टोकन पाएं:

from oauth2client.service_account import ServiceAccountCredentials
import httplib2

SCOPES = [ "https://www.googleapis.com/auth/indexing" ]
ENDPOINT = "https://indexing.googleapis.com/v3/urlNotifications:publish"

# service_account_file.json is the private key that you created for your service account.
JSON_KEY_FILE = "service_account_file.json"

credentials = ServiceAccountCredentials.from_json_keyfile_name(JSON_KEY_FILE, scopes=SCOPES)

http = credentials.authorize(httplib2.Http())

# Define contents here as a JSON string.
# This example shows a simple update request.
# Other types of requests are described in the next step.

content = """{
  \"url\": \"http://example.com/jobs/42\",
  \"type\": \"URL_UPDATED\"
}"""

response, content = http.request(ENDPOINT, method="POST", body=content)

Java

Java के लिए Google API Client library इस्तेमाल करके OAuth टोकन पाएं:

String scopes = "https://www.googleapis.com/auth/indexing";
String endPoint = "https://indexing.googleapis.com/v3/urlNotifications:publish";

JsonFactory jsonFactory = new JacksonFactory();

// service_account_file.json is the private key that you created for your service account.
InputStream in = IOUtils.toInputStream("service_account_file.json");

GoogleCredential credentials =
  GoogleCredential.fromStream(in, this.httpTransport, jsonFactory).createScoped(Collections.singleton(scopes));

GenericUrl genericUrl = new GenericUrl(endPoint);
HttpRequestFactory requestFactory = this.httpTransport.createRequestFactory();

// Define content here. The structure of the content is described in the next step.
String content = "{"
  + "\"url\": \"http://example.com/jobs/42\","
  + "\"type\": \"URL_UPDATED\","
  + "}";

HttpRequest request =
  requestFactory.buildPostRequest(genericUrl, ByteArrayContent.fromString("application/json", content));

credentials.initialize(request);
HttpResponse response = request.execute();
int statusCode = response.getStatusCode();

PHP

PHP के लिए Google API Client library इस्तेमाल करके OAuth टोकन पाएं:

require_once 'google-api-php-client/vendor/autoload.php';

$client = new Google_Client();

// service_account_file.json is the private key that you created for your service account.
$client->setAuthConfig('service_account_file.json');
$client->addScope('https://www.googleapis.com/auth/indexing');

// Get a Guzzle HTTP Client
$httpClient = $client->authorize();
$endpoint = 'https://indexing.googleapis.com/v3/urlNotifications:publish';

// Define contents here. The structure of the content is described in the next step.
$content = '{
  "url": "http://example.com/jobs/42",
  "type": "URL_UPDATED"
}';

$response = $httpClient->post($endpoint, [ 'body' => $content ]);
$status_code = $response->getStatusCode();

Node.js के लिए

Node.js के लिए Google API Client library का इस्तेमाल करके OAuth टोकन पाएं.

var request = require("request");
var { google } = require("googleapis");
var key = require("./service_account.json");

const jwtClient = new google.auth.JWT(
  key.client_email,
  null,
  key.private_key,
  ["https://www.googleapis.com/auth/indexing"],
  null
);

jwtClient.authorize(function(err, tokens) {
  if (err) {
    console.log(err);
    return;
  }
  let options = {
    url: "https://indexing.googleapis.com/v3/urlNotifications:publish",
    method: "POST",
    // Your options, which must include the Content-Type and auth headers
    headers: {
      "Content-Type": "application/json"
    },
    auth: { "bearer": tokens.access_token },
    // Define contents here. The structure of the content is described in the next step.
    json: {
      "url": "http://example.com/jobs/42",
      "type": "URL_UPDATED"
    }
  };
  request(options, function (error, response, body) {
    // Handle the response
    console.log(body);
  });
});

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