- Open Source
- APIs
- Advertising
- Blog
- Events
- Podcasts
- Apps
- Native
- Documentation
- Yahoo Native to Yahoo DSP API Migration Guide
- Sign In
- Language:
Shared Sitelink Setting¶
Abstract¶
Provides methods for creating, updating and retrieving shared sitelinks.
Overview¶
Shared sitelinks settings are entities created on the advertiser account level, using the Shared Sitelink endpoint. Once created, they can be shared and linked to any campaign or adgroup. The relationship or link to campaign or adgroup is handled using this endpoint.
Endpoint¶
Resource URI
https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting/
Fields¶
Name |
Description |
Type |
Add |
Update |
---|---|---|---|---|
|
The ID of the shared sitelink. |
long |
required |
required |
|
The ID of the advertiser. |
long |
required |
optional |
|
The ID of the parent shared sitelink. |
long |
required |
optional |
|
The ID of the parent campaign or adgroup. |
long |
required |
optional |
|
The parent type to assign the shared site link to. Valid values are: CAMPAIGN, ADGROUP. |
enum |
required |
optional |
|
The status of the shared sitelink. Valid values: ACTIVE, PAUSED, DELETED. |
enum |
required |
optional |
|
When displaying an ad, Oath: Ad will factor in this attribute in order to determine which links to show and in which order to show them. This should be a priority number between 1 and 10. |
int |
required |
optional |
Example Representations¶
Shared Sitelink Setting
{
"position": 1,
"parentType": "CAMPAIGN",
"siteLinkId": 2222222,
"parentId": 111111,
"status": "ACTIVE",
"id": 103002,
"advertiserId": 925746
}
Shared Sitelink Setting Array
[
{
"position": 1,
"parentType": "CAMPAIGN",
"siteLinkId": 2222222,
"parentId": 111111,
"status": "ACTIVE",
"id": 103002,
"advertiserId": 925746
},
{
"position": 1,
"parentType": "CAMPAIGN",
"siteLinkId": 2222222,
"parentId": 333333,
"status": "ACTIVE",
"id": 103003,
"advertiserId": 925746
}
]
Shared Sitelink Setting Response
{
"errors": null,
"response": [
{
"position": 1,
"parentType": "CAMPAIGN",
"siteLinkId": 2222222,
"parentId": 111111,
"status": "ACTIVE",
"id": 103002,
"advertiserId": 925746
}
]
}
Operations¶
Read
Method: To retrieve data for a specific shared sitelink setting, make a GET call with the ID parameter:
GET https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting/1234
The response will be the shared sitelink setting associated with the id:
{
"errors": null,
"response": [
{
"title": "Sales",
"landingUrl": "www.yahoo.com",
"description": "Sales - site link",
"status": "ACTIVE",
"id": 1234,
"advertiserId": 925746
}
]
}
Method: To retrieve data for a shared sitelink setting with multiple IDs, make a GET call with the ID parameter:
https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting?id=1234&id=5678
The response will be the shared sitelinks setting associated with multiple ids:
{
"errors": null,
"response": [
{
"position": 1,
"parentType": "CAMPAIGN",
"siteLinkId": 2222222,
"parentId": 111111,
"status": "ACTIVE",
"id": 103002,
"advertiserId": 925746
},
{
"title": "Sales",
"landingUrl": "www.yahoo.com",
"description": "Sales - site link",
"status": "ACTIVE",
"id": 5678,
"advertiserId": 925746
}
]
}
Read data for filtered list of shared sitelink settings
Method: To retrieve data for a filtered list of shared sitelink settings, make a GET call with the following parameters:
Name |
Description |
Type |
---|---|---|
|
The maximum number of rows to retrieve. |
int |
|
The start index or the first element to retrieve. |
int |
|
The ID of the advertiser to filter the shared site links by. |
long |
|
The ID of the parent campaign or adgroup to filter the shared site links by. |
long |
|
The parent type, either CAMPAIGN or ADGROUP. |
enum |
|
The ID of the parent shared sitelink to filter the shared site links by. |
long |
|
The shared sitelink status to filter by. |
enum |
Endpoint¶
Resource URI
https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting?advertiserId=1111&parentType=CAMPAIGN&parentId=22222
Create a new shared sitelink setting
Method: To create a new shared sitelink setting, make a POST call. The response will be the newly created shared sitelink.
For example:
POST https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting/
Update existing shared sitelink settings
Method: To update existing shared sitelink settings, make a PUT call. The result will be the list of updated shared sitelinks.
PUT https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting/
Delete a shared sitelink setting
Method: To delete a shared sitelink setting, make a PUT call.
Note
In v2, the DELETE operation is supported for both single and multiple ids.
For example:
DELETE https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting/1234
DELETE https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting?id=1234&id=5678
PUT https://api.gemini.yahoo.com/v3/rest/sharedsitelinksetting/
{
"status": "DELETED",
"id": 103002
}