Yahoo developer network
Native
Yahoo developer network logo
  • Open Source
  • APIs
  • Advertising
  • Blog
  • Events
  • Podcasts
  • Apps
  • Native
  • Documentation

    • Yahoo Native to Yahoo DSP API Migration Guide
      • Understanding Domain Models
      • Migration scenarios
      • Campaign package structure
      • Understanding DSP packages
      • Seat types
      • Authorization
      • Advertiser
      • Campaigns
      • Lines
      • Blocked cases
      • Pixels
      • Reporting
      • Targeting
      • Postman toolkit
      • Appendix
      • Sample code
        • Create DSP shell
        • Create DSP creative
        • Flatten & Filter Targeting attributes
    • What’s New
    • Latest Updates
    • Get Started - API Endpoints
    • Navigating the API
      • Authentication
      • Testing - Sandbox
      • Versioning
      • API v1 Deprecation & v2 Changes
      • FAQs
    • Objects
      • Advertisers
      • Campaigns
      • Ad Group
      • Ad
      • Keyword
      • Targeting Attribute
      • Ad Extensions
      • Shared Sitelink
      • Shared Sitelink Setting
      • Ad Site Setting
    • Matrix View of Ad Types
    • Postman API Toolkit
    • Upgraded URLs
      • Migration path
    • Yahoo Native Ads
      • Native Ad Matrix View
      • Moments Ads
      • Search Ads
      • Image Ads
      • Mail Ads
      • Carousel Ads
      • Tiles Ads
      • Native Video Ads
      • App Install Ads
    • Frequency Cap
    • Reach and Performance
    • Dynamic Product Ads
    • Enhanced Attribution
    • Account Change History
    • Bulk Operations
      • Bulk File Schema & Fields
      • Bulk Upload API
      • Bulk Download API
      • Best Practices
    • Shared Set Libraries
      • Create shared sets
      • Populate shared sets
      • Associate shared sets
    • Audience Management
      • Audiences from websites
      • Audiences from customer lists
      • Audiences from your app
      • Audiences from email lists
      • Lookalike audiences
      • Conversion rule audiences
      • Dot tags
      • Conversion rules
      • Utilize Dot tags & conversion rules
      • Custom audience strategies
    • Reporting
      • Cubes
      • Dimensions
      • FAQs
    • Reseller Management API
    • Resources
      • Dynamic Parameters
      • Data Dictionary
      • Best Practices
      • Error Codes and Responses
      • Release Notes - Archived
    • Glossary
      • Glossary of Yahoo Native Terms
    • Partner Support
      • Product bulletin 2023 February
      • Product bulletin 2023 January
      • Product bulletin 2022 December
      • Product bulletin 2022 November
      • Product bulletin 2022 October
      • Product bulletin 2022 September
    • Policies
    • Advertiser Guide - UI
    • Technical Notes
      • Search on native
      • Create, serve & filter shared sitelinks
    • Server-to-Server Specifications
      • App Install Spec
      • In-app Events Spec
      • Post-install Spec
  • Sign In
  • Language:
    • English (U.S.)
    • 中文(香港)
    • 中文(台灣)

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
Support
Terms and Privacy Policy
Your Privacy Choices
About Us Jobs Developer Privacy Developer Terms Developer Policies Site Feedback
Brands Yahoo Developer Yahoo Ads SDK Analytics Reporting Yahoo Edgecast Developer Ad Platform Help Center
Group 5 Group 7 Group 4 Group 3 Group 14
Yahoo Logo