REST Resource: accounts.containers.workspaces.tags

المرجع: العلامة

تمثّل علامة أداة "إدارة العلامات من Google".

تمثيل JSON
{
  "path": string,
  "accountId": string,
  "containerId": string,
  "workspaceId": string,
  "tagId": string,
  "name": string,
  "type": string,
  "liveOnly": boolean,
  "priority": {
    object (Parameter)
  },
  "notes": string,
  "scheduleStartMs": string,
  "scheduleEndMs": string,
  "parameter": [
    {
      object (Parameter)
    }
  ],
  "fingerprint": string,
  "firingTriggerId": [
    string
  ],
  "blockingTriggerId": [
    string
  ],
  "setupTag": [
    {
      object (SetupTag)
    }
  ],
  "teardownTag": [
    {
      object (TeardownTag)
    }
  ],
  "parentFolderId": string,
  "tagFiringOption": enum (TagFiringOption),
  "tagManagerUrl": string,
  "paused": boolean,
  "monitoringMetadata": {
    object (Parameter)
  },
  "monitoringMetadataTagNameKey": string,
  "consentSettings": {
    object (ConsentSetting)
  }
}
الحقول
path

string

المسار النسبي لواجهة برمجة تطبيقات علامة "إدارة العلامات من Google"

accountId

string

رقم تعريف حساب "إدارة العلامات من Google"

containerId

string

رقم تعريف حاوية "إدارة العلامات من Google"

workspaceId

string

رقم تعريف مساحة عمل "إحصاءات Google‏ 4"

tagId

string

يحدّد رقم تعريف العلامة علامة "إدارة العلامات من Google" بشكل فريد.

name

string

الاسم المعروض للعلامة

type

string

نوع علامة "إدارة العلامات من Google"

liveOnly

boolean

في حال ضبط القيمة على "صحيح"، لن يتم تفعيل هذه العلامة إلا في البيئة المنشورة (على سبيل المثال، ليس في وضع المعاينة أو وضع تصحيح الأخطاء).

priority

object (Parameter)

الأولوية الرقمية التي حدّدها المستخدم للعلامة. يتم تنشيط العلامات بشكل غير متزامن بترتيب الأولوية. يتمّ إطلاق العلامات ذات القيمة الرقمية الأعلى أولاً. يمكن أن تكون أولوية العلامة قيمة موجبة أو سالبة. القيمة التلقائية هي 0.

notes

string

ملاحظات المستخدم حول كيفية تطبيق هذه العلامة في الحاوية

scheduleStartMs

string (int64 format)

الطابع الزمني للبدء بالملي ثانية لجدولة علامة

scheduleEndMs

string (int64 format)

الطابع الزمني للانتهاء بالمللي ثانية لجدولة علامة

parameter[]

object (Parameter)

مَعلمات العلامة

fingerprint

string

بصمة علامة "إدارة العلامات من Google" كما تم احتسابها في وقت التخزين تتم إعادة احتساب هذه القيمة عند تعديل العلامة.

firingTriggerId[]

string

أرقام تعريف عوامل التشغيل التي يتم تنشيطها سيتم تنشيط العلامة عندما يكون أيّ من عوامل التشغيل المُدرَجة صحيحًا وجميع

blockingTriggerIds

(إذا تم تحديد أي منها) تكون خاطئة.

blockingTriggerId[]

string

أرقام تعريف مشغِّلات الحظر إذا تم تقييم أيّ من عوامل التفعيل المدرَجة على أنّها صحيحة، لن يتم تنشيط العلامة.

setupTag[]

object (SetupTag)

قائمة علامات الإعداد نسمح حاليًا بإضافة علامة واحدة فقط.

teardownTag[]

object (TeardownTag)

قائمة علامات الإزالة نسمح حاليًا بإضافة علامة واحدة فقط.

parentFolderId

string

معرّف المجلد الرئيسي

tagFiringOption

enum (TagFiringOption)

خيار تنشيط هذه العلامة

tagManagerUrl

string

رابط تم إنشاؤه تلقائيًا يؤدي إلى واجهة مستخدم أداة إدارة العلامات

paused

boolean

يشير إلى ما إذا كانت العلامة متوقفة مؤقتًا، ما يمنع العلامة من التنشيط.

monitoringMetadata

object (Parameter)

خريطة لأزواج المفتاح/القيمة للبيانات الوصفية للعلامة التي سيتم تضمينها في بيانات الحدث لتتبُّع العلامة ملاحظات:

  • يجب أن تكون هذه المَعلمة من النوع

    MAP

    .

  • كل مَعلمة في الخريطة من النوع

    TEMPLATE

    ، ولكن لا يمكن أن تحتوي على إشارات إلى متغيّرات.

monitoringMetadataTagNameKey

string

إذا لم يكن فارغًا، سيتم تضمين الاسم المعروض للعلامة في خريطة البيانات الوصفية للمراقبة باستخدام المفتاح المحدّد.

consentSettings

object (ConsentSetting)

إعدادات الموافقة لعلامة معيّنة.

SetupTag

يمثّل إشارة إلى علامة يتم تنشيطها قبل علامة أخرى من أجل إعداد التبعيات.

تمثيل JSON
{
  "tagName": string,
  "stopOnSetupFailure": boolean
}
الحقول
tagName

string

اسم علامة الإعداد

stopOnSetupFailure

boolean

إذا كانت القيمة true، يتم تنشيط العلامة الرئيسية إذا تم تنشيط علامة الإعداد بنجاح فقط. إذا كانت القيمة خطأ، يتم تنشيط العلامة الرئيسية بغض النظر عن حالة تنشيط علامة الإعداد.

TeardownTag

تمثّل علامة يتم تنشيطها بعد علامة أخرى من أجل إزالة التبعيات.

تمثيل JSON
{
  "tagName": string,
  "stopTeardownOnFailure": boolean
}
الحقول
tagName

string

اسم علامة الإزالة

stopTeardownOnFailure

boolean

إذا كانت القيمة true، يتم تنشيط علامة الإزالة إذا تم تنشيط العلامة الرئيسية بنجاح فقط. إذا كانت القيمة "false"، يتم تنشيط علامة الإزالة بغض النظر عن حالة تنشيط العلامة الرئيسية.

TagFiringOption

عمليات التعداد
tagFiringOptionUnspecified
unlimited يمكن تنشيط العلامة عدة مرات لكلّ حدث.
oncePerEvent لا يمكن تنشيط العلامة إلا لكل حدث، ولكن يمكن تنشيطها عدة مرات لكل عملية تحميل (مثل تحميل التطبيق أو الصفحة).
oncePerLoad لا يمكن تنشيط العلامة إلا عند كل عملية تحميل (مثل تحميل التطبيق أو الصفحة).

ConsentSetting

تمثيل JSON
{
  "consentStatus": enum (ManualConsentOption),
  "consentType": {
    object (Parameter)
  }
}
الحقول
consentStatus

enum (ManualConsentOption)

حالة الموافقة على العلامة. في حال ضبطها على NEEDED، سيتحقّق وقت التشغيل من أنّ أنواع الموافقة المحدّدة من

consentType

حقل.

consentType

object (Parameter)

نوع الموافقة المطلوب التحقّق منها أثناء تنشيط العلامة إذا كانت في الحالة "الموافقة مطلوبة". يجب أن تكون هذه المَعلمة من النوع

LIST

حيث يكون كل عنصر في القائمة من النوع

STRING

.

ManualConsentOption

عمليات التعداد
notSet القيمة التلقائية التي لم يحدّد المستخدم أي إعداد لها
notNeeded لا تتطلّب العلامة أيّ إعدادات إضافية للموافقة.
needed تتطلّب العلامة إعدادات موافقة إضافية.

الطُرق

create

تُنشئ علامة "إدارة العلامات من Google".

delete

لحذف علامة "إدارة العلامات من Google"

get

تحصل على علامة أداة "إدارة العلامات من Google".

list

يسرد جميع علامات أداة "إدارة العلامات من Google" الخاصة بحاوية معيّنة.

revert

تُلغي التغييرات التي تم إجراؤها على علامة "إدارة العلامات من Google" في مساحة عمل "إدارة العلامات من Google".

update

تعديل علامة "إدارة العلامات من Google"