כך מגדירים גישה ל-Data Manager API באמצעות SDK או REST.
דרישות מוקדמות
לפני שמשתמשים ב-Data API, צריך לוודא שיש לכם את הדברים הבאים:
- פרויקט ב-Google Cloud.
- חשבון Google עם ההרשאה
serviceusage.services.enableבפרויקט ב-Google Cloud, או עם תפקיד שכולל את ההרשאה הזו. לדוגמה, ההרשאהserviceusage.services.enableכלולה גם ב-roles/ownerוגם ב-roles/serviceusage.serviceUsageAdmin. כדי לבדוק את ההרשאות, אפשר לעיין במאמר בנושא הצגת הגישה הנוכחית.
הפעלת ה-API
אם עדיין לא עשיתם את זה, אתם צריכים להפעיל את Data Manager API. כדי לעשות את זה, לוחצים על Enable the Data Manager API או פועלים לפי ההוראות.
הפעלת Data Manager APIאם אתם לא מוצאים את Data Manager API או שההפעלה של Data Manager API נכשלת, אתם צריכים לוודא שחשבון Google שלכם עומד בדרישות המוקדמות.
מגדירים אימות
אתם יכולים להשתמש בכל אחת משיטות האימות ב-Google, חוץ ממפתחות API. מומלץ לעיין במאמר בנושא בחירת שיטת האימות שמתאימה לתרחיש שלכם לדוגמה כדי להחליט איזו גישה מתאימה לתרחיש שלכם.
שתי שיטות נפוצות לאימות הן חשבונות משתמשים וחשבונות שירות:
- חשבונות משתמשים: מייצגים אנשים שמנהלים אינטראקציה ישירה עם ממשקי ה-API והשירותים של Google.
- חשבונות שירות: מייצגים אפליקציות, לא אנשים, בתור משתמשים. הן מאפשרות לאפליקציות שלכם לנהל אימות והרשאה. לדוגמה, אם אפליקציה צריכה לגשת למשאבים של Google Cloud.
השילוב יכול להשתמש ב-Application Default Credentials (ADC) כדי למצוא באופן אוטומטי פרטי כניסה מהסביבה, כך שלא תצטרכו לשנות את קוד הלקוח כדי לבצע אימות.
בוחרים באפשרות חשבון משתמש או התחזות לחשבון שירות כדי להגדיר ADC:
כדי לבצע אימות באמצעות פרטי כניסה של חשבון משתמש:
מגדירים את ההגדרות של Google Auth Platform בפרויקט.
פותחים את הדף Branding במסוף Google Cloud.
בוחרים את הפרויקט הרצוי.
ממלאים את הטופס ולוחצים על יצירה.
ההיקף של Data Manager API הוא היקף רגיש, ולכן צריך לבצע את השלבים הבאים:
עוברים להגדרות גישה לנתונים של הפרויקט.
לוחצים על הוספה או הסרה של היקפים.
מסמנים את התיבה לצד Data Manager API (ה-API של המרכז לניהול נתונים) ברשימת ההיקפים ולוחצים על Update (עדכון).
לוחצים על שמירה.
עוברים אל קהל ב-Google Cloud Console ומעדכנים את סטטוס הפרסום ואת סוג המשתמש. מידע נוסף על ההגדרות האלה זמין במאמר בנושא ניהול קהלים של אפליקציות.
לוחצים על Create OAuth2 client כדי ליצור לקוח OAuth2 בפרויקט, או פועלים לפי ההוראות ליצירת לקוח OAuth2 מסוג Desktop.
יצירת לקוח OAuth2בשלב האחרון, לוחצים על הורדת הגדרות הלקוח ורושמים את מיקום ההורדה שבחרתם.
מריצים את הפקודה הבאה כדי ליצור קובץ ADC מקומי. הפקודה הזו מפעילה תהליך אינטרנטי שבו מוצגת בקשה להתחבר לחשבון Google שבו אתם משתמשים עם ה-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"כדי לוודא שפרטי הכניסה מוגדרים בצורה נכונה, משתמשים בפקודה הבאה. אם הפקודה מסתיימת בלי שגיאות, היא מדפיסה אסימון גישה במסוף.
gcloud auth application-default print-access-token
למידע נוסף על אימות ופרטי כניסה לאפליקציה, אפשר לעיין במאמרים שיטות אימות ב-Google והסבר על Application Default Credentials.
הגדרת גישה לחשבון התפעולי
נותנים לכתובת האימייל שמשויכת לחשבון המשתמש שלכם גישה אלDestination.
- אם משתמשים בחשבון Google Ads או בחשבון של שותף נתונים, צריך לפעול לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
- אם אתם משתמשים בחשבון Display & Video 360, אתם צריכים לפעול לפי ההוראות כדי להוסיף את כתובת האימייל של המשתמש לחשבון.
הגדרת ה-SDK לשפת התכנות
במחשב המקומי, מתקינים את ה-SDK הרצוי:
REST
- צריך לעדכן את ה-placeholders בדוגמה הבאה, כמו OPERATING_ACCOUNT_PRODUCT, OPERATING_ACCOUNT_ID ו-AUDIENCE_ID, עם הערכים של החשבון והיעד.
- מחליפים את PROJECT_ID במזהה של הפרויקט ב-Google Cloud.
מעתיקים את הדוגמה לשורת הפקודה כדי לשלוח את הבקשה.
מסירים את המאפיין
linkedAccountשל הרשומה ב-destinationsאם לא ניגשים אלoperatingAccountבאמצעות קישור מוצר קיים.#!/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
התקנת ספריית הלקוח
פועלים לפי ההוראות במדריך בנושא התקנה של ספריית לקוח ב-.NET כדי להוסיף תלות בספריית הלקוח בפרויקט.
אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.
מורידים ומחלצים את הקובץ data-manager-dotnet.tar.gz.
בפרויקט .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" />כדי לעצב נתונים, משתמשים בכלי
Formatterבפרויקט .NET.דוגמאות קוד נמצאות בספריית המשנה
samples.עוברים לספרייה
samplesומשתמשים ב-dotnet runכדי לקבל את רשימת הדוגמאות הזמינות.dotnet runכשמריצים מדגם כדי להדפיס הצהרת שימוש עם פרמטרים צפויים, צריך להעביר את הארגומנט
--help.dotnet run -- ingest-audience-members --helpכדי להתחיל לעבוד עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת
samples/sampledata/audience_members_1.csv.
Java
התקנת ספריית הלקוח
- מורידים את הקובץ google-cloud-ads-datamanager-v1-java.tar.gz ופותחים אותו לתיקייה לא מכווצת.
- מנווטים לספרייה
google-cloud-ads-datamanager-v1-java. מריצים את הפקודה הבאה כדי לבנות ולפרסם את הספרייה במאגר Maven המקומי לשימוש עם Maven או Gradle.
./gradlew installבפרויקט Java, מצהירים על תלות בספריית Data Manager API.
Gradle:
implementation 'com.google.cloud:gapic-google-cloud-ads-datamanager-v1-java:0.1.4'Maven:
<dependency> <groupId>com.google.cloud</groupId> <artifactId>gapic-google-cloud-ads-datamanager-v1-java</artifactId> <version>0.1.4</version> </dependency>
אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.
משכפלים את מאגר GitHub.
git clone https://github.com/googleads/data-manager-java.gitמנווטים לספרייה
data-manager-java.יוצרים ומפרסמים את ספריית כלי העזר במאגר Maven המקומי.
./gradlew data-manager-util:installבפרויקט Java, מצהירים על תלות בספריית כלי השירות.
Gradle:
implementation 'com.google.api-ads:data-manager-util:0.1.0'Maven:
<dependency> <groupId>com.google.api-ads</groupId> <artifactId>data-manager-util</artifactId> <version>0.1.0</version> </dependency>כדי לעצב ולהצפין את הנתונים, משתמשים בכלי השירות
UserDataFormatterו-Encrypterבפרויקט Java.אפשר לעיין בדוגמאות קוד בספריית המשנה
data-manager-samplesאו ב-GitHub. כדי להריץ דוגמה משורת הפקודה, משתמשים במשימהrunשל Gradle.לדוגמה, הפקודה הבאה מריצה את הדוגמה
IngestAudienceMembersומדפיסה הצהרת שימוש:./gradlew data-manager-samples:run \ --args='IngestAudienceMembers --help'כדי להתחיל לעבוד עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת
data-manager-samples/src/main/resources/sampledata/audience_members_1.csv.
Node.js
התקנת ספריית הלקוח
- מורידים ומחלצים את הקובץ ads-datamanager-v1-nodejs.tar.gz.
- מנווטים לספרייה
ads-datamanager-v1-nodejs. מריצים את הפקודה הבאה כדי לקמפל את ספריית הלקוח ולדחוס אותה לקובץ
.tgzלשימוש עםnpm.npm packהפקודה יוצרת ארכיון בשם
google-cloud-datamanager-0.1.4.tgz. חשוב לשים לב למיקום הקובץ כדי שתוכלו להשתמש בו בשלבים הבאים.בפרויקט Node.js, מכריזים על תלות בספריית הלקוח של Data Manager API על ידי הוספת רשומה של
dependenciesלנתיב המלא ולשם הקובץ של הקובץgoogle-cloud-datamanager-0.1.4.tgz.{ "dependencies": { ... "@google-cloud/datamanager": "file:PATH_TO_CLIENT_LIBRARY/google-cloud-datamanager-0.1.4.tgz", ... } }
אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.
- מורידים ומחלצים את הקובץ data-manager-node.tar.gz.
- מנווטים לספרייה
data-manager-node. עוברים לספרייה
util.cd utilמריצים את הפקודה הבאה כדי לקמפל ולארוז את ספריית כלי השירות בקובץ
.tgzלשימוש עםnpm.npm packהפקודה יוצרת ארכיון בשם
google-ads-datamanager-util-0.1.0.tgz. חשוב לשים לב למיקום הקובץ כדי שתוכלו להשתמש בו בשלבים הבאים.בפרויקט Node.js, מכריזים על תלות בספריית כלי השירות של Data Manager API על ידי הוספת רשומה
dependenciesלנתיב המלא ולשם הקובץ של הקובץgoogle-ads-datamanager-util-0.1.0.tgz.{ "dependencies": { ... "@google-ads/data-manager-util": "file:PATH_TO_UTILITY_LIBRARY/google-ads-datamanager-util-0.1.0.tgz", ... } }כדי לעצב את הנתונים, משתמשים בכלי
UserDataFormatterבפרויקט Node.js.דוגמאות קוד נמצאות בספריית המשנה
samples. כדי להריץ את הדוגמאות, מבצעים את השלבים הבאים:מעתיקים את
google-cloud-datamanager-0.1.4.tgzלספריית האב של הספרייהdata-manager-node.מנווטים לספרייה
samplesבקטעdata-manager-node.מריצים את הפקודה הבאה כדי לקמפל את הדוגמאות.
npm run compileמריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. כשמריצים דוגמה, מעבירים את הארגומנט
--helpכדי להדפיס הצהרת שימוש עם פרמטרים צפויים.לדוגמה, הפקודה הבאה מריצה את הדוגמה
ingest_audience_membersומדפיסה הצהרת שימוש:npx ts-node audiences/ingest_audience_members.ts --help
כדי להתחיל לעבוד עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת
samples/sampledata/audience_members_1.csv.
PHP
התקנת ספריית הלקוח
- מורידים את הקובץ google-cloud-ads-datamanager-v1-php.tar.gz ופותחים אותו לתיקייה לא מכווצת.
- מנווטים לספרייה
google-cloud-ads-datamanager-v1-php. מריצים את הפקודה הבאה כדי לפתור את יחסי התלות של הספרייה:
composer update --prefer-distבקובץ
composer.jsonשל פרויקט PHP באותו מארח, מצהירים על תלות בספריית Data Manager API באמצעות השלבים הבאים:מוסיפים קטע
repositoriesשמצביע על המיקום של הספרייהgoogle-cloud-ads-datamanager-v1-php."repositories" : [ { "type" : "path", "url" : "PATH_TO_CLIENT_LIBRARY" } ]מצהירים על תלות בספריית Data Manager API.
"require": { "googleads/data-manager": "0.1.4" }
אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.
- מורידים ומחלצים את הקובץ data-manager-php.tar.gz.
- מנווטים לספרייה
data-manager-php. מריצים את הפקודה הבאה כדי לפתור את יחסי התלות של הספרייה:
composer update --prefer-distבקבצים
composer.jsonשל פרויקט ה-PHP באותו מארח, צריך להצהיר על תלות בספריית כלי השירות באמצעות השלבים הבאים:מוסיפים רשומה בקטע
repositoriesשמפנה למיקום של ספרייתdata-manager-php."repositories" : [ { "type" : "path", "url" : "PATH_TO_UTILITY_LIBRARY" } ]מצהירים על תלות בספריית כלי העזר.
"require": { "googleads/data-manager-util": "@dev" }
כדי לעצב נתונים, משתמשים בכלי
Formatterבפרויקט PHP.דוגמאות קוד נמצאות בספריית המשנה
samples. כדי להריץ את הדוגמאות, מבצעים את השלבים הבאים:מנווטים לספרייה
samples.מגדירים את משתנה הסביבה
DATA_MANAGER_PHP_LIBלנתיב שבו חילצתם את ספריית הלקוח.export DATA_MANAGER_PHP_LIB="PATH_TO_CLIENT_LIBRARY"מריצים את הפקודה הבאה כדי לפתור את יחסי התלות של הספרייה:
composer update --prefer-distמריצים את הדוגמאות ומעבירים את הארגומנטים הנדרשים. כשמריצים דוגמה, מעבירים את הארגומנט
--helpכדי להדפיס הצהרת שימוש עם פרמטרים צפויים.
כדי להתחיל לעבוד עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת
samples/sampledata/audience_members_1.csv.
Python
התקנת ספריית הלקוח
- מורידים את ads-datamanager-v1-py.tar.gz.
- עוברים לספרייה של ההורדה.
מריצים את הפקודה הבאה כדי ליצור את הספרייה ולהפוך אותה לזמינה לפרויקטים אחרים באותה סביבת Python:
pip install ./ads-datamanager-v1-py.tar.gzבפרויקט Python, מצהירים על תלות בספריית Data Manager API. לדוגמה, אם משתמשים בקובץ
requirements.txtבפרויקט, מוסיפים את השורה הבאה לקובץ:google-ads-data-manager=0.1.4
אופציונלי: הורדה של ספריית כלי השירות ודוגמאות קוד.
- מורידים ומחלצים את הקובץ data-manager-python.tar.gz.
- מנווטים לספרייה
data-manager-python. כדי להתקין את ספריית כלי השירות בסביבת Python, מריצים את הפקודה הבאה:
pip install .בפרויקט Python, מצהירים על תלות בספריית כלי השירות. לדוגמה, אם משתמשים בקובץ
requirements.txtבפרויקט, מוסיפים את השורה הבאה לקובץ:google-ads-data-manager-util=0.1.0כדי לעצב ולהצפין את הנתונים, משתמשים בכלי השירות
Formatterו-Encrypterבפרויקט Python.דוגמאות קוד נמצאות בספריית המשנה
samples. כשמריצים דוגמה, מעבירים את הארגומנט--helpכדי להדפיס הצהרת שימוש עם פרמטרים צפויים.כדי להתחיל לעבוד עם נתוני דוגמה, אפשר להשתמש בקובץ בכתובת
samples/sampledata/audience_members_1.csv.
Ruby
התקנת ספריית הלקוח
פועלים לפי ההוראות שבמדריך להתקנת ספריית הלקוח של Ruby כדי להוסיף תלות בספריית הלקוח בפרויקט.
השלבים הבאים
- מידע נוסף על שליחת נתוני קהלים
- מידע נוסף על שליחת אירועים
- אפשר לעיין בחומרי העזר של REST או RPC.