REST API v4: PUT hyperlinkextensies (drag-and-droptemplate)

Met deze methode kun je de hyperlinkextensies van een Marketing Suite (drag-and-drop) template configureren. Door een PUT-request naar de volgende URL te sturen, kun je hyperlinkextensieregels aanmaken, bijwerken of verwijderen:

https://api.copernica.com/v4/draganddrop/template/$id/hyperlinkextensions

De $id moet worden vervangen door de numerieke identifier van de template.

De volledige configuratie van de hyperlinkextensies moet in de request body worden meegestuurd.

Door een lege array te versturen, worden alle hyperlinkextensies van de template verwijderd.

Body data

De request body moet een array met hyperlinkextensieregels bevatten.

Elke regel kan de volgende velden bevatten:

• parameter: de URL-parameter die moet worden toegevoegd of bijgewerkt
• value: de waarde van de URL-parameter
• type: bepaalt welke actie op de hyperlink wordt uitgevoerd. Momenteel wordt alleen setparameter ondersteund; hiermee wordt een URL-parameter toegevoegd of aangepast
• last: bepaalt of de verwerking na deze regel moet stoppen
• unique: bepaalt of de regel wordt overgeslagen wanneer een eerdere regel dezelfde URL al heeft aangepast
• checks: voorwaarden die bepalen wanneer de regel moet worden toegepast

De volgende checktypes worden ondersteund:

• domain: controleert het domein van de URL;
• path: controleert het pad van de URL;
• parameter: controleert een bestaande URL-parameter;
• protocol: controleert het protocol van de URL, bijvoorbeeld http of https.

Voor domain-, path- en parameterchecks worden de volgende vergelijkingstypes ondersteund:

• equals: de waarde moet exact overeenkomen;
• notequals: de waarde mag niet overeenkomen;
• contains: de waarde moet de opgegeven tekst bevatten;
• notcontains: de waarde mag de opgegeven tekst niet bevatten;
• match: vergelijkt de waarde met een glob-patroon. Wildcards zoals * en ? kunnen worden gebruikt en de vergelijking is niet hoofdlettergevoelig;
• regex: vergelijkt de waarde met een reguliere expressie via PHP preg_match().

JSON-voorbeeld

De volgende JSON laat zien hoe je hyperlinkextensies kunt configureren:

[
    {
        "parameter": "utm_source",
        "value": "copernica",
        "type": "setparameter",
        "last": false,
        "unique": false,
        "checks": []
    },
    {
        "parameter": "utm_content",
        "value": "link",
        "type": "setparameter",
        "last": false,
        "unique": false,
        "checks": [
            {
                "type": "domain",
                "value": "copernica.com",
                "comparison": "contains"
            }
        ]
    }
]

PHP-voorbeeld

Het volgende PHP-script laat zien hoe je deze API-methode kunt aanroepen:

// dependencies
require_once('CopernicaRestAPI.php');

// vervang dit door je eigen access token
$api = new CopernicaRestAPI("your-access-token", 4);

// configuratie van de hyperlinkextensies
$data = array(
    array(
        'parameter' => 'utm_source',
        'value'     => 'copernica',
        'type'      => 'setparameter',
        'last'      => false,
        'unique'    => false,
        'checks'    => array()
    )
);

// voer de call uit
print_r($api->put("draganddrop/template/{$templateID}/hyperlinkextensions", $data));

Voor het bovenstaande voorbeeld is de CopernicaRestApi class vereist.

Meer informatie

• Overzicht van alle API-calls