البدء في استخدام Ads Data Hub API

يشرح هذا الدليل كيفية البدء في كتابة التطبيقات التي تستخدم Ads Data Hub REST API للتفاعل مع Ads Data Hub. تسمح لك واجهة Ads Data Hub REST API بالاطّلاع على عملاء Ads Data Hub المرتبطين بحسابك على Google، وإنشاء طلبات بحث، وتنفيذ طلبات البحث.

ضبط إعدادات الجهاز

هناك بضع خطوات يجب إكمالها قبل استخدام Ads Data Hub API:

  1. تأكَّد من منح المستخدم الذي يفعّل واجهة برمجة التطبيقات الحصول على إذن "serviceusage.services.enable" في مشروع Google Cloud المستخدِم لديه إذن serviceusage.services.enable، يجب أيضًا إضافته إلى القائمة المسموح بها الوصول إلى واجهة برمجة التطبيقات.
  2. تفعيل واجهة برمجة تطبيقات Ads Data Hub API في مشروع Google Cloud الذي تم فيه إنشاء بيانات اعتماد العميل أو حساب الخدمة لتفعيل واجهة برمجة التطبيقات Ads Data Hub API لمشروع يستخدم وحدة التحكّم، اتّبِع الخطوات التالية:
    1. انتقِل إلى مكتبة Cloud Console API.
    2. اختَر المشروع الذي تريد استخدامه من قائمة المشاريع.
    3. ابحث عن "واجهة برمجة تطبيقات Ads Data Hub".
    4. في صفحة واجهة برمجة التطبيقات، انقر على تفعيل.
  3. إدارة الأذونات:
    1. يجب أن يكون عنوان البريد الإلكتروني أو حساب الخدمة المُستخدَمان لإنشاء بيانات الاعتماد: أن تتم إضافته إلى Ads Data Hub باستخدام الأذونات المناسبة. بالنسبة إلى حساب الخدمة، هذا هو عنوان البريد الإلكتروني لحساب الخدمة. بالنسبة OAuth، هذا هو عنوان البريد الإلكتروني للمستخدم. يضمن ذلك وصول الخدمة لدى الحساب أو حساب المستخدم النهائي إذن لتنفيذ طلبات البحث في Ads Data Hub.
  4. (يُنصح به) تثبيت مكتبة برامج Google API:
    1. تتوفر مكتبات عملاء واجهة Google API بعدة طرق شائعة كما تسمح لك بالعمل باستخدام العديد من واجهات برمجة تطبيقات Google. على الرغم من أن هذا ليس تقوم مكتبات العملاء بتقليل مقدار التعليمات البرمجية التي لديك الكتابة وتسهيل إعداد المصادقة.
مكتبة العميل نماذج Ads Data Hub
مكتبة برامج Google API للغة Java Java
مكتبة برامج Google API للغة Python

المصادقة والتفويض

يمكن لواجهة Ads Data Hub API الوصول إلى البيانات وتغييرها في حساب عميل Ads Data Hub. الحساب، لذلك يجب التحقق من أنك مستخدم معتمَد. لهذا السبب، قبل بدء التفاعل مع Ads Data Hub API، عليك الاطّلاع على من خلال عملية تفويض يمنحك تدفق التفويض الأذونات اللازمة للتفاعل مع واجهة برمجة التطبيقات. يمكنك المصادقة باستخدام OAuth 2.0 أو حساب خدمة.

إعداد حساب الخدمة

  1. انتقِل إلى وحدة تحكّم Google API، ثم إلى مشروع المشرف.
  2. التحقّق من تفعيل Ads Data Hub API لمشروعك ضمن واجهات برمجة التطبيقات الخدمات:
    1. وإذا لم تكن كذلك، انقر على + تفعيل واجهات برمجة التطبيقات والخدمات وفعِّل "إعلانات Google". واجهة برمجة تطبيقات Data Hub.
  3. في قائمة التنقّل اليمنى، انقر على إدارة الهوية وإمكانية الوصول المشرف > حسابات الخدمة:
    1. إذا لم تكن قد أنشأت حساب خدمة بعد، إنشاء واحدة.
  4. انقر على قائمة النقاط الثلاث () ضمن "الإجراءات"، ثمّ انقر على إدارة المفاتيح.
    1. انقر على إضافة مفتاح >. إنشاء مفتاح جديد
    2. بعد التأكد من أن "JSON" الذي تم تحديده، انقر على إنشاء.
  5. إضافة عنوان البريد الإلكتروني لحساب الخدمة كمستخدم في Ads Data Hub الحساب.

إرسال نموذج طلب

#!/usr/bin/env python3

"""This sample shows how to retrieve all accounts associated with the user.
"""
import json
from google.oauth2.service_account import Credentials
from googleapiclient.discovery import build

SCOPES = ['https://www.googleapis.com/auth/adsdatahub']
DISCOVERY_URL = 'https://adsdatahub.googleapis.com/$discovery/rest?version=v1'
creds = Credentials.from_service_account_file(
    'service-account.json').with_scopes(SCOPES)
developer_key = 'YOUR_DEVELOPER_KEY'  # Replace with your developer key.
service = build('AdsDataHub', 'v1', credentials=creds,
                developerKey=developer_key, discoveryServiceUrl=DISCOVERY_URL)

# Replace with your ADH account ID.
adh_account_id = input('ADH account ID (e.g. "customers/123456789"): ').strip()
queries = service.customers().analysisQueries().list(
    parent=adh_account_id).execute()
print(json.dumps(queries, sort_keys=True, indent=4))

الخطوات التالية

  • اطّلِع على نماذج طلبات البحث في Ads Data Hub للحصول على أمثلة على طلبات البحث التي يمكنك إنشاؤها وتنفيذها باستخدام Ads Data Hub REST API.
  • وسِّع نطاق النماذج للتعرّف على واجهة برمجة التطبيقات وتخصيصها حسب حالة استخدامك. بعد ذلك، يُرجى محاولة:
    • حالة عملية طلب الاستطلاع.
    • استخدِم مكتبة برامج BigQuery لاسترداد نتائج طلبات البحث المكتملة.
  • يمكنك التواصل مع فريق دعم Ads Data Hub إذا كانت لديك أسئلة أو ملاحظات حول واجهة برمجة التطبيقات.
السابق
إعداد حسابك
التالي
استخدام واجهة مستخدم الويب