Campaigns¶

Abstract¶

Describes Yahoo DSP and Native GET and POST campaigns with endpoints, CURL and JSON example code.

Overview¶

A campaign is an advertising goal that defines a strategy for delivering ads within a set time period. You set up a campaign by defining its flight dates, budgets, frequency caps, demographic targeting data provider, and campaign goals.

Every campaign belongs to a specific advertiser and inherits default settings (time zone, currency, etc.) from the advertiser-level settings. Campaign flight dates, frequency caps, and budget settings constrain line-level settings.

You can set one of the following campaign budget types:

A single budget that applies to all lines in the campaign as defined by the budgetSchedules array with a single object.
Multiple budget schedules apply to the lines under the campaign as defined in the budgetSchedules array with multiple objects.

Use the following HTTP methods:

Use the GET method to view a campaign.
Use the POST method to create a new campaign.
Use the PUT method to update an existing campaign.

GET Campaign¶

Yahoo Native¶

Endpoint:

https://api.gemini.yahoo.com/v3/rest/campaign/campaign_id

Method: GET

Header:

Content-Type: application/json Authorization: Bearer <access_token>

CURL

curl --location --request GET 'https://api.gemini.yahoo.com/v3/rest/campaign/404722009' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer access_token'

Response

{
    "errors": null,
    "timestamp": "2021-02-13 6:30:08",
    "response": {
        "lastUpdateDate": 1611933797232,
        "createdDate": 1611887751449,
        "advertiserId": 12345,
        "trackingUrl": null,
        "language": "en",
        "objective": "VISIT_WEB",
        "campaignName": "Test Campaign Name",
        "advancedGeoPos": "DEFAULT",
        "advancedGeoNeg": "DEFAULT",
        "conversionRuleIds": null,
        "biddingStrategy": "DEFAULT",
        "effectiveStatus": "PAUSED",
        "budgetType": "DAILY",
        "conversionRuleConfig": {
            "timeWindow": 43200,
            "conversionCounting": "ALL_PER_INTERACTION",
            "postViewTimeWindow": 2880,
            "optimizationRuleIds": []
        },
        "subChannelModifier": 0.3,
        "budget": 270,
        "customParameters": null,
        "subChannel": "SRN_AND_SEARCH",
        "isPartnerNetwork": "TRUE",
        "status": "PAUSED",
        "id": 2342435,
        "tagId": 10102341,
        "editorialStatus": "NOT_REVIEWED",
        "channel": "SEARCH",
        "isDeepLink": "FALSE"
    }
}

Yahoo DSP¶

Endpoint:

https://dspapi.admanagerplus.yahoo.com/traffic/campaigns/campaign_id

Method: GET

Header:

Content-Type: application/json X-Auth-Token: access_token X-Auth-Method: OAUTH2

CURL

curl --location --request GET 'https://dspapi.admanagerplus.yahoo.com/traffic/campaigns/236087' \
--header 'X-Auth-Method: OAUTH2' \
--header 'X-Auth-Token: access_token' \
--header 'Content-Type: application/json'

Response

    "response": {
        "id": 12345,
        "name": "First campaign",
        "createdAt": "2020-04-19T14:53:11Z",
        "updatedAt": "2020-11-02T00:26:40Z",
        "goalValue": 0,
        "frequencyCapValue": 0,
        "accountId": 123,
        "status": "INACTIVE",
        "goalType": "CPA",
        "timezone": "America/Los_Angeles",
        "currency": "USD",
        "demoVendor": "YAHOO",
        "budgetSchedules": [
            {
                "id": 3453,
                "startDate": "2020-04-20T07:00:00Z",
                "endDate": "2020-04-21T07:00:00Z",
                "scheduleBudget": 100.7,
                "scheduleDailyBudget": 0,
                "scheduleBudgetType": "TOTAL_BUDGET"
            }
        ],
        "frequencyCapPeriodType": "UNLIMITED"
    },
    "errors": null,
    "timeStamp": "2020-11-11T01:01:41.813Z"
}

POST Campaign¶

Yahoo Native¶

Endpoint:

https://api.gemini.yahoo.com/v3/rest/campaign

Method: POST

Header:

Content-Type: application/json Authorization: Bearer <access_token>

Body:

{
      "advertiserId":advertiser_id,
      "budget":100,
      "budgetType":"DAILY",
      "campaignName":"Visit My Website (SRN and Search)",
      "channel":"SEARCH_AND_NATIVE",
      "objective": "VISIT_WEB",
      "status":"PAUSED"
  }

CURL

curl --location --request POST 'https://api.gemini.yahoo.com/v3/rest/campaign' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer access_token' \
--data-raw '
  {
      "advertiserId":advertiser_id,
      "budget":100,
      "budgetType":"DAILY",
      "campaignName":"Visit My Website (SRN and Search)",
      "channel":"SEARCH_AND_NATIVE",
      "objective": "VISIT_WEB",
      "status":"PAUSED"
  }'

Yahoo DSP¶

Endpoint:

https://dspapi.admanagerplus.yahoo.com/traffic/campaigns

Method: GET

Header:

Content-Type: application/json X-Auth-Token: access_token X-Auth-Method: OAUTH2

Body

{
  "name": "Test O&O Native Campaign",
  "goalValue": 2,
  "frequencyCapValue": 0,
  "accountId": advertiser_id,
  "dailyBudget": 0,
  "status": "ACTIVE",
  "goalType": "CTR",
  "timezone": "America/Los_Angeles",
  "currency": "USD",
  "demoVendor": "YAHOO",
  "frequencyCapPeriodType": "UNLIMITED",
  "budgetSchedules": [
    {
      "scheduleBudget": 10000,
      "scheduleBudgetType": "TOTAL_BUDGET",
      "startDate": "2021-01-01",
      "endDate": "2021-03-31"
    }
  ]
}

CURL

curl --location --request POST 'https://dspapi.admanagerplus.yahoo.com/traffic/campaigns' \
--header 'X-Auth-Method: OAUTH2' \
--header 'X-Auth-Token: access_token' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Test O&O Native Campaign",
  "campaignStartDate": "2021-01-01",
  "campaignEndDate": "2021-03-31",
  "totalBudgetType": "UNLIMITED",
  "budget": null,
  "dailyBudget": 3,
  "dailyBudgetType": "TOTAL_BUDGET",
  "goalType": "CTR",
  "goalValue": 0,
  "accountId": advertiser_id,
  "currency": "USD",
  "status": "ACTIVE",
  "frequencyCapValue": 10,
  "frequencyCapPeriodType": "DAILY",
  "timezone": "America/Los_Angeles"
}'

Response

    "response": {
        "id": 1111,
        "name": "Test O&O Native Campaign",
        "createdAt": "2021-01-17T19:54:25Z",
        "updatedAt": "2021-01-17T19:54:25Z",
        "goalValue": 2.0,
        "frequencyCapValue": 0,
        "accountId": 1612534,
        "status": "ACTIVE",
        "goalType": "CTR",
        "timezone": "America/Los_Angeles",
        "currency": "USD",
        "demoVendor": "YAHOO",
        "budgetSchedules": [
            {
                "id": 3122,
                "startDate": "2021-01-01T08:00:00Z",
                "endDate": "2021-03-31T08:00:00Z",
                "scheduleBudget": 10000.0,
                "scheduleDailyBudget": 0.0,
                "scheduleBudgetType": "TOTAL_BUDGET"
            }
        ],
        "frequencyCapPeriodType": "UNLIMITED"
    },
    "errors": null,
    "timeStamp": "2021-01-17T19:54:25.158Z"
}