Skip to content

Updates the relative weights used to select a campaign when a visit matches multiple campaigns. The campaign with the highest-weighted matching condition is selected.

Method update.campaign_parameter_weights
Description Updates the relative weights used to select a campaign when a visit matches multiple campaigns. The campaign with the highest-weighted matching condition is selected.
Who has access Agents and clients

Request parameters

Name Type Required Valid values Description
access_token string yes Session key used to authenticate the request
user_id number no Unique ID of the client user on whose behalf the request is made. Required when an agent makes the request. To retrieve a list of client users, call get.customer_users.
site_id number yes Unique site ID
entrance_page number no 0-100 Weight assigned to landing page matches
referrer_domain number no 0-100 Weight assigned to referrer domain matches
search_engine number no 0-100 Weight assigned to search engine matches
search_query number no 0-100 Weight assigned to search query matches
engine number no 0-100 Weight assigned to advertising platform matches
referrer number no 0-100 Weight assigned to referrer matches
channel number no 0-100 Weight assigned to channel matches
location number no 0-100 Weight assigned to city, region, and country matches
utm_tags number no 0-100 Weight assigned to utm_source, utm_medium, utm_campaign, utm_term, and utm_content matches
os_tags number no 0-100 Weight assigned to openstat_service, openstat_campaign, openstat_source, and openstat_ad matches
other_tags number no 0-100 Weight assigned to ef_id, yclid, gclid, and ymclid matches

Example request

{
    "jsonrpc": "2.0",
    "id": "number",
    "method": "update.campaign_parameter_weights",
    "params": {
        "access_token": "string",
        "user_id": "number",
        "site_id": "number",
        "other_tags": "number",
        "search_query": "number",
        "engine": "number",
        "referrer": "number",
        "channel": "number",
        "entrance_page": "number",
        "location": "number",
        "utm_tags": "number",
        "os_tags": "number",
        "referrer_domain": "number",
        "search_engine": "number"
    }
}

Example response

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "data": {},
        "metadata": {}
    }
}

List of returned errors

See the "List of errors for update methods" section.