دسترسی 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 را فعال کنید

اگر قبلاً این کار را نکرده‌اید، Data Manager API را فعال کنید .

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

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

یک روش احراز هویت را انتخاب و تنظیم کنید. توصیه می کنیم برای یافتن خودکار اعتبارنامه ها از محیط ، Application Default Credentials را تنظیم کنید . این API از کلیدهای API استفاده نمی کند.

دامنه https://www.googleapis.com/auth/datamanager برای هر اعتباری که با Data Manager API استفاده می‌شود لازم است. برای مثالی از نحوه استفاده از scope ها، به مستندات دستور gcloud auth application-default login مراجعه کنید.

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

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

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

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

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

استراحت

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

  3. برای ارسال درخواست، نمونه را در خط فرمان کپی کنید.

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

    #!/bin/bash

# Uses gcloud to get an access token.
DATA_MANAGER_ACCESS_TOKEN="$(gcloud auth application-default print-access-token --scopes=https://www.googleapis.com/auth/datamanager)"

# 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-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. data-manager-java.tar.gz را دانلود و استخراج کنید.
    2. به دایرکتوری data-manager-java بروید.

    3. برای Maven یا Gradle دستور زیر را اجرا کنید. این دستور کتابخانه ابزار را در مخزن محلی 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 مرور کنید. برای اجرای یک نمونه از خط فرمان، از 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 استفاده کنید.