Variables: update

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

یک متغیر GTM را به روز می کند. اکنون آن را امتحان کنید یا نمونه ای را ببینید .

درخواست

درخواست HTTP

PUT https://www.googleapis.com/tagmanager/v1/accounts/accountId/containers/containerId/variables/variableId

مولفه های

نام پارامتر ارزش شرح
پارامترهای مسیر
accountId string شناسه حساب GTM.
containerId string شناسه کانتینر GTM.
variableId string شناسه متغیر GTM.
پارامترهای پرس و جو اختیاری
fingerprint string در صورت ارائه، این اثر انگشت باید با اثر انگشت متغیر موجود در حافظه مطابقت داشته باشد.

مجوز

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

محدوده
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 "
قابل نوشتن
type string نوع متغیر GTM. قابل نوشتن
ویژگی های اختیاری
disablingTriggerId[] list فقط برای کانتینرهای موبایل: فهرستی از شناسه‌های ماشه برای غیرفعال کردن متغیرهای شرطی. متغیر در صورتی فعال می شود که یکی از تریگرهای فعال کننده درست باشد در حالی که همه محرک های غیرفعال کننده نادرست باشند. به عنوان یک مجموعه نامرتب رفتار می شود. قابل نوشتن
enablingTriggerId[] list فقط برای کانتینرهای موبایل: فهرستی از شناسه‌های راه‌انداز برای فعال کردن متغیرهای شرطی. متغیر در صورتی فعال می شود که یکی از محرک های فعال کننده درست باشد در حالی که همه محرک های غیرفعال نادرست باشند. به عنوان یک مجموعه نامرتب رفتار می شود. قابل نوشتن
notes string یادداشت های کاربر در مورد نحوه اعمال این متغیر در ظرف. قابل نوشتن
parameter[] list پارامترهای متغیر قابل نوشتن
parameter[]. key string کلید نامگذاری شده که به طور منحصر به فرد یک پارامتر را شناسایی می کند. برای پارامترهای سطح بالا و همچنین مقادیر نقشه مورد نیاز است. برای مقادیر لیست نادیده گرفته شد. قابل نوشتن
parameter[]. list[] list پارامترهای این پارامتر فهرست (کلیدها نادیده گرفته خواهند شد). قابل نوشتن
parameter[]. map[] list پارامترهای این پارامتر نقشه (باید کلید داشته باشد؛ کلیدها باید منحصر به فرد باشند). قابل نوشتن
parameter[]. value string مقدار یک پارامتر (ممکن است حاوی ارجاعات متغیری مانند "") متناسب با نوع مشخص شده باشد. قابل نوشتن
scheduleEndMs long مهر زمانی پایان در میلی ثانیه برای برنامه ریزی یک متغیر. قابل نوشتن
scheduleStartMs long مهر زمان شروع در میلی ثانیه برای برنامه ریزی یک متغیر. قابل نوشتن

واکنش

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

مثال ها

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

جاوا

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

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

/*
 * This request updates an existing variable for the authorized user.
 */

// Create the variable object.
Variable variable = new Variable();
variable.setName("RandomNumber");
variable.setType("r"); // The random number type.

try {
  Variable response = tagmanager.accounts().containers().
      variables().update("12345", "54321", "2", variable).execute();

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

/*
 * The results of the update method are stored in the response object.
 * The following code shows how to access the updated name and fingerprint.
 */
System.out.println("Updated Name = " + response.getName());
System.out.println("Updated Fingerprint = " + response.getFingerprint());

پایتون

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

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

# This request updates an existing variable.
try:
  response = tagmanager.accounts().containers().variables().update(
      accountId='123456',
      containerId='54321',
      variableId='4',
      body={
          'name': 'updated_random_number',
          'type': 'r'
      }
  ).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 update method are stored in the response object.
# The following code shows how to access the updated name and fingerprint.
print 'Updated Name = %s' % response.get('name')
print 'Updated Fingerprint = %s' % response.get('fingerprint')

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

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