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

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

پیش نیازها

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

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

API را فعال کنید

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

Data Manager API را فعال کنید

اگر نتوانستید API مدیر داده را پیدا کنید یا API مدیر داده را فعال کنید ، بررسی کنید حساب Google شما پیش نیازها را برآورده کند.

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

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

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

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

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

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

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

  1. تنظیمات پلتفرم Google Auth را برای پروژه خود پیکربندی کنید.

    1. صفحه برندسازی را در Google Cloud Console باز کنید.

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

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

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

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

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

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

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

    5. در Google Cloud Console به Audience بروید و وضعیت انتشار و نوع کاربر را به‌روزرسانی کنید. درباره این تنظیمات در مدیریت مخاطبان برنامه بیشتر بدانید.

  3. برای ایجاد یک سرویس گیرنده OAuth2 در پروژه، روی Create OAuth2 client کلیک کنید، یا دستورالعمل ها را برای ایجاد یک سرویس گیرنده Desktop OAuth2 دنبال کنید.

    مشتری OAuth2 ایجاد کنید

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

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

    نام فایل JSON را که دانلود کردید جایگزین PATH_TO_CLIENT_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
    

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

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

به ایمیل مرتبط با حساب کاربری خود اجازه دسترسی به Destination بدهید.

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

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

استراحت

  1. متغیرهای موجود در نمونه زیر، مانند OPERATING_ACCOUNT_PRODUCT ، OPERATING_ACCOUNT_ID ، و AUDIENCE_ID را با مقادیر حساب و مقصد خود به‌روزرسانی کنید.
  2. شناسه Google Cloud خود را جایگزین PROJECT_ID کنید.
  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": {
            "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
    

دات نت

  1. google-cloud-ads-datamanager-v1-csharp.tar.gz را دانلود و استخراج کنید.

  2. در پروژه دات نت خود، یک وابستگی ProjectReference به کتابخانه Data Manager API اعلام کنید. PATH_TO_CLIENT_LIBRARY با مکانی که فهرست راهنمای google-cloud-ads-datamanager-v1-csharp از google-cloud-ads-datamanager-v1-csharp.tar.gz استخراج کردید، جایگزین کنید.

    <ProjectReference Include="PATH_TO_CLIENT_LIBRARY\Google.Ads.DataManager.V1\Google.Ads.DataManager.V1.csproj" />
    
  3. اختیاری کتابخانه ابزار و نمونه کد را دریافت کنید.

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

    2. در پروژه دات نت خود، یک وابستگی 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 در پروژه دات نت خود استفاده کنید.

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

      برای اجرای نمونه‌های کد، متغیر محیطی DATA_MANAGER_DOTNET_LIB روی مکانی تنظیم کنید که فهرست راهنمای google-cloud-ads-datamanager-v1-csharp از google-cloud-ads-datamanager-v1-csharp.tar.gz استخراج کرده‌اید.

      export DATA_MANAGER_DOTNET_LIB="PATH_TO_CLIENT_LIBRARY"
      

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

      dotnet run --framework net8.0
      

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

      dotnet run --framework net8.0 -- 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 -Pversion=0.1.0 install
    
  4. در پروژه جاوا خود، یک وابستگی به کتابخانه Data Manager API اعلام کنید.

    گریدل:

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

    ماون:

    <dependency>
      <groupId>com.google.cloud</groupId>
      <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId>
      <version>0.1.0</version>
    </dependency>
    
  5. اختیاری کتابخانه ابزار و نمونه کد را دریافت کنید.

    1. مخزن GitHub را شبیه سازی کنید.

      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-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.0
    
  5. اختیاری کتابخانه ابزار و نمونه کد را دریافت کنید.

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

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 خود، با افزودن یک ورودی dependencies برای مسیر کامل و نام فایل فایل google-cloud-datamanager-0.1.0.tgz یک وابستگی به کتابخانه Data Manager API اعلام کنید.

PHP

  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.0"
      }
      
  5. (اختیاری) کتابخانه ابزار و نمونه کد را دریافت کنید.

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

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

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

مراحل بعدی