GeotargetingFilter Types

GeotargetingFilter WSDL

An GeotargetingFilter model
This service is stateful.

Examples +

  • create city target
  • create city target
  • create region target
  • create region target
  • create country target
  • create country target
  • create nielsen target
  • create nielsen target
  • edit
  • edit
  • delete
  • delete
  • create inventoried
  • create inventoried
  • create subfilter
  • create subfilter
.

    addtop

    Deprecated 2011-01-01

    This method will be removed in upcoming releases.

    Use save() to persist a new entity

    Description

    Saves changes made to the GeotargetingFilter

    int add()

    Return Values

    int The ID of the GeotargetingFilter (unique)

    addFilterClusterGrouptop

    Description

    Add to filter cluster group

    boolean addFilterClusterGroup(int $filter_cluster_group)

    Parameters

    int $filter_cluster_group

    Return Values

    boolean

    addItemtop

    Description

    Add an item to the filter (e.g. id 1 (for germany) to the country-filter)

    boolean addItem(string $item)

    Parameters

    string $item (war int. muß string wegen 3a/3b nielsen)

    Return Values

    boolean

    addParenttop

    Description

    Add a parent

    boolean addParent(string $parent_type, int $parent_id)

    Parameters

    string $parent_type $parentType
    int $parent_id

    Return Values

    boolean

    clearObjectDatatop

    Description

    Clears the current object state.
    This method will unload possibly loaded objects. Unsaved changes will be lost.

    boolean clearObjectData()

    Return Values

    boolean

    doComplexCalltop

    Description

    Execute a complex call.
    For further information read the API-User documentation.

    string doComplexCall(string $xmlstr)

    Parameters

    string $xmlstr XML of Complex Statements

    Return Values

    string The output produced by the statements

    edittop

    Deprecated 2011-01-01

    This method will be removed in upcoming releases.

    Use save() to persist changes made to an entity

    Description

    Saves changes made to the GeotargetingFilter

    boolean edit()

    Return Values

    boolean TRUE on succes, FALSE on fail

    getAllCitiestop

    Deprecated 2020-06-30

    This method will be removed in upcoming releases.

    Deprecated in favor of getCitiesByCountry(), getCitiesByState(), getCitiesByNielsenZone() and getCitiesByName()

    Description

    Throws \Exception when called and informs customer

    boolean getAllCities()

    Return Values

    boolean Never returns anything because it throws an exception.

    getAllCountriestop

    Description

    Get all countries

    string getAllCountries()

    Return Values

    string All countries.

    getAllNielsenZonestop

    Description

    Get all nielsen zones

    string getAllNielsenZones()

    Return Values

    string

    getAllRegionstop

    Description

    Get all regions

    string getAllRegions()

    Return Values

    string All regions.

    getAllStatestop

    Description

    Get all states

    string getAllStates()

    Return Values

    string All states.

    getCitiesByCountrytop

    Description

    Get all cities located in a given country

    string getCitiesByCountry(int $country_id)

    Parameters

    int $country_id The id of the country

    Return Values

    string The cities in the given country.

    getCitiesByNametop

    Description

    Returns all cities that matches given name,
    tailing asterix is added automatically.

    string getCitiesByName(string $name)

    Parameters

    string $name The begining part of the citiys name

    Return Values

    string The cities beginng with that name part

    getCitiesByNielsenZonetop

    Description

    Get all cities for a nielsen zone

    string getCitiesByNielsenZone(string $zone_id)

    Parameters

    string $zone_id The zone id

    Return Values

    string The cities in the given nielson zone.

    getCitiesByStatetop

    Description

    Get all cities located in a given state

    string getCitiesByState(int $state_id)

    Parameters

    int $state_id The state id

    Return Values

    string The cities in the given state.

    getCityNamesByPostalCodesIndexedByCityIdstop

    Description

    Gets a list of city names by its postcodes. The list is indexed by city id.
    E.g.:

    array(
    42492 => "Freiburg im Breisgau",
    …
    );

    string getCityNamesByPostalCodesIndexedByCityIds(string $postal_codes, int $country_id)

    Parameters

    string $postal_codes $postalCodes A list of postalcodes, containing at least one postalcode.
    int $country_id A country id

    Return Values

    string

    getDescriptiontop

    Description

    Get filter description

    Applies to inventoried and sub-filters

    string getDescription()

    Return Values

    string

    getFilterClusterGroupIdstop

    Description

    Get filter cluster group ids

    string getFilterClusterGroupIds()

    Return Values

    string

    getFilterItemstop

    Description

    Get the items stored in the filter

    string getFilterItems()

    Return Values

    string The items

    getIdtop

    Description

    Get id

    int getId()

    Return Values

    int $id

    getNametop

    Description

    Get filter name

    Applies to inventoried and sub-filters

    string getName()

    Return Values

    string

    getNetworktop

    Description

    Returns the current network id

    int getNetwork()

    Return Values

    int Network ID

    getNetworkIdtop

    Deprecated 2011-01-01

    This method will be removed in upcoming releases.

    Description

    Returns the current network id. Alias for getNetwork()

    int getNetworkId()

    Return Values

    int Network ID

    getParentstop

    Description

    Gets the filter parents

    For multiple parents:
    {
    "campaign" : [1, 2, .., N],
    "banner" : [1, 2, .., N]
    }

    For no parents:
    {
    "<orphan>" : [0]
    }

    For single filter parent (current filter must be a sub-filter):
    {
    "<filter>" : [N]
    }

    string getParents()

    Return Values

    string

    getPeriodtop

    Description

    Get period for the limit (e.g. hourly, daily, weeky, monthly)

    string getPeriod()

    Return Values

    string

    getRegionsByCountrytop

    Description

    Get all regions located in a given country

    string getRegionsByCountry(int $country_id)

    Parameters

    int $country_id The id of the country

    Return Values

    string The regions in the given country

    getStatesByCountrytop

    Description

    Get the state ids of a country

    string getStatesByCountry(string $country)

    Parameters

    string $country The country

    Return Values

    string The states in the given country.

    getSummarytop

    Description

    Get a textual summary for a loaded Filter

    string getSummary()

    Return Values

    string

    getTokentop

    Description

    Gets the session token. Can be used for single-sign-on.

    string getToken()

    Return Values

    string

    getTypetop

    Description

    Get the type, returns the user friendly source type, always english

    string getType()

    Return Values

    string $type The type (e.g. city, region, state, nielsen, country, etc.)

    getValidParentTypestop

    Description

    Get list of valid parent types

    string getValidParentTypes()

    Return Values

    string

    hasMultipleParentstop

    Description

    Determines, whether the filter has multiple parents

    boolean hasMultipleParents()

    Return Values

    boolean

    hasParentstop

    Description

    Determines, whether the filter has parents

    boolean hasParents()

    Return Values

    boolean

    isInventoriedtop

    Description

    Determines, whether the filter is inventoried.

    boolean isInventoried()

    Return Values

    boolean

    isInvertedtop

    Description

    Get inverted flag

    boolean isInverted()

    Return Values

    boolean

    isSubFiltertop

    Description

    Determines, whether the filter is a sub-filter, a non-inventoried filter
    which may be referenced in another filter specified by his parent

    boolean isSubFilter()

    Return Values

    boolean

    isVisibletop

    Description

    Determines, whether the filter is visible
    and can be therefore assigned to other objects,
    i.e. referenced in the code of a TagFilter.

    boolean isVisible()

    Return Values

    boolean

    loadtop

    Description

    Load a filter by its ID

    boolean load(int $id)

    Parameters

    int $id The id of the filter to load

    Return Values

    boolean True on success, otherwise false

    logintop

    Description

    Initializes a new session with given information

    boolean login(string $user, string $pass, int $network)

    Parameters

    string $user Username
    string $pass Password
    int $network $network Network ID

    Return Values

    boolean true on success, false on fail

    loginSmartPhonetop

    Deprecated 2014-12-22

    This method will be removed in upcoming releases.

    Was only useful for the mobile app, which is not supported anymore.

    Description

    Login method

    boolean loginSmartPhone(string $user, string $pass, int $network, string $client)

    Parameters

    string $user Username
    string $pass Password
    int $network $network Network ID
    string $client Client token e.g. "apn" token of iPhone

    Return Values

    boolean TRUE on success, FALSE on fail

    logouttop

    Description

    Destroys the active session, logging out the user.

    boolean logout()

    Return Values

    boolean true on success, false on fail

    provideNielsenStatestop

    Description

    Get the states for a given nielsen zone

    string provideNielsenStates(string $nielsen_id)

    Parameters

    string $nielsen_id Nielsen zone id

    Return Values

    string The states in the nielsen zone

    provideRegionStatestop

    Description

    Get the states for a specific region

    string provideRegionStates(int $region_id)

    Parameters

    int $region_id The States located in a given region

    Return Values

    string The states of this region

    removetop

    Description

    Remove filter

    boolean remove()

    Return Values

    boolean True on success, otherwise false

    removeByIdtop

    Description

    Removes a GeotargetingFilterFilterModel with the given id

    boolean removeById(int $id)

    Parameters

    int $id ID of object to remove.

    Return Values

    boolean

    removeFilterClusterGrouptop

    Description

    Remove from filter cluster group

    boolean removeFilterClusterGroup(int $filter_cluster_group)

    Parameters

    int $filter_cluster_group

    Return Values

    boolean

    removeItemtop

    Description

    Remove an item from the filter

    boolean removeItem(string $item)

    Parameters

    string $item The item to remove

    Return Values

    boolean

    removeParenttop

    Description

    Remove a parent

    boolean removeParent(string $parent_type, int $parent_id)

    Parameters

    string $parent_type $parentType
    int $parent_id

    Return Values

    boolean

    savetop

    Description

    Persists current object state

    boolean save()

    Return Values

    boolean True on success, otherwise false

    setDescriptiontop

    Description

    Set filter description

    Applies to inventoried and sub-filters

    boolean setDescription(string $description)

    Parameters

    string $description

    Return Values

    boolean

    setInventoriedtop

    Description

    Set the inventoried flag.
    If true, the filter will be available in the network-wide inventory under an unique name.
    Once a filter has been inventoried and saved, the inventoried flag cannot be changed.

    boolean setInventoried(boolean $inventoried)

    Parameters

    boolean $inventoried

    Return Values

    boolean

    setInvertedtop

    Description

    Inverts the current filter, i.e. everywhere but NOT in ...

    boolean setInverted(boolean $inverted)

    Parameters

    boolean $inverted

    Return Values

    boolean

    setItemstop

    Description

    Sets items into the filter, overwriting all items in the filter

    int setItems(string $items)

    Parameters

    string $items

    Return Values

    int Returns the number of items set

    setNametop

    Description

    Set filter name

    Applies to inventoried and sub-filters

    boolean setName(string $name)

    Parameters

    string $name

    Return Values

    boolean

    setTypetop

    Description

    Set the filter type (city, region, state, nielsen, country)

    boolean setType(string $type)

    Parameters

    string $type Allowed values: [city, region, state, nielsen, country]

    Return Values

    boolean true on success

    setVisibletop

    Description

    Set visibility

    Applies to inventoried and sub-filters

    boolean setVisible(boolean $visible)

    Parameters

    boolean $visible

    Return Values

    boolean

    validatetop

    Description

    Validates the object and returns an error stack.

    string validate()

    Return Values

    string

    Console