एपीआई ऐक्सेस सेट अप करना

एसडीके या REST की मदद से, Data Manager API का ऐक्सेस सेट अप करने का तरीका यहां बताया गया है.

ज़रूरी शर्तें

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

  1. एक Google Cloud प्रोजेक्ट.
  2. एक ऐसा Google खाता जो इन दोनों शर्तों को पूरा करता हो:
    1. आपने Data Manager API में दिलचस्पी दिखाने वाला फ़ॉर्म भर दिया हो और आपको Data Manager API का ऐक्सेस मिल गया हो. अगर आपको एपीआई प्रॉडक्ट के बारे में जानकारी वाला पेज दिखता है, तो इसका मतलब है कि आपके पास ऐक्सेस है.
    2. आपके Google Cloud प्रोजेक्ट के लिए, serviceusage.services.enable की अनुमति हो या उसके पास ऐसी भूमिका हो जिसमें यह अनुमति शामिल हो. उदाहरण के लिए, roles/owner और roles/serviceusage.serviceUsageAdmin, दोनों में serviceusage.services.enable अनुमति शामिल है. अनुमतियां देखने के लिए, मौजूदा ऐक्सेस देखें पर जाएं.

एपीआई चालू करना

अगर आपने अब तक ऐसा नहीं किया है, तो Data Manager API चालू करें.

अगर आपको Data Manager API नहीं मिल रहा है, तो पुष्टि करें कि आपका Google खाता ज़रूरी शर्तें पूरी करता हो.

पुष्टि करने की सुविधा सेट अप करना

पुष्टि करने का तरीका चुनें और उसे सेट अप करें. हमारा सुझाव है कि आप ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल सेट अप करें, ताकि एनवायरमेंट से क्रेडेंशियल अपने-आप मिल सकें. यह एपीआई, एपीआई कुंजियों का इस्तेमाल नहीं करता.

Data Manager API के साथ इस्तेमाल किए जाने वाले किसी भी क्रेडेंशियल के लिए, https://www.googleapis.com/auth/datamanager स्कोप ज़रूरी है. स्कोप इस्तेमाल करने के तरीके का उदाहरण देखने के लिए, gcloud auth application-default login कमांड का दस्तावेज़ देखें.

अपने ऐप्लिकेशन के लिए पुष्टि करने और क्रेडेंशियल के बारे में ज़्यादा जानने के लिए, Google पर पुष्टि करने के तरीके और ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल कैसे काम करते हैं लेख पढ़ें.

ऑपरेटिंग खाते का ऐक्सेस सेट अप करना

अपने उपयोगकर्ता या सेवा खाते से जुड़े ईमेल को Destination का ऐक्सेस दें.

अपनी प्रोग्रामिंग लैंग्वेज के लिए एसडीके सेट अप करना

अपने कंप्यूटर पर, अपनी पसंद का एसडीके इंस्टॉल करें:

REST

  1. नीचे दिए गए सैंपल में, प्लेसहोल्डर को अपडेट करें. जैसे, OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID, और AUDIENCE_ID. इन्हें अपने खाते और डेस्टिनेशन की वैल्यू के साथ अपडेट करें.
  2. PROJECT_ID की जगह अपना Google Cloud आईडी डालें.
  3. अनुरोध भेजने के लिए, सैंपल को कमांड लाइन पर कॉपी करें.

    अगर आपको प्रॉडक्ट लिंक का इस्तेमाल करके operatingAccount को ऐक्सेस नहीं करना है, तो destinations में मौजूद एंट्री का linkedAccount एट्रिब्यूट हटाएं.

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account, the command that specifies
    # --scopes fails. This sample falls back to the command without the
    # --scopes argument.
    DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager || \
      gcloud auth application-default print-access-token)"
    
    # Fetches and prints the scope information for the access token. If you
    # get scope-related errors when you send the request in the next step,
    # verify that this output includes the Data Manager API scope:
    #   https://www.googleapis.com/auth/datamanager
    curl https://www.googleapis.com/oauth2/v1/tokeninfo?access_token="${DATA_MANAGER_ACCESS_TOKEN}"
    
    # Sends the request.
    curl -X POST "https://datamanager.googleapis.com/v1/audienceMembers:ingest" \
      --header "Authorization: Bearer ${DATA_MANAGER_ACCESS_TOKEN}" \
      --header "x-goog-user-project: PROJECT_ID" \
      --header "Content-Type: application/json" \
      --data @- <<EOF
    {
      "destinations": [
        {
          "operatingAccount": {
            "product": "OPERATING_ACCOUNT_PRODUCT",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "product": "LOGIN_ACCOUNT_PRODUCT",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "product": "LINKED_ACCOUNT_PRODUCT",
            "accountId": "LINKED_ACCOUNT_ID"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
              },
              {
                "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
              },
              {
                "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
              },
              {
                "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
              },
              {
                "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
              }
            ]
          }
        },
        {
          "userData": {
            "userIdentifiers": [
              {
                "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
              },
              {
                "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
              }
            ]
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

Java

  1. google-cloud-ads-datamanager-v1-java.tar.gz को डाउनलोड और एक्सट्रैक्ट करें.
  2. google-cloud-ads-datamanager-v1-java डायरेक्ट्री पर जाएं.
  3. Maven या Gradle के साथ इस्तेमाल करने के लिए, लाइब्रेरी को अपनी लोकल Maven रिपॉज़िटरी में बनाने और पब्लिश करने के लिए, यह कमांड चलाएं.

    ./gradlew -Pversion=0.1.0 install
    
  4. अपने Java प्रोजेक्ट में, Data Manager API लाइब्रेरी के लिए डिपेंडेंसी का एलान करें.

    Gradle:

    implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.0'
    

    Maven:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. Optional. यूटिलिटी लाइब्रेरी और कोड सैंपल पाएं.

    1. GitHub रिपॉज़िटरी का क्लोन बनाएं.

      git clone https://github.com/googleads/data-manager-java.git
      
    2. data-manager-java डायरेक्ट्री पर जाएं.

    3. यूटिलिटी लाइब्रेरी बनाएं और उसे अपने लोकल मेवन रिपॉज़िटरी में पब्लिश करें.

      ./gradlew data-manager-util:install
      
    4. अपने Java प्रोजेक्ट में, यूटिलिटी लाइब्रेरी पर डिपेंडेंसी तय करें.

      Gradle:

      implementation 'com.google.api-ads:data-manager-util:0.1.0'
      

      Maven:

      <dependency>
         <groupId>com.google.api-ads</groupId>
         <artifactId>data-manager-util</artifactId>
         <version>0.1.0</version>
      </dependency>
      
    5. डेटा को फ़ॉर्मैट और एन्क्रिप्ट (सुरक्षित) करने के लिए, अपने Java प्रोजेक्ट में UserDataFormatter और Encrypter यूटिलिटी का इस्तेमाल करें.

    6. data-manager-samples सबडायरेक्ट्री में या GitHub पर कोड के सैंपल ब्राउज़ करें. कमांड लाइन से किसी सैंपल को चलाने के लिए, Gradle run टास्क का इस्तेमाल करें.

      उदाहरण के लिए, यहां दिया गया निर्देश IngestAudienceMembers सैंपल को चलाता है और इस्तेमाल से जुड़ा स्टेटमेंट प्रिंट करता है:

      ./gradlew data-manager-samples:run \
        --args='IngestAudienceMembers --help'
      

      कुछ सैंपल डेटा के साथ शुरुआत करने के लिए, data-manager-samples/src/main/resources/sampledata/audience_members_1.csv पर मौजूद फ़ाइल का इस्तेमाल करें.

Python

  1. ads-datamanager-v1-py.tar.gz डाउनलोड करें.
  2. डाउनलोड की गई फ़ाइल की डायरेक्ट्री पर जाएं.
  3. लाइब्रेरी बनाने और उसे एक ही Python एनवायरमेंट में मौजूद अन्य प्रोजेक्ट के लिए उपलब्ध कराने के लिए, यह कमांड चलाएं:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. अपने Python प्रोजेक्ट में, Data Manager API लाइब्रेरी के लिए डिपेंडेंसी का एलान करें. उदाहरण के लिए, अगर आपको अपने प्रोजेक्ट में requirements.txt फ़ाइल का इस्तेमाल करना है, तो फ़ाइल में यह लाइन जोड़ें:

    google-ads-data-manager=0.1.0
    
  5. Optional. यूटिलिटी लाइब्रेरी और कोड सैंपल पाएं.

    1. data-manager-python.tar.gz को डाउनलोड और एक्सट्रैक्ट करें.
    2. data-manager-python डायरेक्ट्री पर जाएं.
    3. अपने Python एनवायरमेंट में यूटिलिटी लाइब्रेरी इंस्टॉल करने के लिए, यह कमांड चलाएं:

      pip install .
      
    4. अपने Python प्रोजेक्ट में, यूटिलिटी लाइब्रेरी पर डिपेंडेंसी का एलान करें. उदाहरण के लिए, अगर आपको अपने प्रोजेक्ट में requirements.txt फ़ाइल का इस्तेमाल करना है, तो फ़ाइल में यह लाइन जोड़ें:

      google-ads-data-manager-util=0.1.0
      
    5. डेटा को फ़ॉर्मैट और एन्क्रिप्ट (सुरक्षित) करने के लिए, अपने Python प्रोजेक्ट में Formatter और Encrypter यूटिलिटी का इस्तेमाल करें.

    6. samples सबडायरेक्ट्री में कोड के सैंपल ब्राउज़ करें. सैंपल को चलाने के दौरान, --help आर्ग्युमेंट पास करें, ताकि अनुमानित पैरामीटर के साथ इस्तेमाल से जुड़ा स्टेटमेंट प्रिंट किया जा सके.

      कुछ सैंपल डेटा के साथ शुरुआत करने के लिए, samples/sampledata/audience_members_1.csv पर मौजूद फ़ाइल का इस्तेमाल करें.

Node.js

  1. ads-datamanager-v1-nodejs.tar.gz डाउनलोड करें और इसे एक्सट्रैक्ट करें.
  2. ads-datamanager-v1-nodejs डायरेक्ट्री पर जाएं.
  3. लाइब्रेरी को कंपाइल और पैक करके .tgz फ़ाइल में बदलने के लिए, यहां दिए गए कमांड चलाएं. इससे npm के साथ लाइब्रेरी का इस्तेमाल किया जा सकेगा.

    npm install
    npm pack
    

    इन कमांड से, google-cloud-datamanager-0.1.0.tgz नाम का एक संग्रह जनरेट होता है.

  4. अपने Node.js प्रोजेक्ट में, Data Manager API लाइब्रेरी पर निर्भरता का एलान करें. इसके लिए, google-cloud-datamanager-0.1.0.tgz फ़ाइल के पूरे पाथ और फ़ाइल नाम के लिए dependencies एंट्री जोड़ें.

PHP

  1. google-cloud-ads-datamanager-v1-php.tar.gz को डाउनलोड और एक्सट्रैक्ट करें.
  2. google-cloud-ads-datamanager-v1-php डायरेक्ट्री पर जाएं.
  3. लाइब्रेरी के लिए ज़रूरी सॉफ़्टवेयर से जुड़ी समस्याओं को ठीक करने के लिए, यह कमांड चलाएं:

    composer update --prefer-dist
    
  4. उसी होस्ट पर मौजूद अपने PHP प्रोजेक्ट की composer.json फ़ाइल में, यहां दिया गया तरीका अपनाकर Data Manager API लाइब्रेरी पर डिपेंडेंसी का एलान करें:

    1. एक repositories सेक्शन जोड़ें, जो google-cloud-ads-datamanager-v1-php डायरेक्ट्री की जगह की ओर ले जाता हो.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_CLIENT_LIBRARY"
         }
      ]
      
    2. Data Manager API लाइब्रेरी पर डिपेंडेंसी का एलान करें.

      "require": {
         "googleads/data-manager": "^0.1.0"
      }
      
  5. (ज़रूरी नहीं) यूटिलिटी लाइब्रेरी और कोड के सैंपल पाएं.

    1. data-manager-php.tar.gz को डाउनलोड और एक्सट्रैक्ट करें.
    2. data-manager-php डायरेक्ट्री पर जाएं.
    3. लाइब्रेरी के लिए ज़रूरी सॉफ़्टवेयर से जुड़ी समस्याओं को ठीक करने के लिए, यह कमांड चलाएं:

      composer update --prefer-dist
      
    4. उसी होस्ट पर मौजूद अपने PHP प्रोजेक्ट की composer.json फ़ाइल में, यहां दिया गया तरीका अपनाकर यूटिलिटी लाइब्रेरी के लिए डिपेंडेंसी का एलान करें:

      1. repositories सेक्शन में एक एंट्री जोड़ें, जो data-manager-php डायरेक्ट्री की जगह की ओर इशारा करती हो.

        "repositories" : [
           {
              "type" : "path",
              "url" : "PATH_TO_UTILITY_LIBRARY"
           }
        ]
        
      2. यूटिलिटी लाइब्रेरी पर डिपेंडेंसी का एलान करें.

        "require": {
           "googleads/data-manager-util": "@dev"
        }
        

      डेटा को फ़ॉर्मैट करने के लिए, अपने PHP प्रोजेक्ट में Formatter यूटिलिटी का इस्तेमाल करें.

    5. samples सबडायरेक्ट्री में कोड के सैंपल ब्राउज़ करें. यहां दिया गया तरीका अपनाकर, सैंपल चलाएं:

      1. samples डायरेक्ट्री पर जाएं.

      2. DATA_MANAGER_PHP_LIB एनवायरमेंट वैरिएबल को उस पाथ पर सेट करें जहां आपने क्लाइंट लाइब्रेरी को एक्सट्रैक्ट किया था.

        export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"
        
      3. लाइब्रेरी के लिए ज़रूरी सॉफ़्टवेयर से जुड़ी समस्याओं को ठीक करने के लिए, यह कमांड चलाएं:

        composer update --prefer-dist
        
      4. ज़रूरी आर्ग्युमेंट पास करके, सैंपल चलाएं. इस्तेमाल से जुड़ी जानकारी को प्रिंट करने के लिए, सैंपल चलाते समय --help आर्ग्युमेंट पास करें. इसमें अनुमानित पैरामीटर शामिल होते हैं.

      कुछ सैंपल डेटा के साथ शुरुआत करने के लिए, samples/sampledata/audience_members_1.csv पर मौजूद फ़ाइल का इस्तेमाल करें.

अगले चरण