Update Adgroup - GroundTruth

Updates an ad group

Request

Path Params

Query Params

Body Params application/jsonRequired

Example

{
    "name": "string",
    "objective": 1,
    "tactic": 0,
    "media_types": [
        "app"
    ],
    "bid_type": "cpm",
    "bid_price": 0,
    "budgets": [
        {
            "start_date": "2019-08-24",
            "end_date": "2019-08-24",
            "budget": 0
        }
    ],
    "audiences": [
        {
            "id": "string",
            "type": "behavior",
            "exclude": false
        }
    ],
    "lookalike_audience_scale": 1,
    "location_filters": [
        {
            "type": "City",
            "exclude": false,
            "city": "string",
            "state": "string",
            "zip_code": "string",
            "county": "string",
            "dma": "string",
            "lat": -90,
            "lng": -180,
            "address": "string",
            "radius": 0.1
        }
    ],
    "drive_to_locations": [
        {
            "id": "string",
            "type": "brand"
        }
    ],
    "genders": [
        "M"
    ],
    "age_ranges": [
        "18-24"
    ],
    "enable_alcohol_age": false,
    "income_ranges": [
        "-50"
    ],
    "communities": [
        "aa"
    ],
    "optimization_strategy": "delivery",
    "ctr_threshold": 0,
    "sar_threshold": 0,
    "conversion_threshold": 0,
    "psvr_threshold": 0,
    "publisher_categories": [
        {
            "id": 0
        }
    ],
    "streaming_video_content_categories": [
        {
            "id": 0
        }
    ],
    "ctv_premium_categories": [
        {
            "id": 0
        }
    ],
    "audio_podcast_topics": [
        {
            "id": 0
        }
    ],
    "audio_streaming_genres": [
        {
            "id": 0
        }
    ],
    "audio_podcast_ad_positions": [
        0
    ],
    "languages": [
        "en"
    ],
    "operating_systems": [
        "ios"
    ],
    "dayparting": [
        0
    ],
    "on_premise_locations": [
        {
            "id": "string",
            "type": "brand",
            "proximity": "in_store",
            "radius": 0
        }
    ],
    "neighborhoods": [
        {
            "id": "string",
            "type": "behavior"
        }
    ],
    "neighborhood_types": [
        "business"
    ],
    "tracking_pixels": [
        {
            "id": 0
        }
    ],
    "billability_type": 0,
    "added_cost_cpm": 0,
    "viewable_percentage": 1,
    "measurable_percentage": 1,
    "gross_bid_price": 0,
    "ad_package": {
        "id": 0
    },
    "budget_padding": 0,
    "status": 2
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api-public.groundtruth.com/adgroups/?tenant_id' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "objective": 1,
    "tactic": 0,
    "media_types": [
        "app"
    ],
    "bid_type": "cpm",
    "bid_price": 0,
    "budgets": [
        {
            "start_date": "2019-08-24",
            "end_date": "2019-08-24",
            "budget": 0
        }
    ],
    "audiences": [
        {
            "id": "string",
            "type": "behavior",
            "exclude": false
        }
    ],
    "lookalike_audience_scale": 1,
    "location_filters": [
        {
            "type": "City",
            "exclude": false,
            "city": "string",
            "state": "string",
            "zip_code": "string",
            "county": "string",
            "dma": "string",
            "lat": -90,
            "lng": -180,
            "address": "string",
            "radius": 0.1
        }
    ],
    "drive_to_locations": [
        {
            "id": "string",
            "type": "brand"
        }
    ],
    "genders": [
        "M"
    ],
    "age_ranges": [
        "18-24"
    ],
    "enable_alcohol_age": false,
    "income_ranges": [
        "-50"
    ],
    "communities": [
        "aa"
    ],
    "optimization_strategy": "delivery",
    "ctr_threshold": 0,
    "sar_threshold": 0,
    "conversion_threshold": 0,
    "psvr_threshold": 0,
    "publisher_categories": [
        {
            "id": 0
        }
    ],
    "streaming_video_content_categories": [
        {
            "id": 0
        }
    ],
    "ctv_premium_categories": [
        {
            "id": 0
        }
    ],
    "audio_podcast_topics": [
        {
            "id": 0
        }
    ],
    "audio_streaming_genres": [
        {
            "id": 0
        }
    ],
    "audio_podcast_ad_positions": [
        0
    ],
    "languages": [
        "en"
    ],
    "operating_systems": [
        "ios"
    ],
    "dayparting": [
        0
    ],
    "on_premise_locations": [
        {
            "id": "string",
            "type": "brand",
            "proximity": "in_store",
            "radius": 0
        }
    ],
    "neighborhoods": [
        {
            "id": "string",
            "type": "behavior"
        }
    ],
    "neighborhood_types": [
        "business"
    ],
    "tracking_pixels": [
        {
            "id": 0
        }
    ],
    "billability_type": 0,
    "added_cost_cpm": 0,
    "viewable_percentage": 1,
    "measurable_percentage": 1,
    "gross_bid_price": 0,
    "ad_package": {
        "id": 0
    },
    "budget_padding": 0,
    "status": 2
}'

Responses

🟢200OK

application/json

Successful Response

Body

Example

{
    "id": 0,
    "tenant_id": 0,
    "organization_id": 0,
    "account_id": 0,
    "campaign_id": 0,
    "name": "string",
    "start_date": "2019-08-24",
    "end_date": "2019-08-24",
    "status": 2,
    "objective": 1,
    "tactic": 0,
    "media_types": [
        "app"
    ],
    "bid_type": "cpm",
    "bid_price": "string",
    "budgets": [
        {
            "start_date": "2019-08-24",
            "end_date": "2019-08-24",
            "budget": "string"
        }
    ],
    "budget_type": 0,
    "audiences": [
        {
            "id": "string",
            "name": "string",
            "type": "behavior",
            "exclude": true,
            "size": 0,
            "description": "string",
            "sensitivity": 0,
            "location_group_metadata": {
                "type": 0,
                "url": "string",
                "accepted": 0,
                "rejected": 0,
                "invalid": 0,
                "conflict": 0
            }
        }
    ],
    "lookalike_audience_scale": 1,
    "location_filters": [
        {
            "type": "City",
            "exclude": false,
            "city": "string",
            "state": "string",
            "zip_code": "string",
            "county": "string",
            "dma": "string",
            "lat": -90,
            "lng": -180,
            "address": "string",
            "radius": 0.1,
            "display_name": "string"
        }
    ],
    "drive_to_locations": [
        {
            "id": "string",
            "name": "string",
            "type": "brand",
            "location_group_metadata": {
                "type": 0,
                "url": "string",
                "accepted": 0,
                "rejected": 0,
                "invalid": 0,
                "conflict": 0
            }
        }
    ],
    "genders": [
        "M"
    ],
    "age_ranges": [
        "18-24"
    ],
    "enable_alcohol_age": true,
    "income_ranges": [
        "-50"
    ],
    "communities": [
        "aa"
    ],
    "optimization_strategy": "delivery",
    "ctr_threshold": 0,
    "sar_threshold": 0,
    "conversion_threshold": 0,
    "psvr_threshold": 0,
    "publisher_categories": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "streaming_video_content_categories": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "ctv_premium_categories": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "audio_podcast_topics": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "audio_streaming_genres": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "audio_podcast_ad_positions": [
        0
    ],
    "operating_systems": [
        "ios"
    ],
    "languages": [
        "en"
    ],
    "dayparting": [
        0
    ],
    "neighborhoods": [
        {
            "id": "string",
            "name": "string",
            "type": "behavior",
            "sensitivity": 0,
            "location_group_metadata": {
                "type": 0,
                "url": "string",
                "accepted": 0,
                "rejected": 0,
                "invalid": 0,
                "conflict": 0
            }
        }
    ],
    "neighborhood_types": [
        "business"
    ],
    "created_date": "2019-08-24T14:15:22.123Z",
    "updated_date": "2019-08-24T14:15:22.123Z",
    "on_premise_locations": [
        {
            "id": "string",
            "name": "string",
            "type": "brand",
            "proximity": "in_store",
            "radius": 0,
            "sensitivity": 0,
            "location_group_metadata": {
                "type": 0,
                "url": "string",
                "accepted": 0,
                "rejected": 0,
                "invalid": 0,
                "conflict": 0
            }
        }
    ],
    "completed_steps": [
        1
    ],
    "tracking_pixels": [
        {
            "id": 0,
            "name": "string"
        }
    ],
    "billability_type": 0,
    "added_cost_cpm": "0",
    "viewable_percentage": 0,
    "measurable_percentage": 0,
    "gross_bid_price": "string",
    "ad_package": {
        "id": 0,
        "name": "string"
    },
    "budget_padding": "0"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error