في ما يلي كيفية إعداد إذن الوصول إلى Data Manager API باستخدام حزمة تطوير برامج (SDK) أو REST.
المتطلبات الأساسية
قبل استخدام Data API، تأكَّد من توفّر ما يلي:
- مشروع Google Cloud
- حساب Google لديه إذن
serviceusage.services.enableفي مشروعك على Google Cloud، أو لديه دور يتضمّن هذا الإذن على سبيل المثال، يتضمّن كل منroles/ownerوroles/serviceusage.serviceUsageAdminالإذنserviceusage.services.enable. للاطّلاع على أذوناتك، راجِع مقالة عرض إذن الوصول الحالي.
تفعيل واجهة برمجة التطبيقات
إذا لم يسبق لك تفعيل واجهة برمجة التطبيقات "إدارة بيانات إعلانات Google"، يمكنك إجراء ذلك من خلال النقر على تفعيل واجهة برمجة التطبيقات "إدارة بيانات إعلانات Google" أو اتّباع التعليمات لتنفيذ هذه الخطوة يدويًا.
تفعيل Data Manager APIإذا لم تتمكّن من العثور على Data Manager API أو تعذّر عليك تفعيل Data Manager API، تحقّق من أنّ حسابك على Google يستوفي المتطلبات الأساسية.
إعداد المصادقة
يمكنك استخدام أي من طرق المصادقة في Google باستثناء مفاتيح واجهة برمجة التطبيقات. ننصحك بمراجعة كيفية اختيار طريقة المصادقة المناسبة لحالة الاستخدام لتحديد الطريقة المناسبة لحالة الاستخدام.
طريقتان شائعتان للمصادقة هما حسابات المستخدمين وحسابات الخدمة:
- حسابات المستخدمين: تمثّل الأشخاص الذين يتفاعلون مع واجهات برمجة التطبيقات وخدمات Google مباشرةً.
- حسابات الخدمة: تمثّل التطبيقات، وليس الأشخاص، بصفتها المستخدمين. وتتيح هذه الرموز لتطبيقاتك إدارة المصادقة والتفويض. على سبيل المثال، إذا كان أحد التطبيقات بحاجة إلى الوصول إلى موارد Google Cloud.
يمكن أن يستخدم الدمج بيانات الاعتماد التلقائية للتطبيق (ADC) للعثور تلقائيًا على بيانات الاعتماد من البيئة، وبالتالي لن تحتاج إلى تغيير رمز العميل للمصادقة.
اختَر حساب المستخدم أو انتحال هوية حساب الخدمة لإعداد ADC:
في ما يلي خطوات المصادقة باستخدام بيانات اعتماد حساب المستخدم:
اضبط إعدادات منصة Google Auth لمشروعك.
افتح صفحة "تحديد هوية العلامة التجارية" في Google Cloud Console.
اختَر مشروعك.
املأ النموذج وانقر على إنشاء.
بما أنّ نطاق Data Manager API هو نطاق حسّاس، يجب اتّباع الخطوات التالية:
انتقِل إلى إعدادات الوصول إلى البيانات لمشروعك.
انقر على إضافة نطاقات أو إزالتها.
ضَع علامة في المربّع بجانب Data Manager API في قائمة النطاقات، ثم انقر على تعديل.
انقر على حفظ.
انتقِل إلى شريحة الجمهور في Google Cloud Console وعدِّل حالة النشر ونوع المستخدم. يمكنك الاطّلاع على مزيد من المعلومات عن هذه الإعدادات في مقالة إدارة جمهور التطبيق.
انقر على إنشاء عميل OAuth2 لإنشاء عميل OAuth2 في المشروع، أو اتّبِع التعليمات لإنشاء عميل OAuth2 تطبيق مكتبي.
إنشاء عميل OAuth2في الخطوة الأخيرة، انقر على تنزيل إعدادات العميل واحتفظ بمكان التنزيل الذي تختاره.
أنشئ ملف ADC محليًا من خلال تنفيذ الأمر التالي. يؤدي هذا الأمر إلى تشغيل مسار على الويب يُطلب منك فيه تسجيل الدخول إلى حساب Google الذي تستخدمه مع واجهة برمجة التطبيقات.
استبدِل 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 وطريقة عمل بيانات الاعتماد التلقائية للتطبيقات.
إعداد إذن الوصول إلى حساب التشغيل
امنح عنوان البريد الإلكتروني المرتبط بحساب المستخدم إذن الوصول إلىDestination.
- في حال استخدام حساب على "إعلانات Google" أو حساب شريك بيانات، يُرجى اتّباع التعليمات لإضافة عنوان البريد الإلكتروني للمستخدِم إلى الحساب.
- في حال استخدام حساب على "مساحة العرض والفيديو 360"، عليك اتّباع التعليمات لإضافة عنوان البريد الإلكتروني للمستخدم إلى الحساب.
إعداد حزمة تطوير البرامج (SDK) للغة البرمجة
على جهازك، ثبِّت حزمة تطوير البرامج (SDK) التي تختارها:
REST
- عدِّل العناصر النائبة في النموذج التالي، مثل 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 لتشغيل نموذج من سطر الأوامر، استخدِم مهمة Gradlerun.على سبيل المثال، ينفّذ الأمر التالي
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.