Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

The App/Site entity is an alternative to the publisher entity. It allows customizing sellers id, macros, trackers, and more for each app or site that are used in the platform.

1. Login

To log in - the general login API is used. Example - https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/155975720/Reporting+API#Login-API

2. Logout

To log out - the general logout API is used. Example - https://aniviewwiki.atlassian.net/wiki/spaces/HELP/pages/155975720/Reporting+API#Logout-API

3. App/Site API

3.1. Get App/Site List

Retrieves a list of all App/Site entities.

Request URL:
https://manage.aniview.com/api/adserver/channelpublishers?format=json&filter={"$and":[{"status":{"$in":[1]}}]}

Request Method:
GET

Status Code:
200 OK

Filtering Parameters (Optional):

Parameter

Description

Values

status

Status of template

Active:1, Archived:2

3.2. Create App/Site

Request URL:

https://manage.aniview.com/api/adserver/channelpublishers?format=json

Request Method:
POST

Minimal Request Example Payload:

{
    "status": 1,
    "frequencyCap": {
        "frequency": 4,
        "sum": 0
    },
    "playerSettings": {
        "tagTimeout": 20000,
        "optimizedTimeout": false,
        "maxRPM": 0
    },
    "name": "app/site name"
}

Full Request Example Payload:

{
    "status": 1,
    "frequencyCap": {
        "frequency": 4,
        "sum": 0
    },
    "playerSettings": {
        "tagTimeout": 20000,
        "optimizedTimeout": false,
        "maxRPM": 0
    },
    "name": "App Site example2",
    "sid": "site id",
    "domain": "site_domain.com",
    "sellerType": "PUBLISHER",
    "email": "email@email.com",
    "description": "description",
    "macro": "macro=1",
    "trackers": [
        {
            "e": "impression",
            "url": "https://www.mako.co.il",
            "t": 1,
            "tsp": 100
        }
    ],
    "isOno": true,
    "isConfidential": true,
    "isExcludedFromSJson": true
}

Main

Parameter

Type

Description

name

String

App/Site name.

email

String

App/Site email.

description

String

App/Site description.

macro

String

Use to pass one or more values for reporting and/or targeting purposes.
It needs to be built as a string (with an '&' sign connecting each value) and using Aniview's macros as placeholders.
For example: AV_APPNAME=appname_value&AV_CUSTOM1=custom1_value

sid

String

Seller ID

domain

String

Site domain

sellerType

"PUBLISHER|"/"BOTH"/

"INTERMEDIARY"

Seller type

isOno

Boolean

Set true if owned and operated

isConfidential

Boolean

Set true if confidential

isExcludedFromSJson

Boolean

Set true if you want to exclude this App/Site from the sellers.json

status

Active:1, Archived:2

App/Site status in the system.

Frequency Cap

Parameter

Type

Description

frequency

{ "Daily": 1, "Weekly": 2, "Unlimited": 3, "Hourly": 5 }

Frequency Capping.

sum

Int

number of times per day.

Player Settings

Parameter

Type

Description

tagTimeout

Int

Time the player waits until adsource finds ad.

optimizedTimeout

Boolean

Set true to optimize time out.

maxRPM

Int

Max Requests per Minute. The calculation is 60 / *configured_number*
Example: If set to 2, the adsoure will send request every 30 seconds.

Trackers

Parameter

Type

Description

e

FIRST_QUARTILE: "firstQuartile",
MID_POINT: "midpoint",
THIRD_QUARTILE: "thirdQuartile",
COMPLETE: "complete",
START: "start",
SUPPLY_ERROR: "supplyError",
MUTE: "mute",
UNMUTE: "unmute",
PAUSE: "pause",
RESUME: "resume",
IMPRESSION: "impression",
CLICK: "clickThrough",
INVENTORY: "inventory",
SYNC: "sync",
CLOSE: "close",
PROGRESS: "progress",
VIEWABLE_IMPRESSION: "viewableImpression"

Tracker type or event.

url

String

Tracker URL.

t

1:Image, 2:JS,3:Iframe,4:Google Analytics

Tacker method.

tsp

Number between 0-100

Precentage of events on which the tracker will be exacuted.

3.3. Edit App/Site

Request URL:

Request URL: https://manage.aniview.com/api/adserver/channelpublishers/{$App/Siter_ID}?format=json

Request Method:
Put

Status Code:
200 OK

Request payload:

{
    "email": "email@email.com",
    "trackers": [
        {
            "e": "impression",
            "t": 1,
            "url": "https://www.website.co.il",
            "offset": null,
            "eventAction": null,
            "eventActionSwitch": false,
            "eventCategory": null,
            "eventCategorySwitch": false,
            "eventLabel": null,
            "eventLabelSwitch": false,
            "eventValue": null,
            "tsp": 100
        }
    ],
    "sid": "app_site_id",
    "domain": "website.com",
    "macro": "macro=1",
    "sellerType": "PUBLISHER",
    "isOno": true,
    "isConfidential": true,
    "isExcludedFromSJson": true,
    "isIncludeInJson": false,
    "adstxt": {
        "advertisers": {},
        "fileURL": null,
        "tabName": null,
        "fileMapping": {
            "approved": {
                "value": "",
                "keyMap": {}
            },
            "domain": {
                "value": "",
                "keyMap": {}
            }
        },
        "lines": []
    },
    "priceList": null,
    "status": 1,
    "name": "App Site example21",
    "description": "description",
    "publisherId": "publisherId",
    "restoreFrom": null,
    "adsourceOriginId": null,
    "lastAuditTrailId": null,
    "id": null,
    "frequencyCap": {
        "frequency": 4,
        "sum": 0
    },
    "playerSettings": {
        "tagTimeout": 20000,
        "optimizedTimeout": false,
        "maxRPM": 0
    }
}

3.4. Delete App/Site

Request URL:

Request URL: https://manage.aniview.com/api/adserver/channelpublishers/${App/Site_ID}?format=json

Request Method:
Delete

Status Code:
200 OK

  • No labels