התקן ספריית לקוח

במאמר הזה מוסבר איך מתקינים ומגדירים ספריית לקוח או REST.

דרישות מוקדמות

לפני שמתקינים ספריית לקוח, צריך לבצע את השלבים שבמאמר הגדרת גישה ל-API, כולל הגדרה של Application Default Credentials ‏ (ADC).

התקנת ספרייה

במחשב המקומי, מתקינים את ספריית הלקוח הרצויה:

REST

בוחרים את סוג תהליך ההגדרה שרוצים לבצע:

  1. מעדכנים את ערכי ה-placeholder בדוגמה הבאה, כמו 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, 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"
      },
      "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

התקנת ספריית הלקוח

פועלים לפי ההוראות במדריך התקנת ספריית לקוח ב-‎.NET כדי להוסיף תלות בספריית הלקוח בפרויקט.

אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.

  1. משכפלים את מאגר GitHub.

    git clone https://github.com/googleads/data-manager-dotnet.git

  2. בפרויקט ‎ .NET, מצהירים על תלות בספריית כלי העזר ProjectReference. מחליפים את PATH_TO_UTILITY_LIBRARY במיקום שבו שיבטתם את מאגר data-manager-dotnet.

    <ProjectReference Include="PATH_TO_UTILITY_LIBRARY\Google.Ads.DataManager.Util\src\Google.Ads.DataManager.Util.csproj" />

  3. כדי לעצב נתונים, משתמשים בכלי Formatter בפרויקט ‎ .NET.

  4. אפשר לעיין בדוגמאות קוד בספריית המשנה samples או ב-GitHub.

    עוברים לספרייה samples ומשתמשים ב-dotnet run כדי לקבל את רשימת הדוגמאות הזמינות.

    dotnet run

    כשמריצים דוגמה, מעבירים את הארגומנט --help כדי להדפיס הצהרת שימוש עם הפרמטרים הצפויים.

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

    כדי לעזור לכם להתחיל עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת samples/sampledata/audience_members_1.csv.

Java

התקנת ספריית הלקוח

פועלים לפי ההוראות במדריך התקנת ספריית לקוח ב-Java כדי להוסיף תלות בספריית הלקוח בפרויקט.

אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.

  1. משכפלים את מאגר GitHub.

    git clone https://github.com/googleads/data-manager-java.git

  2. מנווטים לספרייה data-manager-java.

  3. יוצרים ומפרסמים את ספריית כלי העזר במאגר Maven המקומי.

    ./gradlew data-manager-util:install

  4. בפרויקט Java, מצהירים על תלות בספריית כלי השירות.

    ‫Gradle:

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

    ‫Maven:

    <dependency>
   <groupId>com.google.api-ads</groupId>
   <artifactId>data-manager-util</artifactId>
   <version>0.2.0</version>
</dependency>

  5. כדי לעצב ולהצפין את הנתונים, משתמשים בכלי השירות UserDataFormatter ו-Encrypter בפרויקט Java.

  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.

Node.js

התקנת ספריית הלקוח

פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח Node.js כדי להוסיף תלות בספריית הלקוח @google-ads/datamanager בפרויקט.

אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.

  1. משכפלים את מאגר GitHub.

    git clone https://github.com/googleads/data-manager-node.git

  2. מנווטים לספרייה data-manager-node.

  3. מריצים את הפקודה הבאה כדי להתקין את יחסי התלות.

    npm install

  4. עוברים לספרייה util.

    cd util

  5. מריצים את הפקודה הבאה כדי לקמפל ולארוז את ספריית כלי השירות בקובץ .tgz לשימוש עם npm.

    npm pack

    הפקודה יוצרת ארכיון בשם google-ads-datamanager-util-0.2.0.tgz. חשוב לשים לב למיקום הקובץ כדי שתוכלו להשתמש בו בשלבים הבאים.

  6. בפרויקט Node.js, מכריזים על תלות בספריית כלי העזר של Data Manager API על ידי הוספת רשומה dependencies לנתיב המלא ולשם הקובץ של הקובץ google-ads-datamanager-util-0.2.0.tgz.

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

    כדי לעצב את הנתונים, משתמשים בכלי UserDataFormatter בפרויקט Node.js.

  7. אפשר לעיין בדוגמאות קוד בספריית המשנה samples או ב-GitHub. כדי להריץ את הדוגמאות:

    1. מנווטים לספרייה data-manager-node.

    2. מריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. כשמריצים דוגמה, מעבירים את הארגומנט --help כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

      לדוגמה, הפקודה הבאה מריצה את הדוגמה ingest_audience_members ומדפיסה הצהרת שימוש:

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

    כדי לעזור לכם להתחיל עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת samples/sampledata/audience_members_1.csv.

PHP

התקנת ספריית הלקוח

פועלים לפי ההוראות במדריך התקנת ספריית הלקוח של PHP כדי להוסיף תלות בספריית הלקוח googleads/data-manager בפרויקט.

אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.

  1. משכפלים את מאגר GitHub.

    git clone https://github.com/googleads/data-manager-php.git

  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 או ב-GitHub. כדי להריץ את הדוגמאות:

    1. מנווטים לספרייה samples.

    2. מריצים את הפקודה הבאה כדי לפתור את יחסי התלות של הספרייה:

      composer update --prefer-dist

    3. מריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. כשמריצים דוגמה, מעבירים את הארגומנט --help כדי להדפיס הצהרת שימוש עם פרמטרים צפויים.

    כדי לעזור לכם להתחיל עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת samples/sampledata/audience_members_1.csv.

Python

התקנת ספריית הלקוח

פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח של Python כדי להוסיף תלות בספריית הלקוח google-ads-datamanager בפרויקט.

אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.

  1. משכפלים את מאגר GitHub.

    git clone https://github.com/googleads/data-manager-python.git

  2. מנווטים לספרייה data-manager-python.

  3. כדי להתקין את ספריית כלי השירות בסביבת Python, מריצים את הפקודה הבאה:

    pip install .

  4. בפרויקט Python, מצהירים על תלות בספריית כלי השירות. לדוגמה, אם משתמשים בקובץ requirements.txt בפרויקט, מוסיפים את השורה הבאה לקובץ:

    google-ads-data-manager-util=0.2.0

  5. כדי לעצב ולהצפין את הנתונים, משתמשים בכלי השירות Formatter ו-Encrypter בפרויקט Python.

  6. אפשר לעיין בדוגמאות קוד בספריית המשנה samples או ב-GitHub. כדי להריץ דוגמאות, צריך להתקין את יחסי התלות הנדרשים:

    pip install .[samples]

    כשמריצים דוגמה, מעבירים את הארגומנט --help כדי להדפיס הצהרת שימוש עם הפרמטרים הצפויים.

    כדי לעזור לכם להתחיל עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת samples/sampledata/audience_members_1.csv.

Ruby

התקנת ספריית הלקוח

פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח של Ruby כדי להוסיף תלות בספריית הלקוח בפרויקט.

השלבים הבאים

הקודם
הגדרת גישה ל-API