इस एपीआई का इस्तेमाल शुरू करें

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

बिड मैनेजर एपीआई v2 सबसे नया और सुझाया गया वर्शन है.

1. शुरू करने से पहले

अगर आपको Google Display & Video 360 के कॉन्सेप्ट के बारे में कुछ भी नहीं पता है, तो Display & Video 360 सहायता केंद्र पढ़ें और यूज़र इंटरफ़ेस के साथ प्रयोग करें.

2. पुष्टि करने की तैयारी करना

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

अगर आपने पहले से ऐसा नहीं किया है, तो क्रेडेंशियल बनाएं > OAuth क्लाइंट आईडी पर क्लिक करके, अपने OAuth 2.0 क्रेडेंशियल बनाएं. क्रेडेंशियल बनाने के बाद, क्रेडेंशियल पेज पर जाकर अपना क्लाइंट आईडी देखा जा सकता है. क्लाइंट सीक्रेट, रीडायरेक्ट यूआरआई, JavaScript ऑरिजिन पता, और ईमेल पता जैसी जानकारी के लिए, क्लाइंट आईडी पर क्लिक करें.

ज़्यादा जानकारी के लिए, अनुरोधों को अनुमति देना देखें.

3. Bid Manager API को कॉल करें

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

Java

  1. ज़रूरी लाइब्रेरी इंपोर्ट करें.

    import static java.nio.charset.StandardCharsets.UTF_8;
    import com.google.api.client.auth.oauth2.Credential;
    import com.google.api.client.extensions.java6.auth.oauth2.AuthorizationCodeInstalledApp;
    import com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver;
    import com.google.api.client.googleapis.auth.oauth2.GoogleAuthorizationCodeFlow;
    import com.google.api.client.googleapis.auth.oauth2.GoogleClientSecrets;
    import com.google.api.client.googleapis.util.Utils;
    import com.google.api.services.doubleclickbidmanager.DoubleClickBidManager;
    import com.google.api.services.doubleclickbidmanager.model.ListQueriesResponse;
    import com.google.api.services.doubleclickbidmanager.model.Query;
    import java.io.Reader;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
  2. क्लाइंट सीक्रेट वाली फ़ाइल लोड करें और ऑथराइज़ेशन क्रेडेंशियल जनरेट करें.

    पहली बार यह चरण पूरा करने पर, आपसे अपने ब्राउज़र में अनुमति देने का अनुरोध स्वीकार करने के लिए कहा जाता है. स्वीकार करने से पहले, पक्का करें कि आपने ऐसे Google खाते से साइन इन किया है जिसके पास Display & Video 360 का ऐक्सेस है. आपके ऐप्लिकेशन को उस खाते की तरफ़ से डेटा ऐक्सेस करने की अनुमति होगी जिसमें फ़िलहाल साइन इन किया हुआ है.

    // Read client secrets file.
    GoogleClientSecrets clientSecrets;
    try (Reader reader = Files.newBufferedReader(Paths.get(path-to-client-secrets-file), UTF_8)) {
      clientSecrets = GoogleClientSecrets.load(Utils.getDefaultJsonFactory(), reader);
    }
    
    // Generate authorization credentials.
    // Set up the authorization code flow.
    GoogleAuthorizationCodeFlow flow =
        new GoogleAuthorizationCodeFlow.Builder(
            Utils.getDefaultTransport(),
            Utils.getDefaultJsonFactory(),
            clientSecrets,
            oauth-scopes)
        .build();
    
    Credential credential =
        new AuthorizationCodeInstalledApp(flow, new LocalServerReceiver()).authorize("user");
    
  3. अनुमति वाला एपीआई क्लाइंट बनाएं.

    // Create authorized API client.
    DoubleClickBidManager service =
        new DoubleClickBidManager.Builder(credential.getTransport(), credential.getJsonFactory(), credential)
            .setApplicationName("bidmanager-java-installed-app-sample")
            .build();
    
  4. कोई कार्रवाई करें.

    // Perform an operation.
    // Call the API, getting a list of 10 queries.
    ListQueriesResponse queriesResponse = service.queries().list().setPageSize(10).execute();
    
    // Print them out.
    System.out.println("Id\t\tName");
    if (queriesResponse.getQueries().size() > 0) {
      for (int i = 0; i < queriesResponse.getQueries().size(); i++) {
        Query currentQuery = queriesResponse.getQueries().get(i);
        System.out.printf(
            "%s\t%s%n",
            currentQuery.getQueryId(),
            currentQuery.getMetadata().getTitle());
      }
    } else {
      System.out.println("No queries exist.");
    }
    

Java के साथ बिड मैनेजर एपीआई का इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, बिड मैनेजर एपीआई के उदाहरणों में README फ़ाइल देखें.

Python

  1. ज़रूरी लाइब्रेरी इंपोर्ट करें.

    from google_auth_oauthlib.flow import InstalledAppFlow
    from googleapiclient import discovery
    
  2. क्लाइंट सीक्रेट वाली फ़ाइल लोड करें और ऑथराइज़ेशन क्रेडेंशियल जनरेट करें.

    पहली बार यह चरण पूरा करने पर, आपसे अपने ब्राउज़र में अनुमति देने का अनुरोध स्वीकार करने के लिए कहा जाता है. स्वीकार करने से पहले, पक्का करें कि आपने ऐसे Google खाते से साइन इन किया है जिसके पास Display & Video 360 का ऐक्सेस है. आपके ऐप्लिकेशन को उस खाते की तरफ़ से डेटा ऐक्सेस करने की अनुमति होगी जिसमें फ़िलहाल साइन इन किया हुआ है.

    # Set up a flow object to create the credentials using the
    # client secrets file and OAuth scopes.
    credentials = InstalledAppFlow.from_client_secrets_file(
        path-to-client-secrets-file, oauth-scopes).run_local_server()
    
  3. अनुमति वाला एपीआई क्लाइंट बनाएं.

    # Build the discovery document URL.
    discovery_url = f'https://doubleclickbidmanager.googleapis.com/$discovery/rest?version=v2'
    
    # Build the API service.
    service = discovery.build(
        'doubleclickbidmanager',
        'v2',
        discoveryServiceUrl=discovery_url,
        credentials=credentials)
    
  4. कोई कार्रवाई करें.

    # Build and execute queries.listqueries request.
    response = service.queries().list(pageSize='10').execute()
    
    # Print queries out.
    if 'queries' in response:
      print('Id\t\tName')
      for query in response['queries']:
        print('%s\t%s' % (query['queryId'], query['metadata']['title']))
    else:
      print('No queries exist.')
    

Python के साथ बिड मैनेजर एपीआई का इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, बिड मैनेजर एपीआई के उदाहरणों में README फ़ाइल देखें.

PHP

यह नमूना मानता है कि आप पहले से मौजूद वेब सर्वर के साथ PHP चला रहे हैं. साथ ही, आपको संबंधित वेब पेज पर रीडायरेक्ट करने के लिए, अपने क्रेडेंशियल कॉन्फ़िगर किए हैं. उदाहरण के लिए, index.php फ़ाइल में मौजूद इस कोड को, नीचे दिए गए कमांड और क्रेडेंशियल का इस्तेमाल करके चलाया जा सकता है. पुष्टि किए जाने के बाद, इसे http://localhost:8000 पर रीडायरेक्ट करने के लिए कॉन्फ़िगर किया गया है:

php -S localhost:8000 -t ./

  1. Google API PHP Client को डाउनलोड और इंस्टॉल करें.

    आम तौर पर, यह तरीका कंपोज़र से इस्तेमाल किया जाता है:

    composer require google/apiclient:^2.12.1
    

    इंस्टॉल होने के बाद, पक्का करें कि आपने ऑटोलोडर

    require_once '/path/to/your-project/vendor/autoload.php';
    
    को शामिल किया है

  2. Google_Client ऑब्जेक्ट बनाएं.

    $client = new Google_Client();
    
  3. क्लाइंट सेट अप करें, ज़रूरत पड़ने पर, पुष्टि करने वाले यूआरएल पर रीडायरेक्ट करें, और ऐक्सेस टोकन वापस पाएं.

    पहली बार यह चरण पूरा करने पर, आपसे अपने ब्राउज़र में अनुमति देने का अनुरोध स्वीकार करने के लिए कहा जाता है. स्वीकार करने से पहले, पक्का करें कि आपने ऐसे Google खाते से साइन इन किया है जिसके पास Display & Video 360 का ऐक्सेस है. आपके ऐप्लिकेशन को उस खाते की तरफ़ से डेटा ऐक्सेस करने की अनुमति होगी जिसमें फ़िलहाल साइन इन किया हुआ है.

    // Set up the client.
    $client->setApplicationName('DBM API PHP Samples');
    $client->addScope(oauth-scope);
    $client->setAccessType('offline');
    $client->setAuthConfigFile(path-to-client-secrets-file);
    
    // If the code is passed, authenticate. If not, redirect to authentication page.
    if (isset($_GET['code'])) {
      $client->authenticate($_GET['code']);
    } else {
      $authUrl = $client->createAuthUrl();
      header('Location: ' . $authUrl);
    }
    
    // Exchange authorization code for an access token.
    $accessToken = $client->getAccessToken();
    $client->setAccessToken($accessToken);
    
  4. Display & Video 360 API सेवा के लिए क्लाइंट बनाएं.

    $service = new Google_Service_DoubleClickBidManager($client);
    
  5. कोई कार्रवाई करें.

    // Configure params for the Queries.listqueries request.
    $optParams = array('pageSize' => 10);
    
    // Execute the request.
    $result = $service->queries->listQueries($optParams);
    
    // Print the retrieved queries.
    if (!empty($result->getQueries())) {
      print('<pre><p>Id Name</p>');
      foreach ($result->getQueries() as $query) {
        printf('<p>%s %s</p>', $query->queryId, $query->metadata->title);
      }
      print('</pre>');
    } else {
      print '<p>No queries exist.</p>';
    }
    

PHP के साथ बिड मैनेजर एपीआई का इस्तेमाल करने के बारे में ज़्यादा जानकारी के लिए, बिड मैनेजर एपीआई के उदाहरणों में README फ़ाइल देखें.

4. अगले चरण

अब आपकी क्लाइंट लाइब्रेरी तैयार है और काम कर रही है, तो रेफ़रंस दस्तावेज़ देखें और उन्हें लागू करना शुरू करें.

शेड्यूल की गई रिपोर्ट के इस्तेमाल और रिपोर्ट करने के सबसे सही तरीकों को अपनाने के लिए, अन्य गाइड भी उपलब्ध हैं.