...
Element | Parent Element | Attributes | Description |
|---|---|---|---|
ads |
|
| Top level container of advertisement elements |
ad | ads |
| Advertisement data |
| ppe | ad | Price per event | |
| budget_allocation_id | ad | Budget allocation id | |
| call_duration_seconds_minimum | ad | (Nullable) Minimum call duration for a phone call to be eligible for billing | |
| dedupe_period | ad | (Nullable) period for which calls from a same caller number on the same advertiser will not be counted more than oncededuped | |
| dedupe_unit | ad | (Nullable) unit of the dedupe period, for eg. days, hours, months etc. | |
| remaining_budget | ad | Budget available | |
| day_parting_settings | ad | (Nullable) Day parting settings for this ad and day (apply to all listings in the ad) if any specified by the advertiser | |
| windows | day_parting_settings | List of day parting windows | |
| window | windows | A window of time within which the budget is available | |
| start_time | window | The start time of the day parting window (formatted using xml native "time" format) | |
| end_time | window | The end time of the day parting window (formatted using xml native "time" format) | |
| listings | ad | The group of businesses sharing the same budget | |
| listing | listings | Data of a business location | |
listing_id | listing |
| The ID to uniquely identify CityGrid's businesses |
| listing_name | listing | The name of the business | |
| reference_id | listing | The ID to uniquely identify provider to which listing belongs to | |
| in_day_parting | listing | Boolean that indicates weather or not the advertiser accepts connections at the current time of the day | |
| remaining_budget_override | listing | (Nullable) Budget available for this listing if different from remaining_budget | |
| phone_number | listing | (Nullable) phone number for the advertiser listing | |
categories | listing |
| List of categories associated to this advertiser |
category | categories | primary= true if the category is primary for this business | Category associated to this advertiser |
markets | listing |
| List of markets associated to this advertiser |
market | markets |
| Market associated to this advertiser |
neighborhoods | listing |
| List of neighborhoods associated to this advertiser |
neighborhood | neighborhoods |
| Neighborhood associated to this advertiser |
| cities | listing | List of cities associated to this advertiser | |
| city | cities | City associated to this advertiser | |
| postal_codes | listing | List of postal codes associated to this advertiser | |
| postal_code | postal_codes | Postal code associated to this advertiser | |
| day_parting_settings_overrides | listing | (Nullable) Day parting settings that apply for this particular listing if different from day_parting_settings |
...
Element | Parent Element | Attributes | Description |
|---|---|---|---|
ads |
|
| Root element |
ad | ads |
| Advertisement data |
net_ppe | ad |
| Price per event |
| reference_id | ad | The ID to uniquely identify provider to which listing belongs to | |
| budget_remaining | ad | Budget available | |
| budget_allocation_id | ad | Budget allocation id available | |
| call_duration_seconds_minimum | ad | (Nullable) Minimum call duration for a phone call to be eligible for billing | |
| dedupe_period | ad | (Nullable) period for which calls from a same caller number on the same advertiser will not be counted more than oncededuped | |
| dedupe_unit | ad | (Nullable) unit of the dedupe period, for eg. days, hours, months etc. | |
| day_parting_settings | ad | (Nullable) Day parting settings for this ad and day (apply to all listings in the ad) if any specified by the advertiser | |
| windows | day_parting_settings | List of day parting windows | |
| window | windows | A window of time within which the budget is available | |
| start_time | window | The start time of the day parting window (formatted using xml native "time" format) | |
| end_time | window | The end time of the day parting window (formatted using xml native "time" format) | |
| listings | ad | The group of businesses that shares the budget available | |
| listing | listings | Data for a given location | |
listing_id | listing |
| The ID to uniquely identify CityGrid's businesses |
| in_day_parting | listing | Boolean that indicates weather or not the advertiser accepts connections at the current time of the day | |
| remaining_budget_override | listing | (Nullable) Budget available for this listing if different from remaining_budget | |
| phone_number | listing | (Nullable) phone number for the advertiser listing | |
| day_parting_settings_overrideslisting | listing | (Nullable) Day parting settings that apply for this particular listing if different from day_parting_settings |
...