Method: properties.submitUserDeletion

يرسل طلبًا بحذف مستخدم من إحدى المواقع.

طلب HTTP

POST https://analyticsadmin.googleapis.com/v1alpha/{name=properties/*}:submitUserDeletion

يستخدم عنوان URL بنية تحويل الترميز إلى gRPC.

مَعلمات المسار

المَعلمات
name

string

الحقل مطلوب. اسم الموقع الذي سيتم إرسال طلب حذف بيانات المستخدمين إليه.

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON
{

  // Union field user can be only one of the following:
  "userId": string,
  "clientId": string,
  "appInstanceId": string,
  "userProvidedData": string
  // End of list of possible types for union field user.
}
الحقول
حقل الربط user يمكن أن يكون المستخدم الذي يرسل طلب حذف user إحدى القيم التالية فقط:
userId

string

معرّف المستخدم في "إحصاءات Google"

clientId

string

معرّف العميل في "إحصاءات Google"

appInstanceId

string

معرّف مثيل التطبيق في Firebase

userProvidedData

string

البيانات المقدَّمة من المستخدم يمكن أن يحتوي على عنوان بريد إلكتروني واحد أو رقم هاتف واحد.

يجب أن يتم تنظيم عناوين البريد الإلكتروني على النحو التالي:

  • أحرف صغيرة
  • إزالة النقاط قبل علامة @ في العناوين التي تنتهي بالنطاقَين gmail.com وgooglemail.com
  • إزالة كل المسافات

يجب أن تكون أرقام الهواتف موحّدة على النحو التالي:

  • إزالة جميع الأحرف غير الرقمية
  • إضافة البادئة +

نص الاستجابة

رسالة الردّ على طلب إجراء عن بُعد (RPC) لإرسال طلب حذف مستخدمين

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON
{
  "deletionRequestTime": string
}
الحقول
deletionRequestTime

string (Timestamp format)

تحدّد هذه السمة الوقت الذي يجب فيه حذف جميع بيانات الزوّار قبل هذه النقطة. يتم ضبط هذا الحقل على الوقت الذي تم فيه تلقّي طلب الحذف.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".

نطاقات الأذونات

يجب توفير نطاق OAuth التالي:

  • https://www.googleapis.com/auth/analytics.edit