The data dictionary service allows you to get a list of the supported values for different Gemini object attributes.

Note

The maximum number of objects that can be retrieved in a single GET call is 500. For optimal results, we recommend fetching in batches no larger than 100. For more information about pagination, refer to Pagination.

The dictionary type values can be used in the URI in order to get a list of the supported values for those dictionary types (see examples below). Note that supported dictionary types may be added over time, in which case the array in the response will grow. The GET call required in order to retrieve this list will not change.

Example: get a list of supported languages

To retrieve a list of the supported languages for advertisers and campaigns, make a GET call to the dictionary endpoint and specify “language” in the URI:

GEThttps://api.gemini.yahoo.com/v3/rest/dictionary/language

The response will be an array of all the supported values for the language dictionary type, along with a name describing each value:

WOEIDs represent location ids that are used for geo targeting on Gemini (refer to the targeting attribute service documentation for more details on working with WOEIDs). WOEIDs are different than other data dictionary types in that you need to specify which type of WOEID you are requesting the values for. Supported types are “country”, “region”, “state”, “DMA” and “city”.

For example, to get a list of supported city WOEIDs, make the following GET call:

GEThttps://api.gemini.yahoo.com/v3/rest/dictionary/woeid/?type=city

The response will be an array of all the supported city WOEIDs and a name describing them. The response will also include the parent WOEID for each value in that level:

The WOEIDs returned by the dictionary service cover the locations Yahoo Gemini officially supports. You can still target WOEIDs that are not in the dictionary as long as they are in the country, state, DMA, or city level. On search campaigns zip code level targeting is supported as well. Note that while targeting locations that are not in the dictionary is possible, it will likely result in more limited audience reach.

You can look up the WOEID for a location that may not be in the dictionary by passing in the location name as a parameter, as well as an optional ‘type’ parameter:

The WOEIDs returned by the dictionary service cover the locations Yahoo Gemini officially supports. You can still target WOEIDs that are not in the dictionary as long as they are in the country, state, DMA, or city level. On search campaigns zip code level targeting is supported as well. Note that while targeting locations that are not in the dictionary is possible, it will likely result in more limited audience reach.

You can look up the WOEID for a location that may not be in the dictionary by passing in the location name as a parameter, as well as an optional ‘type’ parameter: