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

مقدمة

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

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

قبل البدء

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

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

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

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

في حال عدم إكمالك لهذه الخطوات، يُرجى التوقف عن قراءة البرنامج التعليمي المخصّص لواجهة برمجة تطبيقات Google Analytics API. يرشدك هذا الدليل التعليمي خلال الخطوات الأولية لإنشاء تطبيق واجهة برمجة التطبيقات Google Analytics API. وبعد اكتمالها، ستفهم كيفية الوصول إلى واجهات برمجة تطبيقات "إحصاءات 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 APIs، يكون مشروع Google Cloud مطلوبًا كنقطة بداية لتفويض الطلب. كما هو موضح في مستندات OAuth 2.0، هذا الحساب هو المكان الذي ستدير منه بيانات اعتمادك لطلبات واجهة برمجة التطبيقات. ومع ذلك، فإنّ حساب "إحصاءات Google" الذي تمّ إنشاؤه غير مرتبط مباشرةً بأيّ شكل من الأشكال بالمشروع على السحابة الإلكترونية أو الحسابات المُدارة له، بل هو مرتبط فقط بحساب المستخدِم أو الخدمة الذي سمح بالطلب. يمكنك استخدام Management API إذا كنت بحاجة إلى ضبط إذن الوصول إلى الحساب على "إحصاءات Google".