publisher/advertiser
The advertiser resource allows a publisher to pull advertiser data for the advertisers on Ascend.
| GET | ||||
|---|---|---|---|---|
| Request Parameters | ||||
| Parameter | Description | Possible Values | Default | Required? |
| format | The format the response will be returned in. | json, xml, or csv | N/A | Yes |
| status | A comma-separated list of statuses to search for. | joined, revoked_advertiser, applied, declined_advertiser, invited, revoked_publisher, declined_publisher, no_relationship | N/A | No |
| category | A comma-separated list of category ids to search for. Use the category resource to retrieve these ids. |
* 123,456,789 | N/A | No |
| programId | A comma-separated list of program ids to search for. | * 123,456,789 | N/A | No |
| name | A comma-separated list of program names to search for. This is a 'like' comparison, so it will return results similar to the provided names. | * Advertiser 1, Advertiser 2, Advertiser 3 | N/A | No |
| firstName | A comma-separated list of contact first names to search for. This is a 'like' comparison, so it will return results similar to the provided names. | * Christine, Brian, John | N/A | No |
| lastName | A comma-separated list of contact last names to search for. This is a 'like' comparison, so it will return results similar to the provided names. | * Smith, Jones, Chan | N/A | No |
| currency | A comma-separated list of currencies to search for. | USD, CAD, GBP, EUR, AUD, CNY, JPY, INR, KRW, SGD, RUB, TRY, BRL, MXN, ARS, CHF, HKD | N/A | No |
| mobileTracking | Whether or not the program has confirmed mobile tracking. Any value that is not empty will filter for mobile enabled programs. Note that 0 is considered empty. | * 1, yes, etc. | N/A | No |
| Response Fields | ||||
| Field | Description | Notes | ||
| id | Advertiser's program ID | |||
| name | Advertiser's program name | |||
| description | A description of the program | |||
| logo | A URL that links to the advertiser's logo | |||
| prohibited_states | A list of states the advertiser will not work in | |||
| website | The advertiser's website | |||
| contact_name | The name of the contact for the advertiser | |||
| phone | The advertiser's contact phone number | The returned value depends on if the publisher is joined to the advertiser |
||
| address1 | The advertiser's address | The returned value depends on if the publisher is joined to the advertiser |
||
| address2 | The advertiser's address | The returned value depends on if the publisher is joined to the advertiser |
||
| city | The advertiser's city | The returned value depends on if the publisher is joined to the advertiser |
||
| state_code | The advertiser's state code | The returned value depends on if the publisher is joined to the advertiser |
||
| zip_code | The advertiser's zip code | The returned value depends on if the publisher is joined to the advertiser |
||
| country_code | The advertiser's country code | The returned value depends on if the publisher is joined to the advertiser |
||
| The email address for the advertiser | The returned value depends on if the publisher is joined to the advertiser |
|||
| currency | The currency the advertiser operates in | |||
| mobile_tracking | Whether or not the program has confirmed mobile tracking. | Either "Enabled" or "N/A" | ||
| status | The status of your relationship with the advertiser | |||
| join_date | Your join date with the publisher | The returned value depends on program status | ||
| category | An array, or string, of categories the advertiser belongs to | The returned value depends on response format: * JSON or XML = Array * CSV = Pipe delimited string of category names |
||
| category[n][id] | The category id | * JSON or XML format only | ||
| category[n][name] | The name of the category | * JSON or XML format only | ||
| cookie_duration | The cookie duration of the assigned or default term | The returned value depends on program status | ||
| percentage_payout | The percentage payout of the assigned or default term | The returned value depends on program status | ||
| flat_payout | The flat payout of the assigned or default term | The returned value depends on program status | ||
| deep_linking | Is deep linking enabled? | Either "Yes" or "No" | ||
| product_feed | Is the product feed enabled? | Either "Yes" or "No" | ||
| lock_period | The Advertiser’s locking period in days | |||
* Values shown are placeholder values. Please replace with actual data.