Tags: create

يتطلّب تفويضًا

تنشئ علامة GTM. جرِّب الخدمة الآن أو اطّلِع على مثال.

الطلب

طلب HTTP

POST https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/tags

المعلمات

اسم المعلَمة القيمة الوصف
مَعلمات المسار
accountId string رقم تعريف حساب "إدارة العلامات من Google"
containerId string رقم تعريف حاوية GTM.

التفويض

يتطلب هذا الطلب تفويضًا بالنطاق التالي (مزيد من المعلومات عن المصادقة والترخيص).

النطاق
https://www.googleapis.com/auth/tagmanager.edit.containers

نص الطلب

في نص الطلب، قدِّم موردًا للعلامات يتضمّن السمات التالية:

اسم الموقع القيمة الوصف ملاحظات
الخصائص المطلوبة
name string الاسم المعروض للعلامة قابل للكتابة
parameter[].type string نوع المَعلمة القيم الصالحة هي:
  • boolean: القيمة تمثل قيمة منطقية، ويتم تمثيلها على أنّها "صحيح" أو "false"
  • integer: تمثل القيمة قيمة عدد صحيح بعلامة 64 بت، في الأساس 10.
  • list: يجب تحديد قائمة بالمعلَمات
  • map: يجب تحديد خريطة بالمَعلمات
  • template: تمثل القيمة أي نص، يمكن أن يشمل ذلك مراجع متغيرة (حتى مراجع متغيرات قد تعرض أنواعًا ليست سلسلة)
  • trigger_reference: تمثل القيمة عامل تشغيل، ويتم تمثيله كرقم تعريف المشغِّل


القيم المقبولة هي:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
 قابل للكتابة
priority.type string نوع المَعلمة القيم الصالحة هي:
  • boolean: القيمة تمثل قيمة منطقية، ويتم تمثيلها على أنّها "صحيح" أو "false"
  • integer: تمثل القيمة قيمة عدد صحيح بعلامة 64 بت، في الأساس 10.
  • list: يجب تحديد قائمة بالمعلَمات
  • map: يجب تحديد خريطة بالمَعلمات
  • template: تمثل القيمة أي نص، يمكن أن يشمل ذلك مراجع متغيرة (حتى مراجع متغيرات قد تعرض أنواعًا ليست سلسلة)
  • trigger_reference: تمثل القيمة عامل تشغيل، ويتم تمثيله كرقم تعريف المشغِّل


القيم المقبولة هي:
  • "boolean"
  • "integer"
  • "list"
  • "map"
  • "template"
  • "triggerReference"
 قابل للكتابة
type string نوع علامة "إدارة العلامات من Google" قابل للكتابة
الخصائص الاختيارية
blockingRuleId[] list أرقام تعريف قواعد الحظر وإذا تم تقييم أي من القواعد المدرجة على أنها صحيحة، فلن يتم تنشيط العلامة. قابل للكتابة
blockingTriggerId[] list حظر معرّفات المشغِّلات وإذا تم تقييم أيّ من عوامل التشغيل المدرَجة على أنّها "صحيح"، لن يتم تنشيط العلامة. قابل للكتابة
firingRuleId[] list أرقام تعريف قواعد التنشيط. يتم تنشيط العلامة عندما تكون أي من القواعد المُدرجة صحيحة وتكون جميع blockingRuleIds (إن وجدت) خاطئة. قابل للكتابة
firingTriggerId[] list جارٍ تنشيط معرّفات المشغِّلات. يتم تنشيط العلامة عندما يكون أي من عوامل التشغيل المدرَجة صحيحًا، وتكون كل blockingTriggerIds (في حال تحديدها) غير صحيحة. قابل للكتابة
liveOnly boolean في حال ضبط هذه العلامة على "صحيح"، لن يتم تنشيطها إلا في البيئة المباشرة (على سبيل المثال، ليس في وضع المعاينة أو تصحيح الأخطاء). قابل للكتابة
notes string ملاحظات المستخدم حول كيفية تطبيق هذه العلامة في الحاوية قابل للكتابة
parameter[] list مَعلمات العلامة. قابل للكتابة
parameter[].key string المفتاح المُسمّى الذي يعرّف معلمة بشكلٍ فريد. مطلوبة لمعلمات المستوى الأعلى، فضلاً عن قيم الخريطة. ويتم تجاهلها لقيم القائمة. قابل للكتابة
parameter[].list[] list معلمات معلمات القائمة هذه (سيتم تجاهل المفاتيح). قابل للكتابة
parameter[].map[] list معلمات معلمة الخريطة هذه (يجب أن يكون لها مفاتيح، ويجب أن تكون المفاتيح فريدة). قابل للكتابة
parameter[].value string قيمة المعلَمة (قد تحتوي على مراجع متغيّرات مثل "") بالشكل المناسب للنوع المحدّد. قابل للكتابة
paused boolean صحيح إذا كانت العلامة متوقفة مؤقتًا. قابل للكتابة
priority nested object الأولوية الرقمية للعلامة من قِبل المستخدم. يتم تنشيط العلامات بشكلٍ غير متزامن بترتيب الأولوية. يتم تنشيط العلامات ذات القيمة الرقمية الأعلى أولاً. قد تكون أولوية العلامة قيمة موجبة أو سلبية. القيمة التلقائية هي 0. قابل للكتابة
priority.key string المفتاح المُسمّى الذي يعرّف معلمة بشكلٍ فريد. مطلوبة لمعلمات المستوى الأعلى، فضلاً عن قيم الخريطة. ويتم تجاهلها لقيم القائمة. قابل للكتابة
priority.list[] list معلمات معلمات القائمة هذه (سيتم تجاهل المفاتيح). قابل للكتابة
priority.map[] list معلمات معلمة الخريطة هذه (يجب أن يكون لها مفاتيح، ويجب أن تكون المفاتيح فريدة). قابل للكتابة
priority.value string قيمة المعلَمة (قد تحتوي على مراجع متغيّرات مثل "") بالشكل المناسب للنوع المحدّد. قابل للكتابة
scheduleEndMs long الطابع الزمني للانتهاء بالملي ثانية لجدولة علامة. قابل للكتابة
scheduleStartMs long الطابع الزمني للبدء بالملي ثانية لجدولة علامة. قابل للكتابة

الرد

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

أمثلة

ملاحظة: إنّ الأمثلة المرتبطة بالرموز والمتوفرة لهذه الطريقة لا تمثّل كل لغات البرمجة المتوافقة (يُرجى مراجعة صفحة مكتبات البرامج للاطّلاع على قائمة باللغات المتوافقة).

Java

تستخدم مكتبة برامج Java.

/*
 * Note: This code assumes you have an authorized tagmanager service object.
 */

/*
 * This request creates a new tag.
 */

// Construct the parameters.
Parameter arg0 = new Parameter();
arg0.setType("template");
arg0.setKey("trackingId");
arg0.setValue("UA-123456-1");

Parameter arg1 = new Parameter();
arg1.setType("template");
arg1.setKey("type");
arg1.setValue("TRACK_TRANSACTION");

// Construct the tag object.
Tag tag = new Tag();
tag.setName("Sample Universal Analytics Tag");
tag.setType("ua");
tag.setLiveOnly(false);
tag.setParameter(Arrays.asList(arg0, arg1));

try {
  Tag response = tagmanager.accounts().containers().
      tags().create("123456", "54321", tag).execute();

} catch (GoogleJsonResponseException e) {
  System.err.println("There was a service error: "
      + e.getDetails().getCode() + " : "
      + e.getDetails().getMessage());
}


/*
 * The results of the create method are stored in response object.
 * The following code shows how to access the created id and fingerprint.
 */
System.out.println("Tag id = " + response.getTagId());
System.out.println("Tag Fingerprint = " + response.getFingerprint());

Python

تستخدم مكتبة برامج Python.

# Note: This code assumes you have an authorized tagmanager service object.

# This request creates a new container tag.
try:
  response = tagmanager.accounts().containers().tags().create(
      accountId='123456',
      containerId='54321',
      body={
          'name': 'Universal Analytics Tag',
          'type': 'ua',
          'liveOnly': False,
          'parameter': [
              {
                  'type': 'template',
                  'key': 'trackingId',
                  'value': 'UA-123456-1'
              },
              {
                  'type': 'template',
                  'key': 'type',
                  'value': 'TRACK_TRANSACTION'
              }
          ]
      }
  ).execute()

except TypeError, error:
  # Handle errors in constructing a query.
  print 'There was an error in constructing your query : %s' % error

except HttpError, error:
  # Handle API errors.
  print ('There was an API error : %s : %s' %
         (error.resp.status, error.resp.reason))

# The results of the create method are stored in the response object.
# The following code shows how to access the created id and fingerprint.
print response.get('tagId')
print response.get('fingerprint')

جرّب الآن

يمكنك استخدام "مستكشف واجهات برمجة التطبيقات" أدناه لطلب هذه الطريقة على البيانات المباشرة والاطّلاع على الردّ.