Specyfikacja raportu dla CRM
Ogólny opis
Raport zawiera informacje o kampaniach reklamowych na platformie M-SQ, w tym statusie ogłoszeń i metrykach wyświetleń. Raport jest przedstawiany w formacie XML.Atrybuty
- generation-date: Data i godzina generacji raportu w formacie ISO 8601.
Struktura XML
Element główny
- offers: Główny element zawierający atrybut
generation-dateoraz jeden lub więcej elementówoffer.
Elementy wewnątrz <offers>
- offer: Element zawierający informacje o konkretnym ogłoszeniu. Może zawierać następujące pod-elementy:
- id: Unikalny numer ogłoszenia na M-SQ. Może być nieobecny. - url: Link do ogłoszenia na M-SQ. Może być nieobecny. - externalid: Unikalny numer CRM z zewnętrznego systemu (feed). - status: Status ogłoszenia. Możliwe wartości:
- `error`: Błąd.
- `finish`: Zakończone.
- `published`: Opublikowane. - message: Opis błędu lub powiadomienie. Może być nieobecny.
- view: Liczba wyświetleń (łączna wartość za historię umieszczenia). Może być nieobecny.
- viewtel: Liczba kontaktów (łączna wartość za historię umieszczenia). Może być nieobecny.Przykład raportu XML
<offers generation-date="2024-06-20T06:00:08+00:00">
<offer>
<url>https://m-sq.eu/offer/1</url>
<id>1</id>
<external_id>R474</external_id>
<status>published</status>
<view>123</view>
<view_tel>7</view_tel>
</offer>
<offer>
<external_id>277</external_id>
<status>error</status>
<message>Nie można określić lokalizacji obiektu; Należy podać lokalizację w ogłoszeniu;</message>
</offer>
</offers>Uwagi
- Elementy
url,id,message,vieworazview_telmogą być nieobecne w zależności od statusu ogłoszenia oraz dostępności odpowiednich danych. - Status
errormoże być opisany za pomocą elementumessage. - Element
messagezawiera błędy wymienione przez;, głównie w języku angielskim, chyba że język nie jest określony.