Whitelabel

Wysłanie zaproszenia dla reklamodawców do sklepu

Typowo zapraszanie reklamodawców do sklepu odbywa się poprzez panel w zakładce “Reklamodawcy” (widoczny tylko dla whitelabel). Ten endpoint udostępnia tę samą funkcjonalność po API, co jest użyteczne, gdy chcemy zautomatyzować zapraszanie reklamodawców.

POST https://api.adshero.io/v1/invitations/shop/{shopId}/whitelabel HTTP/2
Authorization: Bearer {access_token}
Content-Type: application/json

{ 
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "sellerIds": [ "string" ],
  "brands": [ "string" ]
}

curl --location --request POST \
    'https://api.adshero.io/v1/invitations/shop/{shopId}/whitelabel' \ 
    --header 'Authorization: Bearer {access_token}' \
    --header 'Content-Type: application/json' \
    --data '{ 
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "sellerIds": [ "string" ],
      "brands": [ "string" ]
    }'

Opis parametrów:

• firstName — Imię sprzedawcy.
• lastName — Nazwisko sprzedawcy.
• email — Adres e-mail — na ten adres sprzedawca dostanie zaproszenie do założenia konta. Jeśli będzie niepoprawny, to sprzedawca nie skorzysta z Ads-ów.
• sellerIds — Seller ID — Identyfikator sprzedawcy z feed-a (external_seller_id). Może być pusty, ale wtedy należy wypełnić pole brands. Definiuje produkty, które sprzedawca ma dostępne do reklamowania.
• brands — Marka — Identyfikator marki z feeda (brand). Może być pusta, ale wtedy należy wypełnić pole sellerIds. Definiuje produkty, które sprzedawca ma dostępne do reklamowania.

Raport kosztów

Endpoint zwraca raport kosztów reklamodawców pogrupowany po jednostkach reklamowych (business slotach).

GET https://api.adshero.io/v1/public/statistics/whitelabel/businessSlot/{whitelabelHash}/costs?startDate=2024-01-01&page=1&pageSize=10 HTTP/2
Authorization: Bearer {access_token}

curl --location --request GET \
    'https://api.adshero.io/v1/public/statistics/whitelabel/businessSlot/{whitelabelHash}/costs?startDate=2024-01-01&page=1&pageSize=10' \
    --header 'Authorization: Bearer {access_token}'

Opis parametrów:

• whitelabelHash (path, wymagany) — identyfikator whitelabel (UUID), przekazywany przez AdsHero w ramach konfiguracji whitelabel.
• startDate (query, wymagany) — data od, format YYYY-MM-DD.
• endDate (query, opcjonalny) — data do, format YYYY-MM-DD, domyślnie dzisiejsza data.
• page (query, wymagany) — numer strony (wartość > 0).
• pageSize (query, wymagany) — liczba wyników na stronę (wartość > 0).

Przykładowa odpowiedź:

{
  "data": [
    {
      "advertiserId": "adv-123",
      "sellerIds": ["seller-1", "seller-2"],
      "stats": {
        "bs-uuid-1": {
          "placementName": "Strona główna",
          "regularWalletCost": "150.50",
          "bonusWalletCost": "25.00"
        }
      }
    }
  ],
  "meta": {
    "page": 1,
    "itemsPerPage": 10,
    "totalResults": 42,
    "hasNext": true,
    "hasPrevious": false
  }
}

Opis pól odpowiedzi:

• advertiserId — identyfikator reklamodawcy.
• sellerIds — zbiór identyfikatorów sprzedawców (seller ID) powiązanych z reklamodawcą.
• stats — mapa kosztów per jednostka reklamowa, gdzie kluczem jest ID business slota:
  • placementName — nazwa jednostki reklamowej.
  • regularWalletCost — koszt z portfela regularnego.
  • bonusWalletCost — koszt z portfela bonusowego.
• meta.page — bieżąca strona.
• meta.itemsPerPage — liczba wyników na stronę.
• meta.totalResults — łączna liczba wyników.
• meta.hasNext — czy istnieje następna strona.
• meta.hasPrevious — czy istnieje poprzednia strona.