Create, Serve & Filter v2 Shared Sitelinks¶

This Technical Note describes how to work with Shared Sitelinks for creating, serving and filtering on this new v2 object, which has been updated to v3.

The programmatic Yahoo Native API v2 introduced a new object called Shared Sitelink. The object and its fields and operations are described in detail in the section Shared SiteLink.

The object, updated to v3, is managed by this endpoint:

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

Create Shared Sitelinks¶

You can create as many sharedsitelink objects as you wish. Each object will be attached to the advertiser id.

If you create duplicates, the following error will be thrown:

"code": "E40000_INVALID_INPUT","message": "Sitelink duplicated title",

Sitelink Serving¶

To enable the sitelink object to serve, you need to connect the sitelink to an ad group or campaign via the sharedsitelinksetting API, as described in Shared SiteLink Setting.

There is one sharedsitelinksetting object per connection. For example: If you wish to make a sitelink for your order page, and attach it to 2 adgroups and 3 campaigns, you would first create the sitelink and then create 5 sharedsitelinksetting.

Note

You can’t have more than one sitelink in sharedsitelinksetting, i.e., it can’t hold a set.

Because there are no containers, filtering on a GET sharedsitelinksetting call is the easiest way to find what is connected to what.

Filtering¶

You can filter to an actual sharedsitelink id, which will show all ``sharedsitelinksetting``s that exist for it. That is, what ad groups and campaigns this sitelink is linked to

https://api.admanager.yahoo.com/v2/rest/sharedsitelinksetting/?siteLinkId=88922

In the above example, 5 sharedsitelinksetting objects are returned.

You can also filter by adgroup or campaign id. In doing so, you’ll see any and all sharedsitelinksetting’s that are linked to it. That is, what sitelinks are assigned to adgroup 123, for example:

https://api.admanager.yahoo.com/v3/rest/sharedsitelinksetting/?parentId=123&parentType=ADGROUP

In the example below, sitelinks are being shared to 2 campaigns:

Sitelink 1  -> ShareSitelinkSetting 1 -> Campaign 1
Sitelink 1  -> ShareSitelinkSetting 2 -> Campaign 2
Sitelink 2  -> ShareSitelinkSetting 3 -> Campaign 2