Show Menu
TEMAS×

Complemento de Adobe: getQueryParam

Este complemento lo proporciona Adobe Consulting por cortesía para ayudarle a obtener más valor de Adobe Analytics. El Servicio de atención al cliente de Adobe no ofrece asistencia técnica con este complemento, incluida la instalación o solución de problemas. Si necesita ayuda con este complemento, póngase en contacto con el administrador de cuentas de su organización. Pueden organizar una reunión con un consultor para obtener ayuda.
El getQueryParam complemento le permite extraer el valor de cualquier parámetro de cadena de consulta contenido en una dirección URL. Resulta útil para extraer códigos de campaña, tanto internos como externos, de las direcciones URL de las páginas de aterrizaje. También resulta útil al extraer términos de búsqueda u otros parámetros de cadena de consulta.
Este complemento proporciona funciones sólidas para analizar direcciones URL complejas, incluidos hashes y direcciones URL que contienen varios parámetros de cadena de consulta. Si solo necesita parámetros de cadena de consulta simples, Adobe recomienda utilizar las funciones de parámetro de URL en Launch o el Util.getQueryParam() método incluido en AppMeasurement.

Instalación del complemento con la extensión Adobe Experience Platform Launch

Adobe ofrece una extensión que le permite utilizar los complementos más utilizados.
  1. Log in to launch.adobe.com using your AdobeID credentials.
  2. Haga clic en la propiedad que desee.
  3. Vaya a la ficha Extensions y haga clic en el Catalog
  4. Instalación y publicación de la Common Analytics Plugins extensión
  5. Si aún no lo ha hecho, cree una regla con la etiqueta "Inicializar complementos" con la siguiente configuración:
    • Condición: Ninguno
    • Evento: Core - Biblioteca cargada (Principio de página)
  6. Agregue una acción a la regla anterior con la siguiente configuración:
    • Extensión: Complementos comunes de Analytics
    • Tipo de acción: Inicializar getQueryParam
  7. Guarde y publique los cambios en la regla.

Instalación del complemento con el editor de código personalizado Iniciar

Si no desea utilizar la extensión del complemento, puede utilizar el editor de código personalizado.
  1. Log in to launch.adobe.com using your AdobeID credentials.
  2. Haga clic en la propiedad deseada.
  3. Vaya a la Extensions ficha y, a continuación, haga clic en el Configure botón situado debajo de la extensión de Adobe Analytics.
  4. Expanda el Configure tracking using custom code acordeón, que muestra el Open Editor botón.
  5. Abra el editor de código personalizado y pegue el código del complemento que se proporciona a continuación en la ventana de edición.
  6. Guarde y publique los cambios en la extensión de Analytics.
/******************************************* BEGIN CODE TO DEPLOY *******************************************/
/* Adobe Consulting Plugin: getQueryParam v3.3 (Requires pt plug-in) */
s.getQueryParam=function(qsp,de,url){var g=this,e="",k=function(b,de){de=de.split("?").join("&");de=de.split("#").join("&");var d=de.indexOf("&"),url="";b&&(-1<d||de.indexOf("=")>d)&&(d=de.substring(d+1),url=g.pt(d,"&","gpval",b));return url};qsp=qsp.split(",");var l=qsp.length;g.gpval=function(de,b){if(de){var d=de.split("="),url=d[0];d=d[1]?d[1]:!0;if(b.toLowerCase() ==url.toLowerCase())return"boolean"===typeof d?d:this.unescape(d)}return""};de=de?de:"";url=(url?url:g.pageURL?g.pageURL: location.href)+"";if((4<de.length||-1<de.indexOf("="))&&url&&4>url.length){var b=de;de=url;url=b}for(var h=0;h<l;h++)b=k(qsp[h],url) ,"string"===typeof b?(b=-1<b.indexOf("#")?b.substring(0,b.indexOf("#")):b,e+=e?de+b:b):e=""===e?b:e+(de+b);return e};

/* Adobe Consulting Plugin: pt v2.01 */ 
s.pt=function(l,de,cf,fa){if(l&&this[cf]){l=l.split(de||",");de=l.length;for(var e,c=0;c<de;c++)if(e=this[cf](l[c],fa))return e}};
/******************************************** END CODE TO DEPLOY ********************************************/

Utilizar el complemento

El getQueryParam método utiliza los siguientes argumentos:
  • qsp (obligatorio): Lista delimitada por comas de parámetros de cadena de consulta que se buscarán en la dirección URL. No distingue entre mayúsculas y minúsculas.
  • de (opcional): El delimitador que se usará si coinciden varios parámetros de cadena de consulta. El valor predeterminado es una cadena vacía.
  • url (opcional): Dirección URL, cadena o variable personalizada desde la que extraer los valores de parámetro de cadena de consulta. El valor predeterminado es window.location .
Al llamar a este método se devuelve un valor según los argumentos anteriores y la dirección URL:
  • Si no se encuentra un parámetro de cadena de consulta coincidente, el método devuelve una cadena vacía.
  • Si se encuentra un parámetro de cadena de consulta coincidente, el método devuelve el valor del parámetro de cadena de consulta.
  • Si se encuentra un parámetro de cadena de consulta coincidente pero el valor está vacío, el método devuelve true .
  • Si se encuentran varios parámetros de cadena de consulta coincidentes, el método devuelve una cadena con cada valor de parámetro delimitado por la cadena en el de argumento.

Llamadas de ejemplo

Ejemplo n.° 1

Si la dirección URL actual es la siguiente:
http://www.abc123.com/?cid=trackingcode1

El siguiente código establecerá s.campaign como "trackingcode1":
s.campaign=s.getQueryParam('cid');

Ejemplo n.° 2

Si la dirección URL actual es la siguiente:
http://www.abc123.com/?cid=trackingcode1&ecid=123456

El siguiente código establecerá s.campaign como "trackingcode1:123456":
s.campaign=s.getQueryParam('cid,ecid',':');

Ejemplo n.° 3

Si la dirección URL actual es la siguiente:
http://www.abc123.com/?cid=trackingcode1&ecid=123456

El siguiente código establecerá s.campaign como "trackingcode1123456":
s.campaign=s.getQueryParam('cid,ecid');

Ejemplo n.° 4

Si la dirección URL actual es la siguiente:
http://www.abc123.com/?cid=trackingcode1&ecid=123456#location

El siguiente código establecerá s.campaign en "123456":
s.campaign=s.getQueryParam('ecid');

Ejemplo n.° 5

Si la dirección URL actual es la siguiente:
http://www.abc123.com/#location&cid=trackingcode1&ecid=123456

El siguiente código establecerá s.campaign en "123456"
s.campaign=s.getQueryParam('ecid');

Nota: El complemento reemplaza el carácter hash de la dirección URL de Check por un signo de interrogación si no existe un signo de interrogación. Si la dirección URL contiene un signo de interrogación que viene antes del carácter hash, el complemento reemplazará el carácter hash de la dirección URL de Check por un símbolo de interrogación;

Ejemplo n.° 6

Si la dirección URL actual es la siguiente...
http://www.abc123.com/

...y si la variable s.testURL está configurada de la siguiente manera:
s.testURL="http://www.abc123.com/?cid=trackingcode1&ecid=123456#location&pos=300";

El siguiente código no configurará s.campaign en absoluto:
s.campaign=s.getQueryParam('cid');

Sin embargo, el siguiente código establecerá s.campaign como "trackingcode1":
s.campaign=s.getQueryParam('cid','',s.testURL);

Nota: el tercer parámetro puede ser cualquier cadena o variable que el código utilice para intentar encontrar los parámetros de cadena de consulta en
El siguiente código establecerá s.eVar2 igual a "123456|trackingcode1|true|300":
s.eVar2=s.getQueryParam('ecid,cid,location,pos','|',s.testURL);

  • El valor de 123456 se obtiene a partir del parámetro ecid en la variable s.testURL
  • El valor de trackingcode1 proviene del parámetro cid en la variable s.testURL
  • El valor de true proviene de la existencia (pero no del valor) del parámetro de ubicación después del carácter hash en la variable s.testURL
El valor de 300 se obtiene a partir del valor del parámetro pos en la variable s.testURL

Historial de versiones

3.3 (24 de septiembre de 2019)

  • Se omitió la lógica innecesaria para reducir el tamaño del código

3.2 (15 de mayo de 2018)

  • Se han movido findParameterValue y getParameterValue las funciones a la getQueryParam función

3.1 (10 de mayo de 2018)

  • Se ha corregido un problema con la captura de parámetros de cadena de consulta sin valor

3.0 (16 de abril de 2018)

  • Versión puntual (recompilada, tamaño de código más pequeño).
  • Se cambió el nombre de las funciones de ayuda a findParameterValue y getParameterValue para fines de legibilidad.
  • Se ha eliminado la necesidad de agregar un argumento para encontrar los parámetros contenidos en el hash de URL

2,5 (8 de enero de 2016)

  • Compatible con el código H y AppMeasurement (requiere s.pt AppMeasurement).

2.4

  • Se agregó el h parámetro, que permite que el código encuentre los parámetros de cadena de consulta encontrados después del carácter hash ( # )

2.3

  • Se corrigió un problema de regresión en el cual el complemento solo funcionaba cuando el hash estaba presente después del código de seguimiento

2.2

  • Ahora elimina los caracteres hash (y todo después) del valor devuelto

2.1

  • Compatible con código H.10