Zum Inhalt

Zielgruppe

Mit dieser Api werden die Zielgruppe ausgegeben.

Felder

Feld Typ Beschreibung Beispiel
auid integer Zielgruppe ID 1
name string Name Zielgruppe
description string Beschreibung
locale object Text je Sprache
start string Gültig ab 2018-04-08T00:00:00
end string Gültig bis 2018-04-29T00:00:00

Eine Zielgruppe auslesen

Die URL /api/commerce/item/catalog/audience/[AUID] liefert eine Zielgruppe zurück

{
    "dataset": {
        "7e864522-6a41-4212-b4e8-336412d61590": {
            "auid": 1,
            "name": "Zielgruppe",
            "description": "",
            "locale": {
                "de": {
                    "name": "Zielgruppe",
                    "description": "Das ist eine Zielgruppe"
                },
                "en": {
                    "name": "target group",
                    "description": "This is a target audience"
                },
                "fr": {
                    "name": "groupe cible",
                    "description": "Ceci est un public cible"
                }
            },
            "start": "2018-04-08T00:00:00",
            "end": "2018-04-29T00:00:00"
        }
    },
    "sys": {
        "pagination": {
            "total": 1,
            "currentPage": 1,
            "objectsPerPage": 5,
            "offset": 0,
            "nextOffset": null,
            "prevOffset": null,
            "pages": 1
        },
        "message": "200 OK",
        "code": 200
    }
}

Zielgruppe auslesen

Die URL /api/commerce/item/catalog/audience?page=[SEITE]&count=[ANZAHL DER OBJEKTE]&orderby=[SORTIERUNG] liefert alle Zielgruppeen zurück. mit dem Pagestepper kann durch die Daten navigiert werden.

Beispiel : /api/commerce/item/catalog/audience?page=0&count=5

{
    "dataset": {
        "66681c38-1094-4490-e416-9d431fa5ef57": {},
        "caec026c-b9a0-4ea7-af27-0b36e8c47cbd": {},
        "9f9a232a-efc4-4079-f091-035fdb8f1b4c": {},
        "1b3da6a2-994f-4060-a47d-38c12a19a416": {},
        "7555bb79-f8d0-461b-d488-008819447df2": {}
    },
    "sys": {
        "pagination": {
            "total": 47,
            "currentPage": 3,
            "objectsPerPage": 5,
            "offset": 10,
            "nextOffset": 15,
            "prevOffset": 5,
            "pages": 10
        },
        "message": "200 OK",
        "code": 200
    }
}

Zielgruppe suchen

Über die URL /api/commerce/item/catalog/audience/search?q=[QUERY] kann nach Zielgruppe gesucht werden

Beispiel: /api/commerce/item/catalog/audience/search?q=auid%3D1