Tags: create

نیاز به مجوز دارد

یک تگ GTM ایجاد می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .

درخواست

درخواست HTTP

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

مولفه های

نام پارامتر ارزش شرح
پارامترهای مسیر
accountId string شناسه حساب GTM.
containerId string شناسه کانتینر GTM.

مجوز

این درخواست به مجوز با محدوده زیر نیاز دارد ( در مورد احراز هویت و مجوز بیشتر بخوانید ).

محدوده
https://www.googleapis.com/auth/tagmanager.edit.containers

درخواست بدن

در بدنه درخواست، یک منبع برچسب با ویژگی های زیر ارائه کنید:

نام ملک ارزش شرح یادداشت
خواص مورد نیاز
name string نام نمایشی برچسب قابل نوشتن
parameter[]. type string نوع پارامتر مقادیر معتبر عبارتند از:
  • boolean : مقدار یک بولی را نشان می دهد که به صورت "درست" یا "نادرست" نمایش داده می شود.
  • integer : این مقدار یک مقدار عدد صحیح امضا شده 64 بیتی را در پایه 10 نشان می دهد
  • list : لیستی از پارامترها باید مشخص شود
  • map : یک نقشه از پارامترها باید مشخص شود
  • template : مقدار هر متنی را نشان می دهد. این می تواند شامل مراجع متغیر باشد (حتی مراجع متغیری که ممکن است انواع غیر رشته ای را برگرداند)
  • trigger_reference : مقدار نشان دهنده یک ماشه است که به عنوان شناسه ماشه نشان داده می شود


مقادیر قابل قبول عبارتند از:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " template "
  • " triggerReference "
 قابل نوشتن
priority. type string نوع پارامتر مقادیر معتبر عبارتند از:
  • boolean : مقدار یک بولی را نشان می دهد که به صورت "درست" یا "نادرست" نمایش داده می شود.
  • integer : این مقدار یک مقدار عدد صحیح امضا شده 64 بیتی را در پایه 10 نشان می دهد
  • list : لیستی از پارامترها باید مشخص شود
  • map : یک نقشه از پارامترها باید مشخص شود
  • template : مقدار هر متنی را نشان می دهد. این می تواند شامل مراجع متغیر باشد (حتی مراجع متغیری که ممکن است انواع غیر رشته ای را برگرداند)
  • trigger_reference : مقدار نشان دهنده یک ماشه است که به عنوان شناسه ماشه نشان داده می شود


مقادیر قابل قبول عبارتند از:
  • " boolean "
  • " integer "
  • " list "
  • " map "
  • " template "
  • " triggerReference "
 قابل نوشتن
type string نوع برچسب GTM قابل نوشتن
ویژگی های اختیاری
blockingRuleId[] list مسدود کردن شناسه قوانین اگر هر یک از قوانین ذکر شده درست ارزیابی شود، تگ فعال نمی شود. قابل نوشتن
blockingTriggerId[] list مسدود کردن شناسه های ماشه اگر هر یک از محرک های فهرست شده درست ارزیابی شود، تگ فعال نمی شود. قابل نوشتن
firingRuleId[] list شناسه قوانین شلیک یک تگ زمانی فعال می شود که هر یک از قوانین فهرست شده درست باشد و همه blockingRuleIds آن (در صورت مشخص بودن) نادرست باشند. قابل نوشتن
firingTriggerId[] list فعال کردن شناسه های ماشه. یک برچسب زمانی فعال می شود که هر یک از محرک های فهرست شده درست باشد و تمام blockingTriggerIds آن (در صورت مشخص شدن) نادرست باشند. قابل نوشتن
liveOnly boolean اگر روی true تنظیم شود، این تگ فقط در محیط زنده فعال می شود (مثلاً در حالت پیش نمایش یا اشکال زدایی). قابل نوشتن
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 مهر زمان شروع در میلی ثانیه برای برنامه ریزی یک برچسب. قابل نوشتن

واکنش

در صورت موفقیت آمیز بودن، این روش یک منبع Tags را در بدنه پاسخ باز می گرداند.

مثال ها

توجه: نمونه‌های کد موجود برای این روش همه زبان‌های برنامه‌نویسی پشتیبانی‌شده را نشان نمی‌دهند (برای فهرست زبان‌های پشتیبانی‌شده به صفحه کتابخانه‌های سرویس گیرنده مراجعه کنید).

جاوا

از کتابخانه سرویس گیرنده جاوا استفاده می کند.

/*
 * 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());

پایتون

از کتابخانه کلاینت پایتون استفاده می کند.

# 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')

آن را امتحان کنید!

از APIs Explorer زیر برای فراخوانی این روش در داده‌های زنده و دیدن پاسخ استفاده کنید.