adobe.target.getOffers() - at.js 2.x

Med den här funktionen kan du hämta flera erbjudanden genom att skicka in flera rutor. Dessutom kan flera erbjudanden hämtas för alla vyer i aktiva aktiviteter.

NOTE
Den här funktionen introducerades med at.js 2.x. Den här funktionen är inte tillgänglig för at.js version 1.x.
Nyckel
Typ
Obligatoriskt?
Beskrivning
consumerId
Sträng
Nej

Standardvärdet är klientens globala mbox om den inte anges. Den här nyckeln används för att generera det extra data-ID (SDID) som används för A4T-integrering.

När du använder getOffers()genererar varje anrop ett nytt SDID. Om du har flera mbox-begäranden på samma sida och vill bevara SDID (så att det matchar SDID:t från målglobal-mbox och Adobe Analytics SDID) använder du consumerId parameter.

If getOffers() innehåller tre rutor (mbox1, mbox2 och mbox3): consumerId: "mbox1, mbox2, mbox3" i getOffers() ring.

decisioningMethod
Sträng
Nej
"server-side", "on device", "hybrid"
request
Objekt
Ja
Se tabellen över förfrågningar nedan.
timeout
Nummer
Nej
Timeout för begäran. Om inget anges används standardtimeout för at.js.

Begäran

NOTE
Läs Dokumentation för leverans-API för information om godkända typer för alla fält som listas nedan.
Fältnamn
Obligatoriskt?
Begränsningar
Beskrivning
request > id
Nej
En av tntId, thirdPartyId, eller marketingCloudVisitorId är obligatoriskt.
Begäran > id > thirdPartyId
Nej
Maximal storlek = 128.
Request > experienceCloud
Nej
Request > experienceCloud > analytics
Nej
Integrering med Adobe Analytics
Request > experienceCloud > analytics > log
Nej

Följande måste implementeras på sidan:

  • Tjänst för besökar-ID
  • Appmeasurement.js

Följande värden stöds:

client_side: När det anges returneras en analyslast till anroparen som ska användas för att skicka till Adobe Analytics via Data Insertion API.

server_side: Detta är standardvärdet där Target och Analytics backend använder SDID för att sammanfoga samanrop i rapporteringssyfte.

Begäran > förhämtning
Nej
Request > prefetch > views
Nej

Högsta antal 50.

Namnet är inte tomt.

Namnlängd <= 128.

Värdelängd <= 5000.

Namnet får inte börja med "profile".

Otillåtna namn: "orderId", "orderTotal", "productPurchasedId".

Ange parametrar som ska användas för att hämta relevanta vyer i aktiva aktiviteter.
Request > prefetch > views > profileParameters
Nej

Maximantal 50.

Namnet är inte tomt.

Namnlängd <= 128.

Värdelängd <= 5000.

Accepterar endast strängvärden.

Namnet får inte börja med "profile".

Ange profilparametrar som ska användas för att hämta relevanta vyer i aktiva aktiviteter.
Request > prefetch > views > product
Nej
Request > prefetch > views > product -> id
Nej

Inte tom.

maxstorlek = 128.

Ange produkt-ID:n som ska användas för att hämta relevanta vyer i aktiva aktiviteter.
Request > prefetch > views > product > categoryId
Nej

Inte tom.

maxstorlek = 128.

Ange produktkategori-ID:n som ska användas för att hämta relevanta vyer i aktiviteter.
Request > prefetch > views > order
Nej

Begäran > förhämtning > vyer

ordning > id

Nej
Maximal längd = 250.
Ange beställnings-ID:n som ska användas för att hämta relevanta vyer i aktiva aktiviteter.
Request > prefetch > views > order > total
Nej
Totalt >= 0.
Ange ordersummor som ska användas för att hämta relevanta vyer i aktiva aktiviteter.
Request > prefetch > views > order > purchaseProductIds
Nej

Inga tomma värden.

Varje värde har maxlängden 50.

Sammanfogad och avgränsad med komma.

Total längd för produkt-ID <= 250.

Skicka in köpta produkt-ID:n som ska användas för att hämta relevanta vyer i aktiva aktiviteter.
Begäran > Kör
Nej
Request > execute > pageLoad
Nej

Request > execute > pageLoad

parameters

Nej

Högsta antal 50.

Namnet är inte tomt.

Namnlängd <= 128.

Värdelängd <= 5000.

Accepterar endast strängvärden.

Namnet får inte börja med "profile".

Otillåtna namn: "orderId", "orderTotal", "productPurchasedId".

Hämta erbjudanden med angivna parametrar när sidan läses in.

Request > execute > pageLoad

profileParameters

Nej

Högsta antal 50.

Namnet är inte tomt.

Namnlängd <= 128.

Värdelängd <=256.

Namnet får inte börja med "profile".

Accepterar endast strängvärden.

Hämta erbjudanden med angivna profilparametrar när sidan läses in.

Request > execute > pageLoad

product

Nej

Request > execute > pageLoad

product -> id

Nej

Inte tom.

Maximal storlek = 128.

Hämta erbjudanden med angivna produkt-ID när sidan läses in.

Request > execute > pageLoad

product > categoryId

Nej

Inte tom.

Maximal storlek = 128.

Hämta erbjudanden med angivna produktkategori-ID när sidan läses in.

Request > execute > pageLoad

order

Nej

Request > execute > pageLoad

order > id

Nej
Maximal längd = 250.
Hämta erbjudanden med angivna order-ID när sidan läses in.

Request > execute > pageLoad

order > total

Nej
>= 0.
Hämta erbjudanden med angivna ordersummor när sidan läses in.

Request > execute > pageLoad

order > purchaseProductIds

Nej

Inga tomma värden.

Varje värde har maxlängden 50.

Sammanfogad och avgränsad med komma.

Total längd för produkt-ID <= 250.

Hämta erbjudanden med angivna produkt-ID:n när sidan läses in.
Request > execute > mboxes
Nej

Maximal storlek = 50.

Inga null-element.

Request > execute > mboxes>mbox
Ja

Inte tom.

Inget '-klickat'-suffix.

Maximal storlek = 250.

Tecken: `'-, ./=:;&!@#$%^&*()+

?~[]{}'`
Begäran > Kör > mbox>mbox>index
Ja

Inte null.

Unik.

>= 0.

Observera att indexet inte representerar den ordning i vilken rutorna bearbetas. På samma sätt som på en webbsida med flera regionala kryssrutor kan ordningen som de ska bearbetas i inte anges.
Request > execute > mboxes > mbox > parameters
Nej

Högsta antal = 50.

Namnet är inte tomt.

Namnlängd <= 128.

Accepterar endast strängvärden.

Värdelängd <= 5000.

Namnet får inte börja med "profile".

Otillåtna namn: "orderId", "orderTotal", "productPurchasedId".

Hämta erbjudanden för en given mbox med de angivna parametrarna.
Request > execute > mboxes>mbox>profileParameters
Nej

Högsta antal = 50.

Namnet är inte tomt.

Namnlängd <= 128.

Accepterar endast strängvärden.

Värdelängd <=256.

Namnet får inte börja med "profile".

Hämta erbjudanden för en given mbox med de angivna profilparametrarna.
Request > execute > mboxes>mbox > product
Nej
Request > execute > mboxes > mbox > product > id
Nej

Inte tom.

Maximal storlek = 128.

Hämta erbjudanden för en angiven mbox med angivet produkt-ID.
Request > execute > mboxes > mbox > product > categoryId
Nej

Inte tom.

Maximal storlek = 128.

Hämta erbjudanden för en angiven mbox med angivna produktkategori-ID:n.
Request > execute > mboxes > mbox > order
Nej

Request > execute > mbox>mbox

order > id

Nej
Maximal längd = 250.
Hämta erbjudanden för en angiven mbox med de angivna order-ID:n.
Request > execute > mboxes > mbox > order > total
Nej
>= 0.
Hämta erbjudanden för en angiven mbox med de angivna ordersummorna.
Request > execute > mboxes > mbox > order > purchaseProductIds
Nej

Inga tomma värden.

Varje värdes maximala längd = 50.

Sammanfogad och avgränsad med komma.

Total längd för produkt-id <= 250.

Hämta erbjudanden för en angiven mbox med angivet produkt-ID för beställning.

Utlysning getOffers() för alla vyer

adobe.target.getOffers({
    request: {
      prefetch: {
        views: [{}]
    }
  }
});

Utlysning getOffers() att fatta ett beslut på enheten

adobe.target.getOffers({

  decisioningMethod:"on-device",
  request: {
    execute: {
      mboxes: [
        {
          index: 0,
          name: "homepage"
        }
      ]
    }
 }
});

Utlysning getOffers() för att hämta de senaste vyerna med skickade parametrar och profilparametrar

adobe.target.getOffers({
  request: {
    "prefetch": {
      "views": [
        {
          "parameters": {
            "ad": "1"
          },
          "profileParameters": {
            "age": 23
          }
        }
      ]
    }
  }
});

Utlysning getOffers() för att hämta rutor med parametrar och profilparametrar skickade.

adobe.target.getOffers({
  request: {
    execute: {
      mboxes: [
        {
          index: 0,
          name: "first-mbox"
        },
        {
          index: 1,
          name: "second-mbox",
          parameters: {
            a: 1
          },
          profileParameters: {
            b: 2
          }
        }
      ]
    }
  }
});

Utlysning getOffers() för att hämta analysens nyttolast från klientsidan

adobe.target.getOffers({
      request: {
        experienceCloud: {
          analytics: {
            logging: "client_side"
          }
        },
        prefetch: {
          mboxes: [{
            index: 0,
            name: "a1-serverside-xt"
          }]
        }
      }
    })
    .then(console.log)

Svar:

{
  "prefetch": {
    "mboxes": [{
      "index": 0,
      "name": "a1-serverside-xt",
      "options": [{
        "content": "<img src=\"http://s7d2.scene7.com/is/image/TargetAdobeTargetMobile/L4242-xt-usa?tm=1490025518668&fit=constrain&hei=491&wid=980&fmt=png-alpha\"/>",
        "type": "html",
        "eventToken": "n/K05qdH0MxsiyH4gX05/2qipfsIHvVzTQxHolz2IpSCnQ9Y9OaLL2gsdrWQTvE54PwSz67rmXWmSnkXpSSS2Q==",
        "responseTokens": {
          "profile.memberlevel": "0",
          "geo.city": "bucharest",
          "activity.id": "167169",
          "experience.name": "USA Experience",
          "geo.country": "romania"
        }
      }],
      "analytics": {
        "payload": {
          "pe": "tnt",
          "tnta": "167169:0:0|0|100,167169:0:0|2|100,167169:0:0|1|100"
        }
      }
    }]
  }
}

Nyttolasten kan sedan vidarebefordras till Adobe Analytics via API för datainfogning.

Hämta och återge data från flera rutor via getOffers() och applyOffers()

Med at.js 2.x kan du hämta flera mbox via getOffers() API. Du kan även hämta data för flera mbox-rutor och sedan använda applyOffers() för att återge data på olika platser som identifieras av en CSS-väljare.

I följande exempel visas en enkel HTML-sida med at.js 2.x implementerad:

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <title>at.js 2.x, multiple selectors and multiple mboxes</title>
  <script src="at.js"></script>
</head>
<body>
  <div id="container1">Default content 1</div>

  <div id="container2">Default content 2</div>

  <div id="container3">Default content 3</div>
</body>
</html>

Anta att du har tre behållare som du vill ändra via innehåll som tagits emot från Target. Du kan skapa en enda begäran för tre mrutor där varje mbox har visst innehåll som ska återges i respektive behållare.

Koden för begäran och återgivning kan se ut som i följande exempel:

adobe.target.getOffers({
  request: {
    prefetch: {
      mboxes: [
        {
          index: 0,
          name: "mbox1"
        },
        {
          index: 1,
          name: "mbox2"
        },
        {
          index: 2,
          name: "mbox3"
        }
      ]
    }
  }
})
.then(response => {
  // get all mboxes from response
  const mboxes = response.prefetch.mboxes;
  let count = 1;

  mboxes.forEach(el => {
    adobe.target.applyOffers({
      selector: "#container" + count,
      response: {
        prefetch: {
          mboxes: [el]
        }
      }
    });

    count += 1;
  });
});

I request > prefetch > mboxes finns det tre olika kartonger. Om begäran slutfördes utan fel får du svaret för varje ruta från response > prefetch > mboxes. När du har fått svaren och de platser du vill använda för återgivningen kan du anropa applyOffers() för att återge innehåll som hämtats från Target. I det här exemplet har vi följande mappning:

  • mbox1 > CSS-väljare #container1
  • mbox2 > CSS-väljare #container2
  • mbox3 > CSS-väljare #container3

I det här exemplet används variabeln count för att skapa CSS-väljarna. I ett verkligt scenario kan du använda en annan mappning mellan CSS-väljaren och mbox.

Observera att det här exemplet använder prefetch > mboxes, men du kan också använda execute > mboxes. Om du använder förhämtning i getOffers()ska du också använda förhämtning i applyOffers() anrop.

Utlysning getOffers() för att utföra en pageLoad

I följande exempel visas hur du utför en pageLoad med getOffers() med at.js 2.x

adobe.target.getOffers({
    request: {
        execute: {
            pageLoad: {
                parameters: {}
            }
        }
    }
});
recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3