إدارة الحسابات التي يتحكم فيها الشركاء - دليل مطوّري برامج واجهة برمجة التطبيقات

المقدمة

createAccountTree هو جزء من واجهة برمجة التطبيقات لإدارة الحسابات التي يمكن استخدامها لإنشاء حسابات جديدة على "إحصاءات Google" على نطاق واسع. على عكس createAccountTicket، لا تتطلّب createAccountTree أي تفاعل من المستخدم النهائي لإكمال إنشاء الحساب، وتكون العملية مُبرمَجة بالكامل. ويكون ذلك مفيدًا عندما تحتاج إلى تزويد حساب على "إحصاءات Google" تتحكَّم فيه نيابةً عن عميل، والمكان الذي تقدِّم فيه عرضًا مخصّصًا لتلك البيانات.

واجهة برمجة التطبيقات هذه محجوزة للشركاء الذين يتحكمون في مستخدميهم/المواقع الإلكترونية أو مواقع الويب. إذا كان المستخدمون يتحكّمون في مواقعهم الإلكترونية أو مواقعهم الإلكترونية، عليك بدلاً من ذلك إنشاء حسابات على "إحصاءات Google" يتحكّم فيها المستخدمون.

قبل البدء

يتم الوصول إلى جميع واجهات برمجة تطبيقات "إحصاءات Google" بطريقة مشابهة. قبل البدء باستخدام واجهة برمجة التطبيقات لإدارة الحسابات، عليك تنفيذ ما يلي:

  • اقرأ صفحة مكتبات العميل للحصول على قائمة كاملة بمكتبات البرامج بلغات البرمجة التي تعمل مع واجهة برمجة التطبيقات.
  • اقرأ الدليل المرجعي للتعرّف على واجهة واجهة برمجة التطبيقات وكيفية الوصول إلى البيانات بدون مكتبة العميل.

توفِّر كل مكتبة عميل عنصر خدمة إحصاءات واحدًا للوصول إلى واجهة برمجة التطبيقات لإدارة الحسابات. لإنشاء عنصر الخدمة، يجب تنفيذ الخطوات التالية بشكل عام:

  1. سجّل تطبيقك في وحدة التحكم في واجهة Google API.
  2. يُرجى التفويض لإنشاء حساب جديد على "إحصاءات Google".
  3. إنشاء عنصر خدمة "إحصاءات Google".

إذا لم تكمل هذه الخطوات، يُرجى إيقاف قراءة البرنامج التعليمي لواجهة برمجة تطبيقات Google Analytics Hello. سيساعدك هذا البرنامج التعليمي في الخطوات الأولية لإنشاء تطبيق واجهة برمجة تطبيقات في "إحصاءات Google". بعد إكمال هذه العملية، ستتعرّف على كيفية الوصول إلى واجهات برمجة تطبيقات "إحصاءات Google" لتنفيذ مهام فعلية.

حساب النموذج

كجزء من التفويض لاستخدام واجهة برمجة التطبيقات هذه، عليك تقديم حساب "إحصاءات Google" جديد، والذي يكون بمثابة نموذج حساب لواجهة برمجة التطبيقات هذه. عند إنشاء حسابات جديدة، تكتسب هذه المجموعات إعدادات مختلفة من حساب النموذج، بما في ذلك جهة قبول بنود الخدمة والمؤسسة وإعدادات مشاركة البيانات المختلفة. ارجع إلى مرجع createAccountTree للحصول على مزيد من التفاصيل حول حساب النموذج، بما في ذلك قائمة بكل البيانات المكتسبة.

إدارة حساب

لإدارة حساب جديد على "إحصاءات Google"، عليك تقديم طلب إلى نقطة نهاية واجهة برمجة تطبيقات createAccountTree. ستحتاج إلى التفاصيل التالية لإدارة الحسابات:

  • حقول الحساب
    • accountName للحساب.
  • حقول الموقع الإلكتروني
    • تمثّل هذه السمة webpropertyName للموقع.
    • websiteUrl. يجب أن يكون هذا عنوان URL المرتبط بخاصيّة المستخدم لهذا الحساب على "إحصاءات Google".
  • حقول العرض
    • profileName للملف الشخصي.
    • timezone للملف الشخصي.

بعد الحصول على التفاصيل، يمكنك إجراء طلب تمت المصادقة عليه إلى نقطة نهاية واجهة برمجة التطبيقات:

POST https://www.googleapis.com/analytics/v3/provisioning/createAccountTree
{
    "accountName": "Analytics Account",
    "webpropertyName": "Default Property",
    "profileName": "Default View",
    "timezone": "America/Los_Angeles",
    "websiteUrl": "www.example-pet-store.com",
}

في حال نجاح الردّ، ستستجيب واجهة برمجة التطبيقات مع تفاصيل الحساب الذي تم إنشاؤه حديثًا والموقع الإلكتروني وعرض:

{
    "account": {
        "id": "999999999",
        "name": "Analytics Account",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "webproperty": {
        "id": "UA-999999999-1",
        "name": "Default Property",
        "websiteUrl": "www.example-pet-store.com",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    "profile": {
        "id": "999999999",
        "name": "Default View",
        "timezone": "America/Los_Angeles",
        "created": "2018-03-16T23:35:20.699Z",
        "updated": "2018-03-16T23:35:20.699Z",
        ...
    },
    ...
}

ملكية الحساب وإدارته

سيكون حساب "إحصاءات Google" الذي تم إنشاؤه مملوكًا لحساب المستخدم الذي فوّض الاستجابة عبر OAuth. ولهذا السبب، ننصح مؤسستك باستخدام حساب خدمة لإدارة حساب "إحصاءات Google"، بدلاً من حساب مستخدم فردي.

بعد إنشاء الحساب، يمكنك ضبطه باستخدام Management API. في ما يلي بعض المهام الشائعة للحساب الذي تم إنشاؤه حديثًا:

توضيح العلاقات في الحساب

كما هو الحال مع جميع واجهات برمجة تطبيقات Google، يجب توفّر مشروع Google Cloud كنقطة بداية لطلب التفويض. كما هو موضّح في مستندات OAuth 2.0، يمكنك إدارة بيانات الاعتماد الخاصة بطلبات البيانات من واجهة برمجة التطبيقات في هذا الحساب. ومع ذلك، فإن حساب "إحصاءات Google" الذي تم إنشاؤه لا يرتبط بأي شكل من الأشكال بمشروع Cloud أو حساباته الإدارية، بل يرتبط فقط بحساب المستخدم أو حساب الخدمة الذي فوّض الطلب. يمكنك استخدام واجهة برمجة تطبيقات الإدارة إذا كنت بحاجة إلى إعداد الوصول إلى الحساب لحساب "إحصاءات Google".