Ad list

Property Type Description
ads Map<string, Ad> Data for ads, keyed by adId
rankings AdRankings See the AdRankings page for more information.
assets Map<string, Asset> Array of metadata for assets. This is an optional response object that can be disabled through ad-metadata and creative-metadata caching integration.
storeLocations Map<string, StoreLocation[]> Map of StoreLocation objects keyed by adId

Example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
{
  "ads": {
    "11111": {
      "adServeToken": "encodedData",
      "reward": {
        "rewardType": "PERCENT",
        "rewardAmount": "10"
      },
      "activationState": "ACTIVATED",
      "visibilityState": "VISIBLE",
      "redemptionState": "PROCESSING"
    },
    "22222": {
      "adServeToken": "encodedData",
      "reward": {
        "rewardType": "PROGRAM_CURRENCY",
        "rewardAmount": "1.99"
      },
      "activationState": "SERVED",
      "visibilityState": "PARKED"
    },
    "33333": {
      "adServeToken": "encodedData",
      "startDate": "2022-01-01",
      "endDate": "2024-01-01",
      "reward": {
        "rewardType": "PROGRAM_CURRENCY",
        "rewardAmount": "1.99"
      },
      "restrictions": [
        {
          "displayRestrictionType": "CUSTOMER_DATE_TIME"
        }
      ],
      "activationState": "NEW"
    }
  },
  "ranking": {
    "all": ["11111", "33333", "22222"],
    "sections": {
      "LANDING": {
        "all": ["33333", "11111", "22222"]
      },
      "WIDGET": {
        "all": ["22222", "33333", "11111"]
      }
    },
    "storeLocations": {
      "11111": [
        {
          "storeName": "Store 1",
          "address": {
            "addressLine1": "123 Front St",
            "addressLine2": "Suite 1",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94105",
            "country": "US"
          },
          "phoneNumber": "123-456-7890",
          "distance": "1.2",
          "latitude": "37.7749",
          "longitude": "122.4194"
        },
        {
          "storeName": "Store 2",
          "address": {
            "addressLine1": "123 Main St",
            "addressLine2": "Suite 1",
            "city": "San Francisco",
            "state": "CA",
            "postalCode": "94105",
            "country": "US"
          },
          "phoneNumber": "123-456-7890",
          "distance": "1.2",
          "latitude": "37.7749",
          "longitude": "122.4194"
        }
      ]
    }
  }
}