GN IDs API

Publish or Republish a Program

You can publish programs individually or as a batch using the Bulk Publish Programs feature. For more information about bulk publishing, see What is Bulk Publish.

When you publish a program, GN IDS associates the program with a TMS ID in the Gracenote-certified dataset. You can optionally specify a self-mapping ID to immediately associate an ID with the program. With special arrangement with Gracenote, publishing a program also makes the data available to entitled distribution platforms. See Deliver Programs.

Publish an Individual Program

To publish (or republish) a program:

1. Execute the POST /publish method using the presentation's gnID to publish a movie, show, or episode presentation.
2. Optionally, provide a self-mapping ID to associate with this program. Include the ID in the mapping request body. Gracenote may replace this ID if the previous TMS ID was deleted.

Note: Self mapping is initially available on a limited basis. If interested, please ask your Gracenote representative.

The mappingInfo parameters are:

• id: Contains the tmsID to map to the presentation.
• type: Describes the type of ID that was used for self-mapping. Currently, this is tmsID only.

Code
 
{
   "forceCreate": boolean,
   "gnID": "string",
   "mapping": {
     "id": "string",
     "type": "string"
   }
 }

For example:

Code
 
curl -X 'POST' \
 'https://gnids.gracenote.com/api/v1/publish' -H 'accept: application/json' \
 -H 'Content-Type: application/json' \
 -H 'GN-APIKEY: your-api-key \
 -d '{  "forceCreate": false,  "gnID": "GNLZZXW00000001", "mapping": {"id": "<self-mapping-id>", "type": "tmsID" }}'

Note: When published, you can get the mapping information from the mappingInfo object in the response. See Get ID Mapping Information.

Bulk Publish Programs

Provide a list of presentations gnIDs (of type show and/or movie and/or episode) for batch publishing. Optionally, include self-service mapping tmsIDs and a corresponding mapping object. A maximum of 1000 publications can be published at a single time.

To bulk publish multiple programs as a batch:

1. Execute the POST /bulk/publish method using the a list of presentation gnIDs.
   Note: Refer to the Data Dictionary for fields that are required to publish a program.
2. Optionally, provide a self-mapping ID to associate with the presentation. Include the tmsID in the mapping request body. Gracenote may replace this ID if the previous TMS ID was deleted.

Example Request

The sample code below is from the POST method in the API Explorer. Although it is not an actual example, it shows the kinds of data elements that are required for publishing. Refer to the Data Dictionary for more information.

Code
 
 curl --request POST \
  --url https://gnids.gracenote.com/api/v1/bulk/movies/batches \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'GN-APIKEY: <your-api-key>' \
  --data '{
  "context": {
    "property1": "string",
    "property2": "string"
  },
  "presentations": [
    {
      "context": {
        "property1": "string",
        "property2": "string"
      },
      "presentation": {
        "cast": [
          {
            "aka": {
              "first": "string",
              "last": "string",
              "middle": "string",
              "prefix": "string",
              "suffix": "string"
            },
            "name": {
              "first": "string",
              "last": "string",
              "middle": "string",
              "prefix": "string",
              "suffix": "string"
            },
            "order": 1,
            "character": "string",
            "role": "string"
          }
        ],
        "crew": [
          {
            "aka": {
              "first": "string",
              "last": "string",
              "middle": "string",
              "prefix": "string",
              "suffix": "string"
            },
            "name": {
              "first": "string",
              "last": "string",
              "middle": "string",
              "prefix": "string",
              "suffix": "string"
            },
            "order": 1,
            "type": "string"
          }
        ],
        "descriptions": [
          {
            "language": "string",
            "length": -9007199254740991,
            "value": "string"
          }
        ],
        "externalIDs": [
          {
            "id": "string",
            "isPrimary": true,
            "isProvider": true,
            "label": "string"
          }
        ],
        "genres": [
          "Fantasy",
          "Adventure"
        ],
        "originalSource": "Lifetime",
        "presentationLabels": [
          "UK EN",
          "US EN"
        ],
        "productionCompanies": [
          "Newline"
        ],
        "productionCountries": [
          "CA"
        ],
        "productionStatus": "completed",
        "ratings": [
          {
            "advisories": [
              "contains strong language"
            ],
            "rating": "PG-13",
            "ratingBody": "MPAA"
          }
        ],
        "releaseDate": "2019-08-24",
        "releaseYear": 2000,
        "targetAudience": "children",
        "title": {
          "language": "string",
          "value": "string"
        },
        "subType": "featureFilm"
      },
      "versionGnID": "string"
    }
  ]
}'