dev'http_api'reference'GeoObject.RemoveTag

GeoObject.RemoveTag

GeoObject に設定された Tag を削除します。

Params

{ "id": <number>      // optional-A
, "ids": [ <number> ] // optional-A
, "tag: <string>      // optional-B
, "tags: [ <string> ] // optional-B
, "invalid_tag_is_not_an_error": <bool>
}

• optional-A の何れかは必須。両方の定義がある場合は id のみ対象とする。
• optional-B の何れかは必須。両方の定義がある場合は tag のみ対象とする。
• 複数のタグを対象とする場合は invalid_tag_is_not_an_error が必須となり、 true の場合は存在しないタグを削除しようとしてもエラーとしません。

Result

成功した場合は null 、失敗した場合はエラーオブジェクトが帰る。

ID が 1 件のみの場合:

null // or { "code": <number>, "message": <string> }

ID が複数の場合:

{ <string;id>: null // or { "code": <number>, "message": <string> }
}