Built-In Variables: create

یک یا چند متغیر داخلی GTM ایجاد می کند. الآن امتحانش کن .

درخواست

درخواست HTTP

POST https://www.googleapis.com/tagmanager/v2/+parent/built_in_variables

مولفه های

نام پارامتر ارزش شرح
پارامترهای مسیر
parent string مسیر نسبی API GTM Workspace. مثال: accounts/{account_id}/containers/{container_id}/workspace/{workspace_id}
پارامترهای پرس و جو اختیاری
type string انواع متغیرهای داخلی برای فعال کردن

مقادیر قابل قبول عبارتند از:
  • " advertiserId "
  • advertisingTrackingEnabled
  • " ampBrowserLanguage "
  • " ampCanonicalHost "
  • " ampCanonicalPath "
  • " ampCanonicalUrl "
  • " ampClientId "
  • " ampClientMaxScrollX "
  • " ampClientMaxScrollY "
  • " ampClientScreenHeight "
  • " ampClientScreenWidth "
  • " ampClientScrollX "
  • " ampClientScrollY "
  • " ampClientTimestamp "
  • " ampClientTimezone "
  • " ampGtmEvent "
  • " ampPageDownloadTime "
  • " ampPageLoadTime "
  • " ampPageViewId "
  • " ampReferrer "
  • " ampTitle "
  • " ampTotalEngagedTime "
  • " appId "
  • " appName "
  • " appVersionCode "
  • " appVersionName "
  • " builtInVariableTypeUnspecified "
  • " clickClasses "
  • " clickElement "
  • " clickId "
  • " clickTarget "
  • " clickText "
  • " clickUrl "
  • " clientName "
  • " containerId "
  • " containerVersion "
  • " debugMode "
  • " deviceName "
  • " elementVisibilityFirstTime "
  • " elementVisibilityRatio "
  • " elementVisibilityRecentTime "
  • " elementVisibilityTime "
  • environmentName
  • " errorLine "
  • " errorMessage "
  • " errorUrl "
  • " event "
  • " eventName "
  • " firebaseEventParameterCampaign "
  • " firebaseEventParameterCampaignAclid "
  • " firebaseEventParameterCampaignAnid "
  • " firebaseEventParameterCampaignClickTimestamp "
  • " firebaseEventParameterCampaignContent "
  • " firebaseEventParameterCampaignCp1 "
  • " firebaseEventParameterCampaignGclid "
  • " firebaseEventParameterCampaignSource "
  • " firebaseEventParameterCampaignTerm "
  • " firebaseEventParameterCurrency "
  • " firebaseEventParameterDynamicLinkAcceptTime "
  • " firebaseEventParameterDynamicLinkLinkid "
  • " firebaseEventParameterNotificationMessageDeviceTime "
  • " firebaseEventParameterNotificationMessageId "
  • " firebaseEventParameterNotificationMessageName "
  • " firebaseEventParameterNotificationMessageTime "
  • " firebaseEventParameterNotificationTopic "
  • " firebaseEventParameterPreviousAppVersion "
  • " firebaseEventParameterPreviousOsVersion "
  • " firebaseEventParameterPrice "
  • " firebaseEventParameterProductId "
  • " firebaseEventParameterQuantity "
  • " firebaseEventParameterValue "
  • " firstPartyServingUrl "
  • " formClasses "
  • " formElement "
  • " formId "
  • " formTarget "
  • " formText "
  • " formUrl "
  • " historySource "
  • " htmlId "
  • " language "
  • newHistoryFragment
  • " newHistoryState "
  • " newHistoryUrl "
  • " oldHistoryFragment "
  • " oldHistoryState "
  • " oldHistoryUrl "
  • " osVersion "
  • " pageHostname "
  • " pagePath "
  • " pageUrl "
  • " platform "
  • " queryString "
  • " randomNumber "
  • " referrer "
  • " requestMethod "
  • " requestPath "
  • " resolution "
  • " scrollDepthDirection "
  • " scrollDepthThreshold "
  • " scrollDepthUnits "
  • " sdkVersion "
  • " serverPageLocationHostname "
  • " serverPageLocationPath "
  • " serverPageLocationUrl "
  • " videoCurrentTime "
  • " videoDuration "
  • " videoPercent "
  • " videoProvider "
  • " videoStatus "
  • " videoTitle "
  • " videoUrl "
  • " videoVisible "
  • " visitorRegion "

مجوز

این درخواست به مجوز با محدوده زیر نیاز دارد:

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

برای اطلاعات بیشتر، به صفحه احراز هویت و مجوز مراجعه کنید.

درخواست بدن

با این روش بدنه درخواستی ارائه نکنید.

واکنش

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

{
  "builtInVariable": [
    {
      "path": string,
      "accountId": string,
      "containerId": string,
      "workspaceId": string,
      "type": string,
      "name": string
    }
  ]
}
نام ملک ارزش شرح یادداشت
builtInVariable[] list لیست متغیرهای داخلی ایجاد شده
builtInVariable[]. path string مسیر نسبی API GTM BuiltInVariable.
builtInVariable[]. accountId string شناسه حساب GTM.
builtInVariable[]. containerId string شناسه کانتینر GTM.
builtInVariable[]. workspaceId string شناسه فضای کاری GTM.
builtInVariable[]. type string نوع متغیر داخلی

مقادیر قابل قبول عبارتند از:
  • " advertiserId "
  • advertisingTrackingEnabled
  • " ampBrowserLanguage "
  • " ampCanonicalHost "
  • " ampCanonicalPath "
  • " ampCanonicalUrl "
  • " ampClientId "
  • " ampClientMaxScrollX "
  • " ampClientMaxScrollY "
  • " ampClientScreenHeight "
  • " ampClientScreenWidth "
  • " ampClientScrollX "
  • " ampClientScrollY "
  • " ampClientTimestamp "
  • " ampClientTimezone "
  • " ampGtmEvent "
  • " ampPageDownloadTime "
  • " ampPageLoadTime "
  • " ampPageViewId "
  • " ampReferrer "
  • " ampTitle "
  • " ampTotalEngagedTime "
  • " appId "
  • " appName "
  • " appVersionCode "
  • " appVersionName "
  • " builtInVariableTypeUnspecified "
  • " clickClasses "
  • " clickElement "
  • " clickId "
  • " clickTarget "
  • " clickText "
  • " clickUrl "
  • " clientName "
  • " containerId "
  • " containerVersion "
  • " debugMode "
  • " deviceName "
  • " elementVisibilityFirstTime "
  • " elementVisibilityRatio "
  • " elementVisibilityRecentTime "
  • " elementVisibilityTime "
  • environmentName
  • " errorLine "
  • " errorMessage "
  • " errorUrl "
  • " event "
  • " eventName "
  • " firebaseEventParameterCampaign "
  • " firebaseEventParameterCampaignAclid "
  • " firebaseEventParameterCampaignAnid "
  • " firebaseEventParameterCampaignClickTimestamp "
  • " firebaseEventParameterCampaignContent "
  • " firebaseEventParameterCampaignCp1 "
  • " firebaseEventParameterCampaignGclid "
  • " firebaseEventParameterCampaignSource "
  • " firebaseEventParameterCampaignTerm "
  • " firebaseEventParameterCurrency "
  • " firebaseEventParameterDynamicLinkAcceptTime "
  • " firebaseEventParameterDynamicLinkLinkid "
  • " firebaseEventParameterNotificationMessageDeviceTime "
  • " firebaseEventParameterNotificationMessageId "
  • " firebaseEventParameterNotificationMessageName "
  • " firebaseEventParameterNotificationMessageTime "
  • " firebaseEventParameterNotificationTopic "
  • " firebaseEventParameterPreviousAppVersion "
  • " firebaseEventParameterPreviousOsVersion "
  • " firebaseEventParameterPrice "
  • " firebaseEventParameterProductId "
  • " firebaseEventParameterQuantity "
  • " firebaseEventParameterValue "
  • " firstPartyServingUrl "
  • " formClasses "
  • " formElement "
  • " formId "
  • " formTarget "
  • " formText "
  • " formUrl "
  • " historySource "
  • " htmlId "
  • " language "
  • newHistoryFragment
  • " newHistoryState "
  • " newHistoryUrl "
  • " oldHistoryFragment "
  • " oldHistoryState "
  • " oldHistoryUrl "
  • " osVersion "
  • " pageHostname "
  • " pagePath "
  • " pageUrl "
  • " platform "
  • " queryString "
  • " randomNumber "
  • " referrer "
  • " requestMethod "
  • " requestPath "
  • " resolution "
  • " scrollDepthDirection "
  • " scrollDepthThreshold "
  • " scrollDepthUnits "
  • " sdkVersion "
  • " serverPageLocationHostname "
  • " serverPageLocationPath "
  • " serverPageLocationUrl "
  • " videoCurrentTime "
  • " videoDuration "
  • " videoPercent "
  • " videoProvider "
  • " videoStatus "
  • " videoTitle "
  • " videoUrl "
  • " videoVisible "
  • " visitorRegion "
builtInVariable[]. name string نام متغیر داخلی که باید برای اشاره به متغیر داخلی استفاده شود.

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

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