Shared Set Libraries

The v2 Gemini API provides you with a library of shared set objects. You can create shared sets, populate those shared sets with negative keywords and associate shared sets to single or multiple campaigns.

In so doing, you’ll be able to reuse your shared set objects for multiple campaigns. This eliminates the need to manually duplicate the negative keywords in multiple campaigns repetitively.

You create shared sets on the advertiser account level, using the shared set endpoint.

v2 Shared Set Data Model

The v2 shared sets data model illustrates how shared sets work and connect.

shared sets v2

Objects & Tasks

The v2 Gemini API includes the following shared sets with their associated tasks:

Task Description
Create Shared Sets Create, update and retrieve shared sets, for example, using memberCount to determine the number of keywords in a shared set and referenceCount to calculate the number of campaigns that actively use the shared set.
Populate Shared Sets Populate shared sets with negative keywords.
Associate Shared Sets to a Campaign Associate shared sets to single or multiple campaigns.

Usage

Use the methods associated with the objects in the library to create, update and retrieve shared sets.

For example, if you wish to retrieve data for a specific shared set, you make a GET call with the ID parameter:

GET https://api.gemini.yahoo.com/v2/rest/sharedset/1234

The response will be the shared set associated with the id:

{
  "errors": null,
  "response": [
     {
       "name": "My Shared Set",
        "type": "NEGATIVE_KEYWORD",
        "memberCount": 100,
        "referenceCount": 0,
        "status": "ACTIVE",
        "id": 103002,
        "advertiserId": 925746
     }
  ]
}

Once you’ve created a shared set, you can link it to any campaign or ad group. As an example use case, you can create a shared set of negative keywords and populate the set with a list of keywords you may wish to exclude. To retrieve data for a specific shared negative keyword, you make a GET call with the ID parameter:

    GET https://api.gemini.yahoo.com/v2/rest/sharednegativekeyword/1234

    The response will be the shared negative keyword associated with the id:

{
      "errors": null,
      "response": [
         {
           "value": "shoes",
            "matchType": "EXACT",
            "sharedSetId": 100,
            "status": "ACTIVE",
            "id": 103002,
            "advertiserId": 925746
         }
      ]
    }

Once you create a shared set, you can also associate it to multiple campaigns. For example, to retrieve data for a specific campaign shared set, you make a GET call with the ID parameter:

GET https://api.gemini.yahoo.com/v2/rest/campaignsharedset/1234

The response will be the campaign shared set associated with the id:

{
  "errors": null,
  "response": [
     {
       "campaignId": 100,
        "sharedSetId": 100,
        "status": "ACTIVE",
        "id": 103002,
        "advertiserId": 925746
     }
  ]
}

Object Limits

The maximum limits for the three new objects supported in the v2 Gemini API:

Object Limit
Shared Sets per account 20
Negative Keywords per Shared Set 5000
Shared Sitelinks per account 5000

Character Lengths

The maximum lengths (counts) for Title, URL and Description characters supported in the v2 Gemini API:

Character Length
Title 50
URL 2048
Description 2000