Cette page a été traduite par l'API Cloud Translation.

Built-In Variables: create

Crée une ou plusieurs variables intégrées GTM. Essayer maintenant

Requête

Requête HTTP

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

Paramètres

Nom du paramètre	Valeur	Description
Paramètres de chemin d'accès
`parent`	`string`	Chemin d'accès relatif de l'API de l'espace de travail GTM. Exemple : accounts/{account_id}/containers/{container_id}/workspaces/{workspace_id}
Paramètres de requête facultatifs
`type`	`string`	Types de variables intégrées à activer. Valeurs acceptées : "`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`"

Autorisation

Cette requête nécessite une autorisation ayant le champ d'application suivant:

Définition du champ d'application
`https://www.googleapis.com/auth/tagmanager.edit.containers`

Pour en savoir plus, consultez la page Authentification et autorisation.

Corps de la requête

Ne spécifiez pas de corps de requête pour cette méthode.

Réponse

Si la requête aboutit, cette méthode renvoie un corps de réponse présentant la structure suivante :

{
  "builtInVariable": [
    {
      "path": string,
      "accountId": string,
      "containerId": string,
      "workspaceId": string,
      "type": string,
      "name": string
    }
  ]
}

Nom de propriété	Valeur	Description
`builtInVariable[]`	`list`	Liste des variables intégrées créées.
`builtInVariable[].path`	`string`	Chemin relatif de l'API de GTM BuiltInVariable.
`builtInVariable[].accountId`	`string`	ID de compte GTM.
`builtInVariable[].containerId`	`string`	ID de conteneur GTM.
`builtInVariable[].workspaceId`	`string`	ID d'espace de travail GTM.
`builtInVariable[].type`	`string`	Type de variable intégrée. Valeurs acceptées : "`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`	Nom de la variable intégrée à utiliser pour faire référence à la variable intégrée.

Essayer

Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.