boardgamegeek icon indicating copy to clipboard operation
boardgamegeek copied to clipboard

Missing actual name in BoardGameVersion

Open arnauldvm opened this issue 5 years ago • 1 comments

The current name property in BoardGameVersion class is what is actually called "nickname" in the web site.

(For example, the main name for game 41052 is "Loco Motive", but the name of the version 337221 is "Tokyo Train" while its nickname is "Cocktail Games French edition".)

Unfortunately, the actual name ("Tokyo Train" in the example) is not returned by the BGG XMLAPI2 (it returns "Cocktail Games French edition"). And the legacy API does not help for this problem.

The only way I could find to be able to retrieve this information is through a hidden :-( API. E.g.: https://api.geekdo.com/api/geekitem/linkeditems?ajax=1&linkdata_index=boardgameversion&nosession=1&objectid=41052&objecttype=thing&pageid=1&showcount=10&sort=yearpublished&subtype=boardgameversion
returns:

// ...
{
    "yearpublished": "2013",
    // ...
    "linktype": "boardgameversion",
    "objecttype": "version",
    "objectid": "337221",
    // ...
    "linkedname": "Tokyo Train",
    "links": {
        // ...
        "languages": [
            {
                "name": "French",
                // ...
            }
        ]
    },
    "href": "\/boardgameversion\/337221\/cocktail-games-french-edition",
    "versionname": "Cocktail Games French edition",
    "images": {
        // ...
    }
},
// ...

(See also: https://boardgamegeek.com/thread/1616315/getting-structured-game-version-and-publisher-data.)

Though, I'm really not sure if using undocumented (and even less supported) API's is in the scope of this project... :-/

?? Or should I start a side project ??

arnauldvm avatar Mar 14 '19 20:03 arnauldvm

I wouldn't use an undocumented API; if they make it official, sure, but until then...

I'll leave this issue open for the moment, I want to look into it more closely when I get the chance.

On Thu, Mar 14, 2019, 22:24 Arnauld Van Muysewinkel < [email protected]> wrote:

The current name property in BoardGameVersion class is what is actually called "nickname" in the web site.

(For example, the main name for game 41052 is "Loco Motive", but the name of the version 337221 is "Tokyo Train" while its nickname is "Cocktail Games French edition".)

Unfortunately, the actual name ("Tokyo Train" in the example) is not returned by the BGG XMLAPI2 (it returns "Cocktail Games French edition"). And the legacy API does not help for this problem.

The only way I could find to be able to retrieve this information is through a hidden :-( API. E.g.:

https://api.geekdo.com/api/geekitem/linkeditems?ajax=1&linkdata_index=boardgameversion&nosession=1&objectid=41052&objecttype=thing&pageid=1&showcount=10&sort=yearpublished&subtype=boardgameversion returns:

// ... { "yearpublished": "2013", // ... "linktype": "boardgameversion", "objecttype": "version", "objectid": "337221", // ... "linkedname": "Tokyo Train", "links": { // ... "languages": [ { "name": "French", // ... } ] }, "href": "/boardgameversion/337221/cocktail-games-french-edition", "versionname": "Cocktail Games French edition", "images": { // ... } },// ...

(See also: https://boardgamegeek.com/thread/1616315/getting-structured-game-version-and-publisher-data .)

Though, I'm really not sure if using undocumented (and even less supported) API's is in the scope of this project... :-/

?? Or should I start a side project ??

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/lcosmin/boardgamegeek/issues/57, or mute the thread https://github.com/notifications/unsubscribe-auth/ABHFHO5hiwpfKM_xcIr9JgjuuOXMxUk-ks5vWrAWgaJpZM4b1JMW .

lcosmin avatar Mar 16 '19 12:03 lcosmin