نصب کتابخانه کارخواه

در اینجا نحوه نصب و پیکربندی کتابخانه کارخواه یا REST آورده شده است.

پیش‌نیازها

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

مراحل نصب

در ماشین محلی‌تان، کتابخانه مشتری موردنظرتان را نصب کنید:

استراحت

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

    آگهی‌دهنده

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so 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"
          },
          "productDestinationId": "AUDIENCE_ID"
        }
      ],
      "audienceMembers": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
                },
                {
                  "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
                }
              ]
            }
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

    شریک داده

    #!/bin/bash
    
    # Uses gcloud to get an access token. If the Application Default
    # Credentials aren't for a service account then the command that
    # specifies --scopes fails, so 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": [
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "07e2f1394b0ea80e2adca010ea8318df697001a005ba7452720edda4b0ce57b3"
                },
                {
                  "emailAddress": "1df6b43bc68dd38eca94e6a65b4f466ae537b796c81a526918b40ac4a7b906c7"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "2ef46c4214c3fc1b277a2d976d55194e12b899aa50d721f28da858c7689756e3"
                },
                {
                  "emailAddress": "54e410b14fa652a4b49b43aff6eaf92ad680d4d1e5e62ed71b86cd3188385a51"
                },
                {
                  "emailAddress": "e8bd3f8da6f5af73bec1ab3fbf7beb47482c4766dfdfc94e6bd89e359c139478"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "05bb62526f091b45d20e243d194766cca8869137421047dc53fa4876d111a6f0"
                },
                {
                  "emailAddress": "f1fcde379f31f4d446b76ee8f34860eca2288adc6b6d6c0fdc56d9eee75a2fa5"
                }
              ]
            }
          }
        },
        {
          "compositeData": {
            "userData": {
              "userIdentifiers": [
                {
                  "emailAddress": "83a834cc5327bc4dee7c5408988040dc5813c7662611cd93b707aff72bf7d33f"
                },
                {
                  "emailAddress": "223ebda6f6889b1494551ba902d9d381daf2f642bae055888e96343d53e9f9c4"
                }
              ]
            }
          }
        }
      ],
      "consent": {
        "adUserData": "CONSENT_GRANTED",
        "adPersonalization": "CONSENT_GRANTED"
      },
      "encoding": "HEX",
      "termsOfService": {
        "customerMatchTermsOfServiceStatus": "ACCEPTED"
      },
      "validateOnly": true
    }
    EOF
    

دات نت

نصب کتابخانه مشتری

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

اختیاری: نصب کتابخانه ابزار کمکی

علاوه‌بر کتابخانه مشتری، می‌توانید کتابخانه کمکی را نصب کنید تا در کارهای رایج مثل قالب‌بندی داده‌ها برای جذب کمک کند.

  1. در پروژه .NET، وابستگی به کتابخانه کمکی Google.Ads.DataManager.Util را اعلام کنید.

    dotnet add package Google.Ads.DataManager.Util --version 0.4.0
    
  2. برای قالب‌بندی داده‌ها، از ابزار UserDataFormatter در پروژه NET .خود استفاده کنید.

مرور نمونه‌های کد

نمونه‌های کد را در زیرفهرست راهنمای samples یا در GitHub مرور کنید.

برای اجرای نمونه‌ها:

  1. مخزن GitHub را در برچسب v0.4.0 همسان‌سازی کنید:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-dotnet.git
    
  2. به فهرست راهنمای data-manager-dotnet بروید.

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

    dotnet run
    

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

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

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

رفتن

نصب کتابخانه مشتری

go get cloud.google.com/go/datamanager/apiv1@latest

برای اطلاعات بیشتر، دستورالعمل‌های موجود در راهنمای کتابخانه Go client را دنبال کنید.

جاوا

نصب کتابخانه مشتری

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

اختیاری: نصب کتابخانه ابزار کمکی

علاوه‌بر کتابخانه کارخواه، می‌توانید کتابخانه کمکی را نصب کنید تا در کارهای رایج مثل قالب‌بندی و رمزگذاری داده‌ها برای استخراج به شما کمک کند.

  1. در پروژه Java، وابستگی به کتابخانه کمکی data-manager-util را اعلام کنید.

    Gradle:

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

    Maven:

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

مرور نمونه‌های کد

نمونه‌های کد را در زیرفهرست راهنمای data-manager-samples یا در GitHub مرور کنید.

برای اجرای نمونه‌ها:

  1. مخزن GitHub را در برچسب v0.4.0 همسان‌سازی کنید:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-java.git
    
  2. به فهرست راهنمای data-manager-java بروید.

  3. نمونه‌ها را از خط فرمان بااستفاده از Gradle run task اجرا کنید و هر متغیر مستقل لازم را ارسال کنید. هنگام اجرای نمونه، آرگومان --help را ارسال کنید تا عبارت استفاده با پارامترهای موردانتظار چاپ شود.

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

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

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

Node.js

نصب کتابخانه مشتری

دستورالعمل‌های راهنمای نصب کتابخانه کارخواه Node.js را دنبال کنید تا وابستگی به کتابخانه کارخواه @google-ads/datamanager را به پروژه‌تان اضافه کنید.

اختیاری: نصب کتابخانه ابزار کمکی

علاوه‌بر کتابخانه مشتری، می‌توانید کتابخانه کمکی را نصب کنید تا در کارهای رایج مثل قالب‌بندی داده‌ها برای جذب کمک کند.

  1. در پروژه Node.js خود، وابستگی به کتابخانه کمکی @google-ads/datamanager-util را اعلام کنید:

    npm install @google-ads/datamanager-util
    
  2. برای قالب‌بندی داده‌ها، از ابزار UserDataFormatter در پروژه Node.js خود استفاده کنید.

مرور نمونه‌های کد

نمونه‌های کد را در زیرفهرست راهنمای samples یا در GitHub مرور کنید.

برای اجرای نمونه‌ها:

  1. مخزن GitHub را در برچسب v0.4.1 همسان‌سازی کنید:

    git clone --branch v0.4.1 https://github.com/googleads/data-manager-node.git
    
  2. به فهرست راهنمای data-manager-node بروید.

  3. وابستگی‌ها را برای اجرای نمونه‌ها نصب کنید:

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

    برای مثال، فرمان زیر نمونه ingest-audience-members را اجرا می‌کند و بیانیه استفاده را چاپ می‌کند:

    npm run ingest-audience-members -w samples -- --help
    

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

PHP

نصب کتابخانه مشتری

دستورالعمل‌های راهنمای نصب کتابخانه مشتری PHP را دنبال کنید تا وابستگی به کتابخانه مشتری googleads/data-manager را به پروژه‌تان اضافه کنید.

اختیاری: نصب کتابخانه ابزار کمکی

علاوه‌بر کتابخانه مشتری، می‌توانید کتابخانه کمکی را نصب کنید تا در کارهای رایج مثل قالب‌بندی داده‌ها برای جذب کمک کند.

  1. در فایل composer.json پروژه PHP خود در همان میزبان، وابستگی به کتابخانه ابزار را اعلام کنید:

    composer require googleads/data-manager-util
    
  2. برای قالب‌بندی داده‌ها، از ابزار Formatter در پروژه PHP خود استفاده کنید.

مرور نمونه‌های کد

نمونه‌های کد را در زیرفهرست راهنمای samples یا در GitHub مرور کنید.

برای اجرای نمونه‌ها:

  1. مخزن GitHub را در برچسب v0.4.0 همسان‌سازی کنید:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-php.git
    
  2. به فهرست راهنمای data-manager-php/samples بروید.

  3. وابستگی‌ها را برای اجرای نمونه‌ها نصب کنید:

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

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

    php audiences/ingest_audience_members.php --help
    

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

Python

نصب کتابخانه مشتری

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

اختیاری: نصب کتابخانه ابزار کمکی

علاوه‌بر کتابخانه کارخواه، می‌توانید کتابخانه کمکی را نصب کنید تا در کارهای رایج مثل قالب‌بندی و رمزگذاری داده‌ها برای استخراج به شما کمک کند.

  1. در پروژه Python، وابستگی به کتابخانه کمکی google-ads-datamanager-util را اعلام کنید.

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

    google-ads-datamanager-util==0.4.0
    

    یا کتابخانه ابزار را مستقیماً نصب کنید:

    pip install google-ads-datamanager-util==0.4.0
    
  2. برای قالب‌بندی و رمزگذاری داده‌ها، از ابزارهای کمکی Formatter و Encrypter در پروژه Python خود استفاده کنید.

مرور نمونه‌های کد

  1. مخزن GitHub را در برچسب v0.4.0 همسان‌سازی کنید:

    git clone --branch v0.4.0 https://github.com/googleads/data-manager-python.git
    
  2. به فهرست راهنمای data-manager-python بروید.

  3. وابستگی‌ها را برای اجرای نمونه‌ها نصب کنید:

    pip install -r samples/requirements.txt
    
  4. نمونه‌ها را اجرا کنید و هر آرگومان لازم را ارسال کنید. هنگام اجرای نمونه، متغیر مستقل --help را ارسال کنید تا عبارت استفاده با پارامترهای موردانتظار چاپ شود.

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

    python3 samples/audiences/ingest_audience_members.py --help
    

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

Ruby

نصب کتابخانه مشتری

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

مراحل بعدی