Shared Structured Snippet Setting

Shared structured snippet settings are entities created on the advertiser account level, using the Shared Structured Snippet endpoint. Once created, they can be shared and linked to the advertiser or any campaign or adgroup. The relationship or link to advertiser or campaign or adgroup is handled using this endpoint.

Fields

Structured Snippet Settings include the following fields:

Name

Description

Type

Add

Update

id

The ID of the shared structured snippet.

long

required

required

advertiserId

The ID of the advertiser.

long

required

optional

structuredSnippetId

The ID of the parent shared structured snippet.

long

required

optional

parentId

The ID of the parent advertiser or campaign or adgroup.

long

required

optional

parentType

The parent type to assign the shared sitelink to. Valid values:

  • ADVERTISER

  • CAMPAIGN

  • ADGROUP

enum

required

optional

status

The status of the shared structured snippet. Valid values:

  • ACTIVE

  • DELETED

enum

required

optional

Endpoint

Resource URI

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

Example Representations

Shared Structured Snippet Setting

{
  "parentType": "CAMPAIGN",
  "structuredSnippetId": 111111,
  "status": "ACTIVE",
  "id": 103002,
  "advertiserId": 925746
}

Shared Structured Snippet Setting Array

 [
  {
   "parentType": "CAMPAIGN",
   "structuredSnippetId": 111111,
   "parentId": 222222,
   "status": "ACTIVE",
   "id": 103002,
   "advertiserId": 925746
  },
  {
   "parentType": "CAMPAIGN",
   "structuredSnippetId": 111111,
   "parentId": 222222,
   "status": "ACTIVE",
   "id": 103003,
   "advertiserId": 925746
  }
]

Shared Structured Snippet Setting Response

{
 "errors": null,
 "response": [
   {
     "parentType": "CAMPAIGN",
     "structuredSnippetId": 111111,
     "parentId": 222222,
     "status": "ACTIVE",
     "id": 103002,
     "advertiserId": 925746
   }
 ]
}

Operations

Read

Method: To retrieve data for a specific shared structured snippet setting, make a GET call with the ID parameter:

GET https://api.gemini.yahoo.com/v3/rest/shared structuredsnippetsettings/1234

The response will be the shared structured snippet settings associated with the id:

{
  "errors": null,
  "response": [
     {
        "parentType": "CAMPAIGN",
        "structuredSnippetId": 111111,
        "parentId": 222222,
        "status": "ACTIVE",
        "id": 1234,
        "advertiserId": 925746
     }
  ]
}

Method: To retrieve data for a shared structured snippet settings with multiple IDs, make a GET call with the ID parameter:

GET https://api.gemini.yahoo.com/v3/rest/sharedstructuredsnippet?id=1234&id=5678

    The response will be the structured snippet settings associated with multiple ids:

    {
      "errors": null,
      "response": [
         {
            "parentType": "CAMPAIGN",
            "structuredSnippetId": 111111,
            "parentId": 222222,
            "status": "ACTIVE",
            "id": 1234,
            "advertiserId": 925746
         },
         {
            "parentType": "CAMPAIGN",
            "structuredSnippetId": 111111,
            "parentId": 222222,
            "status": "ACTIVE",
            "id": 5678,
            "advertiserId": 925747
         }
      ]
    }

Read data for a filtered list of shared structured snippet settings

Method: To retrieve data for a filtered list of shared structured snippet settings, make a GET call with the following parameters:

Name

Description

Type

mr

The maximum number of rows to retrieve.

int

si

The start index or the first element to retrieve.

int

advertiserId

The ID of the advertiser to filter the shared structured snippet setting by.

long

status

The shared structured snippet settting status to filter by.

enum


Important

Only one advertiserId parameter is allowed to be passed in as a query parameter for all filtered lists of shared structured snippet settings calls.

Endpoint

Resource URI

https://api.gemini.yahoo.com/v3/rest/sharedstructuredsnippetsettings?advertiserId=1111

Create a new shared structured snippet settings

Method: To create a new shared structured snippet settings, make a POST call. The response will be the newly created structured snippet settings.

For example:

POST https://api.gemini.yahoo.com/v3/rest/sharedstructuredsnippetsettings/

Update existing shared structured snippet

Method: To update an existing shared structured snippet, make a PUT call. The result will be the list of updated shared structured snippets.

PUT  https://api.gemini.yahoo.com/v3/rest/sharedstructuredsnippetsettings/

Delete a shared structured snippet

Method: To delete a shared structured snippet settings, 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/sharedstructuredsnippetsettings/1234
DELETE  https://api.gemini.yahoo.com/v3/rest/sharedstructuredsnippetsettings?id=1234&id=5678

PUT https://api.gemini.yahoo.com/v3/rest/sharedstructuredsnippetsettings/

{
  "status": "DELETED",
  "id": 103002
}