دسترسی API را تنظیم کنید

در اینجا نحوه تنظیم دسترسی به API مدیریت داده با SDK یا REST آورده شده است.

پیش‌نیازها

قبل از اینکه بتوانید از Data API استفاده کنید، مطمئن شوید که موارد زیر را دارید:

  1. یک پروژه ابری گوگل .
  2. یک حساب گوگل که مجوز serviceusage.services.enable را در پروژه Google Cloud شما داشته باشد، یا نقشی داشته باشد که شامل آن مجوز باشد. برای مثال، roles/owner و roles/serviceusage.serviceUsageAdmin هر دو شامل مجوز serviceusage.services.enable هستند. برای بررسی مجوزهای خود، به مشاهده دسترسی فعلی مراجعه کنید.

فعال کردن API

اگر قبلاً این کار را نکرده‌اید، با کلیک روی «فعال کردن API مدیریت داده» (Enable the Data Manager API) آن را فعال کنید یا دستورالعمل‌ها را برای انجام دستی این مرحله دنبال کنید.

فعال کردن رابط برنامه‌نویسی کاربردی مدیریت داده

اگر نمی‌توانید رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) را پیدا کنید یا فعال کردن رابط برنامه‌نویسی کاربردی مدیریت داده (Data Manager API) با شکست مواجه شد، تأیید کنید که حساب گوگل شما پیش‌نیازها را برآورده می‌کند.

تنظیم احراز هویت

شما می‌توانید علاوه بر کلیدهای API، از هر یک از روش‌های احراز هویت در گوگل استفاده کنید. توصیه می‌کنیم نحوه انتخاب روش احراز هویت مناسب برای مورد استفاده خود را بررسی کنید تا تصمیم بگیرید کدام رویکرد برای مورد استفاده شما مناسب است.

دو روش احراز هویت رایج ، حساب‌های کاربری و حساب‌های سرویس هستند:

  • حساب‌های کاربری : نمایانگر افرادی هستند که مستقیماً با APIها و سرویس‌های گوگل تعامل دارند.
  • حساب‌های سرویس : برنامه‌ها را به عنوان کاربر نشان می‌دهند، نه افراد را. آن‌ها به برنامه‌های شما اجازه می‌دهند تا احراز هویت و مجوز را مدیریت کنند. به عنوان مثال، اگر یک برنامه نیاز به دسترسی به منابع Google Cloud داشته باشد.

یکپارچه‌سازی شما می‌تواند از اعتبارنامه‌های پیش‌فرض برنامه (ADC) برای یافتن خودکار اعتبارنامه‌ها از محیط استفاده کند، بنابراین نیازی به تغییر کد کلاینت برای احراز هویت ندارید.

برای تنظیم ADC، یکی از گزینه‌های حساب کاربری یا جعل هویت حساب سرویس را انتخاب کنید:

مراحل احراز هویت با اعتبارنامه حساب کاربری به شرح زیر است:

  1. تنظیمات پلتفرم احراز هویت گوگل (Google Auth Platform) را برای پروژه خود پیکربندی کنید.

    1. صفحه برندسازی را در کنسول ابری گوگل باز کنید.

    2. پروژه خود را انتخاب کنید.

    3. فرم را پر کنید و روی ایجاد کلیک کنید.

  2. از آنجایی که محدوده‌ی API مربوط به Data Manager یک محدوده‌ی حساس است، مراحل زیر لازم است:

    1. به تنظیمات دسترسی به داده‌ها برای پروژه خود بروید.

    2. روی افزودن یا حذف محدوده‌ها کلیک کنید.

    3. کادر کنار Data Manager API را در لیست محدوده‌ها علامت بزنید و روی به‌روزرسانی کلیک کنید.

    4. روی ذخیره کلیک کنید.

    5. به بخش مخاطبان در کنسول گوگل کلود بروید و وضعیت انتشار و نوع کاربر را به‌روزرسانی کنید. برای کسب اطلاعات بیشتر در مورد این تنظیمات به مدیریت مخاطبان برنامه مراجعه کنید.

  3. برای ایجاد یک کلاینت OAuth2 در پروژه، روی «ایجاد کلاینت OAuth2» کلیک کنید، یا دستورالعمل‌ها را برای ایجاد یک کلاینت OAuth2 دسکتاپ دنبال کنید.

    ایجاد کلاینت OAuth2

    در آخرین مرحله، روی دانلود پیکربندی کلاینت کلیک کنید و محل دانلود انتخابی خود را یادداشت کنید.

  4. با اجرای دستور زیر، یک فایل ADC محلی ایجاد کنید. این دستور یک جریان وب را راه‌اندازی می‌کند که در آن از شما خواسته می‌شود به حساب گوگلی که با API از آن استفاده می‌کنید، وارد شوید.

    به جای PATH_TO_CLIENT_JSON ، نام فایل JSON که دانلود کرده‌اید را قرار دهید.

    gcloud auth application-default login \
      --scopes="https://www.googleapis.com/auth/datamanager,https://www.googleapis.com/auth/cloud-platform" \
      --client-id-file="PATH_TO_CLIENT_JSON"
    
  5. با استفاده از دستور زیر، تأیید کنید که اعتبارنامه‌ها به درستی تنظیم شده‌اند. در صورت موفقیت، دستور، یک توکن دسترسی را در کنسول چاپ می‌کند.

    gcloud auth application-default print-access-token
    

برای کسب اطلاعات بیشتر در مورد احراز هویت و اعتبارنامه‌ها برای برنامه خود، به روش‌های احراز هویت در گوگل و نحوه عملکرد اعتبارنامه‌های پیش‌فرض برنامه مراجعه کنید.

تنظیم دسترسی به حساب عملیاتی

به ایمیل مرتبط با حساب کاربری خود، دسترسی به Destination را اعطا کنید.

SDK را برای زبان برنامه‌نویسی خود تنظیم کنید

روی دستگاه محلی خود، SDK مورد نظر خود را نصب کنید:

استراحت

  1. متغیرهای نمونه زیر، مانند OPERATING_ACCOUNT_PRODUCT ، OPERATING_ACCOUNT_ID و AUDIENCE_ID را با مقادیر حساب و مقصد خود به‌روزرسانی کنید.
  2. به جای PROJECT_ID شناسه‌ی Google Cloud خود را وارد کنید.
  3. برای ارسال درخواست، نمونه را در خط فرمان کپی کنید.

    اگر با استفاده از یک لینک محصول مشخص operatingAccount دسترسی ندارید، ویژگی linkedAccount از ورودی در destinations حذف کنید.

    #!/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": {
            "accountType": "OPERATING_ACCOUNT_TYPE",
            "accountId": "OPERATING_ACCOUNT_ID"
          },
          "loginAccount": {
            "accountType": "LOGIN_ACCOUNT_TYPE",
            "accountId": "LOGIN_ACCOUNT_ID"
          },
          "linkedAccount": {
            "accountType": "LINKED_ACCOUNT_TYPE",
            "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
    

دات نت

کتابخانه کلاینت را نصب کنید

برای افزودن یک وابستگی به کتابخانه کلاینت در پروژه خود، دستورالعمل‌های موجود در راهنمای نصب کتابخانه کلاینت .NET را دنبال کنید.

اختیاری: کتابخانه ابزار و نمونه‌های کد را دریافت کنید.

  1. فایل data-manager-dotnet.tar.gz را دانلود و استخراج کنید.

  2. در پروژه .NET خود، یک وابستگی ProjectReference به کتابخانه ابزار تعریف کنید. PATH_TO_UTILITY_LIBRARY با مکانی که دایرکتوری data-manager-dotnet را از data-manager-dotnet.tar.gz استخراج کرده‌اید، جایگزین کنید.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />
    
  3. برای قالب‌بندی داده‌ها، از ابزار Formatter در پروژه .NET خود استفاده کنید.

  4. نمونه‌های کد را در زیرشاخه‌ی samples مرور کنید.

    به دایرکتوری samples بروید و از dotnet run برای دریافت لیست نمونه‌های موجود استفاده کنید.

    dotnet run
    

    هنگام اجرای یک نمونه، آرگومان --help را برای چاپ یک عبارت استفاده با پارامترهای مورد انتظار ارسال کنید.

    dotnet run -- ingest-audience-members --help
    

    برای کمک به شروع کار با برخی از داده‌های نمونه، از فایل samples/sampledata/audience_members_1.csv استفاده کنید.

جاوا

کتابخانه کلاینت را نصب کنید

  1. فایل google-cloud-ads-datamanager-v1-java.tar.gz را دانلود و استخراج کنید.
  2. به پوشه‌ی google-cloud-ads-datamanager-v1-java بروید.
  3. دستور زیر را برای ساخت و انتشار کتابخانه در مخزن محلی Maven خود برای استفاده با Maven یا Gradle اجرا کنید.

    ./gradlew install
    
  4. در پروژه جاوای خود، یک وابستگی (dependency) به کتابخانه Data Manager API تعریف کنید.

    درجه بندی:

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

    ماون:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.4</version>
    </dependency>
    

اختیاری: کتابخانه ابزار و نمونه‌های کد را دریافت کنید.

  1. مخزن گیت‌هاب را کلون کنید.

    git clone https://github.com/googleads/data-manager-java.git
    
  2. به پوشه data-manager-java بروید.

  3. کتابخانه‌ی کاربردی را ساخته و در مخزن محلی Maven خود منتشر کنید.

    ./gradlew data-manager-util:install
    
  4. در پروژه جاوای خود، یک وابستگی به کتابخانه‌ی کاربردی تعریف کنید.

    درجه بندی:

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

    ماون:

    <dependency>
       <groupId>com.google.api-ads</groupId>
       <artifactId>data-manager-util</artifactId>
       <version>0.1.0</version>
    </dependency>
    
  5. برای قالب‌بندی و رمزگذاری داده‌ها، از ابزارهای UserDataFormatter و Encrypter در پروژه جاوا خود استفاده کنید.

  6. نمونه‌های کد را در زیرشاخه data-manager-samples یا در GitHub مرور کنید. برای اجرای یک نمونه از خط فرمان، از دستور Gradle run task استفاده کنید.

    برای مثال، دستور زیر نمونه‌ی IngestAudienceMembers را اجرا می‌کند و یک عبارت استفاده چاپ می‌کند:

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

    برای کمک به شروع کار با برخی از داده‌های نمونه، از فایل موجود در data-manager-samples/src/main/resources/sampledata/audience_members_1.csv استفاده کنید.

نود جی اس

کتابخانه کلاینت را نصب کنید

  1. فایل ads-datamanager-v1-nodejs.tar.gz را دانلود و استخراج کنید.
  2. به پوشه ads-datamanager-v1-nodejs بروید.
  3. دستور زیر را برای کامپایل و فشرده‌سازی کتابخانه کلاینت در یک فایل .tgz برای استفاده با npm اجرا کنید.

    npm pack
    

    این دستور یک فایل آرشیو با نام google-cloud-datamanager-0.1.4.tgz ایجاد می‌کند. محل فایل را یادداشت کنید تا بتوانید در مراحل بعدی از آن استفاده کنید.

  4. در پروژه Node.js خود، با اضافه کردن یک ورودی dependencies برای مسیر کامل و نام فایل google-cloud-datamanager-0.1.4.tgz یک وابستگی به کتابخانه کلاینت Data Manager API اعلام کنید.

    {
       "dependencies": {
          ...
          "@google-cloud/datamanager": "file:PATH_TO_CLIENT_LIBRARY/google-cloud-datamanager-0.1.4.tgz",
          ...
       }
    }
    

اختیاری: کتابخانه ابزار و نمونه‌های کد را دریافت کنید.

  1. فایل data-manager-node.tar.gz را دانلود و استخراج کنید.
  2. به دایرکتوری data-manager-node بروید.
  3. به دایرکتوری util بروید.

    cd util
    
  4. دستور زیر را اجرا کنید تا کتابخانه ابزار را کامپایل و در یک فایل .tgz برای استفاده با npm فشرده کنید.

    npm pack
    

    این دستور یک فایل آرشیو با نام google-ads-datamanager-util-0.1.0.tgz ایجاد می‌کند. محل فایل را یادداشت کنید تا بتوانید در مراحل بعدی از آن استفاده کنید.

  5. در پروژه Node.js خود، با اضافه کردن یک ورودی dependencies برای مسیر کامل و نام فایل google-ads-datamanager-util-0.1.0.tgz یک وابستگی به کتابخانه ابزار Data Manager API اعلام کنید.

    {
       "dependencies": {
          ...
          "@google-ads/data-manager-util": "file:PATH_TO_UTILITY_LIBRARY/google-ads-datamanager-util-0.1.0.tgz",
          ...
       }
    }
    

    برای قالب‌بندی داده‌ها، از ابزار UserDataFormatter در پروژه Node.js خود استفاده کنید.

  6. نمونه‌های کد را در زیرشاخه samples مرور کنید. نمونه‌ها را با استفاده از مراحل زیر اجرا کنید:

    1. فایل google-cloud-datamanager-0.1.4.tgz در دایرکتوری والد دایرکتوری data-manager-node کپی کنید.

    2. به پوشه‌ی samples در زیر data-manager-node بروید.

    3. برای کامپایل نمونه‌ها، دستور زیر را اجرا کنید.

      npm run compile
      
    4. نمونه‌ها را اجرا کنید و آرگومان‌های مورد نیاز را ارسال کنید. هنگام اجرای یک نمونه، آرگومان --help را ارسال کنید تا یک عبارت استفاده با پارامترهای مورد انتظار چاپ شود.

      برای مثال، دستور زیر نمونه ingest_audience_members را اجرا می‌کند و یک عبارت استفاده چاپ می‌کند:

      npx ts-node audiences/ingest_audience_members.ts --help
      

    برای کمک به شروع کار با برخی از داده‌های نمونه، از فایل samples/sampledata/audience_members_1.csv استفاده کنید.

پی اچ پی

کتابخانه کلاینت را نصب کنید

  1. فایل google-cloud-ads-datamanager-v1-php.tar.gz را دانلود و اکسترکت کنید.
  2. به پوشه google-cloud-ads-datamanager-v1-php بروید.
  3. برای حل وابستگی‌های کتابخانه، دستور زیر را اجرا کنید:

    composer update --prefer-dist
    
  4. در فایل composer.json پروژه PHP خود که روی همان میزبان قرار دارد، با استفاده از مراحل زیر، یک وابستگی به کتابخانه 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.4"
      }
      

اختیاری: کتابخانه ابزار و نمونه‌های کد را دریافت کنید.

  1. فایل data-manager-php.tar.gz را دانلود و استخراج کنید.
  2. به پوشه data-manager-php بروید.
  3. برای حل وابستگی‌های کتابخانه، دستور زیر را اجرا کنید:

    composer update --prefer-dist
    
  4. در فایل composer.json پروژه PHP خود که روی همان میزبان قرار دارد، با استفاده از مراحل زیر، یک وابستگی به کتابخانه‌ی کاربردی (utility library) تعریف کنید:

    1. یک ورودی در بخش repositories اضافه کنید که به محل دایرکتوری data-manager-php اشاره کند.

      "repositories" : [
         {
            "type" : "path",
            "url" : "PATH_TO_UTILITY_LIBRARY"
         }
      ]
      
    2. یک وابستگی به کتابخانه‌ی کاربردی تعریف کنید.

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

    برای قالب‌بندی داده‌ها، از ابزار Formatter در پروژه PHP خود استفاده کنید.

  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 استفاده کنید.

پایتون

کتابخانه کلاینت را نصب کنید

  1. ads-datamanager-v1-py.tar.gz را دانلود کنید.
  2. به دایرکتوری دانلود بروید.
  3. دستور زیر را برای ساخت کتابخانه و در دسترس قرار دادن آن برای سایر پروژه‌ها در همان محیط پایتون اجرا کنید:

    pip install ./ads-datamanager-v1-py.tar.gz
    
  4. در پروژه پایتون خود، یک وابستگی به کتابخانه Data Manager API تعریف کنید. برای مثال، اگر از فایل requirements.txt در پروژه خود استفاده می‌کنید، خط زیر را به فایل اضافه کنید:

    google-ads-data-manager=0.1.4
    

اختیاری: کتابخانه ابزار و نمونه‌های کد را دریافت کنید.

  1. فایل data-manager-python.tar.gz را دانلود و استخراج کنید.
  2. به پوشه data-manager-python بروید.
  3. برای نصب کتابخانه‌ی کاربردی در محیط پایتون خود، دستور زیر را اجرا کنید:

    pip install .
    
  4. در پروژه پایتون خود، یک وابستگی به کتابخانه ابزار تعریف کنید. برای مثال، اگر از فایل requirements.txt در پروژه خود استفاده می‌کنید، خط زیر را به فایل اضافه کنید:

    google-ads-data-manager-util=0.1.0
    
  5. برای قالب‌بندی و رمزگذاری داده‌ها، از ابزارهای Formatter و Encrypter در پروژه پایتون خود استفاده کنید.

  6. نمونه‌های کد را در زیرشاخه samples مرور کنید. هنگام اجرای یک نمونه، آرگومان --help را برای چاپ عبارت استفاده با پارامترهای مورد انتظار ارسال کنید.

    برای کمک به شروع کار با برخی از داده‌های نمونه، از فایل samples/sampledata/audience_members_1.csv استفاده کنید.

روبی

کتابخانه کلاینت را نصب کنید

برای افزودن وابستگی به کتابخانه کلاینت در پروژه خود، دستورالعمل‌های موجود در راهنمای نصب کتابخانه کلاینت روبی را دنبال کنید.

مراحل بعدی